Add fwupdmgr attachment job (New)

[stanley31huang]

Description

This is a follow up PR for the PR965, I have applied the workaround (provided by Pierre). And I have verified the tests on EGW 3200.
https://certification.canonical.com/hardware/202312-33237/submission/360846/

This attachment job is requested from the OEM SWE team. They'd like to parse the fwupdmgr device information from the submission.
This PR added a firmware/fwupdmgr_get_devices attachment job and the related test plan to be nested in the client-cert-desktop test plan.

The firmware/fwupdmgr_get_devices only does the following command:

fwupdmgr get-devices --json

Requires

requires:
    executable.name == "fwupdmgr"
    environment.SNAP == ""  # only execute on Debian checkbox

The tests will only be executed when fwupdmgr executable is available.
Also, we found a limitation:

Our purpose is to run the fwupdmgr command from the default deb package to get the needed information. However, while Checkbox is running in the snap environment, the fwupdmgr will try to find the snap services snap.fwupd.fwupd.service, which leads to the following daemon and client mismatch error,

root@u-Inspiron-15-5508:/home/u# fwupdmgr get-devices
Mismatched daemon and client, use fwupd.fwupdmgr instead

This environment check is written in https://github.com/fwupd/fwupd/blob/main/src/fu-util-common.c#L42

#define SYSTEMD_FWUPD_UNIT	"fwupd.service"
#define SYSTEMD_SNAP_FWUPD_UNIT "snap.fwupd.fwupd.service"

fu_util_get_systemd_unit(void)
{
	if (g_getenv("SNAP") != NULL)
		return SYSTEMD_SNAP_FWUPD_UNIT;
	return SYSTEMD_FWUPD_UNIT;
}

Using the Debian version checkbox will not encounter this problem. Currently, I don’t have any good idea to solve this problem. So I intend to add a job for Debian Checkbox for now. And the environment.SNAP == "" is to ensure the job will only be executed with Debian Checkbox.

Resolved issues

Request from SWE team
https://warthogs.atlassian.net/browse/OEMQA-3797

Tests

Sideload result on an Ubuntu Desktop 22.04 laptop with Debian Checkbox
https://pastebin.canonical.com/p/4Jf5gXDKYV/
Sideload result on an Ubuntu Desktop 22.04 laptop with Snap Checkbox -> job skipped
https://pastebin.canonical.com/p/8wnCchBnWv/

[codecov]

Codecov Report

Attention: Patch coverage is 94.44444% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 42.87%. Comparing base (8b61956) to head (5c875ed).
Report is 24 commits behind head on main.

❗ Current head 5c875ed differs from pull request most recent head 34588f1. Consider uploading reports for the commit 34588f1 to get more accurate results

Files	Patch %	Lines
providers/base/bin/get_firmware_info_fwupd.py	94.44%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1089      +/-   ##
==========================================
+ Coverage   42.85%   42.87%   +0.02%     
==========================================
  Files         351      352       +1     
  Lines       38443    38461      +18     
  Branches     6532     6536       +4     
==========================================
+ Hits        16475    16492      +17     
  Misses      21302    21302              
- Partials      666      667       +1     

Flag	Coverage Δ
provider-base	15.36% <94.44%> (+0.09%)	⬆️
provider-certification-client	57.14% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[kissiel]

Minor addition proposed in line, and one possible simplification.

[kissiel]

The tests provided here look like they are here just to have test coverage instead of testing the logic (and the most difficult piece of logic is untested).

[kissiel]

Awesome! Thanks for all the amendments!
+1