Merge lp:~jacekn/charm-helpers/charm-helpers into lp:charm-helpers

[Jacek Nykis]

Added apt_purge function and tests

[lp:~jacekn/charm-helpers/charm-helpers]

71. By Jacek Nykis on 2013-08-21

Added BzrUrlFetchHandler class and tests

[Jacek Nykis (jacekn)]

Now the proposal also includes new BzrUrlFetchHandler class and small bugfix in fetch/__init__.py

=== modified file 'charmhelpers/fetch/__init__.py'
--- charmhelpers/fetch/__init__.py	2013-08-07 23:14:14 +0000
+++ charmhelpers/fetch/__init__.py	2013-08-21 11:46:14 +0000
@@ -65,6 +65,20 @@
         subprocess.call(cmd)
 
 
+def apt_purge(packages, fatal=False):
+    """Purge one or more packages"""
+    cmd = ['apt-get', '-y', 'purge']
+    if isinstance(packages, basestring):
+        cmd.append(packages)
+    else:
+        cmd.extend(packages)
+    log("Purging {}".format(packages))
+    if fatal:
+        subprocess.check_call(cmd)
+    else:
+        subprocess.call(cmd)
+
+
 def add_source(source, key=None):
     if ((source.startswith('ppa:') or
          source.startswith('http:'))):
@@ -120,6 +134,7 @@
 # least- to most-specific URL matching.
 FETCH_HANDLERS = (
     'charmhelpers.fetch.archiveurl.ArchiveUrlFetchHandler',
+    'charmhelpers.fetch.bzrurl.BzrUrlFetchHandler',
 )
 
 
@@ -139,6 +154,7 @@
     # We ONLY check for True here because can_handle may return a string
     # explaining why it can't handle a given source.
     handlers = [h for h in plugins() if h.can_handle(source) is True]
+    installed_to = None
     for handler in handlers:
         try:
             installed_to = handler.install(source)

=== added file 'charmhelpers/fetch/bzrurl.py'
--- charmhelpers/fetch/bzrurl.py	1970-01-01 00:00:00 +0000
+++ charmhelpers/fetch/bzrurl.py	2013-08-21 11:46:14 +0000
@@ -0,0 +1,44 @@
+import os
+from bzrlib.branch import Branch
+from charmhelpers.fetch import (
+    BaseFetchHandler,
+    UnhandledSource
+)
+from charmhelpers.core.host import mkdir
+
+
+class BzrUrlFetchHandler(BaseFetchHandler):
+    """Handler for bazaar branches via generic and lp URLs"""
+    def can_handle(self, source):
+        url_parts = self.parse_url(source)
+        if url_parts.scheme not in ('bzr+ssh', 'lp'):
+            return False
+        else:
+            return True
+
+    def branch(self, source, dest):
+        url_parts = self.parse_url(source)
+        # If we use lp:branchname scheme we need to load plugins
+        if not self.can_handle(source):
+            raise UnhandledSource("Cannot handle {}".format(source))
+        if url_parts.scheme == "lp":
+            from bzrlib.plugin import load_plugins
+            load_plugins()
+        try:
+            remote_branch = Branch.open(source)
+            remote_branch.bzrdir.sprout(dest).open_branch()
+        except Exception as e:
+            raise e
+
+    def install(self, source):
+        url_parts = self.parse_url(source)
+        branch_name = url_parts.path.strip("/").split("/")[-1]
+        dest_dir = os.path.join(os.environ.get('CHARM_DIR'), "fetched", branch_name)
+        if not os.path.exists(dest_dir):
+            mkdir(dest_dir, perms=0755)
+        try:
+            self.branch(source, dest_dir)
+        except OSError as e:
+            raise UnhandledSource(e.strerror)
+        return dest_dir
+

=== modified file 'tests/core/test_host.py'
--- tests/core/test_host.py	2013-08-07 23:14:14 +0000
+++ tests/core/test_host.py	2013-08-21 11:46:14 +0000
@@ -447,6 +447,50 @@
         check_call.assert_called_with(['apt-get', '-y', '--foo', '--bar',
                                        'install', 'foo', 'bar'])
 
+
+    @patch('subprocess.check_call')
+    @patch.object(host, 'log')
+    def test_purges_apt_packages_as_string_fatal(self, log, mock_call):
+        packages = 'irrelevant names'
+        mock_call.side_effect = OSError('fail')
+
+        mock_call.assertRaises(OSError, fetch.apt_purge, packages, fatal=True )
+        log.assert_called()
+
+
+    @patch('subprocess.check_call')
+    @patch.object(host, 'log')
+    def test_purges_apt_packages_fatal(self, log, mock_call):
+        packages = ['irrelevant', 'names']
+        mock_call.side_effect = OSError('fail')
+
+        mock_call.assertRaises(OSError, fetch.apt_purge, packages, fatal=True )
+        log.assert_called()
+
+
+    @patch('subprocess.call')
+    @patch.object(host, 'log')
+    def test_purges_apt_packages_as_string_nofatal(self, log, mock_call):
+        packages = 'foo bar'
+
+        fetch.apt_purge(packages)
+
+        log.assert_called()
+        mock_call.assert_called_with(['apt-get', '-y', 'purge', 'foo bar'])
+
+
+    @patch('subprocess.call')
+    @patch.object(host, 'log')
+    def test_purges_apt_packages_nofatal(self, log, mock_call):
+        packages = ['foo', 'bar']
+
+        fetch.apt_purge(packages)
+
+        log.assert_called()
+        mock_call.assert_called_with(['apt-get', '-y', 'purge', 'foo',
+                                      'bar'])
+
+
     @patch('subprocess.check_call')
     def test_apt_update_fatal(self, check_call):
         fetch.apt_update(fatal=True)

=== added file 'tests/fetch/test_bzrurl.py'
--- tests/fetch/test_bzrurl.py	1970-01-01 00:00:00 +0000
+++ tests/fetch/test_bzrurl.py	2013-08-21 11:46:14 +0000
@@ -0,0 +1,80 @@
+import os
+from testtools import TestCase
+from urlparse import urlparse
+from mock import (
+    MagicMock,
+    patch,
+)
+from charmhelpers.fetch import (
+    bzrurl,
+    UnhandledSource,
+)
+
+
+class BzrUrlFetchHandlerTest(TestCase):
+
+    def setUp(self):
+        super(BzrUrlFetchHandlerTest, self).setUp()
+        self.valid_urls = (
+            "bzr+ssh://example.com/branch-name",
+            "bzr+ssh://example.com/branch-name/",
+            "lp:lp-branch-name",
+            "lp:example/lp-branch-name",
+        )
+        self.invalid_urls = (
+            "http://example.com/foo.tar.gz",
+            "http://example.com/foo.tgz",
+            "http://example.com/foo.tar.bz2",
+            "http://example.com/foo.tbz2",
+            "http://example.com/foo.zip",
+            "http://example.com/foo.zip?bar=baz&x=y#whee",
+            "ftp://example.com/foo.tar.gz",
+            "https://example.com/foo.tgz",
+            "file://example.com/foo.tar.bz2",
+            "git://example.com/foo.tar.gz",
+            "http://example.com/foo",
+            "http://example.com/foobar=baz&x=y#tar.gz",
+            "http://example.com/foobar?h=baz.zip",
+            "abc:example",
+            "file//example.com/foo.tar.bz2",
+            "garbage",
+        )
+        self.fh = bzrurl.BzrUrlFetchHandler()
+
+
+    def test_handles_bzr_urls(self):
+        for url in self.valid_urls:
+            result = self.fh.can_handle(url)
+            self.assertEqual(result, True, url)
+        for url in self.invalid_urls:
+            result = self.fh.can_handle(url)
+            self.assertNotEqual(result, True, url)
+
+
+    @patch('bzrlib.branch.Branch.open')
+    def test_branch(self, _open):
+        dest_path = "/destination/path"
+        for url in self.valid_urls:
+            self.fh.remote_branch = MagicMock()
+            self.fh.load_plugins = MagicMock()
+            self.fh.branch(url, dest_path)
+
+            _open.assert_called_with(url)
+
+        for url in self.invalid_urls:
+            with patch.dict('os.environ', {'CHARM_DIR': 'foo'}):
+                self.assertRaises(UnhandledSource, self.fh.branch, url, dest_path)
+
+
+    @patch('charmhelpers.fetch.bzrurl.mkdir')
+    def test_installs(self, _mkdir):
+        self.fh.branch = MagicMock()
+
+        for url in self.valid_urls:
+            branch_name = urlparse(url).path.strip("/").split("/")[-1]
+            dest = os.path.join('foo', 'fetched', os.path.basename(branch_name))
+            with patch.dict('os.environ', {'CHARM_DIR': 'foo'}):
+                where = self.fh.install(url)
+            self.assertEqual(where, dest)
+            _mkdir.assert_called_with(where, perms=0755)
+

=== modified file 'tests/fetch/test_fetch.py'
--- tests/fetch/test_fetch.py	2013-08-07 23:14:14 +0000
+++ tests/fetch/test_fetch.py	2013-08-21 11:46:14 +0000
@@ -183,14 +183,17 @@
             "ftp://example.com/foo.tar.gz",
             "https://example.com/foo.tgz",
             "file://example.com/foo.tar.bz2",
+            "bzr+ssh://example.com/branch-name",
+            "bzr+ssh://example.com/branch-name/",
+            "lp:branch-name",
+            "lp:example/branch-name",
         )
         self.invalid_urls = (
             "git://example.com/foo.tar.gz",
             "http://example.com/foo",
             "http://example.com/foobar=baz&x=y#tar.gz",
             "http://example.com/foobar?h=baz.zip",
-            "bzr+ssh://example.com/foo.tar.gz",
-            "lp:example/foo.tgz",
+            "abc:example",
             "file//example.com/foo.tar.bz2",
             "garbage",
         )