Merge ~morphis/snappy-hwe-snaps/+git/network-manager:global-wol-config into ~snappy-hwe-team/snappy-hwe-snaps/+git/network-manager:master

[Simon Fels]

Enable wake-on-lan by default on all ethernet connections

This is a project requirement and we will refine this once we have proper configuration hook support and then each device can select via the gadget snap if this should be enabled or not. On devices like the Raspberry Pi having this enabled by default doesn't hurt as wake-on-lan is not supported at all.

Spread tests are just covering the configuration bits as in QEMU we can't really test the hardware part. Proper integration tests will be added to the engineering-tests.

[Konrad Zapałowicz (kzapalowicz)]

ack

review: Approve (code)

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

FAILED: Continuous integration, rev:84bd272c24dc0c7038b83dd4a0692335439e0004
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/367/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/system-enablement/job/generic-run-snap-spread-tests/117/console
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/275/console

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

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:84bd272c24dc0c7038b83dd4a0692335439e0004
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/370/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/system-enablement/job/generic-run-snap-spread-tests/120/console
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/278/console

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

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:fd5eff594219e1850d145795ac0b076c481e19e0
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/374/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/system-enablement/job/generic-run-snap-spread-tests/124/console
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/282/console

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

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:fd5eff594219e1850d145795ac0b076c481e19e0
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/375/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/system-enablement/job/generic-run-snap-spread-tests/125/console
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/283/console

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

review: Needs Fixing (continuous-integration)

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

PASSED: Continuous integration, rev:b549a36d29695c00e10213e4b2a4926e7376110a
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/385/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-run-snap-spread-tests/134
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/293/console

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

review: Approve (continuous-integration)

[Alfonso Sanchez-Beato (alfonsosanchezbeato)]

LGTM

review: Approve

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

PASSED: Continuous integration, rev:b549a36d29695c00e10213e4b2a4926e7376110a
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/386/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-run-snap-spread-tests/135
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/294/console

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

review: Approve (continuous-integration)

diff --git a/bin/networkmanager b/bin/networkmanager
index f72fa93..eab3b7e 100755
--- a/bin/networkmanager
+++ b/bin/networkmanager
@@ -67,6 +67,13 @@ fi
 # stopped.
 $SNAP/bin/dhcp-lease-mover &
 
+# Run available startup hooks to have a point to store custom
+# logic outside of this script. More of the things from above
+# should be moved into these.
+for hook in $SNAP/startup-hooks/* ; do
+    [ -x "$hook" ] && /bin/sh -x "$hook"
+done
+
 export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:$SNAP/usr/lib/NetworkManager"
 
 $SNAP/usr/sbin/NetworkManager \
diff --git a/snapcraft.yaml b/snapcraft.yaml
index e34b875..50dc540 100644
--- a/snapcraft.yaml
+++ b/snapcraft.yaml
@@ -35,6 +35,7 @@ parts:
       bin/dhcp-lease-mover: bin/dhcp-lease-mover
       conf/NetworkManager.conf: etc/NetworkManager/NetworkManager.conf
       data/copyright: usr/share/doc/network-manager/copyright
+      startup-hooks/99-wol-by-default.sh: startup-hooks/99-wol-by-default.sh
 
   inotify-tools:
     plugin: nil
diff --git a/startup-hooks/99-wol-by-default.sh b/startup-hooks/99-wol-by-default.sh
new file mode 100755
index 0000000..c2d4480
--- /dev/null
+++ b/startup-hooks/99-wol-by-default.sh
@@ -0,0 +1,13 @@
+#!/bin/sh
+
+# Enable wake-on-lan by default until we have a configuration
+# hook to do that.
+if [ ! -e $SNAP_DATA/conf.d/enable-wol.conf ] ; then
+	mkdir -p $SNAP_DATA/conf.d
+	cat <<-EOF > $SNAP_DATA/conf.d/enable-wol.conf
+		[connection]
+		# Value 64 maps to the 'magic' setting; see man nm-settings
+		# for more information.
+		802-3-ethernet.wake-on-lan=64
+	EOF
+fi
diff --git a/tests/full/wol-enabled-by-default/task.yaml b/tests/full/wol-enabled-by-default/task.yaml
new file mode 100644
index 0000000..434ef01
--- /dev/null
+++ b/tests/full/wol-enabled-by-default/task.yaml
@@ -0,0 +1,59 @@
+summary: Verify that wake-on-lan is enabled by default for all ethernet connections
+
+execute: |
+    . $TESTSLIB/utilities.sh
+    nmcli=/snap/bin/network-manager.nmcli
+    case "$SPREAD_REBOOT" in
+        0)
+            # For correct timing if the device has just booted
+            wait_for_network_manager
+
+            # The config file needs to be present and have the correct default set
+            test -e /var/snap/network-manager/current/conf.d/enable-wol.conf
+            cat /var/snap/network-manager/current/conf.d/enable-wol.conf | grep '802-3-ethernet.wake-on-lan=64'
+
+            # Precondition is a existing network connection
+            $nmcli d | grep 'eth0.*connected'
+
+            # The netplan configuration file has WoL disabled by default as
+            # the default one the core snap provides does not explicitly
+            # enable WoL.
+            connection=$($nmcli -m multiline -f UUID c show --active | awk '{print$2;exit}')
+            $nmcli -m multiline -f connection.id c show $connection | grep 'netplan-eth0'
+            $nmcli -m multiline -f connection.type c show $connection | grep '802-3-ethernet'
+            $nmcli -m multiline -f 802-3-ethernet.wake-on-lan c show $connection | grep '0 (none)'
+
+            # Now prepare for the next boot where we will run without a netplan
+            # config to get eth0 correctly configured.
+            rm /etc/netplan/00-snapd-config.yaml
+            REBOOT
+            ;;
+        1)
+            # For correct timing if the device has just booted
+            wait_for_network_manager
+
+            # Precondition is a existing network connection
+            $nmcli d | grep 'eth0.*connected'
+
+            # Connection should have the default wake-on-lan setting
+            connection=$($nmcli -m multiline -f UUID c show | awk '{print$2;exit}')
+            $nmcli -m multiline -f connection.type c show $connection | grep '802-3-ethernet'
+            # wake-on-lan should be set to respect the global defaults here
+            $nmcli -m multiline -f 802-3-ethernet.wake-on-lan c show $connection | grep '1 (default)'
+
+            # We can sadly only verify that the value was correctly applied when
+            # we're running the tests on a real device. QEMU doesn't support setting
+            # the WoL value of the ethernet network device.
+            if [ ! cat /proc/cpuinfo | grep QEMU ] ; then
+                # Get the tools snap to have the ethtool tool available
+                snap install --devmode --edge se-test-tools
+                snap connect se-test-tools:network core
+                snap connect se-test-tools:network-bind core
+                snap connect se-test-tools:network-control core
+
+                # See `man ethtool` for details; 'g' means 'wakeup when magic packet comes in'
+                # and is the default behavior we want.
+                /snap/bin/se-test-tools.ethtool eth0 | grep 'Wake-up: g'
+            fi
+            ;;
+    esac