Merge ~alfonsosanchezbeato/snappy-hwe-snaps/+git/tests-extras:master into ~snappy-hwe-team/snappy-hwe-snaps/+git/tests-extras:master

[Alfonso Sanchez-Beato]

Improvements to allow spread testing of snaps out for snappy-hwe-team.

Improvements to allow spread testing of snaps out for snappy-hwe-team.

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

FAILED: Continuous integration, rev:6b205fb6ec10446a6dca0246ef0554725dac6dd1
https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-build-prepare/382/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-build/ARCHITECTURE=amd64/415/console
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-build/ARCHITECTURE=arm64/415
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-build/ARCHITECTURE=armhf/415
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-build/ARCHITECTURE=i386/415
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-docs/1207
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-cleanup/949
    None: https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-update-mp/995/console

Click here to trigger a rebuild:
https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-build-prepare/382/rebuild

review: Needs Fixing (continuous-integration)

diff --git a/create-image-scripts/create-image.sh b/create-image-scripts/create-image.sh
index 19dd0af..d51d523 100755
--- a/create-image-scripts/create-image.sh
+++ b/create-image-scripts/create-image.sh
@@ -16,7 +16,7 @@
 
 set -e
 
-if [ $(id -u) -ne 0 ] ; then
+if [ "$(id -u)" -ne 0 ] ; then
 	echo "ERROR: needs to be executed as root"
 	exit 1
 fi
@@ -34,7 +34,7 @@ show_help() {
     echo
     echo "optional arguments:"
     echo "  --channel=<channel>         Select another channel to build the image from (default: $channel)"
-    echo "  --snap=<name>               Extra snap to install"
+    echo "  --snap=<name>               Snap to copy inside the image to make it available to the tests"
     echo "  --unsigned-core-snap        Use an unsigned core snap (so that it might be replaced during a test"
     echo "  --unsigned-gadget-snap      Use an unsigned gadget snap"
     echo "  --unsigned-kernel-snap      Use an unsigned kernel snap"
@@ -76,42 +76,37 @@ done
 
 
 model=pc
-arch=amd64
 image_name=ubuntu-core-16.img
 ubuntu_image_extra_args=
 
-if [ -n "$snap" ] ; then
-	ubuntu_image_extra_args="--extra-snaps $snap"
-fi
-
 if [ -n "$unsigned_core" ] ; then
-    snap download --$channel core
+    snap download --"$channel" core
     ubuntu_image_extra_args="$ubuntu_image_extra_args --extra-snaps core_*.snap"
 fi
 
 if [ -n "$unsigned_gadget" ] ; then
-    snap download --$channel pc
+    snap download --"$channel" pc
     ubuntu_image_extra_args="$ubuntu_image_extra_args --extra-snaps pc_*.snap"
 fi
 
 if [ -n "$unsigned_kernel" ] ; then
-    snap download --$channel pc-kernel
+    snap download --"$channel" pc-kernel
     ubuntu_image_extra_args="$ubuntu_image_extra_args --extra-snaps pc-kernel_*.snap"
 fi
 
-ubuntu-image \
-	--channel $channel \
-	-O $(pwd) \
+ubuntu-image snap \
+	--channel "$channel" \
+	-O "$(pwd)" \
 	--image-size 4G \
-	$ubuntu_image_extra_args \
-	$model.model
+	"$ubuntu_image_extra_args" \
+	"$model".model
 
-mv $model.img $image_name
+mv "$model".img "$image_name"
 
 # kpartx -s: don't return until the partitions are created
 partitions=$(sudo kpartx -asv ubuntu-core-16.img | grep "add map" |  cut -d' ' -f3)
 for part in $partitions; do
-    loop_path=/dev/mapper/$part
+    loop_path=/dev/mapper/"$part"
     if blkid -s LABEL "$loop_path" | grep 'LABEL="writable"'; then
         break
     fi
@@ -125,32 +120,37 @@ tmp_mount=$(mktemp -d)
 
 mount "$loop_path" "$tmp_mount"
 
+# Make snap available in the image
+if [ -n "$snap" ]; then
+    cp "$snap" "$tmp_mount"/system-data/
+fi
+
 # Migrate all systemd units from core snap into the writable area. This
 # would be normally done on firstboot by the initramfs but we can't rely
 # on that because we  are adding another file in there and that will
 # prevent the initramfs from transitioning any files.
-core_snap=$(find $tmp_mount/system-data/var/lib/snapd/snaps -name "core_*.snap")
+core_snap=$(find "$tmp_mount"/system-data/var/lib/snapd/snaps -name "core_*.snap")
 tmp_core=$(mktemp -d)
-mount $core_snap $tmp_core
-mkdir -p $tmp_mount/system-data/etc/systemd
-cp -rav $tmp_core/etc/systemd/* \
-	$tmp_mount/system-data/etc/systemd/
-umount $tmp_core
-rm -rf $tmp_core
+mount "$core_snap" "$tmp_core"
+mkdir -p "$tmp_mount"/system-data/etc/systemd
+cp -ra "$tmp_core"/etc/systemd/* \
+       "$tmp_mount"/system-data/etc/systemd/
+umount "$tmp_core"
+rm -rf "$tmp_core"
 
 # system-user assertion which gives us our test:test user we use to
 # log into the system
-mkdir -p $tmp_mount/system-data/var/lib/snapd/seed/assertions
-cp test-user.assertion $tmp_mount/system-data/var/lib/snapd/seed/assertions
+mkdir -p "$tmp_mount"/system-data/var/lib/snapd/seed/assertions
+cp test-user.assertion "$tmp_mount"/system-data/var/lib/snapd/seed/assertions
 
 # Disable console-conf for the first boot
-mkdir -p $tmp_mount/system-data/var/lib/console-conf/
-touch $tmp_mount/system-data/var/lib/console-conf/complete
+mkdir -p "$tmp_mount"/system-data/var/lib/console-conf/
+touch "$tmp_mount"/system-data/var/lib/console-conf/complete
 
 # Create systemd service which is running on firstboot and sets up
 # various things for us.
-mkdir -p $tmp_mount/system-data/etc/systemd/system
-cat << 'EOF' > $tmp_mount/system-data/etc/systemd/system/devmode-firstboot.service
+mkdir -p "$tmp_mount"/system-data/etc/systemd/system
+cat << 'EOF' > "$tmp_mount"/system-data/etc/systemd/system/devmode-firstboot.service
 [Unit]
 Description=Run devmode firstboot setup
 After=snapd.service snapd.socket
@@ -162,12 +162,12 @@ RemainAfterExit=yes
 TimeoutSec=3min
 EOF
 
-mkdir -p $tmp_mount/system-data/etc/systemd/system/multi-user.target.wants
+mkdir -p "$tmp_mount"/system-data/etc/systemd/system/multi-user.target.wants
 ln -sf /etc/systemd/system/devmode-firstboot.service \
-	$tmp_mount/system-data/etc/systemd/system/multi-user.target.wants/devmode-firstboot.service
+	"$tmp_mount"/system-data/etc/systemd/system/multi-user.target.wants/devmode-firstboot.service
 
-mkdir $tmp_mount/system-data/var/lib/devmode-firstboot
-cat << EOF > $tmp_mount/system-data/var/lib/devmode-firstboot/00-snapd-config.yaml
+mkdir "$tmp_mount"/system-data/var/lib/devmode-firstboot
+cat << EOF > "$tmp_mount"/system-data/var/lib/devmode-firstboot/00-snapd-config.yaml
 network:
   version: 2
   ethernets:
@@ -175,7 +175,7 @@ network:
       dhcp4: true
 EOF
 
-cat << 'EOF' > $tmp_mount/system-data/var/lib/devmode-firstboot/run.sh
+cat << 'EOF' > "$tmp_mount"/system-data/var/lib/devmode-firstboot/run.sh
 #!/bin/sh
 
 set -e
@@ -220,8 +220,8 @@ touch /writable/system-data/var/lib/devmode-firstboot/complete
 reboot
 EOF
 
-chmod +x $tmp_mount/system-data/var/lib/devmode-firstboot/run.sh
+chmod +x "$tmp_mount"/system-data/var/lib/devmode-firstboot/run.sh
 
-umount $tmp_mount
+umount "$tmp_mount"
 kpartx -d $image_name
-rm -rf $tmp_mount
+rm -rf "$tmp_mount"
diff --git a/run-tests.sh b/run-tests.sh
index 1fcfdc0..05cce59 100755
--- a/run-tests.sh
+++ b/run-tests.sh
@@ -14,11 +14,11 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-if [ ! -x "`which shellcheck`" ]; then
+if [ ! -x "$(which shellcheck)" ]; then
     sudo apt install shellcheck
 fi
 
 FILES_TO_TEST="tests-runner.sh templates/run-tests.sh"
 for f in $FILES_TO_TEST ; do
-	shellcheck -e SC2086 $f
+	shellcheck "$f"
 done
diff --git a/templates/run-tests.sh b/templates/run-tests.sh
index f069bfb..a4ada66 100755
--- a/templates/run-tests.sh
+++ b/templates/run-tests.sh
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 #
 # Copyright (C) 2016 Canonical Ltd
 #
@@ -17,7 +17,7 @@
 set -e
 
 TESTS_EXTRAS_URL="https://git.launchpad.net/~snappy-hwe-team/snappy-hwe-snaps/+git/tests-extras"
-TESTS_EXTRAS_PATH=".tests-extras"
+TESTS_EXTRAS_PATH="tests-extras"
 
 show_help() {
     exec cat <<'EOF'
@@ -36,8 +36,7 @@ EOF
 # Clone the tests-extras repository
 clone_tests_extras() {
 	echo "INFO: Fetching tests-extras scripts into $TESTS_EXTRAS_PATH ..."
-	git clone -b master $TESTS_EXTRAS_URL $TESTS_EXTRAS_PATH >/dev/null 2>&1
-	if [ $? -ne 0 ]; then
+	if ! git clone -b master $TESTS_EXTRAS_URL $TESTS_EXTRAS_PATH >/dev/null 2>&1; then
 		echo "ERROR: Failed to fetch the $TESTS_EXTRAS_URL repo, exiting.."
 		exit 1
 	fi
@@ -58,6 +57,16 @@ restore_and_update_tests_extras() {
 # The tests-extras repository ends up checked out in the snap tree but as a
 # hidden directory which is re-used since then.
 
+# Find snap to use in the tests
+snaps=$(find . -maxdepth 1 -type f -name '*_*.snap')
+while read -r snap_file; do
+    if [ -n "$snap" ]; then
+        printf "More than one snap revision in the folder\n"
+        exit 1
+    fi
+    snap=$PWD/${snap_file#*/}
+done < <(printf "%s\n" "$snaps")
+
 [ ! -d "$TESTS_EXTRAS_PATH" ] && [ "$1" = "--help" ] && show_help
 
 if [ -d "$TESTS_EXTRAS_PATH" ]; then
@@ -68,9 +77,11 @@ fi
 
 # Any project-specific options for test-runner should be specified in
 # .tests_config under EXTRA_ARGS
-if [ -e ".tests_config" ]; then
+if [ -f ".tests_config" ]; then
+    # shellcheck disable=SC1091
     . .tests_config
 fi
 
 echo "INFO: Executing tests runner"
-cd $TESTS_EXTRAS_PATH && ./tests-runner.sh "$@" "$EXTRA_ARGS"
+# shellcheck disable=SC2086
+cd $TESTS_EXTRAS_PATH && ./tests-runner.sh "$@" --snap="$snap" $EXTRA_ARGS
diff --git a/tests-runner.sh b/tests-runner.sh
index 6a33587..f96900d 100755
--- a/tests-runner.sh
+++ b/tests-runner.sh
@@ -24,7 +24,6 @@ snap=
 spread_filter=
 spread_opts="-v"
 spread_system=
-force_new_image=0
 test_from_channel=
 image_unsigned_core=
 image_unsigned_gadget=
@@ -44,7 +43,7 @@ there passing arguments as-is.
 optional arguments:
   --help                           Show this help message and exit
   --channel=<channel>              Select another channel to build the base image from (default: $channel)
-  --snap=<name>                    Extra snap to install
+  --snap=<name>                    Snap to copy inside the image to make it available to the tests
   --debug                          Enable verbose debugging output
   --verbose                        Be extra verbose
   --test-from-channel=<channel>    Pull snap from the specified channel instead of building it from source
@@ -108,7 +107,7 @@ while [ -n "$1" ]; do
 			shift
 			;;
 		--force-new-image)
-			force_new_image=1
+			printf "WARNING: --force-new-image is deprecated\n"
 			shift
 			;;
 		--image-unsigned-core)
@@ -162,33 +161,33 @@ if [ "$SPREAD_BACKEND" = "qemu" ] ; then
 		SPREAD_QEMU_PATH="$HOME/snap/spread/$current_version/.spread/qemu/"
 	fi
 
-	if [ ! -e "$SPREAD_QEMU_PATH/$image_name" ] || [ $force_new_image -eq 1 ] ; then
-
-		CREATE_IMAGE_PATH="./create-image-scripts"
-
-		create_image_args="--channel=$channel"
-
-		if [ -n "$snap" ]; then
-			create_image_args+="$create_image_args --snap=$snap"
-		fi
-
-		if [ -n "$image_unsigned_core" ] ; then
-			create_image_args="$create_image_args --unsigned-core-snap"
-		fi
-
-		if [ -n "$image_unsigned_gadget" ] ; then
-			create_image_args="$create_image_args --unsigned-gadget-snap"
-		fi
+	# We always create a new VM - it is quite cheap and we avoid
+	# contamination from previous test runs.
+	if [ -e "$SPREAD_QEMU_PATH/$image_name" ]; then
+		rm -rf "$SPREAD_QEMU_PATH"
+	fi
 
-		if [ -n "$image_unsigned_kernel" ] ; then
-			create_image_args="$create_image_args --unsigned-kernel-snap"
-		fi
+	CREATE_IMAGE_PATH="./create-image-scripts"
+	create_image_args="--channel=$channel"
 
-		echo "INFO: Creating new qemu test image ..."
-		(cd $CREATE_IMAGE_PATH; $SUDO ./create-image.sh $create_image_args)
-		mkdir -p "$SPREAD_QEMU_PATH"
-		mv $CREATE_IMAGE_PATH/ubuntu-core-16.img "$SPREAD_QEMU_PATH/$image_name"
+	if [ -n "$snap" ]; then
+		create_image_args="$create_image_args --snap=$snap"
+	fi
+	if [ -n "$image_unsigned_core" ] ; then
+		create_image_args="$create_image_args --unsigned-core-snap"
+	fi
+	if [ -n "$image_unsigned_gadget" ] ; then
+		create_image_args="$create_image_args --unsigned-gadget-snap"
 	fi
+	if [ -n "$image_unsigned_kernel" ] ; then
+		create_image_args="$create_image_args --unsigned-kernel-snap"
+	fi
+
+	echo "INFO: Creating qemu test image ..."
+	# shellcheck disable=SC2086
+	(cd $CREATE_IMAGE_PATH; $SUDO ./create-image.sh $create_image_args)
+	mkdir -p "$SPREAD_QEMU_PATH"
+	mv $CREATE_IMAGE_PATH/ubuntu-core-16.img "$SPREAD_QEMU_PATH/$image_name"
 fi
 
 # We currently only run spread tests but we could do other things
@@ -202,4 +201,5 @@ if [ -n "$spread_system" ]; then
 else
 	spread_opts="$spread_opts $SPREAD_BACKEND:$spread_filter"
 fi
+# shellcheck disable=SC2086
 spread $spread_opts