From 3e610f498d5b31110de80f30802e312bf75042ff Mon Sep 17 00:00:00 2001 From: Dina Belova Date: Mon, 19 Aug 2013 20:54:39 +0400 Subject: [PATCH] Migrate to pbr Change-Id: I733ae148c300165a35c7bba5cc3c331dc96d3df2 --- .../cmd/climate_rpc_zmq_receiver.py | 0 .../cmd/climate_scheduler.py | 6 +- climate/openstack/common/setup.py | 359 ------------------ tools/pip-requires => requirements.txt | 0 setup.cfg | 33 ++ setup.py | 51 +-- test-requirements.txt | 7 + tools/test-requires | 4 - tox.ini | 9 +- 9 files changed, 50 insertions(+), 419 deletions(-) rename bin/climate-rpc-zmq-receiver => climate/cmd/climate_rpc_zmq_receiver.py (100%) rename bin/climate-scheduler => climate/cmd/climate_scheduler.py (97%) delete mode 100644 climate/openstack/common/setup.py rename tools/pip-requires => requirements.txt (100%) create mode 100644 setup.cfg create mode 100644 test-requirements.txt delete mode 100644 tools/test-requires diff --git a/bin/climate-rpc-zmq-receiver b/climate/cmd/climate_rpc_zmq_receiver.py similarity index 100% rename from bin/climate-rpc-zmq-receiver rename to climate/cmd/climate_rpc_zmq_receiver.py diff --git a/bin/climate-scheduler b/climate/cmd/climate_scheduler.py similarity index 97% rename from bin/climate-scheduler rename to climate/cmd/climate_scheduler.py index d8156018..09308e76 100755 --- a/bin/climate-scheduler +++ b/climate/cmd/climate_scheduler.py @@ -25,9 +25,13 @@ from climate.service import prepare_service from climate.scheduler import service as scheduler_service from climate.openstack.common import service -if __name__ == '__main__': + +def main(): prepare_service(sys.argv) service.launch( scheduler_service.SchedulerService(cfg.CONF.host, 'climate.scheduler') ).wait() + +if __name__ == '__main__': + main() diff --git a/climate/openstack/common/setup.py b/climate/openstack/common/setup.py deleted file mode 100644 index 030df61c..00000000 --- a/climate/openstack/common/setup.py +++ /dev/null @@ -1,359 +0,0 @@ -# vim: tabstop=4 shiftwidth=4 softtabstop=4 - -# Copyright 2011 OpenStack Foundation. -# Copyright 2012-2013 Hewlett-Packard Development Company, L.P. -# All Rights Reserved. -# -# 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 with minimum-depends for use in setup.py -""" - -import email -import os -import re -import subprocess -import sys - -from setuptools.command import sdist - - -def parse_mailmap(mailmap='.mailmap'): - mapping = {} - if os.path.exists(mailmap): - with open(mailmap, 'r') as fp: - for l in fp: - try: - canonical_email, alias = re.match( - r'[^#]*?(<.+>).*(<.+>).*', l).groups() - except AttributeError: - continue - mapping[alias] = canonical_email - return mapping - - -def _parse_git_mailmap(git_dir, mailmap='.mailmap'): - mailmap = os.path.join(os.path.dirname(git_dir), mailmap) - return parse_mailmap(mailmap) - - -def canonicalize_emails(changelog, mapping): - """Takes in a string and an email alias mapping and replaces all - instances of the aliases in the string with their real email. - """ - for alias, email_address in mapping.iteritems(): - changelog = changelog.replace(alias, email_address) - return changelog - - -# Get requirements from the first file that exists -def get_reqs_from_files(requirements_files): - for requirements_file in requirements_files: - if os.path.exists(requirements_file): - with open(requirements_file, 'r') as fil: - return fil.read().split('\n') - return [] - - -def parse_requirements(requirements_files=['requirements.txt', - 'tools/pip-requires']): - requirements = [] - for line in get_reqs_from_files(requirements_files): - # For the requirements list, we need to inject only the portion - # after egg= so that distutils knows the package it's looking for - # such as: - # -e git://github.com/openstack/nova/master#egg=nova - if re.match(r'\s*-e\s+', line): - requirements.append(re.sub(r'\s*-e\s+.*#egg=(.*)$', r'\1', - line)) - # such as: - # http://github.com/openstack/nova/zipball/master#egg=nova - elif re.match(r'\s*https?:', line): - requirements.append(re.sub(r'\s*https?:.*#egg=(.*)$', r'\1', - line)) - # -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) - - return requirements - - -def parse_dependency_links(requirements_files=['requirements.txt', - 'tools/pip-requires']): - dependency_links = [] - # dependency_links inject alternate locations to find packages listed - # in requirements - for line in get_reqs_from_files(requirements_files): - # skip comments and blank lines - if re.match(r'(\s*#)|(\s*$)', line): - continue - # lines with -e or -f need the whole line, minus the flag - if re.match(r'\s*-[ef]\s+', line): - dependency_links.append(re.sub(r'\s*-[ef]\s+', '', line)) - # lines that are only urls can go in unmolested - elif re.match(r'\s*https?:', line): - dependency_links.append(line) - return dependency_links - - -def _run_shell_command(cmd, throw_on_error=False): - if os.name == 'nt': - output = subprocess.Popen(["cmd.exe", "/C", cmd], - stdout=subprocess.PIPE, - stderr=subprocess.PIPE) - else: - output = subprocess.Popen(["/bin/sh", "-c", cmd], - stdout=subprocess.PIPE, - stderr=subprocess.PIPE) - out = output.communicate() - if output.returncode and throw_on_error: - raise Exception("%s returned %d" % cmd, output.returncode) - if len(out) == 0: - return None - if len(out[0].strip()) == 0: - return None - return out[0].strip() - - -def _get_git_directory(): - parent_dir = os.path.dirname(__file__) - while True: - git_dir = os.path.join(parent_dir, '.git') - if os.path.exists(git_dir): - return git_dir - parent_dir, child = os.path.split(parent_dir) - if not child: # reached to root dir - return None - - -def write_git_changelog(): - """Write a changelog based on the git changelog.""" - new_changelog = 'ChangeLog' - git_dir = _get_git_directory() - if not os.getenv('SKIP_WRITE_GIT_CHANGELOG'): - if git_dir: - git_log_cmd = 'git --git-dir=%s log' % git_dir - changelog = _run_shell_command(git_log_cmd) - mailmap = _parse_git_mailmap(git_dir) - 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|stackforge).org' - old_authors = 'AUTHORS.in' - new_authors = 'AUTHORS' - git_dir = _get_git_directory() - if not os.getenv('SKIP_GENERATE_AUTHORS'): - if git_dir: - # don't include jenkins email address in AUTHORS file - git_log_cmd = ("git --git-dir=" + git_dir + - " log --format='%aN <%aE>' | sort -u | " - "egrep -v '" + jenkins_email + "'") - changelog = _run_shell_command(git_log_cmd) - mailmap = _parse_git_mailmap(git_dir) - with open(new_authors, 'w') as new_authors_fh: - new_authors_fh.write(canonicalize_emails(changelog, mailmap)) - if os.path.exists(old_authors): - 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 get_cmdclass(): - """Return dict of commands to run from setup.py.""" - - 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.""" - - def run(self): - write_git_changelog() - generate_authors() - # sdist.sdist is an old style class, can't use super() - sdist.sdist.run(self) - - cmdclass['sdist'] = LocalSDist - - # If Sphinx is installed on the box running setup.py, - # enable setup.py to build the documentation, otherwise, - # just ignore it - try: - from sphinx.setup_command import BuildDoc - - class LocalBuildDoc(BuildDoc): - - builders = ['html', 'man'] - - 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 self.builders: - 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) - - class LocalBuildLatex(LocalBuildDoc): - builders = ['latex'] - - cmdclass['build_sphinx'] = LocalBuildDoc - cmdclass['build_sphinx_latex'] = LocalBuildLatex - except ImportError: - pass - - return cmdclass - - -def _get_revno(git_dir): - """Return the number of commits since the most recent tag. - - We use git-describe to find this out, but if there are no - tags then we fall back to counting commits since the beginning - of time. - """ - describe = _run_shell_command( - "git --git-dir=%s describe --always" % git_dir) - if "-" in describe: - return describe.rsplit("-", 2)[-2] - - # no tags found - revlist = _run_shell_command( - "git --git-dir=%s rev-list --abbrev-commit HEAD" % git_dir) - return len(revlist.splitlines()) - - -def _get_version_from_git(pre_version): - """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.""" - - git_dir = _get_git_directory() - if git_dir: - if pre_version: - try: - return _run_shell_command( - "git --git-dir=" + git_dir + " describe --exact-match", - throw_on_error=True).replace('-', '.') - except Exception: - sha = _run_shell_command( - "git --git-dir=" + git_dir + " log -n1 --pretty=format:%h") - return "%s.a%s.g%s" % (pre_version, _get_revno(git_dir), sha) - else: - return _run_shell_command( - "git --git-dir=" + git_dir + " describe --always").replace( - '-', '.') - return None - - -def _get_version_from_pkg_info(package_name): - """Get the version from PKG-INFO file if we can.""" - try: - pkg_info_file = open('PKG-INFO', 'r') - except (IOError, OSError): - return None - try: - pkg_info = email.message_from_file(pkg_info_file) - except email.MessageError: - return None - # Check to make sure we're in our own dir - if pkg_info.get('Name', None) != package_name: - return None - return pkg_info.get('Version', None) - - -def get_version(package_name, pre_version=None): - """Get the version of the project. First, try getting it from PKG-INFO, if - it exists. If it does, that means we're in a distribution tarball or that - install has happened. Otherwise, if there is no PKG-INFO file, pull the - version from git. - - We do not support setup.py version sanity in git archive tarballs, nor do - we support packagers directly sucking our git repo into theirs. We expect - that a source tarball be made from our git repo - or that if someone wants - to make a source tarball from a fork of our repo with additional tags in it - that they understand and desire the results of doing that. - """ - version = os.environ.get("OSLO_PACKAGE_VERSION", None) - if version: - return version - version = _get_version_from_pkg_info(package_name) - if version: - return version - version = _get_version_from_git(pre_version) - if version: - return version - raise Exception("Versioning for this project requires either an sdist" - " tarball, or access to an upstream git repository.") diff --git a/tools/pip-requires b/requirements.txt similarity index 100% rename from tools/pip-requires rename to requirements.txt diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 00000000..f64202ef --- /dev/null +++ b/setup.cfg @@ -0,0 +1,33 @@ +[metadata] +name = climate +version = 2013.1 +summary = Reservation Service for OpenStack clouds +description-file = README.md +license = Apache Software License +classifiers = + Programming Language :: Python + Programming Language :: Python :: 2 + Programming Language :: Python :: 2.7 + Environment :: OpenStack + Development Status :: 3 - Alpha, + Framework :: Setuptools Plugin, + Intended Audience :: Information Technology + Intended Audience :: System Administrators + License :: OSI Approved :: Apache Software License + Operating System :: POSIX :: Linux +author = OpenStack +author_email = climate@lists.launchpad.net +home-page = https://launchpad.net/climate + +[global] +setup-hooks = pbr.hooks.setup_hook + +[files] +packages = + climate + +[entry_points] +console_scripts = + climate-scheduler=climate.cmd.climate_scheduler:main + climate-rpc-zmq-receiver=climate.cmd.climate_rpc_zmq_receiver:main + diff --git a/setup.py b/setup.py index caf54ed2..d0960acc 100755 --- a/setup.py +++ b/setup.py @@ -17,54 +17,7 @@ import setuptools -from climate.openstack.common import setup as common_setup - -requires = common_setup.parse_requirements(['tools/pip-requires']) -depend_links = common_setup.parse_dependency_links(['tools/pip-requires']) -project = 'climate' -version = common_setup.get_version(project, '2013.1') - - setuptools.setup( - - name='climate', - version=version, - - description='cloud computing metering', - - author='OpenStack', - author_email='climate@lists.launchpad.net', - - url='https://launchpad.net/climate', - - classifiers=[ - 'Development Status :: 3 - Alpha', - 'Framework :: Setuptools Plugin', - 'Environment :: OpenStack', - 'Intended Audience :: Information Technology', - 'Intended Audience :: System Administrators', - 'License :: OSI Approved :: Apache Software License', - 'Operating System :: POSIX :: Linux', - 'Programming Language :: Python', - 'Programming Language :: Python :: 2', - 'Programming Language :: Python :: 2.7', - 'Topic :: System :: Monitoring', - ], - - packages=setuptools.find_packages(exclude=['tests', - 'tests.*', - '*.tests']), - cmdclass=common_setup.get_cmdclass(), - include_package_data=True, - - test_suite='nose.collector', - - scripts=['bin/climate-scheduler'], - - py_modules=[], - - install_requires=requires, - dependency_links=depend_links, - - zip_safe=False, + setup_requires=['pbr>=0.5.21,<1.0'], + pbr=True ) diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 00000000..4edee7ab --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,7 @@ +nose +mock +mox +sphinxcontrib-httpdomain + +-f http://tarballs.openstack.org/nova/nova-master.tar.gz#egg=nova-master +nova>=master diff --git a/tools/test-requires b/tools/test-requires deleted file mode 100644 index 67a31259..00000000 --- a/tools/test-requires +++ /dev/null @@ -1,4 +0,0 @@ -nose -mock -mox -http://tarballs.openstack.org/nova/nova-master.tar.gz \ No newline at end of file diff --git a/tox.ini b/tox.ini index 76199afa..351fa9b6 100644 --- a/tox.ini +++ b/tox.ini @@ -2,8 +2,8 @@ envlist = py26,py27,pep8 [testenv] -deps = -r{toxinidir}/tools/test-requires - -r{toxinidir}/tools/pip-requires +deps = -r{toxinidir}/test-requirements.txt + -r{toxinidir}/requirements.txt setenv = VIRTUAL_ENV={envdir} NOSE_WITH_OPENSTACK=1 NOSE_OPENSTACK_COLOR=1 @@ -19,10 +19,7 @@ commands = nosetests --no-path-adjustment --with-coverage --cover-erase --cover- [testenv:pep8] deps = pep8==1.3.3 -commands = pep8 --repeat --ignore=E125 --show-source climate setup.py tests bin +commands = pep8 --repeat --ignore=E125 --show-source climate setup.py tests [testenv:venv] -deps = -r{toxinidir}/tools/test-requires - -r{toxinidir}/tools/pip-requires - sphinxcontrib-httpdomain commands = {posargs}