Split out pip requires and aligned tox file.

Align tox.ini file with standards.
Align setup.py with openstack-common standards.

Change-Id: I333bbd66648c865a5c97ec2661359ab849274446

.gitignore

@@ -8,4 +8,6 @@ run_tests.log
 .quantum-venv/
 .venv/
 quantum/vcsversion.py
+requirements.txt
+ChangeLog
 .tox/

openstack-common.conf

@@ -0,0 +1,7 @@
+[DEFAULT]
+
+# The list of modules to copy from openstack-common
+modules=setup
+
+# The base module to hold the copy of openstack.common
+base=quantum

quantum/openstack/common/setup.py

@@ -0,0 +1,127 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright 2011 OpenStack LLC.
+# 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 os
+import re
+import subprocess
+
+
+def parse_mailmap(mailmap='.mailmap'):
+    mapping = {}
+    if os.path.exists(mailmap):
+        fp = open(mailmap, 'r')
+        for l in fp:
+            l = l.strip()
+            if not l.startswith('#') and ' ' in l:
+                canonical_email, alias = l.split(' ')
+                mapping[alias] = canonical_email
+    return mapping
+
+
+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 in mapping.iteritems():
+        changelog = changelog.replace(alias, email)
+    return changelog
+
+
+# Get requirements from the first file that exists
+def get_reqs_from_files(requirements_files):
+    reqs_in = []
+    for requirements_file in requirements_files:
+        if os.path.exists(requirements_file):
+            return open(requirements_file, 'r').read().split('\n')
+    return []
+
+
+def parse_requirements(requirements_files=['requirements.txt',
+                                           'tools/pip-requires']):
+    requirements = []
+    for line in get_reqs_from_files(requirements_files):
+        if re.match(r'\s*-e\s+', line):
+            requirements.append(re.sub(r'\s*-e\s+.*#egg=(.*)$', r'\1',
+                                line))
+        elif re.match(r'\s*-f\s+', line):
+            pass
+        else:
+            requirements.append(line)
+
+    return requirements
+
+
+def parse_dependency_links(requirements_files=['requirements.txt',
+                                               'tools/pip-requires']):
+    dependency_links = []
+    for line in get_reqs_from_files(requirements_files):
+        if re.match(r'(\s*#)|(\s*$)', line):
+            continue
+        if re.match(r'\s*-[ef]\s+', line):
+            dependency_links.append(re.sub(r'\s*-[ef]\s+', '', line))
+    return dependency_links
+
+
+def write_requirements():
+    venv = os.environ.get('VIRTUAL_ENV', None)
+    if venv is not None:
+        with open("requirements.txt", "w") as req_file:
+            output = subprocess.Popen(["pip", "-E", venv, "freeze", "-l"],
+                                      stdout=subprocess.PIPE)
+            requirements = output.communicate()[0].strip()
+            req_file.write(requirements)
+
+
+def _run_shell_command(cmd):
+    output = subprocess.Popen(["/bin/sh", "-c", cmd],
+                              stdout=subprocess.PIPE)
+    return output.communicate()[0].strip()
+
+
+def write_vcsversion(location):
+    """ Produce a vcsversion dict that mimics the old one produced by bzr
+    """
+    if os.path.isdir('.git'):
+        branch_nick_cmd = 'git branch | grep -Ei "\* (.*)" | cut -f2 -d" "'
+        branch_nick = _run_shell_command(branch_nick_cmd)
+        revid_cmd = "git rev-parse HEAD"
+        revid = _run_shell_command(revid_cmd).split()[0]
+        revno_cmd = "git log --oneline | wc -l"
+        revno = _run_shell_command(revno_cmd)
+        with open(location, 'w') as version_file:
+            version_file.write("""
+# This file is automatically generated by setup.py, So don't edit it. :)
+version_info = {
+    'branch_nick': '%s',
+    'revision_id': '%s',
+    'revno': %s
+}
+""" % (branch_nick, revid, revno))
+
+
+def write_git_changelog():
+    """ Write a changelog based on the git changelog """
+    if os.path.isdir('.git'):
+        git_log_cmd = 'git log --stat'
+        changelog = _run_shell_command(git_log_cmd)
+        mailmap = parse_mailmap()
+        with open("ChangeLog", "w") as changelog_file:
+            changelog_file.write(canonicalize_emails(changelog, mailmap))

setup.py

@@ -1,39 +1,37 @@
-try:
-    from setuptools import setup, find_packages
-except ImportError:
-    from ez_setup import use_setuptools
-    use_setuptools()
-    from setuptools import setup, find_packages
+# 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.
+
+from setuptools import setup, find_packages
+
+from quantum.openstack.common.setup import parse_requirements
+from quantum.openstack.common.setup import parse_dependency_links
+from quantum.openstack.common.setup import write_requirements
+from quantum.openstack.common.setup import write_git_changelog
+from quantum.openstack.common.setup import write_vcsversion
 
 import sys
 import os
 import subprocess
+
+requires = parse_requirements()
+depend_links = parse_dependency_links()
+write_requirements()
+write_git_changelog()
+write_vcsversion('quantum/vcsversion.py')
+
 from quantum import version
 
-
-def run_git_command(cmd):
-    output = subprocess.Popen(["/bin/sh", "-c", cmd],
-                              stdout=subprocess.PIPE)
-    return output.communicate()[0].strip()
-
-
-if os.path.isdir('.git'):
-    branch_nick_cmd = 'git branch | grep -Ei "\* (.*)" | cut -f2 -d" "'
-    branch_nick = run_git_command(branch_nick_cmd)
-    revid_cmd = "git --no-pager log --max-count=1 | cut -f2 -d' ' | head -1"
-    revid = run_git_command(revid_cmd)
-    revno_cmd = "git --no-pager log --oneline | wc -l"
-    revno = run_git_command(revno_cmd)
-    with open("quantum/vcsversion.py", 'w') as version_file:
-        version_file.write("""
-# This file is automatically generated by setup.py, So don't edit it. :)
-version_info = {
-    'branch_nick': '%s',
-    'revision_id': '%s',
-    'revno': %s
-}
-""" % (branch_nick, revid, revno))
-
 Name = 'quantum'
 Url = "https://launchpad.net/quantum"
 Version = version.canonical_version_string()
@@ -45,19 +43,6 @@ Summary = 'Quantum (virtual network service)'
 ShortDescription = Summary
 Description = Summary
 
-requires = [
-    'Paste',
-    'PasteDeploy',
-    'Routes>=1.12.3',
-    'eventlet>=0.9.12',
-    'lxml',
-    'python-gflags',
-    'simplejson',
-    'sqlalchemy',
-    'webob',
-    'webtest'
-]
-
 EagerResources = [
     'quantum',
 ]
@@ -104,6 +89,7 @@ setup(
     license=License,
     scripts=ProjectScripts,
     install_requires=requires,
+    dependency_links=depend_links,
     include_package_data=False,
     packages=find_packages('.'),
     data_files=DataFiles,

tools/install_venv.py

@@ -31,6 +31,7 @@ import sys
 ROOT = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
 VENV = os.path.join(ROOT, '.venv')
 PIP_REQUIRES = os.path.join(ROOT, 'tools', 'pip-requires')
+TEST_REQUIRES = os.path.join(ROOT, 'tools', 'test-requires')
 PY_VERSION = "python%s.%s" % (sys.version_info[0], sys.version_info[1])
 
 VENV_EXISTS = bool(os.path.exists(VENV))
@@ -93,6 +94,8 @@ def install_dependencies(venv=VENV):
     print 'Installing dependencies with pip (this can take a while)...'
     run_command(['tools/with_venv.sh', 'pip', 'install', '-r',
                  PIP_REQUIRES], redirect_output=False)
+    run_command(['tools/with_venv.sh', 'pip', 'install', '-r',
+                 TEST_REQUIRES], redirect_output=False)
 
     # Tell the virtual env how to "import quantum"
     pthfile = os.path.join(venv, "lib", PY_VERSION, "site-packages",

tools/pip-requires

@@ -8,15 +8,5 @@ python-gflags==1.3
 simplejson
 sqlalchemy
 webob==1.0.8
-webtest
-
-distribute>=0.6.24
-
-coverage
-mock>=0.7.1
-nose
-nosexcover
-pep8==0.6.1
 
 -e git+https://review.openstack.org/p/openstack/python-quantumclient#egg=python-quantumclient-dev
--e git+https://review.openstack.org/p/openstack-dev/openstack-nose.git#egg=openstack.nose_plugin

tools/test-requires

@@ -0,0 +1,9 @@
+distribute>=0.6.24
+
+coverage
+mock>=0.7.1
+nose
+nosexcover
+openstack.nose_plugin
+pep8==0.6.1
+webtest

tox.ini

@@ -2,17 +2,20 @@
 envlist = py26,py27,pep8
 
 [testenv]
+setenv = VIRTUAL_ENV={envdir}
 deps = -r{toxinidir}/tools/pip-requires
-commands = nosetests --where=quantum/tests/unit
+       -r{toxinidir}/tools/test-requires
+commands = nosetests --where=quantum/tests/unit {posargs}
 
 [testenv:pep8]
-commands = pep8 --repeat --show-source bin/* quantum setup.py
+deps = pep8
+commands = pep8 --repeat --show-source quantum setup.py
 
-[testenv:pylint]
-commands = pylint --rcfile=.pylintrc --output-format=parseable quantum
+[testenv:venv]
+commands = {posargs}
 
 [testenv:cover]
-commands = nosetests --with-coverage --cover-html --cover-erase --cover-package=quantum
+commands = nosetests --with-coverage --cover-html --cover-erase --cover-package=quantum {posargs}
 
 [testenv:hudson]
 downloadcache = ~/cache/pip
@@ -27,12 +30,12 @@ deps = file://{toxinidir}/.cache.bundle
 
 [testenv:jenkinspep8]
 deps = file://{toxinidir}/.cache.bundle
-commands = pep8 --repeat --show-source bin/* quantum setup.py
-
-[testenv:jenkinspylint]
-deps = file://{toxinidir}/.cache.bundle
-commands = pylint -E --rcfile=.pylintrc --output-format=parseable quantum
+commands = pep8 --repeat --show-source quantum setup.py
 
 [testenv:jenkinscover]
 deps = file://{toxinidir}/.cache.bundle
-commands = nosetests --where=quantum/tests/unit --cover-erase --cover-package=quantum --with-xcoverage
+commands = nosetests --where=quantum/tests/unit --cover-erase --cover-package=quantum --with-xcoverage {posargs}
+
+[testenv:jenkinsvenv]
+deps = file://{toxinidir}/.cache.bundle
+commands = {posargs}