From 4d7d23d7c50f0ea668fc8e3daaf54501cb3c2479 Mon Sep 17 00:00:00 2001
From: Brian Rosmaita <rosmaita.fossdev@gmail.com>
Date: Tue, 29 May 2018 15:12:08 -0400
Subject: [PATCH] Handle -/_ ambiguity in package names

Some openstack packages show up in the requirements list under a
hyphenated name while their package metadata name contains only
underscores.  (For example, the glance_store library is listed in
requirements as 'glance-store'.)  This is causing problems for the
tox_install_sibling_packages task run by zuul.  Pip is able to handle
this situation [0]; add code so the ansible task can handle it too.

[0] http://paste.openstack.org/show/722298/

Change-Id: I89ad9926647a011174815761e79372f2d7d43609
Needed-by: https://review.openstack.org/#/c/569225/
Closes-bug: #1774030
---
 .../library/tox_install_sibling_packages.py   | 48 ++++++++++++++++---
 1 file changed, 42 insertions(+), 6 deletions(-)

diff --git a/roles/tox/library/tox_install_sibling_packages.py b/roles/tox/library/tox_install_sibling_packages.py
index a2c78ebf3..7f0f56db9 100644
--- a/roles/tox/library/tox_install_sibling_packages.py
+++ b/roles/tox/library/tox_install_sibling_packages.py
@@ -52,6 +52,7 @@ try:
 except ImportError:
     import ConfigParser as configparser
 
+import pkg_resources as prAPI
 import os
 import subprocess
 import tempfile
@@ -120,6 +121,26 @@ def write_new_constraints_file(constraints, packages):
         return constraints_file.name
 
 
+def _get_package_root(name, sibling_packages):
+    '''
+    Returns a package root from the sibling packages dict.
+
+    If name is not found in sibling_packages, tries again using the 'filename'
+    form of the name returned by the setuptools package resource API.
+
+    :param name: package name
+    :param sibling_packages: dict of python packages that zuul has cloned
+    :returns: the package root (str)
+    :raises: KeyError
+    '''
+    try:
+        pkg_root = sibling_packages[name]
+    except KeyError:
+        pkg_root = sibling_packages[prAPI.to_filename(name)]
+
+    return pkg_root
+
+
 def main():
     module = AnsibleModule(
         argument_spec=dict(
@@ -179,7 +200,8 @@ def main():
             log.append(
                 "Found {name} python package installed".format(
                     name=dep_name))
-            if dep_name == package_name:
+            if (dep_name == package_name or
+                prAPI.to_filename(dep_name) == package_name):
                 # We don't need to re-process ourself. We've filtered ourselves
                 # from the source dir list, but let's be sure nothing is weird.
                 log.append(
@@ -192,7 +214,16 @@ def main():
                         name=dep_name,
                         root=sibling_python_packages[dep_name]))
                 changed = True
-
+                found_sibling_packages.append(dep_name)
+            elif prAPI.to_filename(dep_name) in sibling_python_packages:
+                real_name = prAPI.to_filename(dep_name)
+                log.append(
+                    "Package {name} ({pkg_name}) on system in {root}".format(
+                        name=dep_name,
+                        pkg_name=real_name,
+                        root=sibling_python_packages[real_name]))
+                changed = True
+                # need to use dep_name here for later constraint file rewrite
                 found_sibling_packages.append(dep_name)
 
         if constraints:
@@ -210,24 +241,29 @@ def main():
             args = [tox_python, '-m', 'pip', 'install']
             if constraints:
                 args.extend(['-c', constraints_file])
+
+            pkg_root = _get_package_root(sibling_package,
+                                         sibling_python_packages)
             log.append(
                 "Installing {name} from {root} for deps".format(
                     name=sibling_package,
-                    root=sibling_python_packages[sibling_package]))
-            args.append(sibling_python_packages[sibling_package])
+                    root=pkg_root))
+            args.append(pkg_root)
 
             install_output = subprocess.check_output(args)
             log.extend(install_output.decode('utf-8').split('\n'))
 
         for sibling_package in found_sibling_packages:
+            pkg_root = _get_package_root(sibling_package,
+                                         sibling_python_packages)
             log.append(
                 "Installing {name} from {root}".format(
                     name=sibling_package,
-                    root=sibling_python_packages[sibling_package]))
+                    root=pkg_root))
 
             install_output = subprocess.check_output(
                 [tox_python, '-m', 'pip', 'install', '--no-deps',
-                 sibling_python_packages[sibling_package]])
+                 pkg_root])
             log.extend(install_output.decode('utf-8').split('\n'))
     except Exception as e:
         tb = traceback.format_exc()