Merge ~liaou3/checkbox-limerick/+git/checkbox-provider-limerick:replace_wol_s3 into ~checkbox-dev/checkbox-limerick/+git/checkbox-provider-limerick:master

[Vincent Liao]

Replace with new wol_s3 tests

Since to test wol needs pre-setting which is quite annoying, I create a new test with those pre-setting steps run automatically before starting the test.

Submission: https://certification.canonical.com/hardware/202307-31903/submission/362351/

[PeiYao Chang (baconyao)]

See my inline comment

review: Needs Fixing

[Vincent Liao (liaou3)]

> See my inline comment
Fixed

[Vincent Liao (liaou3)]

> See my inline comment
Fixed

[PeiYao Chang (baconyao)]

+1

review: Approve

[Rick Wu (rickwu4444)]

Please see my inline comment

review: Needs Fixing

[Rick Wu (rickwu4444)]

LGTM

review: Approve

diff --git a/units/ethernet/category.pxu b/units/ethernet/category.pxu
 new file mode 100644
index 0000000..79c3e2e
--- /dev/null
+++ b/units/ethernet/category.pxu
@@ -0,0 +1,3 @@
+unit: category
+id: limerick-ethernet
+_name: Limerick Ethernet
diff --git a/units/ethernet/jobs.pxu b/units/ethernet/jobs.pxu
 new file mode 100644
index 0000000..68fe706
--- /dev/null
+++ b/units/ethernet/jobs.pxu
@@ -0,0 +1,37 @@
+unit: template
+template-engine: jinja2
+template-resource: com.canonical.certification::device
+template-filter: device.category == 'NETWORK' and device.interface != 'UNKNOWN'  # Remove device.mac != 'UNKNOWN', due to LP#2009577
+template-id: limerick-ethernet/wol_S3_tests
+_template-summary: Wake on lan testing on Limerick devices
+id: limerick-ethernet/wol_S3_{{ interface }}
+_summary: Wake on LAN (WOL) test from S3 - {{ interface }}
+_purpose:
+    Check that another system can wake up from S3 the SUT using ethernet port {{ interface }} WOL function.
+_steps:
+    1. Ensure there is an ethernet cable attached to port {{ interface }}.
+    2. Press Enter to suspend the system.
+    3. From another computer on the same network run the following command:
+        ping {DUT_IP} -> provided in the job output
+_verification:
+    Did the SUT wake up from S3?
+plugin: user-interact-verify
+imports:
+    from com.canonical.certification import sleep
+requires:
+    sleep.mem == 'supported'
+command:
+    echo "Wake up sources:"
+    wakeup_sources=$(find /sys/ | grep /power/wakeup\$ | grep {{ interface }})
+    echo "$wakeup_sources"
+    for device in $wakeup_sources; do
+        echo enabled > "$device"
+    done
+    echo "Set wol 'a' on {{ interface }}"
+    ethtool -s {{ interface }} wol a
+    ip=$(ip -4 addr show {{ interface }} | grep -oP '(?<=inet\s)\d+(\.\d+){3}')
+    echo "ip: $ip"
+    systemctl suspend
+user: root
+category_id: limerick-ethernet
+estimated_duration: 60
diff --git a/units/ethernet/testplan.pxu b/units/ethernet/testplan.pxu
 new file mode 100644
index 0000000..6609426
--- /dev/null
+++ b/units/ethernet/testplan.pxu
@@ -0,0 +1,8 @@
+id: limerick-ethernet-manual
+unit: test plan
+_name: Limerick Manual Ethernet Tests
+_description: Manual ethernet test
+include:
+    limerick-ethernet/wol_S3_tests
+bootstrap_include:
+    com.canonical.certification::device
diff --git a/units/kd240-test-plan-classic.pxu b/units/kd240-test-plan-classic.pxu
index f97200a..4d8f524 100644
--- a/units/kd240-test-plan-classic.pxu
+++ b/units/kd240-test-plan-classic.pxu
@@ -27,7 +27,9 @@ nested_part:
     com.canonical.qa.ceoem::ce-oem-manual
     com.canonical.certification::client-cert-iot-server-22-04-manual
     com.canonical.qa.ceoem::after-suspend-ce-oem-manual
+    limerick-ethernet-manual
 exclude:
+    com.canonical.certification::ethernet/wol_S3_.*                            # LP:1982453 Since wol on limerick devices needs pre-setting, we replace it with limerick-ethernet/wol_S3_.*
     com.canonical.certification::ethernet/wol_S5_.*                            # LP:2017481
     com.canonical.certification::rtc/battery                                   # LP:2017486
 
diff --git a/units/kr260-test-plan-classic.pxu b/units/kr260-test-plan-classic.pxu
index 548e239..76688c5 100644
--- a/units/kr260-test-plan-classic.pxu
+++ b/units/kr260-test-plan-classic.pxu
@@ -33,6 +33,7 @@ nested_part:
     limerick-after-suspend-monitor-manual
     com.canonical.certification::after-suspend-graphics-integrated-gpu-cert-manual
     limerick-usb-manual
+    limerick-ethernet-manual
 exclude:
     com.canonical.certification::audio.*                                       # keep if audio is not supported
     com.canonical.certification::bluetooth.*                                   # keep if bluetooth is not supported
@@ -57,6 +58,7 @@ exclude:
     com.canonical.certification::after-suspend.*wwan.*                         # keep if post-suspend wwan/4G/5G is not supported
     com.canonical.certification::ethernet/wol_S5_.*
     com.canonical.certification::ethernet/wol_S4_.*
+    com.canonical.certification::ethernet/wol_S3_.*                            # LP:1982453 Since wol on limerick devices needs pre-setting, we replace it with limerick-ethernet/wol_S3_.*
     com.canonical.certification::graphics/1_glxgears_.*
     com.canonical.certification::graphics/1_video_.*
     com.canonical.certification::graphics/1_rotation_.*
diff --git a/units/kv260-test-plan-classic.pxu b/units/kv260-test-plan-classic.pxu
index cf58bba..849d63a 100644
--- a/units/kv260-test-plan-classic.pxu
+++ b/units/kv260-test-plan-classic.pxu
@@ -43,6 +43,7 @@ nested_part:
     limerick-after-suspend-monitor-manual
     com.canonical.certification::after-suspend-graphics-integrated-gpu-cert-manual
     limerick-usb-manual
+    limerick-ethernet-manual
 exclude:
     com.canonical.certification::audio.*                                       # keep if audio is not supported
     com.canonical.certification::bluetooth.*                                   # keep if bluetooth is not supported
@@ -67,6 +68,7 @@ exclude:
     com.canonical.certification::after-suspend.*wwan.*                         # keep if post-suspend wwan/4G/5G is not supported
     com.canonical.certification::ethernet/wol_S5_.*
     com.canonical.certification::ethernet/wol_S4_.*
+    com.canonical.certification::ethernet/wol_S3_.*                            # LP:1982453 Since wol on limerick devices needs pre-setting, we replace it with limerick-ethernet/wol_S3_.*
     com.canonical.certification::graphics/1_glxgears_.*
     com.canonical.certification::graphics/1_video_.*
     com.canonical.certification::graphics/1_rotation_.*