Merge lp:~corey.bryant/charm-helpers/fix-global-reqs into lp:charm-helpers

[Corey Bryant]

[Corey Bryant (corey.bryant)]

This fixes the following error: http://paste.ubuntu.com/11737211/

The problem is that on trusty a virtualenv is created with an old setuptools and therefore and old pkg_resource. When the update.py script from the master branch of global requirements is executed, it fails because of the old version of pkg_resources.

This fix provides two things:
1) upgrade setuptools to latest version after creating the virtualenv
2) when executing 'python update.py <package_dir>' use the python from the virtualenv

[Billy Olsen (billy-olsen)]

Looks good to me.

review: Approve

[Jorge Niedbalski (niedbalski)]

LGTM

review: Approve

[Corey Bryant (corey.bryant)]

Thanks Jorge!

On Mon, Jun 22, 2015 at 6:49 PM, <email address hidden> wrote:

> The proposal to merge lp:~corey.bryant/charm-helpers/fix-global-reqs into
> lp:charm-helpers has been updated.
>
> Status: Needs review => Merged
>
> For more details, see:
>
> https://code.launchpad.net/~corey.bryant/charm-helpers/fix-global-reqs/+merge/262469
> --
> You are the owner of lp:~corey.bryant/charm-helpers/fix-global-reqs.
>

--
Regards,
Corey

=== modified file 'charmhelpers/contrib/openstack/utils.py'
--- charmhelpers/contrib/openstack/utils.py	2015-06-11 14:41:04 +0000
+++ charmhelpers/contrib/openstack/utils.py	2015-06-19 16:09:56 +0000
@@ -555,6 +555,11 @@
 
     pip_create_virtualenv(os.path.join(parent_dir, 'venv'))
 
+    # Upgrade setuptools from default virtualenv version. The default version
+    # in trusty breaks update.py in global requirements master branch.
+    pip_install('setuptools', upgrade=True, proxy=http_proxy,
+                venv=os.path.join(parent_dir, 'venv'))
+
     for p in projects['repositories']:
         repo = p['repository']
         branch = p['branch']
@@ -616,24 +621,24 @@
     else:
         repo_dir = dest_dir
 
+    venv = os.path.join(parent_dir, 'venv')
+
     if update_requirements:
         if not requirements_dir:
             error_out('requirements repo must be cloned before '
                       'updating from global requirements.')
-        _git_update_requirements(repo_dir, requirements_dir)
+        _git_update_requirements(venv, repo_dir, requirements_dir)
 
     juju_log('Installing git repo from dir: {}'.format(repo_dir))
     if http_proxy:
-        pip_install(repo_dir, proxy=http_proxy,
-                    venv=os.path.join(parent_dir, 'venv'))
+        pip_install(repo_dir, proxy=http_proxy, venv=venv)
     else:
-        pip_install(repo_dir,
-                    venv=os.path.join(parent_dir, 'venv'))
+        pip_install(repo_dir, venv=venv)
 
     return repo_dir
 
 
-def _git_update_requirements(package_dir, reqs_dir):
+def _git_update_requirements(venv, package_dir, reqs_dir):
     """
     Update from global requirements.
 
@@ -642,7 +647,8 @@
     """
     orig_dir = os.getcwd()
     os.chdir(reqs_dir)
-    cmd = ['python', 'update.py', package_dir]
+    python = os.path.join(venv, 'bin/python')
+    cmd = [python, 'update.py', package_dir]
     try:
         subprocess.check_call(cmd)
     except subprocess.CalledProcessError:
 
=== modified file 'tests/contrib/openstack/test_openstack_utils.py'
--- tests/contrib/openstack/test_openstack_utils.py	2015-05-11 18:53:44 +0000
+++ tests/contrib/openstack/test_openstack_utils.py	2015-06-19 16:09:56 +0000
@@ -642,11 +642,13 @@
         error_out.assert_called_with(
             'openstack-origin-git key \'%s\' is missing' % key)
 
+    @patch('os.path.join')
     @patch.object(openstack, 'error_out')
     @patch.object(openstack, '_git_clone_and_install_single')
+    @patch.object(openstack, 'pip_install')
     @patch.object(openstack, 'pip_create_virtualenv')
-    def test_git_clone_and_install_errors(self, pip_venv, git_install_single,
-                                          error_out):
+    def test_git_clone_and_install_errors(self, pip_venv, pip_install,
+                                          git_install_single, error_out, join):
         git_missing_repos = """
           repostories:
              - {name: requirements,
@@ -704,19 +706,26 @@
         openstack.git_clone_and_install(git_wrong_order_2, 'keystone', depth=1)
         error_out.assert_called_with('requirements git repo must be specified first')
 
+    @patch('os.path.join')
     @patch.object(openstack, 'charm_dir')
     @patch.object(openstack, 'error_out')
     @patch.object(openstack, '_git_clone_and_install_single')
+    @patch.object(openstack, 'pip_install')
     @patch.object(openstack, 'pip_create_virtualenv')
-    def test_git_clone_and_install_success(self, pip_venv, _git_install_single,
-                                           error_out, charm_dir):
+    def test_git_clone_and_install_success(self, pip_venv, pip_install,
+                                           _git_install_single, error_out,
+                                           charm_dir, join):
         proj = 'keystone'
         charm_dir.return_value = '/var/lib/juju/units/testing-foo-0/charm'
         # the following sets the global requirements_dir
         _git_install_single.return_value = '/mnt/openstack-git/requirements'
+        join.return_value = '/mnt/openstack-git/venv'
 
         openstack.git_clone_and_install(openstack_origin_git, proj, depth=1)
         self.assertTrue(pip_venv.called)
+        pip_install.assert_called_with('setuptools', upgrade=True,
+                                       proxy=None,
+                                       venv='/mnt/openstack-git/venv')
         self.assertTrue(_git_install_single.call_count == 2)
         expected = [
             call('git://git.openstack.org/openstack/requirements',
@@ -775,6 +784,7 @@
         parent_dir = '/mnt/openstack-git/'
         http_proxy = 'http://squid-proxy-url'
         dest_dir = '/mnt/openstack-git'
+        venv_dir = '/mnt/openstack-git'
         reqs_dir = '/mnt/openstack-git/requirements-dir'
         join.return_value = dest_dir
         openstack.requirements_dir = reqs_dir
@@ -786,23 +796,27 @@
         mkdir.assert_called_with(parent_dir)
         install_remote.assert_called_with(repo, dest=parent_dir, depth=1,
                                           branch=branch)
-        _git_update_reqs.assert_called_with(dest_dir, reqs_dir)
+        _git_update_reqs.assert_called_with(venv_dir, dest_dir, reqs_dir)
         pip_install.assert_called_with(dest_dir, venv='/mnt/openstack-git',
                                        proxy='http://squid-proxy-url')
 
+    @patch('os.path.join')
     @patch('os.getcwd')
     @patch('os.chdir')
     @patch('subprocess.check_call')
-    def test_git_update_requirements(self, check_call, chdir, getcwd):
+    def test_git_update_requirements(self, check_call, chdir, getcwd, join):
         pkg_dir = '/mnt/openstack-git/repo-dir'
         reqs_dir = '/mnt/openstack-git/reqs-dir'
         orig_dir = '/var/lib/juju/units/testing-foo-0/charm'
+        venv_dir = '/mnt/openstack-git/venv'
         getcwd.return_value = orig_dir
+        join.return_value = '/mnt/openstack-git/venv/python'
 
-        openstack._git_update_requirements(pkg_dir, reqs_dir)
+        openstack._git_update_requirements(venv_dir, pkg_dir, reqs_dir)
         expected = [call(reqs_dir), call(orig_dir)]
         self.assertEquals(expected, chdir.call_args_list)
-        check_call.assert_called_with(['python', 'update.py', pkg_dir])
+        check_call.assert_called_with(['/mnt/openstack-git/venv/python',
+                                      'update.py', pkg_dir])
 
     @patch('os.path.join')
     @patch('subprocess.check_call')