Merge ~cjwatson/ols-charm-deps:pip-install-code-dir into ols-charm-deps:master

[Colin Watson]

Tell pip to install code dir if it has setup.py

It's sometimes useful to have entry points in the code directory's setup.py that install scripts: for example, lp-signing does this. Support this by adding the code directory to pip's arguments, provided that a setup.py exists there.

[Guillermo Gonzalez (verterok)]

looks good.

review: Approve

diff --git a/layer/ols/lib/ols/base.py b/layer/ols/lib/ols/base.py
index 357ad0a..df9d984 100644
--- a/layer/ols/lib/ols/base.py
+++ b/layer/ols/lib/ols/base.py
@@ -374,11 +374,19 @@ def create_virtualenv(wheels_dir, codedir, python_exe):
     requirements = os.path.join(codedir, 'requirements.txt')
 
     hookenv.log('Installing from local wheelhouse.')
-    subprocess.check_call(['%s/bin/pip' % env_dir,
-                           'install',
-                           '--no-index',
-                           '--find-links={}'.format(wheels_dir),
-                           '-r', requirements])
+    pip_args = [
+        '%s/bin/pip' % env_dir,
+        'install',
+        '--no-index',
+        '--find-links={}'.format(wheels_dir),
+        '-r', requirements,
+    ]
+    # The payload may have a setup.py.  If so, tell pip to install the code
+    # directory as well, so that any entry points configured by the payload
+    # will have corresponding scripts built for them.
+    if os.path.exists(os.path.join(codedir, 'setup.py')):
+        pip_args.append(codedir)
+    subprocess.check_call(pip_args)
 
 
 def render_template(template, context):
diff --git a/layer/ols/unit_tests/test_ols.py b/layer/ols/unit_tests/test_ols.py
index b982636..adef577 100644
--- a/layer/ols/unit_tests/test_ols.py
+++ b/layer/ols/unit_tests/test_ols.py
@@ -489,6 +489,44 @@ class BaseTest(TestCase):
             call('Installing python packages into the venv'),
             call('Installing from local wheelhouse.')])
 
+    @patch.object(hookenv, 'log')
+    def test_create_virtualenv_with_setup_py(self, log):
+        env_dir = os.path.join(base.code_dir(), 'env')
+        wheels_dir = os.path.join(base.code_dir(), 'wheels')
+        requirements = os.path.join(base.code_dir(), 'requirements.txt')
+        setup_py = os.path.join(base.code_dir(), 'setup.py')
+        os.makedirs(base.code_dir())
+        with open(setup_py, 'w'):
+            pass
+        ps = FakeProcesses()
+        self.useFixture(ps)
+        venv_ok = Mock()
+        venv_ok.return_value = {'returncode': 0}
+        ps.add(venv_ok, name='virtualenv')
+        pip = Mock()
+        pip.return_value = {'returncode': 0}
+        pip_bin = '%s/bin/pip' % (env_dir)
+        ps.add(pip, name=pip_bin)
+
+        base.create_virtualenv(wheels_dir, base.code_dir(),
+                               base.python_bin())
+
+        venv_ok.assert_called_once_with({'args': [
+            'virtualenv',
+            '--no-download',
+            '--extra-search-dir=/srv/testservice/code/wheels',
+            '-p', 'python3',
+            '--extra-search-dir', '/srv/testservice/code/wheels',
+            '/srv/testservice/code/env']})
+
+        pip.assert_called_once_with({'args': [
+            pip_bin, 'install', '--no-index',
+            '--find-links={}'.format(wheels_dir), '-r', requirements,
+            base.code_dir()]})
+        log.assert_has_calls([
+            call('Installing python packages into the venv'),
+            call('Installing from local wheelhouse.')])
+
     def test_render_template(self):
         tmpl = """
         {% if True %}