update the search pattern for CAN device (BugFix)

[stanley31huang]

BugFix: Fixed the udevadm parser for CAN devices

Modify the search pattern for CAN devices, including new llcecan device, and adding unit tests

Description

There are two kind of CAN devices on NXP S32G development board, one is generic CAN device named as canxxxx, another one is can devices from Low Latency Communication Engine (LLCE) and named as llcecanxxxx.
The current implementation for CAN devices in udevadm parser is the device name should starts with 'can' string.

So I have modified the search pattern for CAN devices, including new llcecan device, and adding unit tests.

I also applied this patch to the checkbox to ensure checkbox could identified both generic CAN device and LLCE CAN devices on NXP S32G development board.

Resolved issues

N/A

Documentation

N/A

Tests

stanley@stanley-ThinkPad-T490:~/Desktop/Git_Repos/checkbox-2023$ PYTHONPATH=checkbox-support/:$PYTHONAPATH python3 -m unittest -vv checkbox-support/checkbox_support/parsers/tests/test_udevadm.py
-k test_NXP_S32G_SOCKETCAN
test_NXP_S32G_SOCKETCAN (checkbox-support.checkbox_support.parsers.tests.test_udevadm.TestUdevadmParser) ... ok

---

Ran 1 test in 0.079s

OK

C3 submission with side-load checkbox:
https://certification.canonical.com/hardware/202304-31451/submission/349081/test-results/pass/

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (545b143) 35.38% compared to head (db8ec4e) 35.39%.
Report is 49 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #849      +/-   ##
==========================================
+ Coverage   35.38%   35.39%   +0.01%     
==========================================
  Files         303      303              
  Lines       34240    34240              
  Branches     5917     5917              
==========================================
+ Hits        12115    12119       +4     
+ Misses      21559    21558       -1     
+ Partials      566      563       -3     

Flag	Coverage Δ
checkbox-support	49.83% <100.00%> (+0.08%)	⬆️

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]

/canonical/self-hosted-runners/run-workflows 00873f7

[pieqq]

Thanks for this PR!

There are already unit tests for the udevadm parser, they are located in checkbox-support/checkbox_support/parsers/tests/test_udevadm.py (with sample data hosted in checkbox-support/checkbox_support/parsers/tests/udevadm_data).

Is there a reason why you separated your tests and put them at a different location?

I recommend you add the outcome of your own DUT in the udevadm_data, and add your tests to test_udevadm.py. You can look at how tests have been implemented there and use similar methods.

For your information, there are already a few sample data files that have a Canbus device: ZCU104.txt and CARA_T_SOCKETCAN.txt. You can leverage these when you write your tests to make sure your changes don't impact existing data.

[stanley31huang]

@pieqq I just sent a new commits for those suggestion you came up. Please review this PR again, thanks.

[pieqq]

One question about the regex being used below.

Also, since both CARA_T_SOCKETCAN.txt and ZCU104.txt have a socketcan device, could you add a check in their respective unit tests? This will help with regression testing.

[pieqq]

/canonical/self-hosted-runners/run-workflows db8ec4e

[pieqq]

Thanks for the changes! I added a check for socketcan devices in the ZCU104 unit test, so we're good to go!

[diohe0311]

LGTM +1
Just learnt from here that we can run a single unit test, nice!