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

[Sergio Schvezov]

Add a clean command

[lp:~sergiusens/snapcraft/clean]

174. By Sergio Schvezov on 2015-09-17

Use %r for proper string quoting

[Leo Arias (elopio)]

This is good, and works.

From our discussion on IRC, I'd like to see one integration test calling clean. And delete the parts dir if all the parts were removed by clean.

<sergiusens> elopio, like for every test possible?
<elopio> sergiusens: no, just one execution of clean.
<sergiusens> elopio, as in, for every test run in there?
<sergiusens> elopio, ok, I don't mind that :-)
<elopio> sergiusens: the parts directory is not removed.
<elopio> is that on purpose?
<sergiusens> elopio, yes; inside parts you can also have local plugins
<sergiusens> elopio, it's sort of a safe haven for things
<elopio> sergiusens: what about removing it if it's empty?
<sergiusens> elopio, so instead of removing everything I thought it be safer this way
<sergiusens> elopio, yeah, that can be arranged
<elopio> just feels weird to leave behind only one empty dir.

[lp:~sergiusens/snapcraft/clean]

175. By Sergio Schvezov on 2015-09-17

Remove parts if empty

176. By Sergio Schvezov on 2015-09-17

plainbox test for clean

[John Lenton (chipaca)]

Nice. Thanks.

review: Approve

=== modified file 'integration-tests/units/jobs.pxu'
--- integration-tests/units/jobs.pxu	2015-09-17 06:24:37 +0000
+++ integration-tests/units/jobs.pxu	2015-09-17 18:08:11 +0000
@@ -90,6 +90,22 @@
     ${SNAPCRAFT} stage
     test "$(./stage/bin/test)" = "Hello world"
 
+id: snapcraft/normal/simple-make-clean
+plugin: shell
+estimated_duration: 0.3
+command:
+    set -ex
+    cp -rT $PLAINBOX_PROVIDER_DATA/simple-make .
+    ${SNAPCRAFT} snap
+    test "$(./stage/bin/test)" = "Hello world"
+    test -d ./stage
+    test -d ./parts
+    test -d ./snap
+    ${SNAPCRAFT} clean
+    test ! -d ./stage
+    test ! -d ./parts
+    test ! -d ./snap
+
 id: snapcraft/normal/simple-cmake
 plugin: shell
 estimated_duration: 0.3

=== modified file 'snapcraft/__init__.py'
--- snapcraft/__init__.py	2015-09-15 21:02:02 +0000
+++ snapcraft/__init__.py	2015-09-17 18:08:11 +0000
@@ -34,6 +34,7 @@
     def __init__(self, name, options):
         self.name = name
         self.options = options
+        self.partdir = os.path.join(os.getcwd(), "parts", self.name)
         self.sourcedir = os.path.join(os.getcwd(), "parts", self.name, "src")
         self.builddir = os.path.join(os.getcwd(), "parts", self.name, "build")
         self.ubuntudir = os.path.join(os.getcwd(), "parts", self.name, 'ubuntu')

=== modified file 'snapcraft/cmds.py'
--- snapcraft/cmds.py	2015-09-17 13:21:49 +0000
+++ snapcraft/cmds.py	2015-09-17 18:08:11 +0000
@@ -228,6 +228,27 @@
             qemu.kill()
 
 
+def clean(args):
+    config = _load_config()
+
+    for part in config.all_parts:
+        logger.info('Cleaning up for part %r', part.names()[0])
+        if os.path.exists(part.partdir):
+            shutil.rmtree(part.partdir)
+
+    # parts dir does not contain only generated code.
+    if not os.listdir(common.get_partsdir()):
+        os.rmdir(common.get_partsdir())
+
+    logger.info('Cleaning up staging area')
+    if os.path.exists(common.get_stagedir()):
+        shutil.rmtree(common.get_stagedir())
+
+    logger.info('Cleaning up snapping area')
+    if os.path.exists(common.get_snapdir()):
+        shutil.rmtree(common.get_snapdir())
+
+
 def _check_for_collisions(parts):
     parts_files = {}
     for part in parts:

=== modified file 'snapcraft/common.py'
--- snapcraft/common.py	2015-08-28 20:26:41 +0000
+++ snapcraft/common.py	2015-09-17 18:08:11 +0000
@@ -67,6 +67,10 @@
     return _arch_triplet
 
 
+def get_partsdir():
+    return os.path.join(os.getcwd(), 'parts')
+
+
 def get_stagedir():
     return os.path.join(os.getcwd(), 'stage')
 

=== modified file 'snapcraft/main.py'
--- snapcraft/main.py	2015-07-30 14:45:01 +0000
+++ snapcraft/main.py	2015-09-17 18:08:11 +0000
@@ -48,6 +48,9 @@
     parser = subparsers.add_parser('run', help='run snap in kvm', add_help=False)
     parser.set_defaults(func=snapcraft.cmds.run)
 
+    parser = subparsers.add_parser('clean', help='clean up the environment (to start from scratch)')
+    parser.set_defaults(func=snapcraft.cmds.clean)
+
     parser = subparsers.add_parser('pull', help='get sources', parents=[cmd_parser])
     parser.set_defaults(func=snapcraft.cmds.cmd)
 

=== modified file 'snapcraft/plugin.py'
--- snapcraft/plugin.py	2015-09-17 13:10:10 +0000
+++ snapcraft/plugin.py	2015-09-17 18:08:11 +0000
@@ -63,7 +63,8 @@
         self.deps = []
         self.plugin_name = name
 
-        parts_dir = os.path.join(os.getcwd(), 'parts')
+        parts_dir = common.get_partsdir()
+        self.partdir = os.path.join(parts_dir, part_name)
         self.sourcedir = os.path.join(parts_dir, part_name, 'src')
         self.builddir = os.path.join(parts_dir, part_name, 'build')
         self.ubuntudir = os.path.join(parts_dir, part_name, 'ubuntu')

=== modified file 'snapcraft/tests/test_cmds.py'
--- snapcraft/tests/test_cmds.py	2015-09-17 12:41:20 +0000
+++ snapcraft/tests/test_cmds.py	2015-09-17 18:08:11 +0000
@@ -23,6 +23,7 @@
 
 from snapcraft import (
     cmds,
+    common,
     tests
 )
 
@@ -78,6 +79,116 @@
             fake_logger.output)
 
 
+class CleanTestCase(tests.TestCase):
+
+    def setUp(self):
+        super().setUp()
+
+        patcher = mock.patch('shutil.rmtree')
+        self.mock_rmtree = patcher.start()
+        self.addCleanup(patcher.stop)
+
+        patcher = mock.patch('os.path.exists')
+        self.mock_exists = patcher.start()
+        self.addCleanup(patcher.stop)
+
+        patcher = mock.patch('os.listdir')
+        self.mock_listdir = patcher.start()
+        self.mock_listdir.return_value = []
+        self.addCleanup(patcher.stop)
+
+        patcher = mock.patch('os.rmdir')
+        self.mock_rmdir = patcher.start()
+        self.addCleanup(patcher.stop)
+
+        class FakePart:
+
+            def __init__(self, name, partdir):
+                self.name = name
+                self.partdir = partdir
+
+            def names(self):
+                return [self.name, ]
+
+        class FakeConfig:
+            all_parts = [
+                FakePart('part1', 'partdir1'),
+                FakePart('part2', 'partdir2'),
+                FakePart('part3', 'partdir3'),
+            ]
+
+        self.fake_config = FakeConfig()
+
+        patcher = mock.patch('snapcraft.cmds._load_config')
+        self.mock_load_config = patcher.start()
+        self.mock_load_config.return_value = self.fake_config
+        self.addCleanup(patcher.stop)
+
+    def test_clean_all(self):
+        cmds.clean({})
+
+        self.mock_exists.assert_has_calls([
+            mock.call('partdir1'),
+            mock.call().__bool__(),
+            mock.call('partdir2'),
+            mock.call().__bool__(),
+            mock.call('partdir3'),
+            mock.call().__bool__(),
+            mock.call(common.get_stagedir()),
+            mock.call().__bool__(),
+            mock.call(common.get_snapdir()),
+            mock.call().__bool__(),
+        ])
+
+        self.mock_rmtree.assert_has_calls([
+            mock.call('partdir1'),
+            mock.call('partdir2'),
+            mock.call('partdir3'),
+            mock.call(common.get_stagedir()),
+            mock.call(common.get_snapdir()),
+        ])
+
+        self.mock_rmdir.assert_called_once_with(common.get_partsdir())
+
+    def test_everything_is_clean(self):
+        self.mock_exists.return_value = False
+
+        cmds.clean({})
+
+        self.mock_exists.assert_has_calls([
+            mock.call('partdir1'),
+            mock.call('partdir2'),
+            mock.call('partdir3'),
+            mock.call(common.get_stagedir()),
+            mock.call(common.get_snapdir()),
+        ])
+
+        self.mock_rmdir.assert_called_once_with(common.get_partsdir())
+
+        self.assertFalse(self.mock_rmtree.called)
+
+    def test_no_parts_defined(self):
+        self.fake_config.all_parts = []
+
+        self.mock_load_config.return_value = self.fake_config
+
+        cmds.clean({})
+
+        self.mock_exists.assert_has_calls([
+            mock.call(common.get_stagedir()),
+            mock.call().__bool__(),
+            mock.call(common.get_snapdir()),
+            mock.call().__bool__(),
+        ])
+
+        self.mock_rmtree.assert_has_calls([
+            mock.call(common.get_stagedir()),
+            mock.call(common.get_snapdir()),
+        ])
+
+        self.mock_rmdir.assert_called_once_with(common.get_partsdir())
+
+
 class InitTestCase(tests.TestCase):
 
     def test_init_with_existing_snapcraft_yaml_must_fail(self):