linter checks

Author: samirans89

mac/common-utils.sh

@@ -1,5 +1,6 @@
 #!/bin/bash
 
+# shellcheck source=/dev/null
 source "$(dirname "$0")/device-machine-allocation.sh"
 
 # # ===== Global Variables =====
@@ -41,20 +42,21 @@ log_msg_to() {
     # write to dest file if provided
     if [ -n "$dest_file" ]; then
         mkdir -p "$(dirname "$dest_file")"
-        echo "$line" >> $NOW_RUN_LOG_FILE
+        echo "$line" >> "$NOW_RUN_LOG_FILE"
     fi
 }
 
 # Spinner function for long-running processes
 show_spinner() {
     local pid=$1
+    # shellcheck disable=SC1003
     local spin='|/-\'
     local i=0
     local ts
     ts="$(date +"%Y-%m-%d %H:%M:%S")"
     while kill -0 "$pid" 2>/dev/null; do
         i=$(( (i+1) %4 ))
-        printf "\r⏳ Processing... ${spin:$i:1}"
+        printf "\r⏳ Processing... %s" "${spin:$i:1}"
         sleep 0.1
     done
     echo ""
@@ -119,7 +121,7 @@ upload_sample_app() {
     log_msg_to "Exported BROWSERSTACK_APP=$BROWSERSTACK_APP"
 
     if [ -z "$app_url" ]; then
-        log_msg_to "❌ Upload failed. Response: $UPLOAD_RESPONSE"
+        log_msg_to "❌ Upload failed. Response: $upload_response"
         return 1
     fi
 
@@ -292,7 +294,7 @@ identify_run_status_java() {
     skipped=$(echo "$line" | grep -m 1 -oE "Skipped: [0-9]+" | awk '{print $2}')
 
     # Calculate passed tests
-    passed=$(( $tests_run - ($failures + $errors + $skipped) ))
+    passed=$(( tests_run-(failures+errors+skipped) ))
 
     # Check condition
     if (( passed > 0 )); then
@@ -302,8 +304,6 @@ identify_run_status_java() {
         log_error "Error: No tests passed (Tests run: $tests_run, Failures: $failures, Errors: $errors, Skipped: $skipped)"
         return 1
     fi
-    
-    return 1
 }
 
 

mac/env-prequisite-checks.sh

@@ -26,15 +26,15 @@ parse_proxy() {
 
 set_proxy_in_env() {
     log_section "🌐 Network & Proxy Validation"
-    base64_encoded_creds=$(printf "%s" $BROWSERSTACK_USERNAME:$BROWSERSTACK_ACCESS_KEY | base64 | tr -d '\n')
+    base64_encoded_creds=$(printf "%s" "$BROWSERSTACK_USERNAME":"$BROWSERSTACK_ACCESS_KEY" | base64 | tr -d '\n')
 
 
     # If no proxy configured, exit early
     if [ -z "$PROXY" ]; then
         log_warn "No proxy found. Using direct connection."
         export PROXY_HOST=""
         export PROXY_PORT=""
-        return 0 2>/dev/null || exit 0
+        return 0 2>/dev/null
     fi
 
     log_msg_to "Proxy detected: $PROXY"

mac/env-setup-run.sh

@@ -2,7 +2,7 @@
 # shellcheck shell=bash
 
 setup_environment() {
-    local setup_type=$1  # "web" or "mobile"
+    local setup_type=$1  
     local tech_stack=$2
     local max_parallels
 
@@ -17,7 +17,7 @@ setup_environment() {
         max_parallels=$TEAM_PARALLELS_MAX_ALLOWED_MOBILE
     fi
 
-    log_msg_to "Starting ${setup_type} setup for $TECH_STACK" "$NOW_RUN_LOG_FILE"
+    log_msg_to "Starting ${setup_type} setup for " "$tech_stack" "$NOW_RUN_LOG_FILE"
 
     local local_flag=false
 
@@ -134,7 +134,7 @@ setup_app_java() {
     local app_url=$BROWSERSTACK_APP
     log_msg_to "APP_PLATFORM: $APP_PLATFORM" >> "$NOW_RUN_LOG_FILE" 2>&1
 
-    clone_repository $REPO $TARGET_DIR
+    clone_repository "$REPO" "$TARGET_DIR"
 
     if [[ "$APP_PLATFORM" == "all" || "$APP_PLATFORM" == "android" ]]; then
         cd "android/testng-examples" || return 1
@@ -145,7 +145,7 @@ setup_app_java() {
 
     # YAML config path
     export BROWSERSTACK_CONFIG_FILE="./browserstack.yml"
-    platform_yaml=$(generate_mobile_platforms $TEAM_PARALLELS_MAX_ALLOWED_MOBILE "yaml")
+    platform_yaml=$(generate_mobile_platforms "$TEAM_PARALLELS_MAX_ALLOWED_MOBILE" "yaml")
 
     cat >> "$BROWSERSTACK_CONFIG_FILE" <<EOF
 app: ${app_url}
@@ -182,7 +182,7 @@ EOF
     show_spinner "$cmd_pid"
     wait "$cmd_pid"
 
-    cd "$WORKSPACE_DIR/$PROJECT_FOLDER"
+    cd "$WORKSPACE_DIR/$PROJECT_FOLDER" || return 1
     return 0
 }
 
@@ -232,14 +232,14 @@ EOF
     print_tests_running_log_section "browserstack-sdk pytest -s src/test/suites/*.py --browserstack.config ./src/conf/browserstack_parallel.yml"
     log_msg_to "🚀 Running 'browserstack-sdk pytest -s tests/bstack-sample-test.py'. This could take a few minutes. Follow the Automaton build here: https://automation.browserstack.com/"
     # Run tests
-    browserstack-sdk pytest -s src/test/suites/*.py --browserstack.config ./src/conf/browserstack_parallel.yml >> $NOW_RUN_LOG_FILE 2>&1
+    browserstack-sdk pytest -s src/test/suites/*.py --browserstack.config ./src/conf/browserstack_parallel.yml >> "$NOW_RUN_LOG_FILE" 2>&1
     # &
     # cmd_pid=$!|| return 1
 
     # show_spinner "$cmd_pid"
     # wait "$cmd_pid"
 
-    cd "$WORKSPACE_DIR/$PROJECT_FOLDER"
+    cd "$WORKSPACE_DIR/$PROJECT_FOLDER" || return 1
     return 0
 }
 
@@ -251,24 +251,20 @@ setup_app_python() {
     REPO="now-pytest-appium-app-browserstack"
     TARGET_DIR="$WORKSPACE_DIR/$PROJECT_FOLDER/$REPO"
 
-    clone_repository $REPO $TARGET_DIR
+    clone_repository "$REPO" "$TARGET_DIR"
 
     detect_setup_python_env
 
     # Install dependencies
     pip install -r requirements.txt >> "$NOW_RUN_LOG_FILE" 2>&1
     log_success "Dependencies installed"
 
-    
-    # Prepare platform-specific YAMLs in android/ and ios/
-    local original_platform="$APP_PLATFORM"
-    
     local app_url=$BROWSERSTACK_APP
     local platform_yaml
 
     export BSTACK_PARALLELS=1
     export BROWSERSTACK_CONFIG_FILE="./android/browserstack.yml"
-    platform_yaml=$(generate_mobile_platforms $TEAM_PARALLELS_MAX_ALLOWED_MOBILE "yaml")
+    platform_yaml=$(generate_mobile_platforms "$TEAM_PARALLELS_MAX_ALLOWED_MOBILE" "yaml")
 
     cat >> "$BROWSERSTACK_CONFIG_FILE" <<EOF
 
@@ -312,13 +308,13 @@ setup_web_nodejs() {
     TARGET_DIR="$WORKSPACE_DIR/$PROJECT_FOLDER/$REPO"
     mkdir -p "$WORKSPACE_DIR/$PROJECT_FOLDER"
 
-    clone_repository $REPO $TARGET_DIR
+    clone_repository "$REPO" "$TARGET_DIR"
 
 
     # === 2️⃣ Install Dependencies ===
     log_msg_to "⚙️ Running 'npm install'"
     log_info "Installing dependencies"
-    npm install >> $NOW_RUN_LOG_FILE 2>&1 || return 1
+    npm install >> "$NOW_RUN_LOG_FILE" 2>&1 || return 1
     log_success "Dependencies installed"
 
     local caps_json=""
@@ -345,7 +341,7 @@ setup_web_nodejs() {
     # === 8️⃣ Run Tests ===
     log_msg_to "🚀 Running 'npm run test'. This could take a few minutes. Follow the Automaton build here: https://automation.browserstack.com/"
     print_tests_running_log_section "npm run test"
-    npm run test >> $NOW_RUN_LOG_FILE 2>&1 || return 1 &
+    npm run test >> "$NOW_RUN_LOG_FILE" 2>&1 || return 1 &
     cmd_pid=$!|| return 1
 
     show_spinner "$cmd_pid"
@@ -367,15 +363,15 @@ setup_app_nodejs() {
     TARGET_DIR="$WORKSPACE_DIR/$PROJECT_FOLDER/$REPO"
     TEST_FOLDER="/test"
 
-    clone_repository $REPO $TARGET_DIR $TEST_FOLDER
+    clone_repository $REPO "$TARGET_DIR" "$TEST_FOLDER"
 
     # === 2️⃣ Install Dependencies ===
     log_info "Installing dependencies"
     log_msg_to "⚙️ Running 'npm install'"
-    npm install >> $NOW_RUN_LOG_FILE 2>&1 || return 1
+    npm install >> "$NOW_RUN_LOG_FILE" 2>&1 || return 1
     log_success "Dependencies installed"
 
-    caps_json=$(generate_mobile_platforms $TEAM_PARALLELS_MAX_ALLOWED_MOBILE "json")
+    caps_json=$(generate_mobile_platforms "$TEAM_PARALLELS_MAX_ALLOWED_MOBILE" "json")
 
 
     export BSTACK_CAPS_JSON=$caps_json
@@ -444,7 +440,7 @@ run_setup_wrapper() {
             fi
         ;;
         *)
-            log_msg_to "❌ Invalid TEST_TYPE: $TEST_TYPE"
+            log_msg_to "❌ Invalid TEST_TYPE: $test_type"
             exit 1
         ;;
     esac

mac/run.sh

@@ -18,7 +18,7 @@ source "$(dirname "$0")/env-prequisite-checks.sh"
 run_setup() {
     local test_type=$1
     local tech_stack=$2
-    setup_environment $test_type $tech_stack
+    setup_environment "$test_type" "$tech_stack"
 }
 
 # ===== Main flow (baseline steps then run) =====