Merge lp:~zyga/snapcraft/custom-plugin into lp:~snappy-dev/snapcraft/core

[Zygmunt Krynicki]

[lp:~zyga/snapcraft/custom-plugin]

159. By Sergio Schvezov on 2015-09-14

Filesets based filtering for stage and snap by sergiusens approved by sergiusens,mvo

160. By Sergio Schvezov on 2015-09-14

snapcraft init with templated values by sergiusens approved by mvo

161. By Sergio Schvezov on 2015-09-14

regex for binary and service names by sergiusens approved by mvo

162. By Sergio Schvezov on 2015-09-14

docs refresh by sergiusens approved by chipaca

163. By Sergio Schvezov on 2015-09-14

Collision logic updates with an introduction of _BUILTIN_OPTIONS so all parts have a certain set of options by default even if not declared. by sergiusens approved by mvo

164. By Daniel Holbach on 2015-09-15

fix crash when stage_packages is defined in the yaml for the plugin, but empty (getattr does not use [] as default return value in that case) by dholbach approved by sergiusens

165. By Daniel Holbach on 2015-09-15

Fix small typo. by dholbach approved by sergiusens

166. By Sergio Schvezov on 2015-09-15

Support config by sergiusens approved by sergiusens,chipaca

167. By Sergio Schvezov on 2015-09-16

Try to use wiki when after in part is not local by sergiusens approved by sergiusens,chipaca,dholbach

168. By Zygmunt Krynicki on 2015-09-16

Explicitly ignore __pycache__

Signed-off-by: Zygmunt Krynicki <email address hidden>

169. By Zygmunt Krynicki on 2015-09-16

Symlink .bzrignore to .gitignore

Signed-off-by: Zygmunt Krynicki <email address hidden>

170. By Zygmunt Krynicki on 2015-09-16

Add custom part type

This part type allows developers to integrate arbitrary projects with
arbitrary build commands. It is especially well suited for the long tail
of various projects that don't quite match the strict requirements of
autotools projects and that require custom sprinkle of magic in each
case.

Each custom project requires one definition in the snapcraft yaml file,
the list / string of custom commands. Those are invoked at part build
time. Three variables are interpolated into those commands, those are
$PART_{NAME,{INSTALL,BUILD}_DIR}.

Signed-off-by: Zygmunt Krynicki <email address hidden>

[Sergio Schvezov (sergiusens)]

Thanks for your contribution, but this doesn't go in the desired direction for plugins we desire. Thanks

review: Disapprove

Unmerged revisions

170. By Zygmunt Krynicki on 2015-09-16

Add custom part type

This part type allows developers to integrate arbitrary projects with
arbitrary build commands. It is especially well suited for the long tail
of various projects that don't quite match the strict requirements of
autotools projects and that require custom sprinkle of magic in each
case.

Each custom project requires one definition in the snapcraft yaml file,
the list / string of custom commands. Those are invoked at part build
time. Three variables are interpolated into those commands, those are
$PART_{NAME,{INSTALL,BUILD}_DIR}.

Signed-off-by: Zygmunt Krynicki <email address hidden>

169. By Zygmunt Krynicki on 2015-09-16

Symlink .bzrignore to .gitignore

Signed-off-by: Zygmunt Krynicki <email address hidden>

168. By Zygmunt Krynicki on 2015-09-16

Explicitly ignore __pycache__

Signed-off-by: Zygmunt Krynicki <email address hidden>

=== modified file '.bzrignore'
--- .bzrignore	2015-08-27 21:33:21 +0000
+++ .bzrignore	2015-09-16 06:45:26 +0000
@@ -10,3 +10,4 @@
 *.egg-info
 .coverage**
 htmlcov
+__pycache__

=== added symlink '.gitignore'
=== target is u'.bzrignore'
=== added file 'plugins/custom.yaml'
--- plugins/custom.yaml	1970-01-01 00:00:00 +0000
+++ plugins/custom.yaml	2015-09-16 06:45:26 +0000
@@ -0,0 +1,9 @@
+module: custom
+options:
+    source:
+        required: true
+    source-type:
+    source-tag:
+    source-branch:
+    custom-cmds:
+        required: true

=== added file 'snapcraft/plugins/custom.py'
--- snapcraft/plugins/custom.py	1970-01-01 00:00:00 +0000
+++ snapcraft/plugins/custom.py	2015-09-16 06:45:26 +0000
@@ -0,0 +1,74 @@
+# -*- 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/>.
+
+
+"""Implementation of the "custom" part type."""
+
+import shlex
+
+import snapcraft
+
+
+class CustomPlugin(snapcraft.BasePlugin):
+
+    """
+    Snapcraft plugin for custom builds.
+
+    This plugin is closer to Debian packaging than to "we know better" canned
+    environments. It is most useful with parts that are close but not quite
+    entirely supported by other part types.
+
+    This plugin/type exposes one mandatory command (or list of commands):
+
+    custom-cmds:
+        This command must configure the source tree for building.  The commands
+        have access to quasi variables for the name of the part being built
+        $SNAPCRAFT_PART_NAME, build directory $SNAPCRAFT_BUILD_DIR and the
+        installation directory $SNAPCRAFT_PART_INSTALL_DIR. Those are not real
+        shell variables, instead they are expanded before the command is
+        executed. This is a limitation of the current version of snapcraft.
+    """
+
+    def build(self):
+        """Build a custom snap part."""
+        def make_cmd_list(cmd):
+            if isinstance(cmd, list):
+                return [[
+                    cmd_split_part.replace(
+                        '$SNAPCRAFT_PART_INSTALL_DIR', self.installdir
+                    ).replace(
+                        '$SNAPCRAFT_PART_BUILD_DIR', self.builddir
+                    ).replace(
+                        '$SNAPCRAFT_PART_NAME', self.name
+                    )
+                    for cmd_split_part in shlex.split(cmd_part)
+                ] for cmd_part in cmd]
+            elif isinstance(cmd, str):
+                return make_cmd_list([cmd])
+            elif isinstance(cmd, None):
+                return []
+
+        def dispatch_cmd_list(cmd_list):
+            for cmd in cmd_list:
+                if not self.run(cmd):
+                    return False
+            return True
+
+        return dispatch_cmd_list(make_cmd_list(self.options.custom_cmds))
+
+    def pull(self):
+        """Pull the source of a custom snap part."""
+        return self.handle_source_options()