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

[Vincent Liao]

Modify: Make time based shaper automated

submission: https://certification.canonical.com/hardware/202306-31658/submission/341158/

[PeiYao Chang (baconyao)]

Please see my in-line comment

review: Needs Fixing

[Vincent Liao (liaou3)]

@baconyao
Please see my reply

[Rick Wu (rickwu4444)]

LGTM

review: Approve

[Patrick Liu (patliu)]

LGTM

review: Approve

diff --git a/bin/tsn_time_based_shaper.sh b/bin/tsn_time_based_shaper.sh
new file mode 100755
index 0000000..6106700
--- /dev/null
+++ b/bin/tsn_time_based_shaper.sh
@@ -0,0 +1,49 @@
+#!/bin/bash
+
+set -e
+
+timeout=$1
+eth_interface=$2
+server_user=$3
+server_ip=$4
+server_pwd=$5
+server_eth_interface=$6
+
+echo "## Clearing previous queue discipline configuration..."
+echo "## You will get errors if there's no previous configuration, but you could ignore it."
+tc qdisc del dev "$eth_interface" root || true
+echo ""
+
+echo "## Setting time schedule..."
+tc qdisc add dev "$eth_interface" handle 8001: parent root mqprio num_tc 4 map 0 1 2 3 3 3 3 3 3 3 3 3 3 3 3 3 queues 1@0 1@1 1@2 1@3 hw 0
+tc qdisc replace dev "$eth_interface" parent 8001:4 etf offload clockid CLOCK_TAI delta 500000
+echo ""
+
+echo "## Showing qdisc settings..."
+tc qdisc show dev "$eth_interface"
+echo ""
+
+echo "## Start sending and receiving udp packets..."
+out=$(mktemp)
+timeout "$timeout" udp_tai -c 3 -i "$eth_interface" -P 1000000 -p 90 -d 600000 > /dev/null &
+(sshpass -p "u" ssh -o StrictHostKeyChecking=no "$server_user"@"$server_ip" "echo $server_pwd | sudo -S tcpdump -G $timeout -Q in -ttt -ni $server_eth_interface --time-stamp-precision=nano -j adapter_unsynced port 7788 -c 20000") | tee "$out"
+
+echo "## Checking result..."
+lines=$(tail -n 10000 "$out")
+count=0
+while read -r line
+do
+    interval=$(echo "$line" | awk '{print $1}' | awk -F "." '{print $2}')
+    if [ "$interval" -gt 1000500 ] || [ "$interval" -lt 999500 ]; then
+        count=$((count+1))
+    fi
+done <<< "$lines"
+
+echo "In the last 10000 packets there are $count packets are not within 1000000+/-500 ns interval."
+echo "Pass condition: Less than 5% packets not within the required interval"
+if [ $count -lt 500 ]; then
+    echo "PASS"
+else
+    echo "FAIL"
+    exit 1
+fi
diff --git a/units/tsn/jobs.pxu b/units/tsn/jobs.pxu
index de2cbae..719da83 100644
--- a/units/tsn/jobs.pxu
+++ b/units/tsn/jobs.pxu
@@ -267,13 +267,14 @@ command:
 unit: template
 template-resource: tsn/tsn-devices
 template-unit: job
-id: tsn/time-based-shaping/udp-packet-time-check-{interface}
+template-engine: jinja2
+id: tsn/time-based-shaping/udp-packet-time-check-{{ interface }}
 category_id: tsn
-_summary: Check the packet time intervals
+_summary: UDP packet time intervals check
 depends:
     tsn/tsn-detected
     tsn/testing-snap-install-check
-plugin: user-interact-verify
+plugin: shell
 user: root
 _purpose:
     To check if the system can transmit udp packet precisely at 1 ms intervals
@@ -283,15 +284,7 @@ environ:
     TSN_SERVER_PWD
     TSN_SERVER_INTERFACE
 command:
-    tc qdisc del dev {interface} root
-    tc qdisc add dev {interface} handle 8001: parent root mqprio num_tc 4 map 0 1 2 3 3 3 3 3 3 3 3 3 3 3 3 3 queues 1@0 1@1 1@2 1@3 hw 0
-    tc qdisc replace dev {interface} parent 8001:4 etf offload clockid CLOCK_TAI delta 500000
-    tc qdisc show dev {interface}
-    timeout 30 udp_tai -c 3 -i {interface} -P 1000000 -p 90 -d 600000 > /dev/null &
-    timeout 30 sshpass -p "u" ssh -o StrictHostKeyChecking=no "$TSN_SERVER_USER"@"$TSN_SERVER_IP" "echo "$TSN_SERVER_PWD" | sudo -S tcpdump -Q in -ttt -ni "$TSN_SERVER_INTERFACE" --time-stamp-precision=nano -j adapter_unsynced port 7788 -c 20000"
-_verification:
-    Is the packets are being transmitted every 1000000ns (+/-500ns)?
-    If > 95% of packets match this criteria the test is successful.
+    tsn_time_based_shaper.sh 30 {{ interface }} "$TSN_SERVER_USER" "$TSN_SERVER_IP" "$TSN_SERVER_PWD" "$TSN_SERVER_INTERFACE"
 
 unit: template
 template-resource: tsn/tsn-devices
diff --git a/units/tsn/test-plan.pxu b/units/tsn/test-plan.pxu
index 025bb18..3978ad2 100644
--- a/units/tsn/test-plan.pxu
+++ b/units/tsn/test-plan.pxu
@@ -18,7 +18,6 @@ include:
     tsn/test-env-setup-for-.*
     tsn/testing-snap-install-check
 nested_part:
-    tsn-time-based-shaping
     tsn-ieee802.1qbv
 
 id: tsn-automated
@@ -34,6 +33,7 @@ nested_part:
     tsn-ieee802.1as-2011
     tsn-ieee802.1qav
     tsn-ieee802.1qbu
+    tsn-time-based-shaping
 
 id: tsn-ieee802.1as-2011
 _name: Time Sensitive Networking Test Plan for IEEE 802.1AS-2011