diff --git a/.gitignore b/.gitignore index caccffbb7..b0dca9bd5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ .coverage .venv +.tox *,cover cover *.pyc @@ -7,6 +8,7 @@ cover *.swp *~ AUTHORS +ChangeLog build dist cinderclient/versioninfo diff --git a/MANIFEST.in b/MANIFEST.in index 98bfc4574..7b9296959 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,10 +1,5 @@ include AUTHORS include ChangeLog -include HACKING -include LICENSE -include README.rst -include run_tests.sh tox.ini include cinderclient/versioninfo -recursive-include doc * -recursive-include tests * -recursive-include tools * +exclude .gitignore +exclude .gitreview diff --git a/cinderclient/__init__.py b/cinderclient/__init__.py index e69de29bb..1f8ab1980 100644 --- a/cinderclient/__init__.py +++ b/cinderclient/__init__.py @@ -0,0 +1,36 @@ +# 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. + +import os +import inspect + + +def _get_client_version(): + """Read version from versioninfo file.""" + mod_abspath = inspect.getabsfile(inspect.currentframe()) + client_path = os.path.dirname(mod_abspath) + version_path = os.path.join(client_path, 'versioninfo') + + if os.path.exists(version_path): + version = open(version_path).read().strip() + else: + version = "Unknown, couldn't find versioninfo file at %s"\ + % version_path + + return version + + +__version__ = _get_client_version() diff --git a/cinderclient/openstack/common/version.py b/cinderclient/openstack/common/version.py new file mode 100644 index 000000000..a19e42265 --- /dev/null +++ b/cinderclient/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) diff --git a/openstack-common.conf b/openstack-common.conf index 969aea6e3..b4c453aeb 100644 --- a/openstack-common.conf +++ b/openstack-common.conf @@ -1,7 +1,7 @@ [DEFAULT] # The list of modules to copy from openstack-common -modules=setup +modules=setup,version # The base module to hold the copy of openstack.common base=cinderclient diff --git a/setup.py b/setup.py index f62cae1a8..50db70808 100644 --- a/setup.py +++ b/setup.py @@ -21,6 +21,7 @@ from cinderclient.openstack.common import setup requires = setup.parse_requirements() depend_links = setup.parse_dependency_links() +tests_require = setup.parse_requirements(['tools/test-requires']) def read_file(file_name): @@ -39,8 +40,9 @@ setuptools.setup( packages=setuptools.find_packages(exclude=['tests', 'tests.*']), cmdclass=setup.get_cmdclass(), install_requires=requires, + tests_require=tests_require, + setup_requires=['setuptools-git>=0.4'], dependency_links=depend_links, - tests_require=["nose", "mock"], test_suite="nose.collector", classifiers=[ "Development Status :: 5 - Production/Stable",