Merge lp:~zyga/snapcraft/hostapd-example into lp:~snappy-dev/snapcraft/core

[Zygmunt Krynicki]

[Sergio Schvezov (sergiusens)]

hmm, this includes the plugin with custom commands, not so sure about it now as I don't think we want to promote this way of creating plugins officially at least.

[Zygmunt Krynicki (zyga)]

> hmm, this includes the plugin with custom commands, not so sure about it now
> as I don't think we want to promote this way of creating plugins officially at
> least.

Is there a way to build this with one of the stock part types?

[Sergio Schvezov (sergiusens)]

> > hmm, this includes the plugin with custom commands, not so sure about it now
> > as I don't think we want to promote this way of creating plugins officially
> at
> > least.
>
> Is there a way to build this with one of the stock part types?

Can't you extend the makefile project to pass in a makefile and have that be the driver for those custom commands?

[Zygmunt Krynicki (zyga)]

I'll try, I did something similar with trousers. I did find that I
need to have precise paths to other parts though (for -I/-L and
pkg-config). Perhaps it's better to just bake those into the makefile
part type in general.

On Thu, Sep 17, 2015 at 2:12 PM, Sergio Schvezov
<email address hidden> wrote:
>> > hmm, this includes the plugin with custom commands, not so sure about it now
>> > as I don't think we want to promote this way of creating plugins officially
>> at
>> > least.
>>
>> Is there a way to build this with one of the stock part types?
>
> Can't you extend the makefile project to pass in a makefile and have that be the driver for those custom commands?
> --
> https://code.launchpad.net/~zyga/snapcraft/hostapd-example/+merge/271336
> You are the owner of lp:~zyga/snapcraft/hostapd-example.

Unmerged revisions

168. By Zygmunt Krynicki on 2015-09-16

Add hostapd example

This example contains a custom build (from upstream sources, not a
repackaged Debian package) for hostapd. Hostapd is a part of a wifi
access point daemon. It can be used to construct a more complicated snap
which offers simple access point on compatible devices.

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

=== added directory 'examples/hostapd'
=== added file 'examples/hostapd/README.rst'
--- examples/hostapd/README.rst	1970-01-01 00:00:00 +0000
+++ examples/hostapd/README.rst	2015-09-16 15:45:47 +0000
@@ -0,0 +1,21 @@
+Example snapcraft file for hostapd
+==================================
+
+This repository contains an example build of hostapd. It is neither supported
+nor endorsed by Canonical. Please use it for anything you wish. If you have
+made any improvements, please share them.
+
+Build Instructions
+==================
+
+To build this project just use snapcraft::
+
+    $ snapcraft
+
+Note that you need snapcraft version at least r167 to build this example.
+
+Notable Missing Features
+========================
+
+- Configuration with snappy config hooks
+- Service with correct configuration

=== added file 'examples/hostapd/icon.png'
Binary files examples/hostapd/icon.png	1970-01-01 00:00:00 +0000 and examples/hostapd/icon.png	2015-09-16 15:45:47 +0000 differ
=== added directory 'examples/hostapd/parts'
=== added symlink 'examples/hostapd/parts/plugins'
=== target is u'../plugins/'
=== added directory 'examples/hostapd/plugins'
=== added file 'examples/hostapd/plugins/README.rst'
--- examples/hostapd/plugins/README.rst	1970-01-01 00:00:00 +0000
+++ examples/hostapd/plugins/README.rst	2015-09-16 15:45:47 +0000
@@ -0,0 +1,4 @@
+This directory contains a local "custom" plugin that aids in building this
+snap. It is symlinked from parts/plugins as that's what the current version of
+snapcraft requires. This will change later so that the symlink is no longer
+needed.

=== added file 'examples/hostapd/plugins/x-custom.yaml'
--- examples/hostapd/plugins/x-custom.yaml	1970-01-01 00:00:00 +0000
+++ examples/hostapd/plugins/x-custom.yaml	2015-09-16 15:45:47 +0000
@@ -0,0 +1,9 @@
+module: x_custom
+options:
+    source:
+        required: true
+    source-type:
+    source-tag:
+    source-branch:
+    custom-cmds:
+        required: true

=== added file 'examples/hostapd/plugins/x_custom.py'
--- examples/hostapd/plugins/x_custom.py	1970-01-01 00:00:00 +0000
+++ examples/hostapd/plugins/x_custom.py	2015-09-16 15:45:47 +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()

=== added file 'examples/hostapd/snapcraft.yaml'
--- examples/hostapd/snapcraft.yaml	1970-01-01 00:00:00 +0000
+++ examples/hostapd/snapcraft.yaml	2015-09-16 15:45:47 +0000
@@ -0,0 +1,24 @@
+name: hostapd
+summary: HostAP Daemon
+icon: icon.png
+description: >
+  User space IEEE 802.11 AP and IEEE 802.1X/WPA/WPA2/EAP Authenticator
+version: 2.4-1
+vendor: Zygmunt Krynicki <[e-mail]>
+parts:
+    hostapd:
+        type: x-custom
+        source: https://w1.fi/releases/hostapd-2.4.tar.gz
+        source-type: tar
+        custom-cmds:
+            - cp hostapd/defconfig hostapd/.config
+            - sed -i -e 's/#CONFIG_LIBNL32=y/CONFIG_LIBNL32=y/g' hostapd/.config
+            - make -C hostapd
+            - make -C hostapd install BINDIR=/usr/bin DESTDIR=$SNAPCRAFT_PART_INSTALL_DIR
+            - strip -v $SNAPCRAFT_PART_INSTALL_DIR/usr/bin/*
+binaries:
+ - name: hostapd 
+   security-template: unconfined
+ - name: hostapd-cli
+   exec: hostapd_cli
+   security-template: unconfined