fix shell check error for case-lib/*

case-lib/hijack.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-declare -g SUDO_CMD=$(which sudo)
+SUDO_CMD=$(command -v sudo)
 
 # Overwrite other functions' exit to perform environment cleanup
 function exit()
@@ -10,41 +10,42 @@ function exit()
  # when sof logger collect is open
  if [ "X$SOF_LOG_COLLECT" == "X1" ]; then
  # when error occurs, exit and catch etrace log
- [[ $exit_status -eq 1 ]] && func_lib_start_log_collect 1 && sleep 1s
- local loggerBin=$(basename $SOFLOGGER)
- sudo pkill -9 $loggerBin 2>/dev/null
+ [[ $exit_status -eq 1 ]] && {
+ func_lib_start_log_collect 1
+ sleep 1s
+ }
+ local loggerBin; loggerBin=$(basename "$SOFLOGGER")
+ sudo pkill -9 "$loggerBin" 2>/dev/null
  sleep 1s
  fi
  # when case ends, store kernel log
+ # /var/log/kern.log format:
+ # f1 f2 f3 f4 f5 f6 f7 f8...
+ # Mouth day Time MachineName kernel: [ time] content
+ # May 15 21:28:38 MachineName kernel: [ 6.469255] sof-audio-pci 0000:00:0e.0: ipc rx: 0x90020000: GLB_TRACE_MSG
+ # May 15 21:28:38 MachineName kernel: [ 6.469268] sof-audio-pci 0000:00:0e.0: ipc rx done: 0x90020000: GLB_TRACE_MSG
  if [[ -n "$DMESG_LOG_START_LINE" && "$DMESG_LOG_START_LINE" -ne 0 ]]; then
- tail -n +"$DMESG_LOG_START_LINE" /var/log/kern.log |cut -f5- -d ' ' > $LOG_ROOT/dmesg.txt
+ tail -n +"$DMESG_LOG_START_LINE" /var/log/kern.log |cut -f5- -d ' ' > "$LOG_ROOT/dmesg.txt"
  else
-cat /var/log/kern.log |cut -f5- -d ' ' > $LOG_ROOT/dmesg.txt
+ cut -f5- -d ' ' /var/log/kern.log > "$LOG_ROOT/dmesg.txt"
  fi
 
  # get ps command result as list
- OLD_IFS="$IFS" IFS=$'\n'
  local -a cmd_lst
- local line
  # $$ as current script pid
  # NOTICE: already test with $BASHPID:
  # it can output the same result of $$
  # but the result could not be stored in the array
- for line in $(ps --ppid $$ -o pid,cmd --no-header|grep -vE "ps|${BASH_SOURCE[-1]}");
- do
- cmd_lst=( "${cmd_lst[@]}" "$line")
- done
- IFS="$OLD_IFS"
+ readarray -t cmd_lst < <(pgrep -P $$ -a|grep -v "$SCRIPT_NAME")
  # now force kill target process which maybe block the script quit
  if [ ${#cmd_lst[@]} -gt 0 ]; then
- dlogw "Process(es) started by ${BASH_SOURCE[-1]} are still active, kill these process(es):"
+ local line
+ dlogw "Process(es) started by $SCRIPT_NAME are still active, kill these process(es):"
  for line in "${cmd_lst[@]}"
  do
- # remove '^[:space:]' because IFS change to keep the '^[:space:]' in variable
- line=$(echo $line|xargs)
  dlogw "Catch pid: $line"
  dlogw "Kill cmd:'${line#* }' by kill -9"
- kill -9 ${line%% *}
+ kill -9 "${line%% *}"
  done
  fi
 
@@ -57,7 +58,7 @@ function exit()
  fi
  # if failed to restore pulseaudio, even test caes passed, set exit status to ret
  # to make test case failed. this helps to dectect pulseaudio failures.
- if [ $exit_status -eq 0 -a $ret -ne 0 ]; then
+ if [ "$exit_status" -eq 0 ] && [ $ret -ne 0 ]; then
  exit_status=$ret
  fi
 
@@ -79,27 +80,24 @@ function exit()
  builtin exit $exit_status
 }
 
+SUDO_LEVEL=""
 # overwrite the sudo command, sudo in the script can direct using sudo command
 sudo()
 {
  func_hijack_setup_sudo_level
+ local cmd
  case $SUDO_LEVEL in
- '0') # as root
- eval $(echo "$*")
- return $?
+ '0') cmd="$*" # as root
  ;;
- '1') # sudo without passwd
- eval $(echo "$SUDO_CMD env 'PATH=$PATH' $*")
- return $?
+ '1') cmd="$SUDO_CMD env 'PATH=$PATH' $*" # sudo without passwd
  ;;
- '2') # sudo need passwd
- eval $(echo "echo '$SUDO_PASSWD' | $SUDO_CMD -S env 'PATH=$PATH' $*")
- return $?
+ '2') cmd="echo '$SUDO_PASSWD' | $SUDO_CMD -S env 'PATH=$PATH' $*" # sudo need passwd
  ;;
  *) # without sudo permission
  dlogw "Need root privilege to run $*"
+ return 2
  esac
-return 2
+eval "$cmd"
 }
 
 func_hijack_setup_sudo_level()
@@ -108,7 +106,7 @@ func_hijack_setup_sudo_level()
  # root permission, don't need to check
  [[ $UID -eq 0 ]] && SUDO_LEVEL=0 && return 0
  # now check whether we need sudo passwd using expect
- expect >/dev/null <<END
+if expect >/dev/null <<END
 spawn $SUDO_CMD ls
 expect {
  "password" {
@@ -117,12 +115,13 @@ expect {
 exit 0
 }
 END
- [[ $? -eq 0 ]] && SUDO_LEVEL=1 && return 0
+ then
+ SUDO_LEVEL=1 && return 0
+ fi
 
  # check for sudo passwd
  if [[ "$SUDO_PASSWD" ]]; then
- local tmp_uid=$(echo "$SUDO_PASSWD"|$SUDO_CMD -S bash -c 'echo $UID')
- [[ $tmp_uid -eq 0 ]] && SUDO_LEVEL=2 && return 0
+ [[ $(echo "$SUDO_PASSWD"|$SUDO_CMD -S id -u) -eq 0 ]] && SUDO_LEVEL=2 && return 0
  fi
  return 1
 }

case-lib/lib.sh

@@ -1,43 +1,59 @@
 #!/bin/bash
 
-# Source from the relative path of current folder
-source $(dirname ${BASH_SOURCE[0]})/config.sh
-source $(dirname ${BASH_SOURCE[0]})/opt.sh
-source $(dirname ${BASH_SOURCE[0]})/logging_ctl.sh
-source $(dirname ${BASH_SOURCE[0]})/pipeline.sh
-source $(dirname ${BASH_SOURCE[0]})/hijack.sh
+# get test-case information
+SCRIPT_HOME="$(dirname "$0")"
+# get test-case parent folder name
+SCRIPT_HOME=$(cd "$SCRIPT_HOME/.." && pwd)
+# shellcheck disable=SC2034 # external script can use it
+SCRIPT_NAME="$0" # get test-case script load name
+# shellcheck disable=SC2034 # external script can use it
+SCRIPT_PRAM="$*" # get test-case parameter
 
-# force ask buffer data write into file system
-sudo sync -f
+# Source from the relative path of current folder
+# shellcheck disable=SC1091 source=./config.sh
+source "$SCRIPT_HOME/case-lib/config.sh"
+# shellcheck disable=SC1091 source=./opt.sh
+source "$SCRIPT_HOME/case-lib/opt.sh"
+# shellcheck disable=SC1091 source=./logging_ctl.sh
+source "$SCRIPT_HOME/case-lib/logging_ctl.sh"
+# shellcheck disable=SC1091 source=./pipeline.sh
+source "$SCRIPT_HOME/case-lib/pipeline.sh"
+# shellcheck disable=SC1091 source=./hijack.sh
+source "$SCRIPT_HOME/case-lib/hijack.sh"
+
+# restrict bash version for some bash feature
+[[ $(echo -e "$BASH_VERSION\n4.1"|sort -V|head -n 1) == '4.1' ]] || {
+ dlogw "Bash version: ${BASH_VERSINFO[0]}.${BASH_VERSINFO[1]} should > 4.1"
+ exit 2
+}
 
 # Add tools to command PATH
-if [ ! "$(declare -p TOOL_PATH 2>/dev/null)" ]; then
- declare -x TOOL_PATH=$(realpath $(dirname ${BASH_SOURCE[1]})/../tools)
- PATH=$TOOL_PATH:$PATH
+# this line equal `! $(echo $PATH|grep "$SCRIPT_HOME/tools")`
+if [[ ! $PATH =~ $SCRIPT_HOME/tools ]]; then
+export PATH=$SCRIPT_HOME/tools:$PATH
 fi
 
 # setup SOFCARD id
 if [ ! "$SOFCARD" ]; then
  SOFCARD=$(grep '\]: sof-[a-z]' /proc/asound/cards|awk '{print $1;}')
 fi
 
-if [ ! "$DMESG_LOG_START_LINE" ]; then
- declare -g DMESG_LOG_START_LINE=$(wc -l /var/log/kern.log|awk '{print $1;}')
-fi
-
-declare -g SOF_LOG_COLLECT=0
-
 func_lib_setup_kernel_last_line()
 {
- declare -g KERNEL_LAST_LINE=$(wc -l /var/log/kern.log|awk '{print $1;}')
+ # shellcheck disable=SC2034 # external script will use it
+ KERNEL_LAST_LINE=$(wc -l /var/log/kern.log|awk '{print $1;}')
 }
 
+SOF_LOG_COLLECT=0
 func_lib_start_log_collect()
 {
- local is_etrace=${1:-0}
- local ldcFile=/etc/sof/sof-$(sof-dump-status.py -p).ldc
+ local is_etrace=${1:-0} ldcFile
+ ldcFile=/etc/sof/sof-$(sof-dump-status.py -p).ldc || {
+ >&2 dlogw "sof-dump-status.py -p to query platform failed"
+ return
+ }
  local loggerBin="" logfile="" logopt="-t"
- [[ "$SOFLOGGER" ]] && loggerBin=$SOFLOGGER || loggerBin=$(which sof-logger)
+ [[ "$SOFLOGGER" ]] && loggerBin=$SOFLOGGER || loggerBin=$(command -v sof-logger)
  if [ "X$is_etrace" == "X0" ];then
  logfile=$LOG_ROOT/slogger.txt
  else
@@ -46,39 +62,42 @@ func_lib_start_log_collect()
  fi
  [[ ! "$loggerBin" ]] && return
  SOFLOGGER=$loggerBin
- func_hijack_setup_sudo_level
- [[ $? -eq 0 ]] && SOF_LOG_COLLECT=1
+ if func_hijack_setup_sudo_level ;then
+ # shellcheck disable=SC2034 # external script will use it
+ SOF_LOG_COLLECT=1
+ else
+ >&2 dlogw "without sudo permission to run $SOFLOGGER command"
+ return
+ fi
 
- sudo $loggerBin $logopt -l $ldcFile -o $logfile 2>/dev/null &
+ sudo "$loggerBin $logopt -l $ldcFile -o $logfile" 2>/dev/null &
 }
 
 func_lib_check_sudo()
 {
- func_hijack_setup_sudo_level
- [[ $? -ne 0 ]] && \
- dlogw "Command needs root privilege to run, please configure SUDO_PASSWD in case-lib/config.sh" && \
+ func_hijack_setup_sudo_level || {
+ dlogw "Command needs root privilege to run, please configure SUDO_PASSWD in case-lib/config.sh"
  exit 2
+ }
 }
 
-declare -ag PULSECMD_LST
-declare -ag PULSE_PATHS
+declare -a PULSECMD_LST
+declare -a PULSE_PATHS
 
 func_lib_disable_pulseaudio()
 {
  [[ "${#PULSECMD_LST[@]}" -ne 0 ]] && return
  # store current pulseaudio command
- OLD_IFS="$IFS" IFS=$'\n'
- PULSECMD_LST=( $(ps -C pulseaudio -o user,cmd --no-header) )
- IFS="$OLD_IFS"
+ readarray -t PULSECMD_LST < <(ps -C pulseaudio -o user,cmd --no-header)
  [[ "${#PULSECMD_LST[@]}" -eq 0 ]] && return
  func_lib_check_sudo
  # get all running pulseaudio paths
- PULSE_PATHS=( $(ps -C pulseaudio -o cmd --no-header | awk '{print $1}') )
+readarray -t PULSE_PATHS < <(ps -C pulseaudio -o cmd --no-header | awk '{print $1}'|sort -u)
  for PA_PATH in "${PULSE_PATHS[@]}"
  do
  # rename pulseaudio before kill it
  if [ -x "$PA_PATH" ]; then
- sudo mv -f $PA_PATH$PA_PATH.bak
+ sudo mv -f "$PA_PATH" "$PA_PATH.bak"
  fi
  done
  sudo pkill -9 pulseaudio
@@ -100,7 +119,7 @@ func_lib_restore_pulseaudio()
  for PA_PATH in "${PULSE_PATHS[@]}"
  do
  if [ -x "$PA_PATH.bak" ]; then
- sudo mv -f $PA_PATH.bak$PA_PATH
+ sudo mv -f "$PA_PATH.bak" "$PA_PATH"
  fi
  done
  # start pulseaudio
@@ -109,7 +128,7 @@ func_lib_restore_pulseaudio()
  do
  user=${line%% *}
  cmd=${line#* }
- nohup sudo -u $user$cmd >/dev/null &
+ nohup sudo -u "$user" "$cmd" >/dev/null &
  done
  # now wait for the pulseaudio restore in the ps process
  timeout=10
@@ -118,7 +137,7 @@ func_lib_restore_pulseaudio()
  do
  sleep 1s
  [ -n "$(ps -C pulseaudio --no-header)" ] && break
- if [ $wait_time -eq $timeout ]; then
+ if [ "$wait_time" -eq $timeout ]; then
  dlogi "Time out. Pulseaudio not restored in $timeout seconds"
  return 1
  fi
@@ -134,25 +153,22 @@ func_lib_restore_pulseaudio()
 func_lib_get_random()
 {
  # RANDOM: Each time this parameter is referenced, a random integer between 0 and 32767 is generated
- local random_max random_min random_scope
+ local random_max=$1 random_min=$2 random_scope
+ random_scope=$(( random_max - random_min ))
  if [ $# -ge 2 ];then
- random_max=$1
- random_min=$2
- random_scope=$(expr $random_max - $random_min)
- expr $RANDOM % $random_scope + $random_min
+ echo $(( RANDOM % random_scope + random_min ))
  elif [ $# -eq 1 ];then
- random_max=$1
- expr $RANDOM % $random_max
+ echo $(( RANDOM % random_max ))
  else
  echo $RANDOM
  fi
 }
 
 func_lib_lsof_error_dump()
 {
- local file=$1
- [[ ! -c $file ]] && return
-local ret=$(lsof $file)
+ local file="$1" ret
+ [[ ! -c "$file" ]] && return
+ ret=$(lsof "$file")
  if [ "$ret" ];then
  dloge "Sound device file is in use:"
  echo "$ret"
@@ -162,18 +178,22 @@ func_lib_lsof_error_dump()
 func_lib_get_tplg_path()
 {
  local tplg=$1
- # tplg given is empty
- if [[ -z "$tplg" ]]; then
+ if [[ -z "$tplg" ]]; then # tplg given is empty
  return 1
- fi
-
- if [[ -f "$TPLG_ROOT/$(basename "$tplg")" ]]; then
+ elif [[ -f "$TPLG_ROOT/$(basename "$tplg")" ]]; then
  echo "$TPLG_ROOT/$(basename "$tplg")"
  elif [[ -f "$tplg" ]]; then
-echo $(realpath "$tplg")
+ realpath "$tplg"
  else
  return 1
  fi
 
  return 0
 }
+
+# force ask buffer data write into file system
+sudo sync -f
+# catch kern.log last line as current case start line
+if [ ! "$DMESG_LOG_START_LINE" ]; then
+ DMESG_LOG_START_LINE=$(wc -l /var/log/kern.log|awk '{print $1;}')
+fi