Merge branch 'check_cmd_dmesg' into dev

* check_cmd_dmesg:
  New check:  check_cmd_dmesg()

Author: Michael Jennings

scripts/lbnl_cmd.nhc

@@ -8,16 +8,16 @@
 # required return code may also be supplied.
 function check_cmd_output() {
     local CMD_TIMEOUT=5 CMD_RETVAL CHECKNAME="$FUNCNAME" OUTPUT_VAR CMD_START_TS=$SECONDS
-    local IFS PID TIMER RET CMD
+    local IFS PID TIMER RET CMD MSG
     local LINENO=0 MATCH_CNT=0 NEG_MATCH_CNT=0 i
-    local -a CMD_LIST LINES MATCHES MATCHED
+    local -a CMD_LIST LINES MATCHES MATCHED MSGS
 
-    MATCHES=( )
     OPTIND=1
-    while getopts ":C:O:e:m:r:t:" OPTION ; do
+    while getopts ":C:M:O:e:m:r:t:" OPTION ; do
         case "$OPTION" in
-            C) CHECKNAME="$OPTARG" ;;  # INTERNAL USE ONLY
-            O) OUTPUT_VAR="$OPTARG" ;;  # INTERNAL USE ONLY
+            C) CHECKNAME="$OPTARG" ;;  # Used for writing wrapper checks
+            O) OUTPUT_VAR="$OPTARG" ;;  # Used for writing wrapper checks
+            M) MSGS[${#MSGS[*]}]="$OPTARG" ;;  # Used for writing wrapper checks
             e) CMD="$OPTARG" ;;
             m) MATCHES[${#MATCHES[*]}]="$OPTARG" ;;
             r) CMD_RETVAL="$OPTARG" ;;
@@ -70,29 +70,36 @@ function check_cmd_output() {
     fi
     IFS=$' \t\n'
 
-    # Iterate through $LINES[] array to gather process data.
-    for ((LINENO = 0; LINENO <= ${#LINES[*]}; LINENO++)); do
-        for ((i = 0; i < ${#MATCHES[*]}; i++)); do
-            if [[ "${MATCHES[$i]:0:1}" = '!' ]]; then
-                # Match expression is negated.  Fail if the line matches this expression.
-                if mcheck "${LINES[$LINENO]}" "${MATCHES[$i]:1}" ; then
-                    die 1 "$CHECKNAME:  \"${MATCHES[$i]:1}\" matched at line $((LINENO+1)) output from \"$CMD\"."
-                    return 1
-                fi
-            elif [ ${MATCHED[$i]} -eq 0 ] && mcheck "${LINES[$LINENO]}" "${MATCHES[$i]}" ; then
-                MATCHED[$i]=1
-                ((MATCH_CNT++))
-                if [[ $MATCH_CNT == ${#MATCHED[*]} ]]; then
-                    # All match expression(s) are positive and have
-                    # matched successfully.  Stop processing output.
-                    break
+    if [[ ${#MATCHES[*]} -gt 0 ]]; then
+        # Iterate through $LINES[] array to gather process data.
+        for ((LINENO = 0; LINENO <= ${#LINES[*]}; LINENO++)); do
+            for ((i = 0; i < ${#MATCHES[*]}; i++)); do
+                if [[ "${MATCHES[$i]:0:1}" = '!' ]]; then
+                    # Match expression is negated.  Fail if the line matches this expression.
+                    if mcheck "${LINES[$LINENO]}" "${MATCHES[$i]:1}" ; then
+                        MSG=${MSGS[$i]:-\"%m\" matched at line %l of \"%c\"}
+                        MSG=${MSG//\%m/${MATCHES[$i]:1}}
+                        MSG=${MSG//\%l/$((LINENO+1))}
+                        MSG=${MSG//\%L/${LINES[$LINENO]//[\"\`\$]}}
+                        MSG=${MSG//\%c/$CMD}
+                        die 1 "$CHECKNAME:  $MSG."
+                        return 1
+                    fi
+                elif [ ${MATCHED[$i]} -eq 0 ] && mcheck "${LINES[$LINENO]}" "${MATCHES[$i]}" ; then
+                    MATCHED[$i]=1
+                    ((MATCH_CNT++))
+                    if [[ $MATCH_CNT == ${#MATCHED[*]} ]]; then
+                        # All match expression(s) are positive and have
+                        # matched successfully.  Stop processing output.
+                        break
+                    fi
                 fi
-            fi
+            done
         done
-    done
 
-    # None of the negated matches matched, so add them to our success count.
-    ((MATCH_CNT += NEG_MATCH_CNT))
+        # None of the negated matches matched, so add them to our success count.
+        ((MATCH_CNT += NEG_MATCH_CNT))
+    fi
 
     if [[ $RET -ne ${CMD_RETVAL:-0} ]]; then
         if [[ $SECONDS -ge $((CMD_START_TS+CMD_TIMEOUT)) && $RET -eq 143 ]]; then
@@ -111,13 +118,20 @@ function check_cmd_output() {
     # At least one expression failed to match.  Locate the first such expression.
     if [[ $MATCH_CNT == 0 && ${#MATCHES[*]} == 1 ]]; then
         # Special case for cleaner output.
-        die 1 "$CHECKNAME:  \"${MATCHES[0]}\" failed to match \"$CMD\" output."
+        MSG=${MSGS[0]:-\"%m\" failed to match \"%c\" output}
+        MSG=${MSG//\%m/${MATCHES[0]}}
+        MSG=${MSG//\%c/$CMD}
+        die 1 "$CHECKNAME:  $MSG."
         return 1
     fi
 
     for ((i = 0; i < ${#MATCHES[*]}; i++)); do
         if [[ ${MATCHED[$i]} == 0 ]]; then
-            die 1 "$CHECKNAME:  \"${MATCHES[$i]}\" failed to match \"$CMD\" output ($((${#MATCHES[*]}-MATCH_CNT))/${#MATCHES[*]} patterns failed)."
+            MSG=${MSGS[$i]:-\"%m\" failed to match \"%c\" output (%f patterns failed)}
+            MSG=${MSG//\%m/${MATCHES[0]}}
+            MSG=${MSG//\%c/$CMD}
+            MSG=${MSG//\%f/$((${#MATCHES[*]}-MATCH_CNT))/${#MATCHES[*]}}
+            die 1 "$CHECKNAME:  $MSG."
             return 1
         fi
     done
@@ -168,3 +182,25 @@ function check_cmd_status() {
     fi
     return 0
 }
+
+# Check dmesg output for matching lines.  Fairly simple wrapper for check_cmd_output() (above).
+function check_cmd_dmesg() {
+    local CMD_TIMEOUT CMD_RETVAL CMD="dmesg"
+    local -a MATCHES MSGS
+
+    OPTIND=1
+    while getopts ":M:e:m:r:t:" OPTION ; do
+        case "$OPTION" in
+            M) MSGS[${#MSGS[*]}]=-M ; MSGS[${#MSGS[*]}]="$OPTARG" ;;
+            e) CMD="$OPTARG" ;;
+            m) MATCHES[${#MATCHES[*]}]=-m ; MATCHES[${#MATCHES[*]}]="$OPTARG" ;;
+            r) CMD_RETVAL="$OPTARG" ;;
+            t) CMD_TIMEOUT="$OPTARG" ;;
+            :) die 1 "$FUNCNAME:  Option -$OPTARG requires an argument." ; return 1 ;;
+            \?) die 1 "$FUNCNAME:  Invalid option:  -$OPTARG" ; return 1 ;;
+        esac
+    done
+    shift $((OPTIND-1))
+
+    check_cmd_output -C $FUNCNAME ${CMD_RETVAL:+-r $CMD_RETVAL} ${CMD_TIMEOUT:+-t $CMD_TIMEOUT} -e "$CMD" "${MSGS[@]}" "${MATCHES[@]}"
+}