Merge ~morphis/snappy-hwe-snaps/+git/wifi-ap:feature/wait-for-snap-setup into ~snappy-hwe-team/snappy-hwe-snaps/+git/wifi-ap:master

[Simon Fels]

Wait for initial snap setup to be done before starting service

In the case that the gadget snap provides configuration items for us those are set after our services are already started which leads to the problem that we don't respect any preset configuration options on first startup.

This fixes the problem by telling our services to wait for a file $SNAP_COMMON/.setup_done to be present.

[Matteo Croce (teknoraver)]

review: Needs Fixing

[Matteo Croce (teknoraver)]

review: Approve

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

FAILED: Continuous integration, rev:760b3bc0674894c2104f2ca1364ea2c64fcf7b59
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/866/
Executed test runs:
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/774/console

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

review: Needs Fixing (continuous-integration)

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

PASSED: Continuous integration, rev:e577ecf5589141ae3fdcfec9ce9515d96955876c
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/867/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-run-snap-spread-tests/578
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/775/console

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

review: Approve (continuous-integration)

[Matteo Croce (teknoraver)]

review: Approve

diff --git a/bin/automatic-setup.sh b/bin/automatic-setup.sh
index 5c86bb2..871429b 100755
--- a/bin/automatic-setup.sh
+++ b/bin/automatic-setup.sh
@@ -16,6 +16,13 @@
 
 set -x
 
+# Wait for the snap to be successfully setup. This will only be true
+# when the snap is started the first time and the configure hook was
+# never called before.
+while [ ! -e $SNAP_COMMON/.setup_done ]; do
+    sleep 0.5
+done
+
 [ -f "$SNAP_COMMON/.block_auto_wizard" ] && exit 0
 
 [ -f "$SNAP_DATA/config" ] && exit 0
diff --git a/cmd/service/main.go b/cmd/service/main.go
index ae5e679..94084d8 100644
--- a/cmd/service/main.go
+++ b/cmd/service/main.go
@@ -19,11 +19,26 @@ import (
 	"os"
 	"os/signal"
 	"syscall"
+	"time"
 )
 
+const snapSetupDoneFilePath = "/var/snap/wifi-ap/common/.setup_done"
+
 func main() {
 	s := &service{}
 
+	// Wait until the configure hook, which is called on snap
+	// installation, marked us as successfully setup. If we
+	// continue before that happen we will miss any initial
+	// configuration set via a gadget snap.
+	for {
+		_, err := os.Stat(snapSetupDoneFilePath)
+		if err == nil {
+			break
+		}
+		time.Sleep(time.Second/2)
+	}
+
 	c := make(chan os.Signal, 1)
 	signal.Notify(c, syscall.SIGHUP, syscall.SIGINT, syscall.SIGTERM, syscall.SIGQUIT)
 	go func(s *service) {
diff --git a/hooks/configure b/hooks/configure
index dd0482a..6b984cd 100755
--- a/hooks/configure
+++ b/hooks/configure
@@ -38,3 +38,10 @@ else
     # If no value provided set up our default
     snapctl set automatic-setup.disable=false
 fi
+
+# If we haven't marked ourself as setup yet after the snap was installed
+# we do this now so that the already started management service can
+# continue doing its job.
+if [ ! -e $SNAP_COMMON/.setup_done ]; then
+    touch $SNAP_COMMON/.setup_done
+fi
diff --git a/tests/main/conf-wizard-disabled-from-gadget/task.yaml b/tests/main/conf-wizard-disabled-from-gadget/task.yaml
index 8907db3..227ecfb 100644
--- a/tests/main/conf-wizard-disabled-from-gadget/task.yaml
+++ b/tests/main/conf-wizard-disabled-from-gadget/task.yaml
@@ -32,6 +32,7 @@ execute: |
     /snap/bin/se-test-tools.unsquashfs -d gadget ${gadget_name}_*.snap
     cat << EOF >> gadget/meta/gadget.yaml
     defaults:
+      # Below snap ID matches the one assigned for wifi-ap in the Ubuntu Store
       2rGgvyaY0CCzlWuKAPwFtCWrgwkM8lqS:
         automatic-setup.disable: true
     EOF
@@ -43,4 +44,8 @@ execute: |
     # unasserted snap to be configured with defaults from the gadget.
     snap install --edge wifi-ap
 
-    test "$(snap get wifi-ap automatic-setup.disable)" = "true"
+    test "$(snap get wifi-ap automatic-setup.disable)" = true
+    test "$(/snap/bin/wifi-ap.config get disabled)" = true
+    /snap/bin/wifi-ap.status | grep "ap.active: false"
+    ! pgrep dnsmasq
+    ! pgrep hostapd