Merge lp:~soren/swift/versioning into lp:~hudson-openstack/swift/trunk

[Soren Hansen]

Add a __canonical_version__ attribute to the swift module. This is only the numbered part of the version string, no "-dev" or similar suffixes.

Add a couple of unit tests to make sure __version__ and __canonical_version__ are generated correctly and to ensure __canonical_version__ never accidentally has anything other than numbers and points in it.

This aligns the release process for all of Swift, Glance and Nova.

__canonical_version__ should be used for anything that affects the release process in any way. E.g. the directory name in the generated tarball, versioned path elements in documentation, etc. As soon as work commences on a release (e.g. once 1.4.0 and you start working on 1.4.1), this version is bumped to '1.4.1'. This ensures that all the automation that has been set up and has run against trunk throughout the dev cycle will apply in exactly the same way to the final release instead of having the release be different in various ways. This reduces the chance of error.

__version__ is constructed of __canonical_version__ + '-dev'. It can be used in documentation *strings* (not path elements), in logs, etc.

It may look like overkill with the class in the swift/__init__.py, but my first couple of attempts without it made testing this stuff quite awkward, and since it's covered by unit tests, it should be safe enough.

[Thierry Carrez (ttx)]

I think that should be (1.4.0, False): the idea would be to switch to (1.4.0, True) at release time on the release branch.

[John Dickinson (notmyname)]

also, pep8

[Thierry Carrez (ttx)]

Also this shouldn't be accepted before Jenkins is tweaked to use timestamps instead of bzrREV, to avoid collisions between branches.

[Soren Hansen (soren)]

> also, pep8

Oh, I got the distinct impression you didn't care about pep8.

/me fixes.

[Soren Hansen (soren)]

The Jenkins magic is now in place and this should be ready for merge.

[OpenStack Infra (hudson-openstack)]

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

running test
running egg_info
creating swift.egg-info
writing swift.egg-info/PKG-INFO
writing top-level names to swift.egg-info/top_level.txt
writing dependency_links to swift.egg-info/dependency_links.txt
writing entry points to swift.egg-info/entry_points.txt
writing manifest file 'swift.egg-info/SOURCES.txt'
reading manifest file 'swift.egg-info/SOURCES.txt'
reading manifest template 'MANIFEST.in'
warning: no files found matching 'ChangeLog'
writing manifest file 'swift.egg-info/SOURCES.txt'
running build_ext

UNABLE TO READ FUNCTIONAL TESTS CONFIG FILE
UNABLE TO READ FUNCTIONAL TESTS CONFIG FILE
SKIPPING FUNCTIONAL TESTS DUE TO NO CONFIG
testAccountHead (test.functional.tests.TestAccount) ... SKIP
testContainerListing (test.functional.tests.TestAccount) ... SKIP
testContainerSerializedInfo (test.functional.tests.TestAccount) ... SKIP
testContainersOrderedByName (test.functional.tests.TestAccount) ... SKIP
testInvalidAuthToken (test.functional.tests.TestAccount) ... SKIP
testInvalidPath (test.functional.tests.TestAccount) ... SKIP
testInvalidUTF8Path (test.functional.tests.TestAccount) ... SKIP
testLastContainerMarker (test.functional.tests.TestAccount) ... SKIP
testListingLimit (test.functional.tests.TestAccount) ... SKIP
testMarkerLimitContainerList (test.functional.tests.TestAccount) ... SKIP
testNoAuthToken (test.functional.tests.TestAccount) ... SKIP
testPUT (test.functional.tests.TestAccount) ... SKIP
testVersionOnlyPath (test.functional.tests.TestAccount) ... SKIP
testGetRequest (test.functional.tests.TestAccountNoContainers) ... SKIP
testGetRequest (test.functional.tests.TestAccountNoContainersUTF8) ... SKIP
testAccountHead (test.functional.tests.TestAccountUTF8) ... SKIP
testContainerListing (test.functional.tests.TestAccountUTF8) ... SKIP
testContainerSerializedInfo (test.functional.tests.TestAccountUTF8) ... SKIP
testContainersOrderedByName (test.functional.tests.TestAccountUTF8) ... SKIP
testInvalidAuthToken (test.functional.tests.TestAccountUTF8) ... SKIP
testInvalidPath (test.functional.tests.TestAccountUTF8) ... SKIP
testInvalidUTF8Path (test.functional.tests.TestAccountUTF8) ... SKIP
testLastContainerMarker (test.functional.tests.TestAccountUTF8) ... SKIP
testListingLimit (test.functional.tests.TestAccountUTF8) ... SKIP
testMarkerLimitContainerList (test.functional.tests.TestAccountUTF8) ... SKIP
testNoAuthToken (test.functional.tests.TestAccountUTF8) ... SKIP
testPUT (test.functional.tests.TestAccountUTF8) ... SKIP
testVersionOnlyPath (test.functional.tests.TestAccountUTF8) ... SKIP
testContainerExistenceCachingProblem (test.functional.tests.TestContainer) ... SKIP
testContainerFileList (test.functional.tests.TestContainer) ... SKIP
testContainerFileListOnContainerThatDoesNotExist (test.functional.tests.TestContainer) ... SKIP
testContainerFileListWithLimit (test.functional.tests.TestContainer) ... SKIP
testContainerInfo (test.functional.tests.TestContainer) ... SKIP
testContainerInfoOnContainerThatDoesNotExist (test.functional.tests.TestContainer) ... SKIP
testContainerNameLimit (test.functional.tests.TestCont...

=== modified file 'setup.py'
--- setup.py	2011-05-12 21:24:51 +0000
+++ setup.py	2011-05-26 14:29:28 +0000
@@ -23,7 +23,7 @@
 except ImportError:
     frontend = None
 
-from swift import __version__ as version
+from swift import __canonical_version__ as version
 
 
 class local_sdist(sdist):

=== modified file 'swift/__init__.py'
--- swift/__init__.py	2011-04-15 09:54:32 +0000
+++ swift/__init__.py	2011-05-26 14:29:28 +0000
@@ -1,5 +1,21 @@
 import gettext
 
 
-__version__ = '1.4-dev'
+class Version(object):
+    def __init__(self, canonical_version, final):
+        self.canonical_version = canonical_version
+        self.final = final
+
+    @property
+    def pretty_version(self):
+        if self.final:
+            return self.canonical_version
+        else:
+            return '%s-dev' % (self.canonical_version,)
+
+
+_version = Version('1.4.0', False)
+__version__ = _version.pretty_version
+__canonical_version__ = _version.canonical_version
+
 gettext.install('swift')

=== added file 'test/unit/common/test_init.py'
--- test/unit/common/test_init.py	1970-01-01 00:00:00 +0000
+++ test/unit/common/test_init.py	2011-05-26 14:29:28 +0000
@@ -0,0 +1,37 @@
+# Copyright (c) 2010-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.
+
+import re
+import unittest
+import swift
+
+class TestVersioning(unittest.TestCase):
+    def test_canonical_version_is_clean(self):
+        """Ensure that a non-clean canonical_version never happens"""
+        pattern = re.compile('^\d+(\.\d+)*$')
+        self.assertTrue(pattern.match(swift.__canonical_version__) is not None)
+
+    def test_canonical_version_equals_version_for_final(self):
+        version = swift.Version('7.8.9', True)
+        self.assertEquals(version.pretty_version, '7.8.9')
+        self.assertEquals(version.canonical_version, '7.8.9')
+
+    def test_version_has_dev_suffix_for_non_final(self):
+        version = swift.Version('7.8.9', False)
+        self.assertEquals(version.pretty_version, '7.8.9-dev')
+        self.assertEquals(version.canonical_version, '7.8.9')
+
+if __name__ == '__main__':
+    unittest.main()