WiFi_Manual_IP: Refactor run.sh to use modular helpers, safe cleanup, and trap-based restore

- Switch WiFi_Manual_IP/run.sh to only use modular helper functions from functestlib.sh.
- Add 'trap' to always restore original udhcpc script on test exit, ensuring testbed is left clean.
- Use wifi_write_wpa_conf for WPA config creation (eliminate code duplication).
- Use ensure_udhcpc_script and restore_udhcpc_script for robust script handling.
- Harden cleanup and error handling (all exits go through helpers).
- Improved logging, POSIX and ShellCheck compliance.
- No change in test semantics or interface.

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

Author: smuppand

Runner/suites/Connectivity/WiFi/WiFi_Dynamic_IP/README_WiFi_Connectivity.md

@@ -0,0 +1,75 @@
+Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
+SPDX-License-Identifier: BSD-3-Clause-Clear
+
+# WiFi Connectivity Validation
+
+## 📋 Overview
+
+This test validates WiFi functionality by:
+
+- Connecting to an access point (AP) using either `nmcli` or `wpa_supplicant`.
+- Verifying IP acquisition via DHCP.
+- Checking internet connectivity with a `ping` test.
+- Handling systemd network service status.
+- Supporting flexible SSID/password input via arguments, environment, or file.
+
+## ✅ SSID/PASSWORD Input Priority (Hybrid Approach)
+
+1. **Command-line arguments**:
+   ```sh
+   ./run.sh "MySSID" "MyPassword"
+   ```
+
+2. **Environment variables**:
+   ```sh
+   SSID_ENV=MySSID PASSWORD_ENV=MyPassword ./run.sh
+   ```
+
+3. **Fallback to `ssid_list.txt` file** (if above not set):
+   ```txt
+   MySSID MyPassword
+   ```
+
+## ⚙️ Supported Tools
+
+- Primary: `nmcli`
+- Fallback: `wpa_supplicant`, `udhcpc`, `ifconfig`
+
+Ensure these tools are available in the system before running the test. Missing tools are detected and logged as skipped/failure.
+
+## 🧪 Test Flow
+
+1. **Dependency check** – verifies necessary binaries are present.
+2. **Systemd services check** – attempts to start network services if inactive.
+3. **WiFi connect (nmcli or wpa_supplicant)** – based on tool availability.
+4. **IP assignment check** – validates `ifconfig wlan0` output.
+5. **Internet test** – pings `8.8.8.8` to confirm outbound reachability.
+6. **Result logging** – writes `.res` file and logs all actions.
+
+## 🧾 Output
+
+- `WiFi_Connectivity.res`: Contains `WiFi_Connectivity PASS` or `FAIL`.
+- Logs are printed using `log_info`, `log_pass`, and `log_fail` from `functestlib.sh`.
+
+## 📂 Directory Structure
+
+```
+WiFi/
+├── run.sh
+├── ssid_list.txt (optional)
+├── README.md
+```
+
+## 🌐 Integration (meta-qcom_PreMerge.yaml)
+
+Add this test with SSID parameters as follows:
+
+```yaml
+- name: WiFi_Connectivity
+  path: Runner/suites/Connectivity/WiFi
+  timeout:
+    minutes: 5
+  params:
+    SSID_ENV: "xxxx"
+    PASSWORD_ENV: "xxxx"
+```

Runner/suites/Connectivity/WiFi/WiFi_Dynamic_IP/run.sh

@@ -0,0 +1,75 @@
+#!/bin/sh
+
+# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
+# SPDX-License-Identifier: BSD-3-Clause-Clear
+
+# Robustly find and source init_env
+SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
+INIT_ENV=""
+SEARCH="$SCRIPT_DIR"
+while [ "$SEARCH" != "/" ]; do
+    if [ -f "$SEARCH/init_env" ]; then
+        INIT_ENV="$SEARCH/init_env"
+        break
+    fi
+    SEARCH=$(dirname "$SEARCH")
+done
+
+if [ -z "$INIT_ENV" ]; then
+    echo "[ERROR] Could not find init_env (starting at $SCRIPT_DIR)" >&2
+    exit 1
+fi
+
+# shellcheck disable=SC1090
+if [ -z "$__INIT_ENV_LOADED" ]; then
+    . "$INIT_ENV"
+fi
+
+# shellcheck disable=SC1090,SC1091
+. "$TOOLS/functestlib.sh"
+
+TESTNAME="WiFi_Dynamic_IP"
+#res_file="./$TESTNAME.res"
+test_path=$(find_test_case_by_name "$TESTNAME")
+cd "$test_path" || exit 1
+
+log_info "-------------------------------------------------------------"
+log_info "------------------- Starting $TESTNAME Test -----------------"
+
+# Credential extraction
+creds=$(get_wifi_credentials "$1" "$2") || log_skip_exit "$TESTNAME" "WiFi: SSID and/or password missing. Skipping test." wifi_cleanup ""
+SSID=$(echo "$creds" | awk '{print $1}')
+PASSWORD=$(echo "$creds" | awk '{print $2}')
+log_info "Using SSID='$SSID' and PASSWORD='[hidden]'"
+
+check_dependencies iw ping
+
+# If not a kernel-only/minimal build, systemd is checked, else skipped automatically
+check_systemd_services systemd-networkd.service || log_fail_exit "$TESTNAME" "Network services check failed" wifi_cleanup ""
+
+WIFI_IFACE=$(get_wifi_interface) || log_fail_exit "$TESTNAME" "No WiFi interface found" wifi_cleanup ""
+log_info "Using WiFi interface: $WIFI_IFACE"
+
+# nmcli with retry
+if wifi_connect_nmcli "$WIFI_IFACE" "$SSID" "$PASSWORD"; then
+    IP=$(wifi_get_ip "$WIFI_IFACE")
+    [ -z "$IP" ] && log_fail_exit "$TESTNAME" "No IP after nmcli" wifi_cleanup "$WIFI_IFACE"
+    if retry_command "ping -I \"$WIFI_IFACE\" -c 3 -W 2 8.8.8.8 >/dev/null 2>&1" 3 3; then
+        log_pass_exit "$TESTNAME" "Internet connectivity verified via ping" wifi_cleanup "$WIFI_IFACE"
+    else
+        log_fail_exit "$TESTNAME" "Ping test failed after nmcli connection" wifi_cleanup "$WIFI_IFACE"
+    fi
+fi
+
+# wpa_supplicant+udhcpc with retry
+if wifi_connect_wpa_supplicant "$WIFI_IFACE" "$SSID" "$PASSWORD"; then
+    IP=$(wifi_get_ip "$WIFI_IFACE")
+    [ -z "$IP" ] && log_fail_exit "$TESTNAME" "No IP after wpa_supplicant" wifi_cleanup "$WIFI_IFACE"
+    if retry_command "ping -I \"$WIFI_IFACE\" -c 3 -W 2 8.8.8.8 >/dev/null 2>&1" 3 3; then
+        log_pass_exit "$TESTNAME" "Internet connectivity verified via ping" wifi_cleanup "$WIFI_IFACE"
+    else
+        log_fail_exit "$TESTNAME" "Ping test failed after wpa_supplicant connection" wifi_cleanup "$WIFI_IFACE"
+    fi
+fi
+
+log_fail_exit "$TESTNAME" "All WiFi connection methods failed for $WIFI_IFACE (SSID: $SSID)" wifi_cleanup "$WIFI_IFACE"

Runner/suites/Connectivity/WiFi/WiFi_Dynamic_IP/ssid_list.txt

@@ -0,0 +1,97 @@
+#!/bin/sh
+
+# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
+# SPDX-License-Identifier: BSD-3-Clause-Clear
+
+# Robustly find and source init_env
+SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
+INIT_ENV=""
+SEARCH="$SCRIPT_DIR"
+while [ "$SEARCH" != "/" ]; do
+    if [ -f "$SEARCH/init_env" ]; then
+        INIT_ENV="$SEARCH/init_env"
+        break
+    fi
+    SEARCH=$(dirname "$SEARCH")
+done
+
+if [ -z "$INIT_ENV" ]; then
+    echo "[ERROR] Could not find init_env (starting at $SCRIPT_DIR)" >&2
+    exit 1
+fi
+
+# Only source if not already loaded (idempotent)
+if [ -z "$__INIT_ENV_LOADED" ]; then
+    # shellcheck disable=SC1090
+    . "$INIT_ENV"
+fi
+# Always source functestlib.sh, using $TOOLS exported by init_env
+# shellcheck disable=SC1090,SC1091
+. "$TOOLS/functestlib.sh"
+
+TESTNAME="WiFi_Firmware_Driver"
+test_path=$(find_test_case_by_name "$TESTNAME")
+cd "$test_path" || exit 1
+
+log_info "--------------------------------------------------------------------------"
+log_info "-------------------Starting $TESTNAME Testcase----------------------------"
+log_info "=== Test Initialization ==="
+
+check_dependencies find grep modprobe lsmod cat
+
+# Detect SoC from /proc/device-tree/model
+if [ -f /proc/device-tree/model ]; then
+    read -r soc_model < /proc/device-tree/model
+else
+    soc_model="Unknown"
+fi
+log_info "Detected SoC model: $soc_model"
+
+# Scan firmware
+log_info "Scanning for WiFi firmware under /lib/firmware/ath11k/..."
+fwfile=""
+if find /lib/firmware/ath11k/ -type f -name "amss.bin" -print -quit 2>/dev/null | grep -q .; then
+    fwfile=$(find /lib/firmware/ath11k/ -type f -name "amss.bin" -print -quit 2>/dev/null)
+elif find /lib/firmware/ath11k/ -type f -name "wpss.mbn" -print -quit 2>/dev/null | grep -q .; then
+    fwfile=$(find /lib/firmware/ath11k/ -type f -name "wpss.mbn" -print -quit 2>/dev/null)
+fi
+
+if [ -z "$fwfile" ]; then
+    log_skip_exit "$TESTNAME" "No WiFi firmware (amss.bin or wpss.mbn) found under /lib/firmware/ath11k/"
+fi
+
+size=$(stat -c%s "$fwfile" 2>/dev/null)
+basename=$(basename "$fwfile")
+log_info "Detected firmware [$basename]: $fwfile (size: $size bytes)"
+
+case "$basename" in
+    wpss.mbn)
+        log_info "Platform using wpss.mbn firmware (e.g., Kodiak)"
+        if validate_remoteproc_running "wpss"; then
+            log_info "Remoteproc 'wpss' is active and validated."
+        else
+            log_fail_exit "$TESTNAME" "Remoteproc 'wpss' validation failed."
+        fi
+        log_info "No module load needed for wpss-based platform (e.g., Kodiak)."
+        ;;
+    amss.bin)
+        log_info "amss.bin firmware detected (e.g., WCN6855 - Lemans/Monaco)"
+        if ! modprobe ath11k_pci 2>/dev/null; then
+            log_fail_exit "$TESTNAME" "Failed to load ath11k_pci module."
+        fi
+        ;;
+    *)
+        log_skip_exit "$TESTNAME" "Unsupported firmware type: $basename"
+        ;;
+esac
+
+log_info "Checking active ath11k-related kernel modules via lsmod..."
+if lsmod | grep -Eq '^ath11k(_.*)?\s'; then
+    lsmod | grep -E '^ath11k(_.*)?\s' | while read -r mod_line; do
+        log_info "  Module loaded: $mod_line"
+    done
+else
+    log_fail_exit "$TESTNAME" "No ath11k-related kernel module detected via lsmod"
+fi
+
+log_pass_exit "$TESTNAME" "WiFi firmware and driver validation successful."

Runner/suites/Connectivity/WiFi/WiFi_Firmware_Driver/run.sh

@@ -0,0 +1,89 @@
+#!/bin/sh
+# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
+# SPDX-License-Identifier: BSD-3-Clause-Clear
+
+# Robustly find and source init_env
+SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
+INIT_ENV=""
+SEARCH="$SCRIPT_DIR"
+while [ "$SEARCH" != "/" ]; do
+    if [ -f "$SEARCH/init_env" ]; then
+        INIT_ENV="$SEARCH/init_env"
+        break
+    fi
+    SEARCH=$(dirname "$SEARCH")
+done
+
+if [ -z "$INIT_ENV" ]; then
+    echo "[ERROR] Could not find init_env (starting at $SCRIPT_DIR)" >&2
+    exit 1
+fi
+
+# Only source if not already loaded (idempotent)
+if [ -z "$__INIT_ENV_LOADED" ]; then
+    # shellcheck disable=SC1090
+    . "$INIT_ENV"
+fi
+# Always source functestlib.sh, using $TOOLS exported by init_env
+# shellcheck disable=SC1090,SC1091
+. "$TOOLS/functestlib.sh"
+
+TESTNAME="WiFi_Manual_IP"
+test_path=$(find_test_case_by_name "$TESTNAME")
+cd "$test_path" || exit 1
+
+log_info "--------------------------------------------------------------------------"
+log_info "-------------------Starting $TESTNAME Testcase----------------------------"
+log_info "=== Test Initialization ==="
+
+# Trap to always restore udhcpc script
+trap 'restore_udhcpc_script' EXIT
+
+# Credential extraction (from arguments, env, or ssid_list.txt)
+if ! CRED=$(get_wifi_credentials "$1" "$2") || [ -z "$CRED" ]; then
+    log_skip_exit "$TESTNAME" "WiFi: SSID and/or password missing. Skipping test."
+fi
+
+SSID=$(echo "$CRED" | awk '{print $1}')
+PASSWORD=$(echo "$CRED" | awk '{print $2}')
+log_info "Using SSID='$SSID' and PASSWORD='[hidden]'"
+
+check_dependencies iw wpa_supplicant udhcpc ip
+
+WIFI_IF=$(get_wifi_interface)
+[ -z "$WIFI_IF" ] && log_fail_exit "$TESTNAME" "No WiFi interface detected."
+
+UDHCPC_SCRIPT=$(ensure_udhcpc_script)
+[ ! -x "$UDHCPC_SCRIPT" ] && log_fail_exit "$TESTNAME" "Failed to create udhcpc script."
+
+wifi_cleanup() {
+    killall -q wpa_supplicant 2>/dev/null
+    rm -f /tmp/wpa_supplicant.conf wpa.log
+    ip link set "$WIFI_IF" down 2>/dev/null
+}
+
+# Generate WPA config using helper (no duplicate code!)
+WPA_CONF="$(wifi_write_wpa_conf "$WIFI_IF" "$SSID" "$PASSWORD")"
+if [ ! -f "$WPA_CONF" ]; then
+    log_fail_exit "$TESTNAME" "Failed to create WPA config" wifi_cleanup
+fi
+
+killall -q wpa_supplicant 2>/dev/null
+wpa_supplicant -B -i "$WIFI_IF" -c "$WPA_CONF" 2>&1 | tee wpa.log
+sleep 4
+
+# Run udhcpc with the script
+udhcpc -i "$WIFI_IF" -s "$UDHCPC_SCRIPT" -n -q &
+sleep 8
+
+IP=$(ip addr show "$WIFI_IF" | awk '/inet / {print $2}' | cut -d/ -f1)
+if [ -n "$IP" ]; then
+    log_info "WiFi got IP: $IP (manual DHCP via udhcpc)"
+    if ping -I "$WIFI_IF" -c 3 -W 2 8.8.8.8 >/dev/null 2>&1; then
+        log_pass_exit "$TESTNAME" "WiFi: Internet connectivity verified via ping" wifi_cleanup
+    else
+        log_fail_exit "$TESTNAME" "WiFi: Ping test failed after DHCP/manual IP" wifi_cleanup
+    fi
+else
+    log_fail_exit "$TESTNAME" "Failed to acquire IP via udhcpc" wifi_cleanup
+fi