Merge ~rodsmith/plainbox-provider-checkbox:add-iso-boot-test into plainbox-provider-checkbox:master

[Rod Smith]

Add: Test that system was installed from Subiquity ISO image

Renames maas-version-check.sh to install-method-check.sh and expands that script to test either of two cases:

* That the server was installed via MAAS and the MAAS version is known
* That the server was installed via Subiquity/an ISO image

The same conditions can be used to test either case; it's just their outcomes that must differ.

For the first case, the results should be identical to the old maas-version-check.sh script. Here's a submission that demonstrates this:

* https://certification.canonical.com/hardware/201006-5798/submission/259147/
  * https://certification.canonical.com/hardware/201006-5798/submission/259147/test/58324/result/25018913/

For the second case, a new launcher is required (MR to be submitted shortly). Passing (installed via ISO image on USB flash drive) and failing (installed via MAAS) submissions are:

* https://certification.canonical.com/hardware/201508-19150/submission/259144/
  * https://certification.canonical.com/hardware/201508-19150/submission/259144/test/157430/result/25018664/

* https://certification.canonical.com/hardware/201006-5798/submission/259146/
  * https://certification.canonical.com/hardware/201006-5798/submission/259146/test/157430/result/25018901/

This MR should be merged BEFORE the companion MR to plainbox-provider-certification-server.

[Rod Smith (rodsmith)]

Companion MR with launcher is at:

https://code.launchpad.net/~rodsmith/plainbox-provider-certification-server/+git/plainbox-provider-certification-server/+merge/419471

[Jeff Lane  (bladernr)]

Just some nitpics and one slightly more important suggestion inline (that's still a nitpick about final output).

[Rod Smith (rodsmith)]

I'm afraid that git blew up in my face and the documentation I found online failed to help, so I've resubmitted this MR, with the changes noted inline below:

https://code.launchpad.net/~rodsmith/plainbox-provider-checkbox/+git/plainbox-provider-checkbox/+merge/419489

(I had several failures of various types along the way. I suspect that Launchpad is overloaded in the week leading up to 22.04's release.)

Unmerged commits

cb873e6... by Rod Smith on 2022-04-14

Add: Test that system was installed from Subiquity ISO image

diff --git a/bin/install-method-check.sh b/bin/install-method-check.sh
new file mode 100755
index 0000000..cffe8a7
--- /dev/null
+++ b/bin/install-method-check.sh
@@ -0,0 +1,139 @@
+#!/bin/bash
+
+# Copyright (C) 2012-2022 Canonical Ltd.
+
+# Authors
+#  Jeff Lane <[e-mail]>
+#  Rod Smith <[e-mail]>
+
+# 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/>.
+
+MAAS_FILE="/etc/installed-by-maas"
+DATASOURCE_FILE="/var/lib/cloud/instance/datasource"
+INSTALL_DATASOURCE=""
+SUBIQUITY_LOG_FILE1="/var/log/installer/subiquity-info.log" # Observed on 20.04
+SUBIQUITY_LOG_FILE2="/var/log/installer/subiquity-server-info.log" # Observed on 22.04
+CONFIRM_INSTALL_TYPE="maas" # or "subiquity", maybe others in future
+RETVAL="0"
+
+get_params() {
+    # Default to equivalent of --verify-maas-install; the option is
+    # provided for clarity in calling script.
+    while [[ $# -gt 0 ]]; do
+        case $1 in
+            --verify-maas-install|-m)
+                CONFIRM_INSTALL_TYPE="maas" # should already be set
+                ;;
+            --verify-iso-install|-i)
+                CONFIRM_INSTALL_TYPE="subiquity"
+                ;;
+            *) echo "Usage: $0 [ -m, --verify-maas-install ] | [ -i, --verify-iso-install ]"
+                ;;
+        esac
+        shift
+    done
+    INSTALL_DATASOURCE_FOUND=0 # Should be found for both MAAS & subiquity
+    MAAS_IP_FOUND=0            # Should be found for MAAS but not subiquity
+    MAAS_VERSION_FOUND=0       # Should be found for MAAS but not subiquity
+    SUBIQUITY_LOG_FOUND=0      # Should be found for subiquity but not MAAS
+}
+
+# Context-sensitive echo() function; prints the message only if the program
+# is launched to confirm a MAAS installation
+conditional_print() {
+    if [[ "$CONFIRM_INSTALL_TYPE" == "$2" ]] ; then
+        echo "$1"
+    fi
+}
+
+# Find the installation data source, as recorded in cloud installer files.
+# This should be present for both MAAS and subiquity installs.
+get_install_datasource() {
+    # Is the file there?
+    if [ -s $DATASOURCE_FILE ]; then
+        INSTALL_DATASOURCE=$(cut -d "[" -f 2 $DATASOURCE_FILE | cut -d "]" -f 1)
+        echo "Installation data source is $INSTALL_DATASOURCE"
+        INSTALL_DATASOURCE_FOUND=1
+    else
+        echo "ERROR: The installation data source file ($DATASOURCE_FILE)"
+        echo "cannot be found."
+    fi
+}
+
+# Verify that the $INSTALL_DATASOURCE points to a valid IP address.
+# Note: Function assumes that $INSTALL_DATASOURCE is already set, as is
+# done by the get_install_datasource() function.
+verify_maas_ip() {
+    if [[ $INSTALL_DATASOURCE_FOUND == 1 ]]; then
+        MAAS_HOSTNAME=$(echo "$INSTALL_DATASOURCE" | cut -d "/" -f 3 | cut -d ":" -f 1)
+        HOST_OUTPUT=$(host "$MAAS_HOSTNAME" | grep "has address")
+        status=$?
+        if [[ $status -eq 0 ]]; then
+            MAAS_IP=$(echo "$HOST_OUTPUT" | cut -d " " -f 4)
+            conditional_print "MAAS server's IP address is $MAAS_IP" "maas"
+            conditional_print "ERROR: MAAS server's IP address is $MAAS_IP" "subiquity"
+            MAAS_IP_FOUND=1
+        else
+            conditional_print "ERROR: Unable to determine MAAS server's IP address" "maas"
+        fi
+    fi
+}
+
+# Pull the MAAS version information from a file left here by the
+# Server Certification pre-seed file
+get_maas_version() {
+    # Is the file there?
+    if [ -s $MAAS_FILE ]; then
+        maas_version=$(cat $MAAS_FILE)
+        conditional_print "MAAS version is $maas_version" "maas"
+        conditional_print "ERROR: Server Certification MAAS version file found; MAAS version is $maas_version" "subiquity"
+        MAAS_VERSION_FOUND=1
+    else
+        conditional_print "ERROR: The MAAS version cannot be determined" "maas"
+    fi
+}
+
+find_subiquity_log() {
+    if [[ -f "$SUBIQUITY_LOG_FILE1" || -f "$SUBIQUITY_LOG_FILE2" ]]; then
+        conditional_print "ERROR: Subiquity log file found" "maas"
+        conditional_print "subiquity log file found" "subiquity"
+        SUBIQUITY_LOG_FOUND=1
+    else
+        conditional_print "ERROR: Subiquity log file not found" "subiquity"
+    fi
+}
+
+#######################
+#
+# Main program begins here....
+#
+#######################
+
+get_params "$@"
+
+# Check for various installation signatures....
+get_install_datasource
+verify_maas_ip
+get_maas_version
+find_subiquity_log
+
+MAAS_FOUND=$((INSTALL_DATASOURCE_FOUND && MAAS_IP_FOUND && MAAS_VERSION_FOUND))
+SUBIQUITY_FOUND=$((INSTALL_DATASOURCE_FOUND && SUBIQUITY_LOG_FOUND))
+
+if [[ $CONFIRM_INSTALL_TYPE == "maas" ]] ; then
+    RETVAL=$((! MAAS_FOUND)) || SUBIQUITY_FOUND
+elif [[ $CONFIRM_INSTALL_TYPE == "subiquity" ]] ; then
+    RETVAL=$((! SUBIQUITY_FOUND)) || MAAS_FOUND
+fi
+
+exit $RETVAL
diff --git a/bin/maas-version-check.sh b/bin/maas-version-check.sh
deleted file mode 100755
index 7d97f0b..0000000
--- a/bin/maas-version-check.sh
+++ /dev/null
@@ -1,75 +0,0 @@
-#!/bin/bash
-
-# Copyright (C) 2012-2022 Canonical Ltd.
-
-# Authors
-#  Jeff Lane <[e-mail]>
-#  Rod Smith <[e-mail]>
-
-# 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/>.
-
-MAAS_FILE="/etc/installed-by-maas"
-DATASOURCE_FILE="/var/lib/cloud/instance/datasource"
-MAAS_DATASOURCE=""
-RETVAL="0"
-
-# Find the MAAS data source, as recorded in cloud installer files
-get_maas_datasource() {
-    # Is the file there?
-    if [ -s $DATASOURCE_FILE ]; then
-        MAAS_DATASOURCE=$(cut -d "[" -f 2 $DATASOURCE_FILE | cut -d "]" -f 1)
-        echo "MAAS data source is $MAAS_DATASOURCE"
-    else
-        echo "ERROR: This system does not appear to have been installed by MAAS"
-        echo "ERROR: " "$(ls -l $DATASOURCE_FILE 2>&1)"
-        RETVAL="1"
-    fi
-}
-
-# Verify that the $MAAS_DATASOURCE points to a valid IP address.
-# Note: Function assumes that $MAAS_DATASOURCE is already set, as is
-# done by the get_maas_datasource() function.
-verify_maas_ip() {
-    if [[ $RETVAL == 0 ]]; then
-        MAAS_HOSTNAME=$(echo "$MAAS_DATASOURCE" | cut -d "/" -f 3 | cut -d ":" -f 1)
-        HOST_OUTPUT=$(host "$MAAS_HOSTNAME" | grep "has address")
-        status=$?
-        if [[ $status -eq 0 ]]; then
-            MAAS_IP=$(echo "$HOST_OUTPUT" | cut -d " " -f 4)
-            echo "MAAS server's IP address is $MAAS_IP"
-        else
-            echo "ERROR: Unable to determine MAAS server's IP address"
-            RETVAL=1
-        fi
-    fi
-}
-
-# Pull the MAAS version information from a file left here by the
-# Server Certification pre-seed file
-get_maas_version() {
-    # Is the file there?
-    if [ -s $MAAS_FILE ]; then
-        maas_version=$(cat $MAAS_FILE)
-        echo "MAAS version is $maas_version"
-    else
-        echo "ERROR: The MAAS version cannot be determined"
-        echo "ERROR: " "$(ls -l $MAAS_FILE 2>&1)"
-        RETVAL="1"
-    fi
-}
-
-get_maas_datasource
-verify_maas_ip
-get_maas_version
-
-exit $RETVAL
diff --git a/units/miscellanea/jobs.pxu b/units/miscellanea/jobs.pxu
index 785eebe..1168391 100644
--- a/units/miscellanea/jobs.pxu
+++ b/units/miscellanea/jobs.pxu
@@ -396,12 +396,20 @@ plugin: shell
 category_id: com.canonical.plainbox::miscellanea
 estimated_duration: 0.1
 id: miscellanea/get_maas_version
-command: maas-version-check.sh
+command: install-method-check.sh --verify-maas-install
 _description: If system was installed via MAAS from a cert server, the MAAS version used should be contained in /etc/installed-by-maas
 _summary: Verify MAAS version used to deploy the SUT
 
 plugin: shell
 category_id: com.canonical.plainbox::miscellanea
+estimated_duration: 0.1
+id: miscellanea/test_iso_install
+command: install-method-check.sh --verify-iso-install
+_description: Test that the system was installed via a Subiquity ISO image
+_summary: Test that the system was installed via a Subiquity ISO image
+
+plugin: shell
+category_id: com.canonical.plainbox::miscellanea
 estimated_duration: 30.0
 id: miscellanea/get_make_and_model
 user: root