Merge lp:~sergiusens/snapcraft/source-tests into lp:~snappy-dev/snapcraft/core

[Sergio Schvezov]

Unit tests for sources

For all but Tar.

[Michael Vogt (mvo)]

This looks great, one whitespace remark because I wanted to comment on at least one line :) But seriously, good stuff and fine to merge.

review: Approve

[Snappy Tarmac (snappydevtarmac)]

There are additional revisions which have not been approved in review. Please seek review and approval of these new revisions.

[Sergio Schvezov (sergiusens)]

bzr pump from previous review and white space fix from review

review: Approve

=== modified file 'snapcraft/tests/test_sources.py'
--- snapcraft/tests/test_sources.py	2015-09-01 10:10:21 +0000
+++ snapcraft/tests/test_sources.py	2015-09-01 10:10:21 +0000
@@ -17,6 +17,7 @@
 import os
 import http.server
 import threading
+import unittest.mock
 
 from snapcraft import sources
 from snapcraft import tests
@@ -59,3 +60,241 @@
 
         with open(os.path.join(dest_dir, tar_file_name), 'r') as tar_file:
             self.assertEqual('Test fake tarball file', tar_file.read())
+
+
+class SourceTestCase(tests.TestCase):
+
+    def setUp(self):
+        super().setUp()
+
+        patcher = unittest.mock.patch('snapcraft.common.run')
+        self.mock_run = patcher.start()
+        self.mock_run.return_value = True
+        self.addCleanup(patcher.stop)
+
+        patcher = unittest.mock.patch('os.rmdir')
+        self.mock_rmdir = patcher.start()
+        self.addCleanup(patcher.stop)
+
+        patcher = unittest.mock.patch('os.path.exists')
+        self.mock_path_exists = patcher.start()
+        self.mock_path_exists.return_value = False
+        self.addCleanup(patcher.stop)
+
+
+class TestBazaar(SourceTestCase):
+
+    def test_pull(self):
+        bzr = sources.Bazaar('lp:my-source', 'source_dir')
+
+        bzr.pull()
+
+        self.mock_rmdir.assert_called_once_with('source_dir')
+        self.mock_run.assert_called_once_with(
+            ['bzr', 'branch', 'lp:my-source', 'source_dir'], cwd=os.getcwd())
+
+    def test_pull_tag(self):
+        bzr = sources.Bazaar('lp:my-source', 'source_dir', source_tag='tag')
+        bzr.pull()
+
+        self.mock_run.assert_called_once_with(
+            ['bzr', 'branch', '-r', 'tag:tag', 'lp:my-source', 'source_dir'], cwd=os.getcwd())
+
+    def test_pull_existing_with_tag(self):
+        self.mock_path_exists.return_value = True
+
+        bzr = sources.Bazaar('lp:my-source', 'source_dir', source_tag='tag')
+        bzr.pull()
+
+        self.mock_run.assert_called_once_with(
+            ['bzr', 'pull', '-r', 'tag:tag', 'lp:my-source', '-d', 'source_dir'], cwd=os.getcwd())
+
+    def test_provision(self):
+        bzr = sources.Bazaar('lp:my-source', 'source_dir')
+        bzr.provision('dst')
+
+        self.mock_run.assert_called_once_with(
+            ['cp', '-Trfa', 'source_dir', 'dst'], cwd=os.getcwd())
+
+    def test_init_with_source_branch_raises_exception(self):
+        with self.assertRaises(sources.IncompatibleOptionsError) as raised:
+            sources.Bazaar('lp:mysource', 'source_dir', source_branch='branch')
+
+        expected_message = 'can\'t specify a source-branch for a bzr source'
+        self.assertEqual(raised.exception.message, expected_message)
+
+
+class TestGit(SourceTestCase):
+
+    def test_pull(self):
+        git = sources.Git('git://my-source', 'source_dir')
+
+        git.pull()
+
+        self.mock_run.assert_called_once_with(
+            ['git', 'clone', 'git://my-source', 'source_dir'], cwd=os.getcwd())
+
+    def test_pull_branch(self):
+        git = sources.Git('git://my-source', 'source_dir', source_branch='my-branch')
+        git.pull()
+
+        self.mock_run.assert_called_once_with(
+            ['git', 'clone', '--branch', 'my-branch', 'git://my-source', 'source_dir'], cwd=os.getcwd())
+
+    def test_pull_tag(self):
+        git = sources.Git('git://my-source', 'source_dir', source_tag='tag')
+        git.pull()
+
+        self.mock_run.assert_called_once_with(
+            ['git', 'clone', '--branch', 'tag', 'git://my-source', 'source_dir'], cwd=os.getcwd())
+
+    def test_pull_existing(self):
+        self.mock_path_exists.return_value = True
+
+        git = sources.Git('git://my-source', 'source_dir')
+        git.pull()
+
+        self.mock_run.assert_called_once_with(
+            ['git', '-C', 'source_dir', 'pull', 'git://my-source', 'HEAD'], cwd=os.getcwd())
+
+    def test_pull_existing_with_tag(self):
+        self.mock_path_exists.return_value = True
+
+        git = sources.Git('git://my-source', 'source_dir', source_tag='tag')
+        git.pull()
+
+        self.mock_run.assert_called_once_with(
+            ['git', '-C', 'source_dir', 'pull', 'git://my-source', 'refs/tags/tag'], cwd=os.getcwd())
+
+    def test_pull_existing_with_branch(self):
+        self.mock_path_exists.return_value = True
+
+        git = sources.Git('git://my-source', 'source_dir', source_branch='my-branch')
+        git.pull()
+
+        self.mock_run.assert_called_once_with(
+            ['git', '-C', 'source_dir', 'pull', 'git://my-source', 'refs/heads/my-branch'], cwd=os.getcwd())
+
+    def test_provision(self):
+        bzr = sources.Git('git://my-source', 'source_dir')
+        bzr.provision('dst')
+
+        self.mock_run.assert_called_once_with(
+            ['cp', '-Trfa', 'source_dir', 'dst'], cwd=os.getcwd())
+
+    def test_init_with_source_branch_and_tag_raises_exception(self):
+        with self.assertRaises(sources.IncompatibleOptionsError) as raised:
+            sources.Git('git://mysource', 'source_dir', source_tag='tag', source_branch='branch')
+
+        expected_message = 'can\'t specify both source-tag and source-branch for a git source'
+        self.assertEqual(raised.exception.message, expected_message)
+
+
+class TestMercurial(SourceTestCase):
+
+    def test_pull(self):
+        hg = sources.Mercurial('hg://my-source', 'source_dir')
+        hg.pull()
+
+        self.mock_run.assert_called_once_with(
+            ['hg', 'clone', 'hg://my-source', 'source_dir'], cwd=os.getcwd())
+
+    def test_pull_branch(self):
+        hg = sources.Mercurial('hg://my-source', 'source_dir', source_branch='my-branch')
+        hg.pull()
+
+        self.mock_run.assert_called_once_with(
+            ['hg', 'clone', '-u', 'my-branch', 'hg://my-source', 'source_dir'], cwd=os.getcwd())
+
+    def test_pull_tag(self):
+        hg = sources.Mercurial('hg://my-source', 'source_dir', source_tag='tag')
+        hg.pull()
+
+        self.mock_run.assert_called_once_with(
+            ['hg', 'clone', '-u', 'tag', 'hg://my-source', 'source_dir'], cwd=os.getcwd())
+
+    def test_pull_existing(self):
+        self.mock_path_exists.return_value = True
+
+        hg = sources.Mercurial('hg://my-source', 'source_dir')
+        hg.pull()
+
+        self.mock_run.assert_called_once_with(
+            ['hg', 'pull', 'hg://my-source'], cwd=os.getcwd())
+
+    def test_pull_existing_with_tag(self):
+        self.mock_path_exists.return_value = True
+
+        hg = sources.Mercurial('hg://my-source', 'source_dir', source_tag='tag')
+        hg.pull()
+
+        self.mock_run.assert_called_once_with(
+            ['hg', 'pull', '-r', 'tag', 'hg://my-source'], cwd=os.getcwd())
+
+    def test_pull_existing_with_branch(self):
+        self.mock_path_exists.return_value = True
+
+        hg = sources.Mercurial('hg://my-source', 'source_dir', source_branch='my-branch')
+        hg.pull()
+
+        self.mock_run.assert_called_once_with(
+            ['hg', 'pull', '-b', 'my-branch', 'hg://my-source'], cwd=os.getcwd())
+
+    def test_provision(self):
+        bzr = sources.Mercurial('hg://my-source', 'source_dir')
+        bzr.provision('dst')
+
+        self.mock_run.assert_called_once_with(
+            ['cp', '-Trfa', 'source_dir', 'dst'], cwd=os.getcwd())
+
+    def test_init_with_source_branch_and_tag_raises_exception(self):
+        with self.assertRaises(sources.IncompatibleOptionsError) as raised:
+            sources.Mercurial('hg://mysource', 'source_dir', source_tag='tag', source_branch='branch')
+
+        expected_message = 'can\'t specify both source-tag and source-branch for a mercurial source'
+        self.assertEqual(raised.exception.message, expected_message)
+
+
+class TestLocal(SourceTestCase):
+
+    def setUp(self):
+        super().setUp()
+
+        patcher = unittest.mock.patch('os.path.isdir')
+        self.mock_isdir = patcher.start()
+        self.mock_isdir.return_value = True
+        self.addCleanup(patcher.stop)
+
+        patcher = unittest.mock.patch('os.symlink')
+        self.mock_symlink = patcher.start()
+        self.addCleanup(patcher.stop)
+
+        patcher = unittest.mock.patch('os.remove')
+        self.mock_remove = patcher.start()
+        self.addCleanup(patcher.stop)
+        self.mock_symlink.return_value = True
+
+        patcher = unittest.mock.patch('os.path.abspath')
+        self.mock_abspath = patcher.start()
+        self.mock_abspath.return_value = '/home/ubuntu/sources/snap/source'
+        self.addCleanup(patcher.stop)
+
+    def test_pull(self):
+        local = sources.Local('.', 'source_dir')
+        self.assertTrue(local.pull())
+
+    def test_provision(self):
+        local = sources.Local('.', 'source_dir')
+        local.provision('dst')
+
+        self.mock_rmdir.assert_called_once_with('dst')
+        self.mock_symlink.assert_called_once_with('/home/ubuntu/sources/snap/source', 'dst')
+
+    def test_provision_when_target_is_file(self):
+        self.mock_isdir.return_value = False
+
+        local = sources.Local('.', 'source_dir')
+        local.provision('dst')
+
+        self.mock_remove.assert_called_once_with('dst')
+        self.mock_symlink.assert_called_once_with('/home/ubuntu/sources/snap/source', 'dst')