Merge ~zongminl/plainbox-provider-checkbox:fix-1953294-missing-exception-handling into plainbox-provider-checkbox:master

[Vic Liu]

Fix: lp1953294 - miscellanea/secure_boot_mode_* fails with a CalledProcessError exception when Secure Boot not activated

- Added exception handler so a SystemExit can be raised when CalledProcessError occurs
- Skipped the volume in gadget.yaml when there is no 'bootloader' defined in it to avoid KeyError

[Pierre Equoy (pieq)]

Thanks for your help!

It now outputs this:

-----
Bootloader is grub

+ mokutil --sb-state
This system doesn't support Secure Boot
/tmp/nest-bvvsju26.648efd11d9fcfc5a24433b6c16a3b54cc18049637438ab18211e9597782aa0e1/boot_mode_test_snappy.py:77: YAMLLoadWarning: calling yaml.load() without Loader=... is deprecated, as the default Loader is unsafe. Please read https://msg.pyyaml.org/load for full details.
  data = yaml.load(f)
Error: Command 'mokutil --sb-state' returned non-zero exit status 255.
-----

I think there is a fix to be made to the `data = yaml.load(f)` (line 19 below) to avoid showing the DeprecationWarning, and as for the command itself, maybe we should just run the command, since `mokutil --sb-state` already outputs "This system doesn't support Secure Boot" by default:

>>> import subprocess
>>> p = subprocess.run("mokutil --sb-state".split())
This system doesn't support Secure Boot
>>> p.stderr
>>> p.stdout
>>> p.args
['mokutil', '--sb-state']
>>> p.returncode
255

review: Needs Fixing

[Vic Liu (zongminl)]

Fixed according to @pieq's suggestion:
1. The commands using here already print error messages on their own, removing exception message when raising SystemExit, now this exits with code 1 silently to prevent redundant messages
2. Using SafeLoader to prevent DeprecationWarning printed when calling yaml.load()

[Pierre Equoy (pieq)]

+1

Thanks!

review: Approve

[Devices Certification Bot (ce-certification-qa)]

The merge was fine but running tests failed.

"10.38.105.54"
"10.38.105.108"
"10.38.105.197"
[xenial] [07:01:09] starting container
Device project added to xenial-testing
"10.38.105.54"
[xenial] [07:01:32] provisioning container
[bionic] [07:02:01] starting container
Device project added to bionic-testing
"10.38.105.120"
[bionic] [07:02:27] provisioning container
[focal] [07:02:58] starting container
[xenial] [07:03:06] Starting tests...
[xenial] Found a test script: ./requirements/container-tests-provider-checkbox
Device project added to focal-testing
"10.38.105.222"
[focal] [07:03:19] provisioning container
[bionic] [07:03:32] Starting tests...
[bionic] Found a test script: ./requirements/container-tests-provider-checkbox
[focal] [07:04:58] Starting tests...
[focal] Found a test script: ./requirements/container-tests-provider-checkbox
[bionic] [07:05:21] container-tests-provider-checkbox: PASS
[bionic] [07:05:21] Fixing file permissions in source directory
[bionic] [07:05:22] Destroying container
[xenial] [07:05:46] container-tests-provider-checkbox: FAIL
[xenial] output: https://paste.ubuntu.com/p/8G6662Vs4x/
[xenial] [07:05:49] Fixing file permissions in source directory
[xenial] [07:05:49] Destroying container
[focal] [07:07:52] container-tests-provider-checkbox: FAIL
[focal] output: https://paste.ubuntu.com/p/TXhKPmvvjM/
[focal] [07:07:54] Fixing file permissions in source directory
[focal] [07:07:54] Destroying container

review: Needs Fixing

diff --git a/bin/boot_mode_test_snappy.py b/bin/boot_mode_test_snappy.py
index 23b30e4..0e0957a 100755
--- a/bin/boot_mode_test_snappy.py
+++ b/bin/boot_mode_test_snappy.py
@@ -19,7 +19,10 @@ from checkbox_support.snap_utils.system import get_lk_bootimg_path
 
 def fitdumpimage(filename):
     cmd = 'dumpimage -l {}'.format(filename)
-    out = sp.check_output(cmd, shell=True).decode(sys.stdout.encoding)
+    try:
+        out = sp.check_output(cmd, shell=True).decode(sys.stdout.encoding)
+    except Exception:
+        raise SystemExit(1)
     buf = io.StringIO(out)
 
     # first line should identify FIT file
@@ -71,8 +74,10 @@ def main():
             'ERROR: failed to find gadget.yaml at {}'.format(gadget_yaml))
 
     with open(gadget_yaml) as f:
-        data = yaml.load(f)
+        data = yaml.load(f, Loader=yaml.SafeLoader)
         for k in data['volumes'].keys():
+            if 'bootloader' not in data['volumes'][k]:
+                continue
             bootloader = data['volumes'][k]['bootloader']
     if not bootloader:
         raise SystemExit('ERROR: could not find name of bootloader')
@@ -162,7 +167,10 @@ def main():
     if bootloader == 'grub':
         cmd = 'mokutil --sb-state'
         print('+', cmd, flush=True)
-        out = sp.check_output(cmd, shell=True).decode(sys.stdout.encoding)
+        try:
+            out = sp.check_output(cmd, shell=True).decode(sys.stdout.encoding)
+        except Exception:
+            raise SystemExit(1)
         print(out, flush=True)
         if out != 'SecureBoot enabled\n':
             raise SystemExit('ERROR: mokutil reports Secure Boot not in use')