BLD: define version when building from git tarball.

Version resolution is now processed as follows:

(1) accept version.hpp if present
(2) use git commit data when building from git repository.
(3) use version data from gitarchive.cfg if expanded.
(4) use FALLBACK_VERSION when archive is not version-tagged.

Author: pavoljuhas

doc/manual/source/conf.py

@@ -58,13 +58,13 @@
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
-from libdiffpybuildutils import gitinfo
-ginfo = gitinfo()
+from libdiffpybuildutils import getversion
+gver = getversion()
 # The short X.Y version.
-vfmt = '%(major)i.%(minor)i' + ('.%(micro)i' if ginfo['micro'] else '')
-version = vfmt % ginfo
+vfmt = '%(major)i.%(minor)i' + ('.%(micro)i' if gver['micro'] else '')
+version = vfmt % gver
 # The full version, including alpha/beta/rc tags.
-release = ginfo['version']
+release = gver['version']
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -73,7 +73,7 @@
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
 #today = ''
-fulldate = ginfo['date']
+fulldate = gver['date']
 today_seconds = time.strptime(fulldate.split()[0], '%Y-%m-%d')
 today = time.strftime('%B %d, %Y', today_seconds)
 year = today.split()[-1]

site_scons/fallback_version.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python
+
+'''
+Definition of FALLBACK_VERSION.  Use it when git repository is
+not available for example, when building from git zip archive.
+
+Update FALLBACK_VERSION when tagging a new release.
+'''
+
+FALLBACK_VERSION = '1.3.3.post0'

site_scons/libdiffpybuildutils.py

@@ -8,6 +8,14 @@
 
 MYDIR = os.path.dirname(os.path.abspath(__file__))
 
+GIT_MISSING_ERROR_MSG = """
+Cannot determine libdiffpy version.  Compile from a git repository
+or use a source archive from
+
+    https://github.com/diffpy/libdiffpy/releases
+"""
+
+
 def gitinfo():
     'Extract dictionary of version data from git records.'
     from subprocess import Popen, PIPE
@@ -28,11 +36,6 @@ def gitinfo():
     vnum = int((words[1:2] or ['0'])[0])
     rv = {}
     rv['commit'], rv['date'] = glog.strip().split(None, 1)
-    mx = re.match(r'^(\d+)\.(\d+)(?:\.(\d+))?((?:[ab]|rc)\d*)?', vtag)
-    rv['major'] = int(mx.group(1))
-    rv['minor'] = int(mx.group(2))
-    rv['micro'] = int(mx.group(3) or 0)
-    rv['prerelease'] = mx.group(4)
     rv['patchnumber'] = vnum
     rv['version'] = vtag
     if vnum:
@@ -41,3 +44,50 @@ def gitinfo():
     return gitinfo()
 
 _cached_gitinfo = None
+
+
+def getversion():
+    """Extract version from gitinfo and/or gitarchive.cfg file.
+
+    Process gitinfo first and make sure it matches FALLBACK_VERSION
+    in gitarchive.cfg.  Use expanded data from gitarchive.cfg when
+    these sources are from git archive bundle.
+    """
+    from ConfigParser import RawConfigParser
+    from fallback_version import FALLBACK_VERSION
+    gitarchivecfgfile = os.path.join(MYDIR, 'gitarchive.cfg')
+    assert os.path.isfile(gitarchivecfgfile)
+    cp = RawConfigParser()
+    cp.read(gitarchivecfgfile)
+    ga = cp.defaults()
+    gi = gitinfo()
+    rv = {}
+    if gi:
+        afb = FALLBACK_VERSION
+        gfb = gi['version'].split('.post')[0] + '.post0'
+        emsg = "Inconsistent FALLBACK_VERSION {!r}.  Git tag suggests {!r}."
+        assert gfb == afb, emgs.format(afb, gfb)
+        rv.update(gi)
+    else:
+        # Not a git repository.  Require that gitarchive.cfg is expanded.
+        assert '$Format:' not in ga['commit'], GIT_MISSING_ERROR_MSG
+        rv['commit'] = ga['commit']
+        rv['date'] = ga['date']
+        # First assume we have an undetermined post-release.  Keep version
+        # suffix as ".post0", but set patchnumber to ensure we are post
+        # FALLBACK_VERSION.
+        rv['version'] = FALLBACK_VERSION
+        rv['patchnumber'] = 1
+        # If we are at version tag turn this to regular release.
+        mx = re.search(r'\btag: v(\d[^,]*)', ga['refnames'])
+        if mx:
+            rv['version'] = mx.group(1)
+            rv['patchnumber'] = 0
+    # rv['version'] is resolved, let's parse its subfields.
+    vbase = rv['version'].split('.post')[0]
+    mx = re.match(r'^(\d+)\.(\d+)(?:\.(\d+))?((?:[ab]|rc)\d*)?', vbase)
+    rv['major'] = int(mx.group(1))
+    rv['minor'] = int(mx.group(2))
+    rv['micro'] = int(mx.group(3) or 0)
+    rv['prerelease'] = mx.group(4)
+    return rv

src/diffpy/SConscript.version

@@ -16,28 +16,28 @@ def parsemajorminor(hcode):
 
 def build_VersionCode(target, source, env):
     tplcode = source[0].get_contents()
-    numversion = ginfo['major']
-    numversion = 1000 * numversion + ginfo['minor']
-    numversion = 1000 * numversion + ginfo['micro']
-    numversion = 1000 * numversion + ginfo['patchnumber']
+    numversion = gver['major']
+    numversion = 1000 * numversion + gver['minor']
+    numversion = 1000 * numversion + gver['micro']
+    numversion = 1000 * numversion + gver['patchnumber']
     # verify that formulas in version.tpl work as advertised
     emsg = "Inconsistent value of DIFFPY_VERSION = %i" % numversion
-    assert numversion // 1000000000 == ginfo['major'], emsg
-    assert numversion // 1000000 % 1000 == ginfo['minor'], emsg
-    assert numversion // 1000 % 1000 == ginfo['micro'], emsg
-    assert numversion % 500 == ginfo['patchnumber'], emsg
+    assert numversion // 1000000000 == gver['major'], emsg
+    assert numversion // 1000000 % 1000 == gver['minor'], emsg
+    assert numversion // 1000 % 1000 == gver['micro'], emsg
+    assert numversion % 500 == gver['patchnumber'], emsg
     libversion = str(numversion) + "LL"
-    if ginfo['prerelease']:
+    if gver['prerelease']:
         libversion = "(-500 + %s)" % libversion
     flds = {
         'DIFFPY_VERSION' : libversion,
-        'DIFFPY_VERSION_MAJOR' : ginfo['major'],
-        'DIFFPY_VERSION_MINOR' : ginfo['minor'],
-        'DIFFPY_VERSION_MICRO' : ginfo['micro'],
-        'DIFFPY_VERSION_PATCH' : ginfo['patchnumber'],
-        'DIFFPY_VERSION_STR' : ginfo['version'],
-        'DIFFPY_VERSION_DATE' : ginfo['date'],
-        'DIFFPY_GIT_SHA' : ginfo['commit'],
+        'DIFFPY_VERSION_MAJOR' : gver['major'],
+        'DIFFPY_VERSION_MINOR' : gver['minor'],
+        'DIFFPY_VERSION_MICRO' : gver['micro'],
+        'DIFFPY_VERSION_PATCH' : gver['patchnumber'],
+        'DIFFPY_VERSION_STR' : gver['version'],
+        'DIFFPY_VERSION_DATE' : gver['date'],
+        'DIFFPY_GIT_SHA' : gver['commit'],
     }
     versiontemplate = string.Template(tplcode)
     versioncode = versiontemplate.safe_substitute(flds)
@@ -65,26 +65,16 @@ env.Append(BUILDERS={'BuildFeaturesCode' :
 
 vhpp = File('version.hpp')
 
-MY_GIT_MISSING_ERROR_MSG = """
-Cannot determine libdiffpy version.  Compile from a git repository
-or use a source archive from
-
-    https://github.com/diffpy/libdiffpy/releases
-"""
-
 # If version.hpp exists do not use git
 if os.path.isfile(str(vhpp.srcnode())):
     majorminor = parsemajorminor(vhpp.srcnode().get_contents())
 else:
-    from libdiffpybuildutils import gitinfo
+    from libdiffpybuildutils import getversion
     vtpl = File('version.tpl')
-    ginfo = gitinfo()
-    if not ginfo:
-        print MY_GIT_MISSING_ERROR_MSG
-        Exit(1)
+    gver = getversion()
     vhpp, = env.BuildVersionCode(['version.hpp'], vtpl)
-    env.Depends(vhpp, env.Value(ginfo['version'] + ginfo['commit']))
-    majorminor = (ginfo['major'], ginfo['minor'])
+    env.Depends(vhpp, env.Value(gver['version'] + gver['commit']))
+    majorminor = (gver['major'], gver['minor'])
 
 fhpp, = env.BuildFeaturesCode(['features.tpl'])
 env.Depends(fhpp, env.Value(env['has_objcryst']))