Ethernet test: Make interface detection dynamic, robustify bring-up and ping validation

- Add logic to auto-detect active Ethernet interface using ip/ipconfig
- Enhance bring-up sequence with retries and logging
- Improve ping test error handling and reporting
- Refactor for better CI diagnostics

Signed-off-by: Srikanth Muppandam <[email protected]>

Author: smuppand

Runner/suites/Connectivity/Ethernet/README.md

@@ -28,6 +28,8 @@ cd <this-repo>
 scp -r common Runner user@target_device_ip:<Path in device>
 ssh user@target_device_ip
 cd <Path in device>/Runner && ./run-test.sh Ethernet
+# Optional: specify preferred interface (e.g., eth1)
+./run.sh [preferred-interface]
 ```
 
 ## Prerequisites
@@ -53,5 +55,14 @@ Test result will be saved in `Ethernet.res` as:
 ## Output
 A .res file is generated in the same directory:
 
-`PASS Ethernet`  OR   `FAIL Ethernet`
+`Ethernet PASS`  OR   `Ethernet FAIL`
 
+## Sample Log
+```
+Output
+
+[INFO] 2025-06-11 10:12:23 - Detected Ethernet interface: enP1p4s0u1u1
+[PASS] 2025-06-11 10:12:30 - enP1p4s0u1u1 is UP
+[INFO] 2025-06-11 10:12:31 - Assigned IP: 10.0.0.55
+[PASS] 2025-06-11 10:12:35 - Ping successful on enP1p4s0u1u1
+```

Runner/suites/Connectivity/Ethernet/run.sh

@@ -36,57 +36,86 @@ test_path=$(find_test_case_by_name "$TESTNAME") || {
 cd "$test_path" || exit 1
 res_file="./$TESTNAME.res"
 rm -f "$res_file"
+summary_file="./$TESTNAME.summary"
+rm -f "$res_file" "$summary_file"
 
 log_info "--------------------------------------------------------------------------"
 log_info "-------------------Starting $TESTNAME Testcase----------------------------"
- 
+
+# Check for dependencies
 check_dependencies ip ping
- 
-IFACE="eth0"
-RETRIES=3
-SLEEP_SEC=3
- 
-# Check interface existence
-if ! ip link show "$IFACE" >/dev/null 2>&1; then
-    log_fail "Ethernet interface $IFACE not found"
-    echo "FAIL $TESTNAME" > "$res_file"
-    exit 1
+
+# User-specified interface (argument) or all detected
+# Accept user-preferred interface as argument
+user_iface="$1"
+if [ -n "$user_iface" ]; then
+    IFACES="$user_iface"
+    log_info "User specified interface: $user_iface"
+else
+    IFACES=$(get_ethernet_interfaces)
+    log_info "Auto-detected Ethernet interfaces: $IFACES"
 fi
- 
-# Bring up interface with retries
-log_info "Ensuring $IFACE is UP..."
-i=0
-while [ $i -lt $RETRIES ]; do
-    ip link set "$IFACE" up
-    sleep "$SLEEP_SEC"
-    if ip link show "$IFACE" | grep -q "state UP"; then
-        log_info "$IFACE is UP"
-        break
+
+iface_passed=0
+iface_failed=0
+iface_skipped=0
+
+for iface in $IFACES; do
+    log_info "---- Testing interface: $iface ----"
+
+    # Check if interface is up
+    if ! is_interface_up "$iface"; then
+        log_warn "$iface is DOWN, skipping"
+        echo "$iface: SKIP (down/no cable)" >> "$summary_file"
+        iface_skipped=$((iface_skipped+1))
+        continue
+    fi
+
+    ip_addr="$(get_ip_address "$iface")"
+
+    if [ -z "$ip_addr" ]; then
+        log_info "$iface has no IP, attempting DHCP"
+        run_dhcp_client "$iface" 10
+        sleep 2
+        ip_addr="$(get_ip_address "$iface")"
+    fi
+
+    if [ -z "$ip_addr" ]; then
+        log_warn "$iface has no IP assigned, skipping"
+        echo "$iface: SKIP (no IP assigned)" >> "$summary_file"
+        iface_skipped=$((iface_skipped+1))
+        continue
+    elif echo "$ip_addr" | grep -q '^169\.254'; then
+        log_warn "$iface got only link-local IP ($ip_addr), skipping"
+        echo "$iface: SKIP (link-local IP: $ip_addr)" >> "$summary_file"
+        iface_skipped=$((iface_skipped+1))
+        continue
+    else
+        log_info "$iface got IP: $ip_addr"
+    fi
+
+    # Ping test
+    if ping -I "$iface" -c 4 -W 2 8.8.8.8 >/dev/null 2>&1; then
+        log_pass "$iface connectivity verified via ping"
+        echo "$iface: PASS" >> "$summary_file"
+        iface_passed=$((iface_passed+1))
+    else
+        log_fail "Ping test failed for $iface"
+        echo "$iface: FAIL (ping failed)" >> "$summary_file"
+        iface_failed=$((iface_failed+1))
     fi
-    log_warn "$IFACE is still DOWN (attempt $((i + 1))/$RETRIES)..."
-    i=$((i + 1))
 done
- 
-if [ $i -eq $RETRIES ]; then
-    log_fail "Failed to bring up $IFACE after $RETRIES attempts"
-    echo "FAIL $TESTNAME" > "$res_file"
+
+log_info "---- Ethernet Interface Test Summary ----"
+cat "$summary_file"
+
+if [ "$iface_passed" -gt 0 ]; then
+    echo "$TESTNAME PASS" > "$res_file"
+    exit 0
+elif [ "$iface_failed" -gt 0 ]; then
+    echo "$TESTNAME FAIL" > "$res_file"
     exit 1
+else
+    echo "$TESTNAME SKIP" > "$res_file"
+    exit 2
 fi
- 
-# Ping test with retries
-log_info "Running ping test to 8.8.8.8 via $IFACE..."
-i=0
-while [ $i -lt $RETRIES ]; do
-    if ping -I "$IFACE" -c 4 -W 2 8.8.8.8 >/dev/null 2>&1; then
-        log_pass "Ethernet connectivity verified via ping"
-        echo "PASS $TESTNAME" > "$res_file"
-        exit 0
-    fi
-    log_warn "Ping failed (attempt $((i + 1))/$RETRIES)... retrying"
-    sleep "$SLEEP_SEC"
-    i=$((i + 1))
-done
- 
-log_fail "Ping test failed after $RETRIES attempts"
-echo "FAIL $TESTNAME" > "$res_file"
-exit 1

Runner/utils/functestlib.sh

@@ -3,6 +3,9 @@
 # Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
 # SPDX-License-Identifier: BSD-3-Clause-Clear
 
+# Suppress 'Broken pipe' errors globally in this shell (put this at the very top once)
+trap '' PIPE
+
 # --- Logging helpers ---
 log() {
     level=$1
@@ -391,3 +394,135 @@ weston_start() {
     fi
 }
 
+# Returns true (0) if interface is administratively and physically up
+is_interface_up() {
+    iface="$1"
+    if [ -f "/sys/class/net/$iface/operstate" ]; then
+        [ "$(cat "/sys/class/net/$iface/operstate")" = "up" ]
+    elif command -v ip >/dev/null 2>&1; then
+        ip link show "$iface" 2>/dev/null | grep -qw "state UP"
+    elif command -v ifconfig >/dev/null 2>&1; then
+        ifconfig "$iface" 2>/dev/null | grep -qw "UP"
+    else
+        return 1
+    fi
+}
+
+# Returns true (0) if physical link/carrier is detected (cable plugged in)
+is_link_up() {
+    iface="$1"
+    [ -f "/sys/class/net/$iface/carrier" ] && [ "$(cat "/sys/class/net/$iface/carrier")" = "1" ]
+}
+
+# Returns true (0) if interface is Ethernet type (type 1 in sysfs)
+is_ethernet_interface() {
+    iface="$1"
+    [ -f "/sys/class/net/$iface/type" ] && [ "$(cat "/sys/class/net/$iface/type")" = "1" ]
+}
+
+# Get all Ethernet interfaces (excluding common virtual types)
+get_ethernet_interfaces() {
+    for path in /sys/class/net/*; do
+        iface=$(basename "$path")
+        case "$iface" in
+            lo|docker*|br-*|veth*|virbr*|tap*|tun*|wl*) continue ;;
+        esac
+        if is_ethernet_interface "$iface"; then
+            echo "$iface"
+        fi
+    done
+}
+
+# Bring up interface with retries (down before up).
+bringup_interface() {
+    iface="$1"; retries="${2:-3}"; sleep_sec="${3:-2}"; i=0
+    while [ $i -lt "$retries" ]; do
+        if command -v ip >/dev/null 2>&1; then
+            ip link set "$iface" down
+            sleep 1
+            ip link set "$iface" up
+            sleep "$sleep_sec"
+            ip link show "$iface" | grep -q "state UP" && return 0
+        elif command -v ifconfig >/dev/null 2>&1; then
+            ifconfig "$iface" down
+            sleep 1
+            ifconfig "$iface" up
+            sleep "$sleep_sec"
+            ifconfig "$iface" | grep -q "UP" && return 0
+        fi
+        i=$((i + 1))
+    done
+    return 1
+}
+
+# Wait for a valid IPv4 address on the given interface, up to a timeout (default 30s)
+wait_for_ip_address() {
+    iface="$1"
+    timeout="${2:-30}"
+    elapsed=0
+    while [ "$elapsed" -lt "$timeout" ]; do
+        ip_addr=$(get_ip_address "$iface")
+        if [ -n "$ip_addr" ]; then
+            if echo "$ip_addr" | grep -q '^169\.254'; then
+                echo "$ip_addr"
+                return 2
+            fi
+            echo "$ip_addr"
+            return 0
+        fi
+        sleep 1
+        elapsed=$((elapsed + 1))
+    done
+    return 1
+}
+
+# Get the IPv4 address for a given interface.
+get_ip_address() {
+    iface="$1"
+    if command -v ip >/dev/null 2>&1; then
+        ip -4 -o addr show "$iface" | awk '{print $4}' | cut -d/ -f1 | head -n1
+    elif command -v ifconfig >/dev/null 2>&1; then
+        ifconfig "$iface" 2>/dev/null | awk '/inet / {print $2}' | head -n1
+    fi
+}
+
+# Run a command with a timeout (in seconds)
+run_with_timeout() {
+    timeout="$1"; shift
+    ( "$@" ) &
+    pid=$!
+    ( sleep "$timeout"; kill "$pid" 2>/dev/null ) &
+    watcher=$!
+    wait $pid 2>/dev/null
+    status=$?
+    kill $watcher 2>/dev/null
+    return $status
+}
+
+# DHCP client logic (dhclient and udhcpc with timeouts)
+run_dhcp_client() {
+    iface="$1"
+    timeout="${2:-10}"
+    ip_addr=""
+    log_info "Attempting DHCP on $iface (timeout ${timeout}s)..."
+    if command -v dhclient >/dev/null 2>&1; then
+        log_info "Trying dhclient for $iface"
+        run_with_timeout "$timeout" dhclient "$iface"
+        ip_addr=$(wait_for_ip_address "$iface" 5)
+        if [ -n "$ip_addr" ]; then
+            echo "$ip_addr"
+            return 0
+        fi
+    fi
+    if command -v udhcpc >/dev/null 2>&1; then
+        log_info "Trying udhcpc for $iface"
+        run_with_timeout "$timeout" udhcpc -i "$iface" -T 3 -t 3
+        ip_addr=$(wait_for_ip_address "$iface" 5)
+        if [ -n "$ip_addr" ]; then
+            echo "$ip_addr"
+            return 0
+        fi
+    fi
+    log_warn "DHCP failed for $iface"
+    return 1
+}