Merge lp:~elopio/snapcraft/base_plugin_tests into lp:~snappy-dev/snapcraft/core

[Leo Arias]

Added unit tests for the base plugin.
Added python3-testscenarios and wget as a dependency.

The important parts of this branch are:
- added a simple local server to test downloads.
- added test scenarios to simplify repetitive unit tests. (already installed in tarmac.)

Once I put this into test I found a bug I introduced by leaving the argument in the fatal function.
I also simplified the makedirs method.

[lp:~elopio/snapcraft/base_plugin_tests]

122. By Leo Arias on 2015-08-04

Added tests for makedirs.

123. By Leo Arias on 2015-08-04

Added testscenarios to the debian deps.

[Michael Terry (mterry)]

Looks great, thanks, especially the fatal() typo fix! :)

But you'll want to add wget to Build-Depends too (we didn't use it during tests before).

review: Needs Fixing

[lp:~elopio/snapcraft/base_plugin_tests]

124. By Leo Arias on 2015-08-04

Added wget to the test deps.

125. By Leo Arias on 2015-08-04

Merged with trunk.

[Michael Terry (mterry)]

Beautiful!

review: Approve

=== modified file 'debian/control'
--- debian/control	2015-08-04 20:46:05 +0000
+++ debian/control	2015-08-04 21:37:20 +0000
@@ -15,8 +15,10 @@
                python3-apt,
                python3-fixtures,
                python3-setuptools,
+               python3-testscenarios,
                python3-yaml,
                ubuntu-snappy-cli,
+               wget,
                xz-utils,
 Homepage: https://launchpad.net/snapcraft
 Standards-Version: 3.9.6

=== modified file 'snapcraft/__init__.py'
--- snapcraft/__init__.py	2015-07-29 04:33:25 +0000
+++ snapcraft/__init__.py	2015-08-04 21:37:20 +0000
@@ -196,7 +196,4 @@
                                source_branch=sbranch)
 
     def makedirs(self, d):
-        try:
-            os.makedirs(d)
-        except FileExistsError:
-            pass
+        os.makedirs(d, exist_ok=True)

=== modified file 'snapcraft/common.py'
--- snapcraft/common.py	2015-07-31 20:14:25 +0000
+++ snapcraft/common.py	2015-08-04 21:37:20 +0000
@@ -46,7 +46,7 @@
         return subprocess.call(['/bin/sh', f.name] + cmd, **kwargs) == 0
 
 
-def fatal(msg):
+def fatal():
     sys.exit(1)
 
 

=== modified file 'snapcraft/tests/__init__.py'
--- snapcraft/tests/__init__.py	2015-07-24 16:16:46 +0000
+++ snapcraft/tests/__init__.py	2015-08-04 21:37:20 +0000
@@ -15,12 +15,13 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 import fixtures
+import testscenarios
 
 from snapcraft import common
 from snapcraft.tests import fixture_setup
 
 
-class TestCase(fixtures.TestWithFixtures):
+class TestCase(testscenarios.WithScenarios, fixtures.TestWithFixtures):
 
     def setUp(self):
         super().setUp()

=== modified file 'snapcraft/tests/test_base_plugin.py'
--- snapcraft/tests/test_base_plugin.py	2015-07-22 20:58:50 +0000
+++ snapcraft/tests/test_base_plugin.py	2015-08-04 21:37:20 +0000
@@ -14,11 +14,32 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+import http.server
+import fixtures
+import logging
+import os
+import threading
+
 import snapcraft
-from snapcraft.tests import TestCase
-
-
-class TestBasePlugin(TestCase):
+from snapcraft import tests
+
+
+class FakeTarballHTTPRequestHandler(http.server.BaseHTTPRequestHandler):
+
+    def do_GET(self):
+        data = 'Test fake tarball file'
+        self.send_response(200)
+        self.send_header('Content-Length', len(data))
+        self.send_header('Content-type', 'text/html')
+        self.end_headers()
+        self.wfile.write(data.encode())
+
+    def log_message(self, *args):
+        # Overwritten so the test does not write to stderr.
+        pass
+
+
+class TestBasePlugin(tests.TestCase):
 
     def test_isurl(self):
         plugin = snapcraft.BasePlugin('mock', {})
@@ -27,3 +48,101 @@
         self.assertFalse(plugin.isurl('./'))
         self.assertFalse(plugin.isurl('/foo'))
         self.assertFalse(plugin.isurl('/fo:o'))
+
+    def test_pull_git_with_tag_and_branch_must_raise_error(self):
+        fake_logger = fixtures.FakeLogger(level=logging.ERROR)
+        self.useFixture(fake_logger)
+
+        plugin = snapcraft.BasePlugin('test_plugin', 'dummy_options')
+        with self.assertRaises(SystemExit) as raised:
+            plugin.pull_git(
+                'dummy_source', source_tag='test_tag',
+                source_branch='test_branch')
+
+        self.assertEqual(raised.exception.code, 1, 'Wrong exit code returned.')
+        expected = (
+            "You can't specify both source-tag and source-branch for a git "
+            "source (part 'test_plugin').\n")
+        self.assertEqual(expected, fake_logger.output)
+
+    def test_pull_tarball_must_download_to_sourcedir(self):
+        server = http.server.HTTPServer(('', 0), FakeTarballHTTPRequestHandler)
+        server_thread = threading.Thread(target=server.serve_forever)
+        self.addCleanup(server_thread.join)
+        self.addCleanup(server.server_close)
+        self.addCleanup(server.shutdown)
+        server_thread.start()
+
+        plugin_name = 'test_plugin'
+        dest_dir = os.path.join('parts', plugin_name, 'src')
+        os.makedirs(dest_dir)
+        tar_file_name = 'test.tar'
+        source = 'http://{}:{}/{file_name}'.format(
+            *server.server_address, file_name=tar_file_name)
+        plugin = snapcraft.BasePlugin(plugin_name, 'dummy_options')
+        plugin.pull_tarball(source)
+
+        with open(os.path.join(dest_dir, tar_file_name), 'r') as tar_file:
+            self.assertEqual('Test fake tarball file', tar_file.read())
+
+    def test_get_source_with_unrecognized_source_must_raise_error(self):
+        fake_logger = fixtures.FakeLogger(level=logging.ERROR)
+        self.useFixture(fake_logger)
+
+        plugin = snapcraft.BasePlugin('test_plugin', 'dummy_options')
+        with self.assertRaises(SystemExit) as raised:
+            plugin.get_source('unrecognized://test_source')
+
+        self.assertEqual(raised.exception.code, 1, 'Wrong exit code returned.')
+        expected = (
+            "Unrecognized source 'unrecognized://test_source' for part "
+            "'test_plugin'.\n")
+        self.assertEqual(expected, fake_logger.output)
+
+    def test_makedirs_with_existing_dir(self):
+        plugin = snapcraft.BasePlugin('dummy_plugin', 'dummy_options')
+        plugin.makedirs(self.path)
+        self.assertTrue(os.path.exists(self.path))
+
+    def test_makedirs_with_unexisting_dir(self):
+        path = os.path.join(self.path, 'unexisting')
+        plugin = snapcraft.BasePlugin('dummy_plugin', 'dummy_options')
+        plugin.makedirs(path)
+        self.assertTrue(os.path.exists(path))
+
+
+class GetSourceTestCase(tests.TestCase):
+
+    scenarios = [
+        ('bzr with source branch', {
+            'source_type': 'bzr',
+            'source_branch': 'test_branch',
+            'source_tag': None,
+            'error': 'source-branch'}),
+        ('tar with source branch', {
+            'source_type': 'tar',
+            'source_branch': 'test_branch',
+            'source_tag': None,
+            'error': 'source-branch'}),
+        ('tar with source tag', {
+            'source_type': 'tar',
+            'source_branch': None,
+            'source_tag': 'test_tag',
+            'error': 'source-tag'})
+    ]
+
+    def test_get_source_with_branch_must_raise_error(self):
+        fake_logger = fixtures.FakeLogger(level=logging.ERROR)
+        self.useFixture(fake_logger)
+
+        plugin = snapcraft.BasePlugin('test_plugin', 'dummy_options')
+        with self.assertRaises(SystemExit) as raised:
+            plugin.get_source(
+                'dummy_source', source_type=self.source_type,
+                source_branch=self.source_branch, source_tag=self.source_tag)
+
+        self.assertEqual(raised.exception.code, 1, 'Wrong exit code returned.')
+        expected = (
+            "You can't specify {} for a {} source "
+            "(part 'test_plugin').\n".format(self.error, self.source_type))
+        self.assertEqual(expected, fake_logger.output)