Sync install_venv_common from oslo

Change-Id: Iadcfa6d00b963a19ce15300b2293036cf0e8204b

openstack-common.conf

@@ -1,9 +1,10 @@
 [DEFAULT]
+module=config
 module=eventlet_backdoor
+module=install_venv_common
 module=notifier
 module=rpc
 module=service
 module=threadgroup
-module=config
 
 base=openstack_dashboard

tools/install_venv.py

@@ -1,156 +1,77 @@
 # vim: tabstop=4 shiftwidth=4 softtabstop=4
 
-# Copyright 2012 United States Government as represented by the
+# Copyright 2010 United States Government as represented by the
 # Administrator of the National Aeronautics and Space Administration.
 # All Rights Reserved.
 #
-# Copyright 2012 OpenStack, LLC
+# Copyright 2010 OpenStack Foundation
+# Copyright 2013 IBM Corp.
+# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
 #
-# Copyright 2012 Nebula, Inc.
+# 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
 #
-#    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
 #
-#         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.
-
-"""
-Installation script for the OpenStack Dashboard development virtualenv.
-"""
+# 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 ConfigParser
 import os
-import subprocess
 import sys
 
+import install_venv_common as install_venv  # flake8: noqa
 
-ROOT = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
-VENV = os.path.join(ROOT, '.venv')
-WITH_VENV = os.path.join(ROOT, 'tools', 'with_venv.sh')
-PIP_REQUIRES = os.path.join(ROOT, 'requirements.txt')
-TEST_REQUIRES = os.path.join(ROOT, 'test-requirements.txt')
-
-
-def die(message, *args):
-    print >> sys.stderr, message % args
-    sys.exit(1)
-
-
-def run_command(cmd, redirect_output=True, check_exit_code=True, cwd=ROOT,
-                die_message=None):
-    """
-    Runs a command in an out-of-process shell, returning the
-    output of that command.  Working directory is ROOT.
-    """
-    if redirect_output:
-        stdout = subprocess.PIPE
-    else:
-        stdout = None
-
-    proc = subprocess.Popen(cmd, cwd=cwd, stdout=stdout)
-    output = proc.communicate()[0]
-    if check_exit_code and proc.returncode != 0:
-        if die_message is None:
-            die('Command "%s" failed.\n%s', ' '.join(cmd), output)
-        else:
-            die(die_message)
-    return output
-
-
-HAS_EASY_INSTALL = bool(run_command(['which', 'easy_install'],
-                                    check_exit_code=False).strip())
-HAS_VIRTUALENV = bool(run_command(['which', 'virtualenv'],
-                                  check_exit_code=False).strip())
-
-
-def check_dependencies():
-    """Make sure virtualenv is in the path."""
-
-    print 'Checking dependencies...'
-    if not HAS_VIRTUALENV:
-        print 'Virtual environment not found.'
-        # Try installing it via easy_install...
-        if HAS_EASY_INSTALL:
-            print 'Installing virtualenv via easy_install...',
-            run_command(['easy_install', 'virtualenv'],
-                        die_message='easy_install failed to install virtualenv'
-                                    '\ndevelopment requires virtualenv, please'
-                                    ' install it using your favorite tool')
-            if not run_command(['which', 'virtualenv']):
-                die('ERROR: virtualenv not found in path.\n\ndevelopment '
-                    ' requires virtualenv, please install it using your'
-                    ' favorite package management tool and ensure'
-                    ' virtualenv is in your path')
-            print 'virtualenv installation done.'
-        else:
-            die('easy_install not found.\n\nInstall easy_install'
-                ' (python-setuptools in ubuntu) or virtualenv by hand,'
-                ' then rerun.')
-    print 'dependency check done.'
-
-
-def create_virtualenv(venv=VENV):
-    """Creates the virtual environment and installs PIP only into the
-    virtual environment
-    """
-    print 'Creating venv...',
-    run_command(['virtualenv', '-q', '--no-site-packages', VENV])
-    print 'done.'
-    print 'Installing pip in virtualenv...',
-    if not run_command([WITH_VENV, 'easy_install', 'pip']).strip():
-        die("Failed to install pip.")
-    print 'done.'
-    print 'Installing distribute in virtualenv...'
-    pip_install('distribute>=0.6.24')
-    print 'done.'
 
+def print_help(project, venv, root):
+    help = """
+    %(project)s development environment setup is complete.
 
-def pip_install(*args):
-    args = [WITH_VENV, 'pip', 'install', '--upgrade'] + list(args)
-    run_command(args, redirect_output=False)
+    %(project)s development uses virtualenv to track and manage Python
+    dependencies while in development and testing.
 
+    To activate the %(project)s virtualenv for the extent of your current
+    shell session you can run:
 
-def install_dependencies(venv=VENV):
-    print "Installing dependencies..."
-    print "(This may take several minutes, don't panic)"
-    pip_install('-r', TEST_REQUIRES)
-    pip_install('-r', PIP_REQUIRES)
+    $ source %(venv)s/bin/activate
 
-    # Tell the virtual env how to "import dashboard"
-    py = 'python%d.%d' % (sys.version_info[0], sys.version_info[1])
-    pthfile = os.path.join(venv, "lib", py, "site-packages", "dashboard.pth")
-    f = open(pthfile, 'w')
-    f.write("%s\n" % ROOT)
+    Or, if you prefer, you can run commands in the virtualenv on a case by
+    case basis by running:
 
-
-def install_horizon():
-    print 'Installing horizon module in development mode...'
-    run_command([WITH_VENV, 'python', 'setup.py', 'develop'], cwd=ROOT)
-
-
-def print_summary():
-    summary = """
-Horizon development environment setup is complete.
-
-To activate the virtualenv for the extent of your current shell session you
-can run:
-
-$ source .venv/bin/activate
-"""
-    print summary
-
-
-def main():
-    check_dependencies()
-    create_virtualenv()
-    install_dependencies()
-    install_horizon()
-    print_summary()
+    $ %(root)s/tools/with_venv.sh <your command>
+    """
+    print help % dict(project=project, venv=venv, root=root)
+
+
+def main(argv):
+    root = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
+
+    if os.environ.get('tools_path'):
+        root = os.environ['tools_path']
+    venv = os.path.join(root, '.venv')
+    if os.environ.get('venv'):
+        venv = os.environ['venv']
+
+    pip_requires = os.path.join(root, 'requirements.txt')
+    test_requires = os.path.join(root, 'test-requirements.txt')
+    py_version = "python%s.%s" % (sys.version_info[0], sys.version_info[1])
+    setup_cfg = ConfigParser.ConfigParser()
+    setup_cfg.read('setup.cfg')
+    project = setup_cfg.get('metadata', 'name')
+
+    install = install_venv.InstallVenv(
+        root, venv, pip_requires, test_requires, py_version, project)
+    options = install.parse_args(argv)
+    install.check_python_version()
+    install.check_dependencies()
+    install.create_virtualenv(no_site_packages=options.no_site_packages)
+    install.install_dependencies()
+    install.post_process()
+    print_help(project, venv, root)
 
 if __name__ == '__main__':
-    main()
+    main(sys.argv)