Merge ~morphis/snappy-hwe-snaps/+git/network-manager:powersave-configuration into ~snappy-hwe-team/snappy-hwe-snaps/+git/network-manager:master

[Simon Fels]

Implement configure hook to accept wifi.powersave option.

This will default to "disable" to keep powersave mode off.

The hook itself isn't enabled in the default snap build yet because snapcraft doesn't support hooks yet. In the spread test we're copying the hook manually in place to be able to test it properly.

[Alfonso Sanchez-Beato (alfonsosanchezbeato)]

Some comments below. Two additional points:

1. Please rebase and force-push to reduce the number of commits so history is cleaner.

2. As hooks are not currently supported by snapcraft, there are additional steps for building the snap. Please comment on how to do this in README.md, or better, provide a script/makefile that makes the build.

review: Needs Fixing

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

PASSED: Continuous integration, rev:23eb8bed67007be71f5cc2ec13ae997f2aaa5e4a
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/435/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-run-snap-spread-tests/175
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/343/console

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

review: Approve (continuous-integration)

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

PASSED: Continuous integration, rev:23eb8bed67007be71f5cc2ec13ae997f2aaa5e4a
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/436/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-run-snap-spread-tests/176
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/344/console

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

review: Approve (continuous-integration)

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

FAILED: Continuous integration, rev:1a18e306888e6eba0c604332f2c64b83e5e4ff27
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/437/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/system-enablement/job/generic-run-snap-spread-tests/177/console
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/345/console

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

review: Needs Fixing (continuous-integration)

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

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

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

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:ae76ecdf3be521930a077bc409aa33a074991b2d
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/439/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/system-enablement/job/generic-run-snap-spread-tests/178/console
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/347/console

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

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:ae76ecdf3be521930a077bc409aa33a074991b2d
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/440/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/system-enablement/job/generic-run-snap-spread-tests/179/console
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/348/console

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

review: Needs Fixing (continuous-integration)

[Alfonso Sanchez-Beato (alfonsosanchezbeato)]

LGTM

review: Approve

[Jim Hodapp (jhodapp)]

One minor typo to fix, see inline below.

review: Needs Fixing (code)

[Simon Fels (morphis)]

@Jim: Fixed.

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

FAILED: Continuous integration, rev:0546274e5119d0615818c35af8a695e8c3d17fda
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/442/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/system-enablement/job/generic-run-snap-spread-tests/180/console
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/350/console

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

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:0546274e5119d0615818c35af8a695e8c3d17fda
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/443/
Executed test runs:
    ABORTED: https://jenkins.canonical.com/system-enablement/job/generic-run-snap-spread-tests/181/console
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/351/console

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

review: Needs Fixing (continuous-integration)

[Jim Hodapp (jhodapp)]

LGTM

review: Approve

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

FAILED: Continuous integration, rev:0546274e5119d0615818c35af8a695e8c3d17fda
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/451/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/system-enablement/job/generic-run-snap-spread-tests/197/console
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/359/console

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

review: Needs Fixing (continuous-integration)

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

PASSED: Continuous integration, rev:b51386d38482ddc461f0456c9693f21073ebfda9
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/460/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-run-snap-spread-tests/203
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/368/console

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

review: Approve (continuous-integration)

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

PASSED: Continuous integration, rev:b51386d38482ddc461f0456c9693f21073ebfda9
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/461/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-run-snap-spread-tests/204
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/369/console

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

review: Approve (continuous-integration)

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

PASSED: Continuous integration, rev:639d7ce78b40bea7ac3db467a76fb95578346b6e
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/462/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-run-snap-spread-tests/205
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/370/console

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

review: Approve (continuous-integration)

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

PASSED: Continuous integration, rev:639d7ce78b40bea7ac3db467a76fb95578346b6e
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/463/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-run-snap-spread-tests/206
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/371/console

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

review: Approve (continuous-integration)

diff --git a/README.md b/README.md
index a8fec2f..8b92863 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,21 @@
 
 This is the snap to package the NetworkManager management service.
 
+## Hook support
+
+All implemented hooks are stored inside the hooks directory.
+
+As snapcraft has no support as of today (09/12/2016) to include
+hooks in a snap this always needs to be done manually. For this
+
+$ snapcraft
+$ cp -r hooks prime/meta/
+$ snapcraft snap prime
+
+does the job. Please note that none of the snaps available from the
+store will have these hooks included until snapcraft receives
+support for hooks.
+
 ## Running tests
 
 We have a set of spread (https://github.com/snapcore/spread) tests which
diff --git a/hooks/configure b/hooks/configure
new file mode 100755
index 0000000..1d3399e
--- /dev/null
+++ b/hooks/configure
@@ -0,0 +1,33 @@
+#!/bin/bash
+wifi_powersave_default="disable"
+wifi_powersave_conf_path=$SNAP_DATA/conf.d/wifi-powersave.conf
+
+switch_wifi_powersave() {
+  # See https://developer.gnome.org/libnm/stable/NMSettingWireless.html#NMSettingWirelessPowersave
+  # for the meaning of the different values for the wifi.powersave option.
+  case $1 in
+    enable)
+      cat << EOF > $wifi_powersave_conf_path
+[connection]
+wifi.powersave = 3
+EOF
+      ;;
+    disable)
+      cat << EOF > $wifi_powersave_conf_path
+[connection]
+wifi.powersave = 2
+EOF
+      ;;
+    *)
+      echo "WARNING: invalid value '$1' supplied for wifi.powersave configuration option"
+      ;;
+  esac
+}
+
+wifi_powersave="`snapctl get wifi.powersave`"
+if [ -n "$wifi_powersave" ]; then
+  switch_wifi_powersave $wifi_powersave
+else
+  snapctl set wifi.powersave=$wifi_powersave_default
+  switch_wifi_powersave $wifi_powersave_default
+fi
diff --git a/spread.yaml b/spread.yaml
index d718813..0ae35a2 100644
--- a/spread.yaml
+++ b/spread.yaml
@@ -55,9 +55,6 @@ suites:
         prepare: |
             . $TESTSLIB/utilities.sh
             stop_after_first_reboot
-            # Force snapd state to be regenerated so that it also preserves
-            # the netplan renderer switch configuration file.
-            rm -f /home/network-manager/snapd-state.tar.gz
             switch_netplan_to_network_manager
             . $TESTSLIB/prepare.sh
             REBOOT
@@ -67,8 +64,4 @@ suites:
             . $TESTSLIB/utilities.sh
             stop_after_first_reboot
             switch_netplan_to_networkd
-            # Need to drop the state here as it includes the netplan config
-            # which configures us to use NetworkManager as renderer. The
-            # prepare script run for the next suite will regenerate it.
-            rm -f /home/network-manager/snapd-state.tar.gz
             REBOOT
diff --git a/tests/full/wol-enabled-by-default/task.yaml b/tests/full/wol-enabled-by-default/task.yaml
index 434ef01..4e1989d 100644
--- a/tests/full/wol-enabled-by-default/task.yaml
+++ b/tests/full/wol-enabled-by-default/task.yaml
@@ -44,7 +44,7 @@ execute: |
             # 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
+            if [ -z "`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
diff --git a/tests/lib/prepare-all.sh b/tests/lib/prepare-all.sh
index 6632406..f8b2eb2 100644
--- a/tests/lib/prepare-all.sh
+++ b/tests/lib/prepare-all.sh
@@ -22,6 +22,12 @@ apt install -y --force-yes snapcraft
 cd /home/network-manager
 snapcraft clean
 snapcraft
+# If we have any hooks we need to copy them in place as long as
+# snapcraft does not support them
+if [ -d hooks ]; then
+	cp -r hooks prime/meta
+	snapcraft snap prime
+fi
 EOF
 chmod +x /home/test/build-snap.sh
 sudo classic /home/test/build-snap.sh
diff --git a/tests/lib/prepare.sh b/tests/lib/prepare.sh
index d290bbc..57d24b5 100644
--- a/tests/lib/prepare.sh
+++ b/tests/lib/prepare.sh
@@ -1,4 +1,5 @@
 #!/bin/bash
+. $TESTSLIB/utilities.sh
 
 echo "Wait for firstboot change to be ready"
 while ! snap changes | grep -q "Done"; do
@@ -21,27 +22,25 @@ done
 echo "Kernel has a store revision"
 snap list | grep ^${kernel_name} | grep -E " [0-9]+\s+canonical"
 
-# If we don't install network-manager 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 network-manager ; then
-		snap install --$SNAP_CHANNEL network-manager
-	fi
-else
-	# Need first install from store to get all necessary assertions into
-	# place. Second local install will then bring in our locally built
-	# snap.
-	snap install network-manager
-	snap install --dangerous /home/network-manager/network-manager_*_amd64.snap
-fi
+# Remove any existing state archive from other test suites
+rm -f /home/network-manager/snapd-state.tar.gz
+rm -f /home/network-manager/nm-state.tar.gz
+
+snap_install network-manager
 
 # Snapshot of the current snapd state for a later restore
-if [ ! -f $SPREAD_PATH/snapd-state.tar.gz ] ; then
-	systemctl stop snapd.service snapd.socket
-	tar czf $SPREAD_PATH/snapd-state.tar.gz /var/lib/snapd /etc/netplan
-	systemctl start snapd.socket
-fi
+systemctl stop snapd.service snapd.socket
+tar czf $SPREAD_PATH/snapd-state.tar.gz /var/lib/snapd /etc/netplan
+systemctl start snapd.socket
+
+# And also snapshot NetworkManager's state
+systemctl stop snap.network-manager.networkmanager
+tar czf $SPREAD_PATH/nm-state.tar.gz /var/snap/network-manager
+systemctl start snap.network-manager.networkmanager
+
+# Make sure the original netplan configuration is applied and active
+netplan generate
+netplan apply
 
 # For debugging dump all snaps and connected slots/plugs
 snap list
diff --git a/tests/lib/restore-each.sh b/tests/lib/restore-each.sh
index bd397e1..87ae5cb 100644
--- a/tests/lib/restore-each.sh
+++ b/tests/lib/restore-each.sh
@@ -1,6 +1,7 @@
 #!/bin/bash
 
 . $TESTSLIB/snap-names.sh
+. $TESTSLIB/utilities.sh
 
 # Remove all snaps not being the core, gadget, kernel or snap we're testing
 for snap in /snap/*; do
@@ -14,12 +15,6 @@ for snap in /snap/*; do
 	esac
 done
 
-# Cleanup all configuration files from NetworkManager so that we have
-# a fresh start for the next test
-rm -rf /var/snap/network-manager/common/*
-rm -rf /var/snap/network-manager/current/*
-systemctl stop snap.network-manager.networkmanager
-
 # Drop any generated or modified netplan configuration files. The original
 # ones will be restored below.
 rm -f /etc/netplan/*
@@ -27,13 +22,15 @@ rm -f /etc/netplan/*
 # Ensure we have the same state for snapd as we had before
 systemctl stop snapd.service snapd.socket
 rm -rf /var/lib/snapd/*
-$(cd / && tar xzf $SPREAD_PATH/snapd-state.tar.gz)
+tar xzf $SPREAD_PATH/snapd-state.tar.gz -C /
 rm -rf /root/.snap
 systemctl start snapd.service snapd.socket
 
+systemctl stop snap.network-manager.networkmanager
+rm -rf /var/snap/network-manager/*
+tar xzf $SPREAD_PATH/nm-state.tar.gz -C /
+systemctl start snap.network-manager.networkmanager
+
 # Make sure the original netplan configuration is applied and active
 netplan generate
 netplan apply
-
-# Bringup NetworkManager again now that the system is restored
-systemctl start snap.network-manager.networkmanager
diff --git a/tests/lib/utilities.sh b/tests/lib/utilities.sh
index 000ef74..8ca1418 100644
--- a/tests/lib/utilities.sh
+++ b/tests/lib/utilities.sh
@@ -1,4 +1,20 @@
 #!/bin/sh
+snap_install() {
+	name=$1
+	if [ -n "$SNAP_CHANNEL" ] ; then
+		# Don't reinstall if we have it installed already
+		if ! snap list | grep $name ; then
+			snap install --$SNAP_CHANNEL $name
+		fi
+	else
+		# Need first install from store to get all necessary assertions into
+		# place. Second local install will then bring in our locally built
+		# snap.
+		snap install $name
+		snap install --dangerous $PROJECT_PATH/$name*_amd64.snap
+	fi
+}
+
 switch_netplan_to_network_manager() {
 	if [ -e /etc/netplan/00-default-nm-renderer.yaml ] ; then
 		return 0
diff --git a/tests/main/wifi-powersave-config-option/task.yaml b/tests/main/wifi-powersave-config-option/task.yaml
new file mode 100644
index 0000000..4711069
--- /dev/null
+++ b/tests/main/wifi-powersave-config-option/task.yaml
@@ -0,0 +1,28 @@
+summary: Verify WiFi powersave can be enabled via a snap config option
+
+environment:
+    WIFI_POWERSAVE_CONF_PATH: /var/snap/network-manager/current/conf.d/wifi-powersave.conf
+
+execute: |
+    . $TESTSLIB/utilities.sh
+
+    # The mac80211_hwsim driver does not support the powersave mode
+    # so we can't check this reliable.
+
+    test "`snap get network-manager wifi.powersave`" = "disable"
+    grep "wifi.powersave = 2" $WIFI_POWERSAVE_CONF_PATH
+
+    # Try to enable and disable again
+    snap set network-manager wifi.powersave=enable
+    test "`snap get network-manager wifi.powersave`" = "enable"
+    grep "wifi.powersave = 3" $WIFI_POWERSAVE_CONF_PATH
+
+    snap set network-manager wifi.powersave=disable
+    test "`snap get network-manager wifi.powersave`" = "disable"
+    grep "wifi.powersave = 2" $WIFI_POWERSAVE_CONF_PATH
+
+    # Specifying no value means the snap should use the default
+    # which is 'disable'
+    snap set network-manager wifi.powersave=
+    test "`snap get network-manager wifi.powersave`" = "disable"
+    grep "wifi.powersave = 2" $WIFI_POWERSAVE_CONF_PATH