Merge lp:~mterry/snapcraft/local-plugins into lp:~snappy-dev/snapcraft/core

[Michael Terry]

Add support for local plugins in parts/plugins.

Add support for local plugins in parts/plugins.

We discussed being able to specify a separate local plugin path in the Isle of Man, but that isn't implemented yet.

[lp:~mterry/snapcraft/local-plugins]

77. By Michael Terry on 2015-07-09

Drop errant ls

[Ricardo Salveti (rsalveti)]

Looks good, one minor question inline, feel free to merge it.

review: Approve

[lp:~mterry/snapcraft/local-plugins]

78. By Michael Terry on 2015-07-10

Add notice when using a local plugin

[Michael Terry (mterry)]

OK, I added an extra log notice.

[Ricardo Salveti (rsalveti)]

Looks good, thanks!

review: Approve

=== modified file '.bzrignore'
--- .bzrignore	2015-07-06 16:48:22 +0000
+++ .bzrignore	2015-07-10 18:35:54 +0000
@@ -1,6 +1,9 @@
-**/parts/
-**/snap/
-**/stage/
+examples/*/parts/
+examples/*/snap/
+examples/*/stage/
+tests/unit/parts/
+tests/unit/snap/
+tests/unit/stage/
 build
 dist
 *.egg-info

=== modified file 'snapcraft/plugin.py'
--- snapcraft/plugin.py	2015-07-08 20:45:52 +0000
+++ snapcraft/plugin.py	2015-07-10 18:35:54 +0000
@@ -31,6 +31,8 @@
         self.config = None
         self.partNames = []
         self.deps = []
+        self.pluginName = name
+        self.isLocalPlugin = False
 
         self.sourcedir = os.path.join(os.getcwd(), "parts", partName, "src")
         self.builddir = os.path.join(os.getcwd(), "parts", partName, "build")
@@ -40,10 +42,17 @@
         self.statefile = os.path.join(os.getcwd(), "parts", partName, "state")
 
         if loadConfig:
-            configPath = os.path.join(snapcraft.common.plugindir, name + ".yaml")
-            if not os.path.exists(configPath):
-                snapcraft.common.log("Missing config for part %s" % (name), file=sys.stderr)
-                return
+            # First look in local path
+            localPluginDir = os.path.abspath(os.path.join('parts', 'plugins'))
+            configPath = os.path.join(localPluginDir, name + ".yaml")
+            if os.path.exists(configPath):
+                self.isLocalPlugin = True
+            else:
+                # OK, now look at snapcraft's plugins
+                configPath = os.path.join(snapcraft.common.plugindir, name + ".yaml")
+                if not os.path.exists(configPath):
+                    snapcraft.common.log("Unknown plugin %s" % name, file=sys.stderr)
+                    return
             self.config = yaml.load(open(configPath, 'r')) or {}
 
             if loadCode:
@@ -64,7 +73,18 @@
                     options = optionsOverride
 
                 moduleName = self.config.get('module', name)
-                module = importlib.import_module("snapcraft.plugins." + moduleName)
+
+                # Load code from local plugin dir if it is there
+                if self.isLocalPlugin:
+                    sys.path = [localPluginDir] + sys.path
+                else:
+                    moduleName = 'snapcraft.plugins.' + moduleName
+
+                module = importlib.import_module(moduleName)
+
+                if self.isLocalPlugin:
+                    sys.path.pop(0)
+
                 for propName in dir(module):
                     prop = getattr(module, propName)
                     if issubclass(prop, snapcraft.BasePlugin):

=== modified file 'snapcraft/yaml.py'
--- snapcraft/yaml.py	2015-07-08 20:45:52 +0000
+++ snapcraft/yaml.py	2015-07-10 18:35:54 +0000
@@ -35,7 +35,7 @@
         self.systemPackages = self.data.get('systemPackages', [])
 
         for partName in self.data.get("parts", []):
-            properties = self.data["parts"][partName]
+            properties = self.data["parts"][partName] or {}
 
             pluginName = properties.get("plugin", partName)
             if "plugin" in properties:
@@ -49,6 +49,13 @@
 
             self.loadPlugin(partName, pluginName, properties)
 
+        localPlugins = set()
+        for part in self.allParts:
+            if part.isLocalPlugin:
+                localPlugins.add(part.pluginName)
+        for localPlugin in localPlugins:
+            snapcraft.common.log("Using local plugin %s" % localPlugin)
+
         # Grab all required dependencies, if not already specified
         newParts = self.allParts.copy()
         while newParts:

=== added directory 'tests/plainbox/data/local-plugin'
=== added directory 'tests/plainbox/data/local-plugin/parts'
=== added directory 'tests/plainbox/data/local-plugin/parts/plugins'
=== added file 'tests/plainbox/data/local-plugin/parts/plugins/local-plugin.yaml'
--- tests/plainbox/data/local-plugin/parts/plugins/local-plugin.yaml	1970-01-01 00:00:00 +0000
+++ tests/plainbox/data/local-plugin/parts/plugins/local-plugin.yaml	2015-07-10 18:35:54 +0000
@@ -0,0 +1,1 @@
+module: local_plugin

=== added file 'tests/plainbox/data/local-plugin/parts/plugins/local_plugin.py'
--- tests/plainbox/data/local-plugin/parts/plugins/local_plugin.py	1970-01-01 00:00:00 +0000
+++ tests/plainbox/data/local-plugin/parts/plugins/local_plugin.py	2015-07-10 18:35:54 +0000
@@ -0,0 +1,22 @@
+# -*- Mode:Python; indent-tabs-mode:nil; tab-width:4 -*-
+#
+# Copyright (C) 2015 Canonical Ltd
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# 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 snapcraft
+
+
+class LocalPlugin(snapcraft.BasePlugin):
+    def build(self):
+        return self.run('touch build-stamp', self.installdir)

=== added file 'tests/plainbox/data/local-plugin/snapcraft.yaml'
--- tests/plainbox/data/local-plugin/snapcraft.yaml	1970-01-01 00:00:00 +0000
+++ tests/plainbox/data/local-plugin/snapcraft.yaml	2015-07-10 18:35:54 +0000
@@ -0,0 +1,2 @@
+parts:
+    local-plugin:

=== modified file 'tests/plainbox/units/jobs.pxu'
--- tests/plainbox/units/jobs.pxu	2015-07-09 13:32:43 +0000
+++ tests/plainbox/units/jobs.pxu	2015-07-10 18:35:54 +0000
@@ -19,6 +19,15 @@
     snapcraft stage
     test -e stamp-install
 
+id: snapcraft/normal/local-plugin
+plugin: shell
+estimated_duration: 0.3
+command:
+    set -ex
+    cp -rT $PLAINBOX_PROVIDER_DATA/local-plugin .
+    snapcraft snap
+    test -e snap/build-stamp
+
 id: snapcraft/normal/simple-make
 plugin: shell
 estimated_duration: 0.3