xref: /OK3568_Linux_fs/yocto/meta-openembedded/meta-oe/classes/gitpkgv.bbclass (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1# gitpkgv.bbclass provides a GITPKGV and GITPKGVTAG variables to be
2# used in PKGV, as described bellow:
3#
4# - GITPKGV which is a sortable version with the format NN+GITHASH, to
5#   be used in PKGV, where
6#
7#   NN equals the total number of revs up to SRCREV
8#   GITHASH is SRCREV's (full) hash
9#
10# - GITPKGVTAG which is the output of 'git describe --tags --exact-match'
11#   allowing for automatic versioning
12#
13# gitpkgv.bbclass assumes the git repository has been cloned, and
14# contains SRCREV. So ${GITPKGV} and ${GITPKGVTAG} should never be
15# used in PV, only in PKGV.  It can handle SRCREV = ${AUTOREV}, as
16# well as SRCREV = "<some fixed git hash>".
17#
18# WARNING: if upstream repository is always using consistent and
19# sortable tag name scheme you can get sortable version including tag
20# name with ${GITPKGVTAG}, but be aware that ie tag sequence "v1.0,
21# v1.2, xtest, v2.0" will force you to increment PE to get upgradeable
22# path to v2.0 revisions
23#
24# use example:
25#
26# inherit gitpkgv
27#
28# PV = "1.0+gitr${SRCPV}"      # expands to something like 1.0+gitr3+4c1c21d7dbbf93b0df336994524313dfe0d4963b
29# PKGV = "1.0+gitr${GITPKGV}"  # expands also to something like 1.0+gitr31337+4c1c21d7d
30#
31# or
32#
33# inherit gitpkgv
34#
35# PV = "1.0+gitr${SRCPV}" # expands to something like 1.0+gitr3+4c1c21d7dbbf93b0df336994524313dfe0d4963b
36# PKGV = "${GITPKGVTAG}"  # expands to something like 1.0-31337+g4c1c21d
37#                           if there is tag v1.0 before this revision or
38#                           ver1.0-31337+g4c1c21d if there is tag ver1.0
39
40GITPKGV = "${@get_git_pkgv(d, False)}"
41GITPKGVTAG = "${@get_git_pkgv(d, True)}"
42
43# This regexp is used to drop unwanted parts of the found tags. Any matching
44# groups will be concatenated to yield the final version.
45GITPKGV_TAG_REGEXP ??= "v(\d.*)"
46
47def gitpkgv_drop_tag_prefix(d, version):
48    import re
49
50    m = re.match(d.getVar('GITPKGV_TAG_REGEXP'), version)
51    if m:
52        return ''.join(group for group in m.groups() if group)
53    else:
54        return version
55
56def get_git_pkgv(d, use_tags):
57    import os
58    import bb
59    from pipes import quote
60
61    src_uri = d.getVar('SRC_URI').split()
62    fetcher = bb.fetch2.Fetch(src_uri, d)
63    ud = fetcher.ud
64
65    #
66    # If SRCREV_FORMAT is set respect it for tags
67    #
68    format = d.getVar('SRCREV_FORMAT')
69    if not format:
70        names = []
71        for url in ud.values():
72            if url.type == 'git' or url.type == 'gitsm':
73                names.extend(url.revisions.keys())
74        if len(names) > 0:
75            format = '_'.join(names)
76        else:
77            format = 'default'
78
79    found = False
80    for url in ud.values():
81        if url.type == 'git' or url.type == 'gitsm':
82            for name, rev in url.revisions.items():
83                if not os.path.exists(url.localpath):
84                    return None
85
86                found = True
87
88                vars = { 'repodir' : quote(url.localpath),
89                         'rev' : quote(rev) }
90
91                rev = bb.fetch2.get_srcrev(d).split('+')[1]
92                rev_file = os.path.join(url.localpath, "oe-gitpkgv_" + rev)
93
94                if not os.path.exists(rev_file) or os.path.getsize(rev_file)==0:
95                    commits = bb.fetch2.runfetchcmd(
96                        "git --git-dir=%(repodir)s rev-list %(rev)s -- 2>/dev/null | wc -l"
97                        % vars, d, quiet=True).strip().lstrip('0')
98
99                    if commits != "":
100                        oe.path.remove(rev_file, recurse=False)
101                        with open(rev_file, "w") as f:
102                            f.write("%d\n" % int(commits))
103                    else:
104                        commits = "0"
105                else:
106                    with open(rev_file, "r") as f:
107                        commits = f.readline(128).strip()
108
109                if use_tags:
110                    try:
111                        output = bb.fetch2.runfetchcmd(
112                            "git --git-dir=%(repodir)s describe %(rev)s --tags --exact-match 2>/dev/null"
113                            % vars, d, quiet=True).strip()
114                        ver = gitpkgv_drop_tag_prefix(d, output)
115                    except Exception:
116                        ver = "0.0-%s-g%s" % (commits, vars['rev'][:7])
117                else:
118                    ver = "%s+%s" % (commits, vars['rev'][:7])
119
120                format = format.replace(name, ver)
121
122    if found:
123        return format
124
125    return '0+0'
126