Merge ~morphis/snappy-hwe-snaps/+git/wifi-ap:feature/config-disable-by-default into ~snappy-hwe-team/snappy-hwe-snaps/+git/wifi-ap:master

[Simon Fels]

Add configure option to allow disabling automatic setup from the gadget snap

The test case needs to stay manual until a first version of the snap
with a configure hook is released into edge.

[System Enablement Bot (system-enablement-ci-bot)]

FAILED: Continuous integration, rev:1dab7f132c18414be05defb712b14307422b8964
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/742/
Executed test runs:
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/650/console

Click here to trigger a rebuild:
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/742/rebuild

review: Needs Fixing (continuous-integration)

[Simon Fels (morphis)]

Please hold-off reviewing this as the state of this MP doesn't reflect what is pushed in the git repository. There seems to be a quite huge delay within the launchpad infrastructure today.

Unmerged commits

1dab7f1... by Simon Fels on 2017-01-27

Add configure option to allow disabling automatic setup from the gadget snap

diff --git a/hooks/configure b/hooks/configure
new file mode 100755
index 0000000..138635d
--- /dev/null
+++ b/hooks/configure
@@ -0,0 +1,27 @@
+#!/bin/sh
+#
+# Copyright (C) 2017 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/>.
+
+set -x
+
+# The 'automatic-setup.disabled' option is only meant to be used from
+# a gadget snap to prevent the wizard on running when the snap is
+# being installed. As the configure hook will be called before the
+# services are being started we can easily create a empty
+# configuration to fallback to the default one for everything.
+value=`snapctl get automatic-setup.disable`
+if [ -n "$value" ]; then
+    echo "# Empty default config" > $SNAP_DATA/.config
+fi
diff --git a/snapcraft.yaml b/snapcraft.yaml
index 6123d4b..a3e20db 100644
--- a/snapcraft.yaml
+++ b/snapcraft.yaml
@@ -45,6 +45,12 @@ apps:
       - network
 
 parts:
+  hooks:
+    plugin: dump
+    source: hooks
+    organize:
+      configure: meta/hooks/configure
+
   common:
     plugin: dump
     source: .
diff --git a/tests/image/create-image.sh b/tests/image/create-image.sh
index 33c1a37..5e68bc7 100755
--- a/tests/image/create-image.sh
+++ b/tests/image/create-image.sh
@@ -40,8 +40,11 @@ if [ ! -z "$snap" ] ; then
 	ubuntu_image_extra_args="--extra-snaps $snap"
 fi
 
+snap download --stable pc
+
 ubuntu-image \
 	--channel $channel \
+	--extra-snaps pc_*.snap \
 	-o $image_name \
 	--image-size 4G \
 	$ubuntu_image_extra_args \
diff --git a/tests/lib/prepare.sh b/tests/lib/prepare.sh
index b95e884..d4b7020 100644
--- a/tests/lib/prepare.sh
+++ b/tests/lib/prepare.sh
@@ -1,5 +1,7 @@
 #!/bin/bash
 
+. $TESTSLIB/utilities.sh
+
 echo "Wait for firstboot change to be ready"
 while ! snap changes | grep -q "Done"; do
 	snap changes || true
@@ -21,24 +23,7 @@ done
 echo "Kernel has a store revision"
 snap list | grep ^${kernel_name} | grep -E " [0-9]+\s+canonical"
 
-# If we don't install wifi-ap here we get a system
-# without any network connectivity after reboot.
-if [ -n "$SNAP_CHANNEL" ] ; then
-	# Don't reinstall if we have it installed already
-	if ! snap list | grep wifi-ap ; then
-		snap install --$SNAP_CHANNEL wifi-ap
-	fi
-else
-	# Install prebuilt wifi-ap snap
-	snap install --dangerous /home/wifi-ap/wifi-ap_*_amd64.snap
-	# As we have a snap which we build locally it's unasserted and therefore
-	# we don't have any snap-declarations in place and need to manually
-	# connect all plugs.
-	snap connect wifi-ap:network-control core
-	snap connect wifi-ap:network-bind core
-	snap connect wifi-ap:network core
-	snap connect wifi-ap:firewall-control core
-fi
+install_snap_under_test
 
 # Snapshot of the current snapd state for a later restore
 if [ ! -f $SPREAD_PATH/snapd-state.tar.gz ] ; then
diff --git a/tests/lib/utilities.sh b/tests/lib/utilities.sh
index 9e2513e..83f2e9e 100644
--- a/tests/lib/utilities.sh
+++ b/tests/lib/utilities.sh
@@ -24,3 +24,24 @@ wait_until_interface_is_available() {
 		sleep 0.2
 	done
 }
+
+install_snap_under_test() {
+	# If we don't install wifi-ap here we get a system
+	# without any network connectivity after reboot.
+	if [ -n "$SNAP_CHANNEL" ] ; then
+		# Don't reinstall if we have it installed already
+		if ! snap list | grep wifi-ap ; then
+			snap install --$SNAP_CHANNEL wifi-ap
+		fi
+	else
+		# Install prebuilt wifi-ap snap
+		snap install --dangerous /home/wifi-ap/wifi-ap_*_amd64.snap
+		# As we have a snap which we build locally it's unasserted and therefore
+		# we don't have any snap-declarations in place and need to manually
+		# connect all plugs.
+		snap connect wifi-ap:network-control core
+		snap connect wifi-ap:network-bind core
+		snap connect wifi-ap:network core
+		snap connect wifi-ap:firewall-control core
+	fi
+}
diff --git a/tests/main/conf-wizard-disabled-by-default/task.yaml b/tests/main/conf-wizard-disabled-by-default/task.yaml
new file mode 100644
index 0000000..3c066ac
--- /dev/null
+++ b/tests/main/conf-wizard-disabled-by-default/task.yaml
@@ -0,0 +1,38 @@
+summary: Verify the wizard can be disabled by default from a gadget snap
+
+prepare: |
+    . $TESTSLIB/snap-names.sh
+    snap list | grep $gadget_name | awk '{print $2}' > /tmp/gadget_version
+
+restore: |
+    . $TESTSLIB/snap-names.sh
+    # Restore the original gadget snap so that any following tests don't suffer
+    # from our modified gadget.
+    original_revision=`cat /tmp/gadget_version`
+    current_revision=`snap list | grep $gadget_name | awk '{print $2}'`
+    if [ $current_revision -ne  $original_revision ]; then
+        snap revert --revision=$original_revision $gadget_name
+    fi
+
+execute: |
+    . $TESTSLIB/snap-names.sh
+    . $TESTSLIB/utilities.sh
+
+    snap remove wifi-ap
+    snap install --edge --devmode se-test-tools
+
+    # We need a custom gadget snap for this so lets fetch one from the store
+    # and modify it.
+    snap download --stable $gadget_name
+    /snap/bin/se-test-tools.unsquashfs -d gadget ${gadget_name}_*.snap
+    cat << EOF >> gadget/meta/snap.yaml
+    defaults:
+      wifi-ap:
+        automatic-setup.disable: true
+    EOF
+    /snap/bin/se-test-tools.mksquashfs gadget $gadget_name.snap -comp xz -no-xattrs
+    snap install --dangerous $gadget_name.snap
+
+    install_snap_under_test
+
+    test "$(snap get wifi-ap automatic-setup.disable)" = "true"