Merge ~liaou3/checkbox-iiotg/+git/checkbox-provider-intliotg:add_tsn_snap_check into ~checkbox-dev/checkbox-iiotg/+git/checkbox-provider-intliotg:master

[Vincent Liao]

Add tsn testing snap check job

Add this job to check if the required snap packages are installed. Those snaps are used for tsn testing.

Submissions:
 - auto: https://certification.canonical.com/hardware/202306-31658/submission/340597/ (fail on purpose)

 - auto: https://certification.canonical.com/hardware/202306-31658/submission/340600/
 - manual: https://certification.canonical.com/hardware/202306-31658/submission/340605/

[Patrick Liu (patliu)]

Hi Vicent,

One small question, please see my in-line comment.

review: Needs Fixing

[Vincent Liao (liaou3)]

> Hi Vicent,
>
> One small question, please see my in-line comment.

You are right. Fixed.

[Patrick Liu (patliu)]

LGTM

review: Approve

[PeiYao Chang (baconyao)]

LGTM

review: Approve

diff --git a/units/tsn/jobs.pxu b/units/tsn/jobs.pxu
index b422172..3bd09c6 100644
--- a/units/tsn/jobs.pxu
+++ b/units/tsn/jobs.pxu
@@ -27,6 +27,31 @@ command:
     exit "$exit_code"
 
 unit: job
+id: tsn/testing-snap-install-check
+category_id: tsn
+_summary: TSN testing snap installation check
+_description: 
+    To check if the TSN related snap is installed
+     - linuxptp-rt
+     - ethtool-rt
+     - iproute2-rt
+depends: tsn/tsn-detected
+plugin: shell
+command:
+    snap_list="linuxptp-rt ethtool-rt iproute2-rt"
+    exit_code=0
+    for snap in $snap_list; do
+        if ! snap list | grep -q $snap; then
+            echo "ERROR: snap package \"${snap}\" not found!"
+            echo "Try install it with the command below"
+            echo "sudo snap install ${snap} --edge --devmode"
+            echo ""
+            exit_code=1
+        fi
+    done
+    exit $exit_code
+
+unit: job
 category_id: tsn
 id: tsn/tsn-devices
 plugin: resource
@@ -127,6 +152,7 @@ _purpose:
     Use {interface} on the SUT to achieve time sync with the second machine as client
 depends:
     tsn/tsn-detected
+    tsn/testing-snap-install-check
 plugin: user-interact-verify
 user: root
 environ:
@@ -151,6 +177,7 @@ _purpose:
     Use {interface} on the SUT to achieve time sync with the second machine as master
 depends:
     tsn/tsn-detected
+    tsn/testing-snap-install-check
 plugin: user-interact-verify
 user: root
 environ:
@@ -173,6 +200,7 @@ _summary:
     Check system time sync with PTP hardware clock as client
 depends:
     tsn/tsn-detected
+    tsn/testing-snap-install-check
     tsn/ieee802.1as-2011/time-sync-between-two-system-as-client-{interface}
 plugin: user-interact-verify
 user: root
@@ -206,6 +234,7 @@ _summary:
     Check system time sync with PTP hardware clock as client
 depends:
     tsn/tsn-detected
+    tsn/testing-snap-install-check
     tsn/ieee802.1as-2011/time-sync-between-two-system-as-master-{interface}
 plugin: user-interact-verify
 user: root
@@ -238,6 +267,7 @@ category_id: tsn
 _summary: Check the packet time intervals
 depends:
     tsn/tsn-detected
+    tsn/testing-snap-install-check
 plugin: user-interact-verify
 user: root
 _purpose:
@@ -267,6 +297,7 @@ category_id: tsn
 _summary: Credit-Based Shaper algorithm check
 depends:
     tsn/tsn-detected
+    tsn/testing-snap-install-check
 plugin: shell
 user: root
 _purpose:
@@ -287,6 +318,7 @@ category_id: tsn
 _summary: Check if the streams packet are handled properly
 depends:
     tsn/tsn-detected
+    tsn/testing-snap-install-check
 plugin: user-interact-verify
 user: root
 _purpose:
@@ -312,22 +344,18 @@ category_id: tsn
 _summary: Frame preemption check
 depends:
     tsn/tsn-detected
+    tsn/testing-snap-install-check
 plugin: shell
 user: root
 _purpose:
     To check if the system can setup frame preemption
 command:
-    if ! command -v ethtool-rt.ethtool > /dev/null; then
-        echo "ERROR: snap ethtool-rt is required for this test and it's probably not installed."
-        echo "Please install it with the following command."
-        echo "$ sudo snap install ethtool-rt --edge --devmode"
-        exit 1
-    fi
     echo "## Setting frame preemption on..."
     ret=$(ethtool-rt.ethtool --set-frame-preemption {interface} fp on)
     if [[ "$ret" != "0" ]]; then
-        echo "FAIL: Cannot set frame preemption via command below"
+        echo "FAIL: Cannot set frame preemption via the command below"
         echo "ethtool-rt.ethtool --set-frame-preemption {interface} fp on"
+        echo ""
         exit 1
     fi
     echo "## Showing frame preemption settings..."
@@ -335,5 +363,6 @@ command:
     echo "$output"
     if ! echo "$output" | grep -q "enabled: enabled"; then
         echo "FAIL: frame preemption is not enabled!"
+        echo ""
         exit 1
     fi
diff --git a/units/tsn/test-plan.pxu b/units/tsn/test-plan.pxu
index 69b1e9f..fd5653c 100644
--- a/units/tsn/test-plan.pxu
+++ b/units/tsn/test-plan.pxu
@@ -16,6 +16,7 @@ bootstrap_include:
 include:
     tsn/tsn-detected
     tsn/test-env-setup-for-.*
+    tsn/testing-snap-install-check
 nested_part:
     tsn-ieee802.1as-2011
     tsn-time-based-shaping
@@ -29,6 +30,7 @@ bootstrap_include:
 include:
     tsn/verify-PTP-for-.*
     tsn/test-env-setup-for-.*
+    tsn/testing-snap-install-check
 nested_part:
     tsn-ieee802.1qav
     tsn-ieee802.1qbu
@@ -44,6 +46,7 @@ unit: test plan
 bootstrap_include:
     tsn/tsn-devices
 include:
+    tsn/testing-snap-install-check
     tsn/ieee802.1as-2011/time-sync-between-two-system-as-client-.*
     tsn/ieee802.1as-2011/time-sync-between-two-system-as-master-.*
     tsn/ieee802.1as-2011/time-sync-system-clock-with-PHC-as-client-.*
@@ -59,6 +62,7 @@ unit: test plan
 bootstrap_include:
     tsn/tsn-devices
 include:
+    tsn/testing-snap-install-check
     tsn/time-based-shaping/udp-packet-time-check-.*
 
 id: tsn-ieee802.1qav
@@ -69,6 +73,7 @@ unit: test plan
 bootstrap_include:
     tsn/tsn-devices
 include:
+    tsn/testing-snap-install-check
     tsn/ieee802.1qav/check-credit-based-shaper-.*
 
 id: tsn-ieee802.1qbv
@@ -79,6 +84,7 @@ unit: test plan
 bootstrap_include:
     tsn/tsn-devices
 include:
+    tsn/testing-snap-install-check
     tsn/ieee802.1qbv/udp-traffic-check-.*
 
 id: tsn-ieee802.1qbu
@@ -89,4 +95,5 @@ unit: test plan
 bootstrap_include:
     tsn/tsn-devices
 include:
+    tsn/testing-snap-install-check
     tsn/ieee802.1qbu/check-frame-preemption-.*