Merge lp:~niedbalski/charm-helpers/fix-lp-1311979 into lp:charm-helpers

[Jorge Niedbalski]

- Added a new module under contrib/python for keeping common python tasks.
 - Added contrib/python/packages, exposing pip_install/pip_uninstall/pip_list/pip_install_from_requirements
 - Added contrib/python/version, exposing current_version/current_version_string

Test status:
-----------

charmhelpers.contrib.python 0 0 100%
charmhelpers.contrib.python.packages 42 3 93% 11-13
charmhelpers.contrib.python.version 6 0 100%

Also

    - Added the fetch.is_package_installed method for
      check if a package or a list of are already installed into the system
     - Added unit tests

    Tests output:
    -------------

    tests.fetch.test_fetch.FetchTest.test_is_package_installed ... ok
    tests.fetch.test_fetch.FetchTest.test_is_package_installed_not_available ... ok

[Marco Ceppi (marcoceppi)]

LGTM +1

review: Approve

=== added directory 'charmhelpers/contrib/python'
=== added file 'charmhelpers/contrib/python/__init__.py'
=== added file 'charmhelpers/contrib/python/packages.py'
--- charmhelpers/contrib/python/packages.py	1970-01-01 00:00:00 +0000
+++ charmhelpers/contrib/python/packages.py	2014-04-24 04:23:58 +0000
@@ -0,0 +1,76 @@
+#!/usr/bin/env python
+# coding: utf-8
+
+__author__ = "Jorge Niedbalski <[e-mail]>"
+
+from charmhelpers.fetch import apt_install
+from charmhelpers.core.hookenv import log
+
+try:
+    from pip import main as pip_execute
+except ImportError:
+    apt_install('python-pip')
+    from pip import main as pip_execute
+
+
+def parse_options(given, available):
+    """Given a set of options, check if available"""
+    for key, value in given.items():
+        if key in available:
+            yield "--{0}={1}".format(key, value)
+
+
+def pip_install_requirements(requirements, **options):
+    """Install a requirements file """
+    command = ["install"]
+
+    available_options = ('proxy', 'src', 'log', )
+    for option in parse_options(options, available_options):
+        command.append(option)
+
+    command.append("-r {0}".format(requirements))
+    log("Installing from file: {} with options: {}".format(requirements,
+                                                           command))
+    pip_execute(command)
+
+
+def pip_install(package, fatal=False, **options):
+    """Install a python package"""
+    command = ["install"]
+
+    available_options = ('proxy', 'src', 'log', "index-url", )
+    for option in parse_options(options, available_options):
+        command.append(option)
+
+    if isinstance(package, list):
+        command.extend(package)
+    else:
+        command.append(package)
+
+    log("Installing {} package with options: {}".format(package,
+                                                        command))
+    pip_execute(command)
+
+
+def pip_uninstall(package, **options):
+    """Uninstall a python package"""
+    command = ["uninstall", "-q", "-y"]
+
+    available_options = ('proxy', 'log', )
+    for option in parse_options(options, available_options):
+        command.append(option)
+
+    if isinstance(package, list):
+        command.extend(package)
+    else:
+        command.append(package)
+
+    log("Uninstalling {} package with options: {}".format(package,
+                                                          command))
+    pip_execute(command)
+
+
+def pip_list():
+    """Returns the list of current python installed packages
+    """
+    return pip_execute(["list"])

=== added file 'charmhelpers/contrib/python/version.py'
--- charmhelpers/contrib/python/version.py	1970-01-01 00:00:00 +0000
+++ charmhelpers/contrib/python/version.py	2014-04-24 04:23:58 +0000
@@ -0,0 +1,18 @@
+#!/usr/bin/env python
+# coding: utf-8
+
+__author__ = "Jorge Niedbalski <[e-mail]>"
+
+import sys
+
+
+def current_version():
+    """Current system python version"""
+    return sys.version_info
+
+
+def current_version_string():
+    """Current system python version as string major.minor.micro"""
+    return "{0}.{1}.{2}".format(sys.version_info.major,
+                                sys.version_info.minor,
+                                sys.version_info.micro)

=== added directory 'tests/contrib/python'
=== added file 'tests/contrib/python/__init__.py'
=== added file 'tests/contrib/python/test_packages.py'
--- tests/contrib/python/test_packages.py	1970-01-01 00:00:00 +0000
+++ tests/contrib/python/test_packages.py	2014-04-24 04:23:58 +0000
@@ -0,0 +1,134 @@
+#!/usr/bin/env python
+# coding: utf-8
+
+__author__ = "Jorge Niedbalski <[e-mail]>"
+
+from unittest import TestCase
+from charmhelpers.contrib.python import packages
+
+import mock
+
+TO_PATCH = [
+    "apt_install",
+    "log",
+    "pip_execute"
+]
+
+
+class PipTestCase(TestCase):
+
+    def setUp(self):
+        TestCase.setUp(self)
+        self.patch_all()
+
+        self.log.return_value = True
+        self.apt_install.return_value = True
+
+    def patch(self, method):
+        _m = mock.patch.object(packages, method)
+        _mock = _m.start()
+        self.addCleanup(_m.stop)
+        return _mock
+
+    def patch_all(self):
+        for method in TO_PATCH:
+            setattr(self, method, self.patch(method))
+
+    def test_pip_install_requirements(self):
+        """
+        Check if pip_install_requirements works correctly
+        """
+        packages.pip_install_requirements("test_requirements.txt")
+        self.pip_execute.assert_called_with(["install",
+                                             "-r test_requirements.txt"])
+
+        packages.pip_install_requirements("test_requirements.txt",
+                                          proxy="proxy_addr:8080")
+
+        self.pip_execute.assert_called_with(["install",
+                                             "--proxy=proxy_addr:8080",
+                                             "-r test_requirements.txt"])
+
+        packages.pip_install_requirements("test_requirements.txt",
+                                          log="output.log",
+                                          proxy="proxy_addr:8080")
+
+        self.pip_execute.assert_called_with(["install",
+                                             "--log=output.log",
+                                             "--proxy=proxy_addr:8080",
+                                             "-r test_requirements.txt"])
+
+    def test_pip_install(self):
+        """
+        Check if pip_install works correctly with a single package
+        """
+        packages.pip_install("mock")
+        self.pip_execute.assert_called_with(["install",
+                                             "mock"])
+        packages.pip_install("mock",
+                             proxy="proxy_addr:8080")
+
+        self.pip_execute.assert_called_with(["install",
+                                             "--proxy=proxy_addr:8080",
+                                             "mock"])
+        packages.pip_install("mock",
+                             log="output.log",
+                             proxy="proxy_addr:8080")
+
+        self.pip_execute.assert_called_with(["install",
+                                             "--log=output.log",
+                                             "--proxy=proxy_addr:8080",
+                                             "mock"])
+
+    def test_pip_install_multiple(self):
+        """
+        Check if pip_install works correctly with multiple packages
+        """
+        packages.pip_install(["mock", "nose"])
+        self.pip_execute.assert_called_with(["install",
+                                             "mock", "nose"])
+
+    def test_pip_uninstall(self):
+        """
+        Check if pip_uninstall works correctly with a single package
+        """
+        packages.pip_uninstall("mock")
+        self.pip_execute.assert_called_with(["uninstall",
+                                             "-q",
+                                             "-y",
+                                             "mock"])
+        packages.pip_uninstall("mock",
+                               proxy="proxy_addr:8080")
+
+        self.pip_execute.assert_called_with(["uninstall",
+                                             "-q",
+                                             "-y",
+                                             "--proxy=proxy_addr:8080",
+                                             "mock"])
+        packages.pip_uninstall("mock",
+                               log="output.log",
+                               proxy="proxy_addr:8080")
+
+        self.pip_execute.assert_called_with(["uninstall",
+                                             "-q",
+                                             "-y",
+                                             "--log=output.log",
+                                             "--proxy=proxy_addr:8080",
+                                             "mock"])
+
+    def test_pip_uninstall_multiple(self):
+        """
+        Check if pip_uninstall works correctly with multiple packages
+        """
+        packages.pip_uninstall(["mock", "nose"])
+        self.pip_execute.assert_called_with(["uninstall",
+                                             "-q",
+                                             "-y",
+                                             "mock", "nose"])
+
+    def test_pip_list(self):
+        """
+        Checks if pip_list works correctly
+        """
+        packages.pip_list()
+        self.pip_execute.assert_called_with(["list"])

=== added file 'tests/contrib/python/test_version.py'
--- tests/contrib/python/test_version.py	1970-01-01 00:00:00 +0000
+++ tests/contrib/python/test_version.py	2014-04-24 04:23:58 +0000
@@ -0,0 +1,27 @@
+#!/usr/bin/env python
+# coding: utf-8
+
+__author__ = "Jorge Niedbalski <[e-mail]>"
+
+from unittest import TestCase
+from charmhelpers.contrib.python import version
+
+import sys
+
+
+class VersionTestCase(TestCase):
+
+    def setUp(self):
+        TestCase.setUp(self)
+
+    def test_current_version(self):
+        """
+        Check if version.current_version and version.current_version_string
+        works correctly
+        """
+        self.assertEquals(version.current_version(),
+                          sys.version_info)
+        self.assertEquals(version.current_version_string(),
+                          "{0}.{1}.{2}".format(sys.version_info.major,
+                                               sys.version_info.minor,
+                                               sys.version_info.micro))