Merge lp:~soren/nova/version into lp:~hudson-openstack/nova/trunk

[Soren Hansen]

Adds a mechanism to programmatically determine the version of Nova. The designated version is defined in nova/version.py. When running python setup.py from a bzr checkout, information about the bzr branch is put into nova/vcsversion.py which is conditionally imported in nova/version.py.

In short, you can now do:

>>> import nova.version
>>> nova.version.canonical_version_string()
'2011.1'
>>> nova.version.version_string()
'2011.1-dev'
>>> nova.version.version_string_with_vcs()
u'2011.1-newlog2:<email address hidden>'

It's also consumed by the docs and setup.py, so this ought to be the canonical place for updating version information from now on.

[Todd Willey (xtoddx)]

review: Approve

[Eric Day (eday)]

nova/version.py is missing a copyright header.

review: Needs Fixing

[Soren Hansen (soren)]

Good catch, Eric. Fixed. Thanks!

[Eric Day (eday)]

lgtm

review: Approve

[OpenStack Infra (hudson-openstack)]

The attempt to merge lp:~soren/nova/version into lp:nova failed. Below is the output from the failed tests.

[Soren Hansen (soren)]

/me puts on brown paper bag

[Soren Hansen (soren)]

There we go. I decided last second to change the function names, didn't follow through. Should be fine now.

[Vish Ishaya (vishvananda)]

lgtm.

review: Approve

=== modified file '.bzrignore'
--- .bzrignore	2010-12-31 04:03:21 +0000
+++ .bzrignore	2011-01-07 23:07:09 +0000
@@ -12,3 +12,4 @@
 CA/serial*
 CA/newcerts/*.pem
 CA/private/cakey.pem
+nova/vcsversion.py
 
=== modified file 'doc/source/conf.py'
--- doc/source/conf.py	2010-11-19 22:04:37 +0000
+++ doc/source/conf.py	2011-01-07 23:07:09 +0000
@@ -60,10 +60,11 @@
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
+from nova import version as nova_version
+# The full version, including alpha/beta/rc tags.
+release = nova_version.version()
 # The short X.Y version.
-version = '2011.1'
-# The full version, including alpha/beta/rc tags.
-release = '2011.1-prerelease'
+version = nova_version.canonical_version_string()
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 
=== modified file 'nova/log.py'
--- nova/log.py	2011-01-06 20:08:14 +0000
+++ nova/log.py	2011-01-07 23:07:09 +0000
@@ -34,24 +34,19 @@
 import traceback
 
 from nova import flags
-# TODO(todd): fix after version.py merge
-# from nova import version
+from nova import version
 
 
 FLAGS = flags.FLAGS
 
-# TODO(todd): fix after version.py merge
-# '(%(name)s %(nova_version)s): %(levelname)s '
 flags.DEFINE_string('logging_context_format_string',
-                    '(%(name)s): %(levelname)s '
+                    '(%(name)s %(nova_version)s): %(levelname)s '
                     '[%(request_id)s %(user)s '
                     '%(project)s] %(message)s',
                     'format string to use for log messages')
 
-# TODO(todd): fix after version.py merge
-# '(%(name)s %(nova_version)s): %(levelname)s [N/A] '
 flags.DEFINE_string('logging_default_format_string',
-                    '(%(name)s): %(levelname)s [N/A] '
+                    '(%(name)s %(nova_version)s): %(levelname)s [N/A] '
                     '%(message)s',
                     'format string to use for log messages')
 
@@ -162,8 +157,7 @@
             extra = {}
         if context:
             extra.update(_dictify_context(context))
-        # TODO(todd): fix after version.py merge
-        #extra.update({"nova_version": version.string_with_vcs()})
+        extra.update({"nova_version": version.version_string_with_vcs()})
         logging.Logger._log(self, level, msg, args, exc_info, extra)
 
     def addHandler(self, handler):
 
=== added file 'nova/version.py'
--- nova/version.py	1970-01-01 00:00:00 +0000
+++ nova/version.py	2011-01-07 23:07:09 +0000
@@ -0,0 +1,46 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+#    Copyright 2011 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.
+
+try:
+    from nova.vcsversion import version_info
+except ImportError:
+    version_info = {'branch_nick': u'LOCALBRANCH',
+                    'revision_id': 'LOCALREVISION',
+                    'revno': 0}
+
+NOVA_VERSION = ['2011', '1']
+YEAR, COUNT = NOVA_VERSION
+
+FINAL = False   # This becomes true at Release Candidate time
+
+
+def canonical_version_string():
+    return '.'.join([YEAR, COUNT])
+
+
+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())
 
=== modified file 'setup.py'
--- setup.py	2011-01-04 05:23:35 +0000
+++ setup.py	2011-01-07 23:07:09 +0000
@@ -24,6 +24,15 @@
 from sphinx.setup_command import BuildDoc
 
 from nova.utils import parse_mailmap, str_dict_replace
+from nova import version
+
+if os.path.isdir('.bzr'):
+    with open("nova/vcsversion.py", 'w') as version_file:
+        vcs_cmd = subprocess.Popen(["bzr", "version-info", "--python"],
+                                   stdout=subprocess.PIPE)
+        vcsversion = vcs_cmd.communicate()[0]
+        version_file.write(vcsversion)
+
 
 class local_BuildDoc(BuildDoc):
     def run(self):
@@ -49,7 +58,7 @@
         sdist.run(self)
 
 setup(name='nova',
-      version='2011.1',
+      version=version.canonical_version_string(),
       description='cloud computing fabric controller',
       author='OpenStack',
       author_email='[e-mail]',