Updated openstack-common setup and version code.

Updating setup and version require code changes in the code base. This is done
here to support Id9c116a1e10e5c240913fae7a127110b806eff0f

Change-Id: I60b6dd6d684982e33de8fbf051a3dcaf98cb9b87

doc/source/conf.py

@@ -76,8 +76,8 @@ copyright = u'2011-present, OpenStack, LLC.'
 # built documents.
 #
 # Version info
-from quantum import version as quantum_version
+from quantum.version import version_info as quantum_version
-release = quantum_version.version_string()
+release = quantum_version.version_string_with_vcs()
 # The short X.Y version.
 version = quantum_version.canonical_version_string()
 

openstack-common.conf

@@ -1,5 +1,5 @@
 [DEFAULT]
 # The list of modules to copy from openstack-common
-modules=cfg,context,eventlet_backdoor,exception,excutils,gettextutils,importutils,iniparser,jsonutils,local,log,loopingcall,network_utils,notifier,policy,rpc,service,setup,threadgroup,timeutils,uuidutils
+modules=cfg,context,eventlet_backdoor,exception,excutils,gettextutils,importutils,iniparser,jsonutils,local,log,loopingcall,network_utils,notifier,policy,rpc,service,setup,threadgroup,timeutils,uuidutils,version
 # The base module to hold the copy of openstack.common
 base=quantum

quantum/common/config.py

@@ -27,7 +27,8 @@ from paste import deploy
 from quantum.api.v2 import attributes
 from quantum.openstack.common import cfg
 from quantum.openstack.common import log as logging
-from quantum.version import version_string
+from quantum.version import version_info as quantum_version
+
 
 LOG = logging.getLogger(__name__)
 
@@ -60,7 +61,7 @@ cfg.CONF.register_opts(core_opts)
 
 def parse(args):
     cfg.CONF(args=args, project='quantum',
-             version='%%prog %s' % version_string())
+             version='%%prog %s' % quantum_version.version_string_with_vcs())
 
     # Validate that the base_mac is of the correct format
     msg = attributes._validate_regex(cfg.CONF.base_mac,

quantum/openstack/common/setup.py

@@ -19,9 +19,11 @@
 Utilities with minimum-depends for use in setup.py
 """
 
+import datetime
 import os
 import re
 import subprocess
+import sys
 
 from setuptools.command import sdist
 
@@ -29,13 +31,13 @@ from setuptools.command import sdist
 def parse_mailmap(mailmap='.mailmap'):
     mapping = {}
     if os.path.exists(mailmap):
-        fp = open(mailmap, 'r')
+        with open(mailmap, 'r') as fp:
-        for l in fp:
+            for l in fp:
-            l = l.strip()
+                l = l.strip()
-            if not l.startswith('#') and ' ' in l:
+                if not l.startswith('#') and ' ' in l:
-                canonical_email, alias = [x for x in l.split(' ')
+                    canonical_email, alias = [x for x in l.split(' ')
-                                          if x.startswith('<')]
+                                              if x.startswith('<')]
-                mapping[alias] = canonical_email
+                    mapping[alias] = canonical_email
     return mapping
 
 
@@ -52,7 +54,8 @@ def canonicalize_emails(changelog, mapping):
 def get_reqs_from_files(requirements_files):
     for requirements_file in requirements_files:
         if os.path.exists(requirements_file):
-            return open(requirements_file, 'r').read().split('\n')
+            with open(requirements_file, 'r') as fil:
+                return fil.read().split('\n')
     return []
 
 
@@ -75,6 +78,10 @@ def parse_requirements(requirements_files=['requirements.txt',
         # -f lines are for index locations, and don't get used here
         elif re.match(r'\s*-f\s+', line):
             pass
+        # argparse is part of the standard library starting with 2.7
+        # adding it to the requirements list screws distro installs
+        elif line == 'argparse' and sys.version_info >= (2, 7):
+            pass
         else:
             requirements.append(line)
 
@@ -112,56 +119,128 @@ def write_requirements():
 def _run_shell_command(cmd):
     output = subprocess.Popen(["/bin/sh", "-c", cmd],
                               stdout=subprocess.PIPE)
-    return output.communicate()[0].strip()
+    out = output.communicate()
+    if len(out) == 0:
+        return None
+    if len(out[0].strip()) == 0:
+        return None
+    return out[0].strip()
 
 
-def write_vcsversion(location):
+def _get_git_next_version_suffix(branch_name):
-    """Produce a vcsversion dict that mimics the old one produced by bzr.
+    datestamp = datetime.datetime.now().strftime('%Y%m%d')
-    """
+    if branch_name == 'milestone-proposed':
-    if os.path.isdir('.git'):
+        revno_prefix = "r"
-        branch_nick_cmd = 'git branch | grep -Ei "\* (.*)" | cut -f2 -d" "'
+    else:
-        branch_nick = _run_shell_command(branch_nick_cmd)
+        revno_prefix = ""
-        revid_cmd = "git rev-parse HEAD"
+    _run_shell_command("git fetch origin +refs/meta/*:refs/remotes/meta/*")
-        revid = _run_shell_command(revid_cmd).split()[0]
+    milestone_cmd = "git show meta/openstack/release:%s" % branch_name
-        revno_cmd = "git log --oneline | wc -l"
+    milestonever = _run_shell_command(milestone_cmd)
-        revno = _run_shell_command(revno_cmd)
+    if milestonever:
-        with open(location, 'w') as version_file:
+        first_half = "%s~%s" % (milestonever, datestamp)
-            version_file.write("""
+    else:
-# This file is automatically generated by setup.py, So don't edit it. :)
+        first_half = datestamp
-version_info = {
+
-    'branch_nick': '%s',
+    post_version = _get_git_post_version()
-    'revision_id': '%s',
+    # post version should look like:
-    'revno': %s
+    # 0.1.1.4.gcc9e28a
-}
+    # where the bit after the last . is the short sha, and the bit between
-""" % (branch_nick, revid, revno))
+    # the last and second to last is the revno count
+    (revno, sha) = post_version.split(".")[-2:]
+    second_half = "%s%s.%s" % (revno_prefix, revno, sha)
+    return ".".join((first_half, second_half))
+
+
+def _get_git_current_tag():
+    return _run_shell_command("git tag --contains HEAD")
+
+
+def _get_git_tag_info():
+    return _run_shell_command("git describe --tags")
+
+
+def _get_git_post_version():
+    current_tag = _get_git_current_tag()
+    if current_tag is not None:
+        return current_tag
+    else:
+        tag_info = _get_git_tag_info()
+        if tag_info is None:
+            base_version = "0.0"
+            cmd = "git --no-pager log --oneline"
+            out = _run_shell_command(cmd)
+            revno = len(out.split("\n"))
+            sha = _run_shell_command("git describe --always")
+        else:
+            tag_infos = tag_info.split("-")
+            base_version = "-".join(tag_infos[:-2])
+            (revno, sha) = tag_infos[-2:]
+        return "%s.%s.%s" % (base_version, revno, sha)
 
 
 def write_git_changelog():
     """Write a changelog based on the git changelog."""
-    if os.path.isdir('.git'):
+    new_changelog = 'ChangeLog'
-        git_log_cmd = 'git log --stat'
+    if not os.getenv('SKIP_WRITE_GIT_CHANGELOG'):
-        changelog = _run_shell_command(git_log_cmd)
+        if os.path.isdir('.git'):
-        mailmap = parse_mailmap()
+            git_log_cmd = 'git log --stat'
-        with open("ChangeLog", "w") as changelog_file:
+            changelog = _run_shell_command(git_log_cmd)
-            changelog_file.write(canonicalize_emails(changelog, mailmap))
+            mailmap = parse_mailmap()
+            with open(new_changelog, "w") as changelog_file:
+                changelog_file.write(canonicalize_emails(changelog, mailmap))
+    else:
+        open(new_changelog, 'w').close()
 
 
 def generate_authors():
     """Create AUTHORS file using git commits."""
-    jenkins_email = 'jenkins@review.openstack.org'
+    jenkins_email = 'jenkins@review.(openstack|stackforge).org'
     old_authors = 'AUTHORS.in'
     new_authors = 'AUTHORS'
-    if os.path.isdir('.git'):
+    if not os.getenv('SKIP_GENERATE_AUTHORS'):
-        # don't include jenkins email address in AUTHORS file
+        if os.path.isdir('.git'):
-        git_log_cmd = ("git log --format='%aN <%aE>' | sort -u | "
+            # don't include jenkins email address in AUTHORS file
-                       "grep -v " + jenkins_email)
+            git_log_cmd = ("git log --format='%aN <%aE>' | sort -u | "
-        changelog = _run_shell_command(git_log_cmd)
+                           "egrep -v '" + jenkins_email + "'")
-        mailmap = parse_mailmap()
+            changelog = _run_shell_command(git_log_cmd)
-        with open(new_authors, 'w') as new_authors_fh:
+            mailmap = parse_mailmap()
-            new_authors_fh.write(canonicalize_emails(changelog, mailmap))
+            with open(new_authors, 'w') as new_authors_fh:
-            if os.path.exists(old_authors):
+                new_authors_fh.write(canonicalize_emails(changelog, mailmap))
-                with open(old_authors, "r") as old_authors_fh:
+                if os.path.exists(old_authors):
-                    new_authors_fh.write('\n' + old_authors_fh.read())
+                    with open(old_authors, "r") as old_authors_fh:
+                        new_authors_fh.write('\n' + old_authors_fh.read())
+    else:
+        open(new_authors, 'w').close()
+
+
+_rst_template = """%(heading)s
+%(underline)s
+
+.. automodule:: %(module)s
+  :members:
+  :undoc-members:
+  :show-inheritance:
+"""
+
+
+def read_versioninfo(project):
+    """Read the versioninfo file. If it doesn't exist, we're in a github
+       zipball, and there's really no way to know what version we really
+       are, but that should be ok, because the utility of that should be
+       just about nil if this code path is in use in the first place."""
+    versioninfo_path = os.path.join(project, 'versioninfo')
+    if os.path.exists(versioninfo_path):
+        with open(versioninfo_path, 'r') as vinfo:
+            version = vinfo.read().strip()
+    else:
+        version = "0.0.0"
+    return version
+
+
+def write_versioninfo(project, version):
+    """Write a simple file containing the version of the package."""
+    with open(os.path.join(project, 'versioninfo'), 'w') as fil:
+        fil.write("%s\n" % version)
 
 
 def get_cmdclass():
@@ -169,6 +248,12 @@ def get_cmdclass():
 
     cmdclass = dict()
 
+    def _find_modules(arg, dirname, files):
+        for filename in files:
+            if filename.endswith('.py') and filename != '__init__.py':
+                arg["%s.%s" % (dirname.replace('/', '.'),
+                               filename[:-3])] = True
+
     class LocalSDist(sdist.sdist):
         """Builds the ChangeLog and Authors files from VC first."""
 
@@ -187,13 +272,91 @@ def get_cmdclass():
         from sphinx.setup_command import BuildDoc
 
         class LocalBuildDoc(BuildDoc):
+            def generate_autoindex(self):
+                print "**Autodocumenting from %s" % os.path.abspath(os.curdir)
+                modules = {}
+                option_dict = self.distribution.get_option_dict('build_sphinx')
+                source_dir = os.path.join(option_dict['source_dir'][1], 'api')
+                if not os.path.exists(source_dir):
+                    os.makedirs(source_dir)
+                for pkg in self.distribution.packages:
+                    if '.' not in pkg:
+                        os.path.walk(pkg, _find_modules, modules)
+                module_list = modules.keys()
+                module_list.sort()
+                autoindex_filename = os.path.join(source_dir, 'autoindex.rst')
+                with open(autoindex_filename, 'w') as autoindex:
+                    autoindex.write(""".. toctree::
+   :maxdepth: 1
+
+""")
+                    for module in module_list:
+                        output_filename = os.path.join(source_dir,
+                                                       "%s.rst" % module)
+                        heading = "The :mod:`%s` Module" % module
+                        underline = "=" * len(heading)
+                        values = dict(module=module, heading=heading,
+                                      underline=underline)
+
+                        print "Generating %s" % output_filename
+                        with open(output_filename, 'w') as output_file:
+                            output_file.write(_rst_template % values)
+                        autoindex.write("   %s.rst\n" % module)
+
             def run(self):
+                if not os.getenv('SPHINX_DEBUG'):
+                    self.generate_autoindex()
+
                 for builder in ['html', 'man']:
                     self.builder = builder
                     self.finalize_options()
+                    self.project = self.distribution.get_name()
+                    self.version = self.distribution.get_version()
+                    self.release = self.distribution.get_version()
                     BuildDoc.run(self)
         cmdclass['build_sphinx'] = LocalBuildDoc
     except ImportError:
         pass
 
     return cmdclass
+
+
+def get_git_branchname():
+    for branch in _run_shell_command("git branch --color=never").split("\n"):
+        if branch.startswith('*'):
+            _branch_name = branch.split()[1].strip()
+    if _branch_name == "(no":
+        _branch_name = "no-branch"
+    return _branch_name
+
+
+def get_pre_version(projectname, base_version):
+    """Return a version which is leading up to a version that will
+       be released in the future."""
+    if os.path.isdir('.git'):
+        current_tag = _get_git_current_tag()
+        if current_tag is not None:
+            version = current_tag
+        else:
+            branch_name = os.getenv('BRANCHNAME',
+                                    os.getenv('GERRIT_REFNAME',
+                                              get_git_branchname()))
+            version_suffix = _get_git_next_version_suffix(branch_name)
+            version = "%s~%s" % (base_version, version_suffix)
+        write_versioninfo(projectname, version)
+        return version
+    else:
+        version = read_versioninfo(projectname)
+    return version
+
+
+def get_post_version(projectname):
+    """Return a version which is equal to the tag that's on the current
+    revision if there is one, or tag plus number of additional revisions
+    if the current revision has no tag."""
+
+    if os.path.isdir('.git'):
+        version = _get_git_post_version()
+        write_versioninfo(projectname, version)
+        return version
+    return read_versioninfo(projectname)

quantum/openstack/common/version.py

@@ -0,0 +1,148 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+#    Copyright 2012 OpenStack LLC
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+"""
+Utilities for consuming the auto-generated versioninfo files.
+"""
+
+import datetime
+import pkg_resources
+
+import setup
+
+
+class _deferred_version_string(object):
+    """Internal helper class which provides delayed version calculation."""
+    def __init__(self, version_info, prefix):
+        self.version_info = version_info
+        self.prefix = prefix
+
+    def __str__(self):
+        return "%s%s" % (self.prefix, self.version_info.version_string())
+
+    def __repr__(self):
+        return "%s%s" % (self.prefix, self.version_info.version_string())
+
+
+class VersionInfo(object):
+
+    def __init__(self, package, python_package=None, pre_version=None):
+        """Object that understands versioning for a package
+        :param package: name of the top level python namespace. For glance,
+                        this would be "glance" for python-glanceclient, it
+                        would be "glanceclient"
+        :param python_package: optional name of the project name. For
+                               glance this can be left unset. For
+                               python-glanceclient, this would be
+                               "python-glanceclient"
+        :param pre_version: optional version that the project is working to
+        """
+        self.package = package
+        if python_package is None:
+            self.python_package = package
+        else:
+            self.python_package = python_package
+        self.pre_version = pre_version
+        self.version = None
+
+    def _generate_version(self):
+        """Defer to the openstack.common.setup routines for making a
+        version from git."""
+        if self.pre_version is None:
+            return setup.get_post_version(self.python_package)
+        else:
+            return setup.get_pre_version(self.python_package, self.pre_version)
+
+    def _newer_version(self, pending_version):
+        """Check to see if we're working with a stale version or not.
+        We expect a version string that either looks like:
+          2012.2~f3~20120708.10.4426392
+        which is an unreleased version of a pre-version, or:
+          0.1.1.4.gcc9e28a
+        which is an unreleased version of a post-version, or:
+          0.1.1
+        Which is a release and which should match tag.
+        For now, if we have a date-embedded version, check to see if it's
+        old, and if so re-generate. Otherwise, just deal with it.
+        """
+        try:
+            version_date = int(self.version.split("~")[-1].split('.')[0])
+            if version_date < int(datetime.date.today().strftime('%Y%m%d')):
+                return self._generate_version()
+            else:
+                return pending_version
+        except Exception:
+            return pending_version
+
+    def version_string_with_vcs(self, always=False):
+        """Return the full version of the package including suffixes indicating
+        VCS status.
+
+        For instance, if we are working towards the 2012.2 release,
+        canonical_version_string should return 2012.2 if this is a final
+        release, or else something like 2012.2~f1~20120705.20 if it's not.
+
+        :param always: if true, skip all version caching
+        """
+        if always:
+            self.version = self._generate_version()
+
+        if self.version is None:
+
+            requirement = pkg_resources.Requirement.parse(self.python_package)
+            versioninfo = "%s/versioninfo" % self.package
+            try:
+                raw_version = pkg_resources.resource_string(requirement,
+                                                            versioninfo)
+                self.version = self._newer_version(raw_version.strip())
+            except (IOError, pkg_resources.DistributionNotFound):
+                self.version = self._generate_version()
+
+        return self.version
+
+    def canonical_version_string(self, always=False):
+        """Return the simple version of the package excluding any suffixes.
+
+        For instance, if we are working towards the 2012.2 release,
+        canonical_version_string should return 2012.2 in all cases.
+
+        :param always: if true, skip all version caching
+        """
+        return self.version_string_with_vcs(always).split('~')[0]
+
+    def version_string(self, always=False):
+        """Return the base version of the package.
+
+        For instance, if we are working towards the 2012.2 release,
+        version_string should return 2012.2 if this is a final release, or
+        2012.2-dev if it is not.
+
+        :param always: if true, skip all version caching
+        """
+        version_parts = self.version_string_with_vcs(always).split('~')
+        if len(version_parts) == 1:
+            return version_parts[0]
+        else:
+            return '%s-dev' % (version_parts[0],)
+
+    def deferred_version_string(self, prefix=""):
+        """Generate an object which will expand in a string context to
+        the results of version_string(). We do this so that don't
+        call into pkg_resources every time we start up a program when
+        passing version information into the CONF constructor, but
+        rather only do the calculation when and if a version is requested
+        """
+        return _deferred_version_string(self, prefix)

quantum/server/__init__.py

@@ -26,7 +26,6 @@ import sys
 from quantum.common import config
 from quantum.openstack.common import cfg
 from quantum import service
-from quantum.version import version_string
 
 
 def main():

quantum/version.py

@@ -14,33 +14,8 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
-try:
+from quantum.openstack.common import version as common_version
-    from quantum.vcsversion import version_info
-except ImportError:
-    version_info = {'branch_nick': u'LOCALBRANCH',
-                    'revision_id': 'LOCALREVISION',
-                    'revno': 0}
 
-QUANTUM_VERSION = ['2013', '1', None]
+NEXT_VERSION = '2013.1'
-YEAR, COUNT, REVSISION = QUANTUM_VERSION
+version_info = common_version.VersionInfo('quantum',
-
+                                          pre_version=NEXT_VERSION)
-FINAL = False   # This becomes true at Release Candidate time
-
-
-def canonical_version_string():
-    return '.'.join(filter(None, QUANTUM_VERSION))
-
-
-def version_string():
-    if FINAL:
-        return canonical_version_string()
-    else:
-        return '%s-dev' % (canonical_version_string(),)
-
-
-def vcs_version_string():
-    return "%s:%s" % (version_info['branch_nick'], version_info['revision_id'])
-
-
-def version_string_with_vcs():
-    return "%s-%s" % (canonical_version_string(), vcs_version_string())

setup.py

@@ -15,17 +15,14 @@
 import setuptools
 
 from quantum.openstack.common import setup
-
+from quantum.version import version_info as version
-setup.write_vcsversion('quantum/vcsversion.py')
-
-from quantum import version
 
 requires = setup.parse_requirements()
 depend_links = setup.parse_dependency_links()
 
 Name = 'quantum'
 Url = "https://launchpad.net/quantum"
-Version = version.canonical_version_string()
+Version = version.canonical_version_string(always=True)
 License = 'Apache License 2.0'
 Author = 'Netstack'
 AuthorEmail = 'netstack@lists.launchpad.net'