Add a manifest entry to check if a SIM card is inserted (New)

[pieqq]

Description

By creating a has_sim_card manifest entry and using it as a requirement on WWAN jobs that need a SIM card, this PR ensure these jobs will not fail if a WWAN is found, but has no working SIM card inserted.

Resolved issues

#1493

https://warthogs.atlassian.net/browse/CHECKBOX-1578

Documentation

Tests

As I don't have a device with a WWAN module, nor a SIM card I could use, I just checked the status of the 24.04 test plan before and after applying this patch by calling checkbox-cli expand "com.canonical.certification::client-cert-desktop-24-04" --format json | jq on main and on this branch, and comparing the results (we can see the requirement on manifest.has_sim_card shows up):

5453c5453
<     "requires": " manifest.has_wwan_module == 'True'\n snap.name == 'modem-manager' or package.name == 'modemmanager'",
---
>     "requires": " manifest.has_wwan_module == 'True'\n manifest.has_sim_card == 'True'\n snap.name == 'modem-manager' or package.name == 'modemmanager'",
5472c5472
<     "requires": " manifest.has_wwan_module == 'True'\n snap.name == 'modem-manager' or package.name == 'modemmanager'",
---
>     "requires": " manifest.has_wwan_module == 'True'\n manifest.has_sim_card == 'True'\n snap.name == 'modem-manager' or package.name == 'modemmanager'",
5507c5507
<     "requires": " manifest.has_wwan_module == 'True'\n snap.name == 'modem-manager' or package.name == 'modemmanager'",
---
>     "requires": " manifest.has_wwan_module == 'True'\n manifest.has_sim_card == 'True'\n snap.name == 'modem-manager' or package.name == 'modemmanager'",

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 47.50%. Comparing base (7182b16) to head (427f80d).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1500   +/-   ##
=======================================
  Coverage   47.50%   47.50%           
=======================================
  Files         369      369           
  Lines       39549    39549           
  Branches     6678     6678           
=======================================
  Hits        18788    18788           
  Misses      20050    20050           
  Partials      711      711           

Flag	Coverage Δ
provider-base	24.02% <ø> (ø)

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.

[pieqq]

The following test is required on a device with a working WWAN module and a working SIM card:

1. Run the client-cert-desktop-22-04 test plan
2. Make sure the WWAN category is selected (and make note of the jobs selected) and start the test
3. Make sure a new "A Working SIM Card Inserted" is shown in the "Does this machine have this piece of hardware?" section of the Manifest Screen, and is selected (along with "WWAN Module")
4. Run the tests

→ the WWAN jobs should run succesfully. These should be:

• wwan/3gpp-scan-manufacturer-model-hw_id-auto
• wwan/check-sim-present-manufacturer-model-hw_id-auto
• wwan/gsm-connection-manufacturer-model-hw_id-auto)

Repeat the same steps, but this time selecting "No" for "A Working SIM Card Inserted".

→ This time, the 3 jobs mentioned above should be skipped.

[hanhsuan]

@pieqq Hi, there is no A working SIM card inserted manifest could be selected.

[hanhsuan]

The manifest is shown, but only one job you mentioned is shown and tested.

with sim
without sim

[pieqq]

Thanks! It's weird that the other jobs don't show up.

Could you run the following on that device and report the output?

$ checkbox-cli list-bootstrapped com.canonical.certification::client-cert-desktop-22-04

and

$ checkbox-cli expand com.canonical.certification::client-cert-desktop-22-04

[pieqq]

Following some testing by @hanhsuan from QA team, we found the following:

• This PR works as advertised 🥳
• There is a problem with the WWAN resource job (wwan_resource output is not RFC822 compliant if firmware revision is multi-line #1505)
• The resource jobs should always "slugify" its values (wwan_resource should slugify the values #1510) to avoid the issue mentioned above
• There should be a generic way to provide a "slugify" function (Provide a generic slugify function in checkbox-support #1511)

This PR is good to land as is, and we need to work on the 3 aforementioned issues to prevent problems with WWAN testing.

[fernando79513]

Gj identifying all the related issues.
LGTM +1!