test: refactor run.sh to use common functestlib.sh functions

- Integrated log_info, log_pass, log_fail, log_error, and check_dependencies
- Ensured compatibility with both standalone and run-test.sh execution
- Improved maintainability and consistency across test suites

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

Author: smuppand

Runner/init_env

@@ -1,11 +1,7 @@
 #!/bin/sh
-# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
 # SPDX-License-Identifier: BSD-3-Clause-Clear
-
-# Source this file to setup the test suite environment
-BASEDIR=$(pwd)
-export BASEDIR
-TOOLS=$(pwd)/utils
-export TOOLS
-SUITES=$(pwd)/suites
-export SUITES
+ 
+# Base directory of Runner
+BASE_DIR="$(CDPATH= cd -- "$(dirname "$0")" >/dev/null 2>&1 && pwd)"
+export TOOLS="${BASE_DIR}/utils"
+export __RUNNER_SUITES_DIR="${BASE_DIR}/suites"

Runner/run-test.sh

@@ -3,70 +3,91 @@
 # Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
 # SPDX-License-Identifier: BSD-3-Clause-Clear
 
-# Import test suite definitions
-. "${PWD}"/init_env
+# Exit on any command failure (optional for stricter CI)
+#set -e
 
-#import test functions library
-. "${TOOLS}"/functestlib.sh
+# shellcheck disable=SC1007
+SCRIPT_DIR="$(CDPATH=cd -- "$(dirname "$0")" >/dev/null 2>&1 && pwd)"
+# shellcheck source=/dev/null
+. "${SCRIPT_DIR}/init_env"
+# shellcheck source=/dev/null
+. "${TOOLS}/functestlib.sh"
 
-
-# Find test case path by name
-find_test_case_by_name() {
-    # Check if the file is a directory
-  if [ -d "$1" ]; then
-    # Get the directory name
-    dir_name_in_dir=${1##*/}
-
-    # Check if the directory name matches the user input
-    if [ "${dir_name_in_dir}" = "$test_name" ]; then
-      # Get the absolute path of the directory
-      abs_path=$(readlink -f "$1")
-      echo "$abs_path"  
-    fi
-  fi
-
-  # Recursively search for the directory in the subdirectory
-  for file in "$1"/*; do
-    # Check if the file is a directory
-    if [ -d "$file" ]; then
-      # Recursively search for the directory in the subdirectory
-      find_test_case_by_name "$file"
-    fi
-  done
-}
+# Store results
+RESULTS_PASS=""
+RESULTS_FAIL=""
 
 # Execute a test case
 execute_test_case() {
     local test_path="$1"
+    local test_name
+    test_name=$(basename "$test_path")
+
     if [ -d "$test_path" ]; then
         run_script="$test_path/run.sh"
         if [ -f "$run_script" ]; then
-            log "Executing test case: $test_path"
-            sh "$run_script" 2>&1 
+            log "Executing test case: $test_name"
+            if (cd "$test_path" && sh "./run.sh"); then
+                log_pass "$test_name passed"
+                RESULTS_PASS=$(printf "%s\n%s" "$RESULTS_PASS" "$test_name")
+            else
+                log_fail "$test_name failed"
+                RESULTS_FAIL=$(printf "%s\n%s" "$RESULTS_FAIL" "$test_name")
+            fi
         else
-            log "No run.sh found in $test_path"
+            log_error "No run.sh found in $test_path"
+            RESULTS_FAIL=$(printf "%s\n%s" "$RESULTS_FAIL" "$test_name (missing run.sh)")
         fi
     else
-        log "Test case directory not found: $test_path"
+        log_error "Test case directory not found: $test_path"
+        RESULTS_FAIL=$(printf "%s\n%s" "$RESULTS_FAIL" "$test_name (directory not found)")
     fi
 }
 
-# Function to run a specific test case by name
+# Run test by name
 run_specific_test_by_name() {
-    test_name="$1"
-    test_path=$(find_test_case_by_name ".")
+    local test_name="$1"
+    local test_path
+    test_path=$(find_test_case_by_name "$test_name")
     if [ -z "$test_path" ]; then
-        log "Test case with name $test_name not found."
+        log_error "Test case with name $test_name not found."
+        RESULTS_FAIL=$(printf "%s\n%s" "$RESULTS_FAIL" "$test_name (not found)")
     else
         execute_test_case "$test_path"
     fi
 }
 
-# Main script logic
+# Run all test cases
+run_all_tests() {
+    find "${__RUNNER_SUITES_DIR}" -type d -name '[A-Za-z]*' -maxdepth 3 | while IFS= read -r test_dir; do
+        if [ -f "$test_dir/run.sh" ]; then
+            execute_test_case "$test_dir"
+        fi
+    done
+}
+
+# Print final summary
+print_summary() {
+    echo
+    log_info "========== Test Summary =========="
+    echo "PASSED:"
+    [ -n "$RESULTS_PASS" ] && printf "%s\n" "$RESULTS_PASS" || echo " None"
+    echo
+    echo "FAILED:"
+    [ -n "$RESULTS_FAIL" ] && printf "%s\n" "$RESULTS_FAIL" || echo " None"
+    log_info "=================================="
+}
+
+# Main
 if [ "$#" -eq 0 ]; then
     log "Usage: $0 [all | <testcase_name>]"
     exit 1
 fi
 
+if [ "$1" = "all" ]; then
+    run_all_tests
+else
+    run_specific_test_by_name "$1"
+fi
 
-run_specific_test_by_name "$1"
+print_summary

Runner/suites/Kernel/FunctionalArea/baseport/CPUFreq_Validation/run.sh

@@ -3,9 +3,26 @@
 # Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
 # SPDX-License-Identifier: BSD-3-Clause-Clear
 
-. "${PWD}/init_env"
+# Resolve the directory containing this script
+SCRIPT_DIR=$(CDPATH=cd -- "$(dirname "$0")" >/dev/null 2>&1 && pwd)
+
+# Traverse upward to find Runner root containing utils/
+RUNNER_DIR="$SCRIPT_DIR"
+while [ ! -d "$RUNNER_DIR/utils" ] && [ "$RUNNER_DIR" != "/" ]; do
+  RUNNER_DIR=$(dirname "$RUNNER_DIR")
+done
+
+FUNCLIB="$RUNNER_DIR/utils/functestlib.sh"
+
+if [ ! -f "$FUNCLIB" ]; then
+  echo "Error: Could not locate functestlib.sh from $SCRIPT_DIR" >&2
+  exit 1
+fi
+
+# shellcheck disable=SC1090
+. "$FUNCLIB"
+
 TESTNAME="CPUFreq_Validation"
-. "$TOOLS/functestlib.sh"
 
 test_path=$(find_test_case_by_name "$TESTNAME")
 log_info "-----------------------------------------------------------------------------------------"
@@ -75,7 +92,7 @@ validate_cpu_core() {
     done
 
     echo "Restoring $cpu governor to 'ondemand'..."
-    echo "ondemand" | sudo tee "$cpu/cpufreq/scaling_governor" > /dev/null
+    echo "ondemand" | tee "$cpu/cpufreq/scaling_governor" > /dev/null
 }
 
 cpu_index=0

Runner/utils/functestlib.sh

@@ -1,45 +1,45 @@
 #!/bin/sh
 
-# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
+# Copyright (c) Qualcomm Technologies, Inc.
 # SPDX-License-Identifier: BSD-3-Clause-Clear
 
-# Import test suite definitions
-. "${PWD}"/init_env
-#import platform
-. "${TOOLS}"/platform.sh
+# Resolve the directory of this script
+UTILS_DIR=$(CDPATH=cd -- "$(dirname "$0")" >/dev/null 2>&1 && pwd)
 
-__RUNNER_SUITES_DIR="/var/Runner/suites"
-__RUNNER_UTILS_BIN_DIR="/var/common"
+# Safely source init_env if present
+if [ -f "$UTILS_DIR/init_env" ]; then
+    # shellcheck disable=SC1090
+    . "$UTILS_DIR/init_env"
+fi
 
-#This function used for test logging
+# Import platform script if available
+if [ -f "${TOOLS}/platform.sh" ]; then
+    # shellcheck disable=SC1090
+    . "${TOOLS}/platform.sh"
+fi
+
+# Set common directories (fallback if init_env not sourced)
+__RUNNER_SUITES_DIR="${__RUNNER_SUITES_DIR:-${ROOT_DIR}/suites}"
+#__RUNNER_UTILS_BIN_DIR="${__RUNNER_UTILS_BIN_DIR:-${ROOT_DIR}/common}"
+
+# Logging function
 log() {
     local level="$1"
     shift
-    # echo "$(date '+%Y-%m-%d %H:%M:%S') - $message" | tee -a /var/test_framework.log
     echo "[$level] $(date '+%Y-%m-%d %H:%M:%S') - $*" | tee -a /var/test_output.log
 }
-# Find test case path by name
-find_test_case_by_name() {
-    local test_name="$1"
-    find $__RUNNER_SUITES_DIR -type d -iname "$test_name" 2>/dev/null
-}
-
-# Find test case path by name
-find_test_case_bin_by_name() {
-    local test_name="$1"
-    find $__RUNNER_UTILS_BIN_DIR -type f -iname "$test_name" 2>/dev/null
-}
 
-# Find test case path by name
-find_test_case_script_by_name() {
-    local test_name="$1"
-    find $__RUNNER_UTILS_BIN_DIR -type d -iname "$test_name" 2>/dev/null
-}
+# Logging levels
+log_info() { log "INFO" "$@"; }
+log_pass() { log "PASS" "$@"; }
+log_fail() { log "FAIL" "$@"; }
+log_error() { log "ERROR" "$@"; }
 
+# Dependency check
 check_dependencies() {
     local missing=0
     for cmd in "$@"; do
-        if ! command -v "$cmd" > /dev/null 2>&1; then
+        if ! command -v "$cmd" >/dev/null 2>&1; then
             log_error "ERROR: Required command '$cmd' not found in PATH."
             missing=1
         fi
@@ -48,38 +48,46 @@ check_dependencies() {
         log_error "Exiting due to missing dependencies."
         exit 1
     else
-    log_pass "Test related dependencies are present."
+        log_pass "Test related dependencies are present."
     fi
 }
 
-# Logging levels
-log_info() { log "INFO" "$@"; }
-log_pass() { log "PASS" "$@"; }
-log_fail() { log "FAIL" "$@"; }
-log_error() { log "ERROR" "$@"; }
+# Test case path search functions
+find_test_case_by_name() {
+    local test_name="$1"
+    find "$__RUNNER_SUITES_DIR" -type d -iname "$test_name" 2>/dev/null
+}
 
+find_test_case_bin_by_name() {
+    local test_name="$1"
+    find "$__RUNNER_UTILS_BIN_DIR" -type f -iname "$test_name" 2>/dev/null
+}
+
+find_test_case_script_by_name() {
+    local test_name="$1"
+    find "$__RUNNER_UTILS_BIN_DIR" -type d -iname "$test_name" 2>/dev/null
+}
 
-## this doc fn comes last
+# Documentation printer
 FUNCTIONS="\
 log_info \
 log_pass \
 log_fail \
 log_error \
 find_test_case_by_name \
 find_test_case_bin_by_name \
-find_test_case_script_by_name  \
+find_test_case_script_by_name \
 log \
 "
 
-functestlibdoc()
-{
-  echo "functestlib.sh"
-  echo ""
-  echo "Functions:"
-  for fn in $FUNCTIONS; do
-    echo $fn
-    eval $fn"_doc"
+functestlibdoc() {
+    echo "functestlib.sh"
     echo ""
-  done
-  echo "Note, these functions will probably not work with >=32 CPUs"
+    echo "Functions:"
+    for fn in $FUNCTIONS; do
+        echo "$fn"
+        eval "$fn""_doc"
+        echo ""
+    done
+    echo "Note: These functions may not behave as expected on systems with >=32 CPUs"
 }