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

[Sergio Schvezov]

Implementation of the organize keyword from the spec

[Ted Gould (ted)]

Small nit in the diff

review: Approve

[lp:~sergiusens/snapcraft/organize]

183. By Sergio Schvezov on 2015-09-18

remove obsolete check

[Sergio Schvezov (sergiusens)]

nit fixed

review: Approve

=== added directory 'integration-tests/data/simple-make-filesets'
=== added file 'integration-tests/data/simple-make-filesets/Makefile'
--- integration-tests/data/simple-make-filesets/Makefile	1970-01-01 00:00:00 +0000
+++ integration-tests/data/simple-make-filesets/Makefile	2015-09-18 20:07:38 +0000
@@ -0,0 +1,12 @@
+# -*- Mode: Makefile; indent-tabs-mode:t; tab-width: 4 -*-
+
+all:
+	echo "file1" > file1
+	echo "file2" > file2
+
+install:
+	mkdir -p $(DESTDIR)/dir1
+	mkdir -p $(DESTDIR)/dir2
+	cp -a file1 $(DESTDIR)/
+	cp -a file2 $(DESTDIR)/
+	cp -a file1 $(DESTDIR)/dir2

=== added file 'integration-tests/data/simple-make-filesets/icon.png'
Binary files integration-tests/data/simple-make-filesets/icon.png	1970-01-01 00:00:00 +0000 and integration-tests/data/simple-make-filesets/icon.png	2015-09-18 20:07:38 +0000 differ
=== added file 'integration-tests/data/simple-make-filesets/snapcraft.yaml'
--- integration-tests/data/simple-make-filesets/snapcraft.yaml	1970-01-01 00:00:00 +0000
+++ integration-tests/data/simple-make-filesets/snapcraft.yaml	2015-09-18 20:07:38 +0000
@@ -0,0 +1,25 @@
+name: test-package
+version: 0.1
+vendor: Sergio Schvezov <[e-mail]>
+summary: Use organized filesets
+description: organize the filesets before staging them
+icon: icon.png
+
+parts:
+  make-project:
+    filesets:
+      files:
+        - share/file1
+        - share/file2
+    stage:
+      - $files
+      - new/dir1
+      - new/dir2
+    snap:
+      - -new/dir1
+    organize:
+      file1: share/file1
+      file2: share/file2
+      dir1: new/dir1
+      dir2: new/dir2
+    source: .

=== modified file 'integration-tests/units/jobs.pxu'
--- integration-tests/units/jobs.pxu	2015-09-18 17:20:50 +0000
+++ integration-tests/units/jobs.pxu	2015-09-18 20:07:38 +0000
@@ -104,6 +104,24 @@
     ${SNAPCRAFT} stage
     test "$(./stage/bin/test)" = "Hello world"
 
+id: snapcraft/normal/simple-make-filesets
+plugin: shell
+estimated_duration: 0.3
+command:
+    set -ex
+    cp -rT $PLAINBOX_PROVIDER_DATA/simple-make-filesets .
+    ${SNAPCRAFT} snap
+    test -d ./stage/new/dir1
+    test -d ./stage/new/dir2
+    grep -q 'file1' ./stage/share/file1
+    grep -q 'file2' ./stage/share/file2
+    grep -q 'file1' ./stage/new/dir2/file1
+    test ! -d ./snap/new/dir1
+    test -d ./snap/new/dir2
+    grep -q 'file1' ./snap/share/file1
+    grep -q 'file2' ./snap/share/file2
+    grep -q 'file1' ./snap/new/dir2/file1
+
 id: snapcraft/normal/simple-make-clean
 plugin: shell
 estimated_duration: 0.3

=== modified file 'snapcraft/plugin.py'
--- snapcraft/plugin.py	2015-09-17 20:56:09 +0000
+++ snapcraft/plugin.py	2015-09-18 20:07:38 +0000
@@ -19,7 +19,7 @@
 import logging
 import os
 import sys
-
+import shutil
 import yaml
 
 import snapcraft
@@ -35,6 +35,7 @@
     'snap': [],
     'stage': [],
     'stage-packages': [],
+    'organize': {}
 }
 
 
@@ -220,6 +221,25 @@
         fileset.extend(plugin_fileset)
         return migratable_filesets(fileset, self.installdir)
 
+    def _organize(self):
+        organize_fileset = getattr(self.code.options, 'organize', {}) or {}
+
+        for key in organize_fileset:
+            src = os.path.join(self.installdir, key)
+            dst = os.path.join(self.installdir, organize_fileset[key])
+
+            os.makedirs(os.path.dirname(dst), exist_ok=True)
+
+            if os.path.exists(dst):
+                logger.warning(
+                    'Stepping over existing file for organization %r',
+                    os.path.relpath(dst, self.installdir))
+                if os.path.isdir(dst):
+                    shutil.rmtree(dst)
+                else:
+                    os.remove(dst)
+            shutil.move(src, dst)
+
     def stage(self, force=False):
         if not self.should_stage_run('stage', force):
             return True
@@ -228,6 +248,7 @@
             return True
 
         self.notify_stage("Staging")
+        self._organize()
         snap_files, snap_dirs = self._migratable_fileset_for('stage')
 
         try: