libisoburn/releng/run_all_releng

#!/bin/bash

# Copyright 2011 George Danchev <danchev@spnet.net>
# Licensed under GNU GPL version 2 or later

set -e

SELF=$(basename "$0")
GEN_DATA_DIR=releng_generated_data
CLOG=${GEN_DATA_DIR}/log.${SELF}
PASSED_OPTIONS="$@"
RELENG_XORRISO=
CLEANUP_LOG=0

not_in_releng_exit() {
  printf "\nPlease execute the tests from releng directory.\n\n"
  exit 1
}

# To catch the exit value of a command in a pipe
return_value_file="$GEN_DATA_DIR"/run_all_"$$"_return_value
return_wrapper()
{
 cmd="$1"
 shift 1
 "$cmd" "$@"
 RET="$?"
 echo "$RET" >"$return_value_file"
 return "$RET"
}

# Using only bash builtin commands.
# On 4 year old amd64 x2 3000 MHz, xterm local,it counts 22471 lines per second
# On 2 year old amd64 x4 2600 MHz, ssh remote, it counts 35348 lines per second
count_lines()
{
 # $1 if not empty: start count
 line=
 if test -n "$1"
 then
   count="$1"
 else
   count=0
 fi
 while read line
 do
   count=$(($count + 1))
   printf "\r  %4d lines logged ... " "$count" >&2
   printf "%s\n" "$line"
 done
 return 0
}

# It is not a good idea to include inc/releng_getopts.inc with the
# master script as it calls the subordinate scripts and they include
# this file too, and we want to avoid sharing variable with subshells
if [ ! -f inc/releng_getopts.inc ]; then
  not_in_releng_exit
fi

#############################################
next_is=
for i in "$@"
do
  if test "$next_is" = "ignore"
  then :
  elif test "$next_is" = "x"
  then
       RELENG_XORRISO="$i"
       next_is=
  elif test x"$i" = x"-x"
  then
       next_is="x"
  elif test x"$i" = x"-c"
  then
       CLEANUP_LOG=1
  fi
done
#############################################
if test "$next_is" = x
then
       echo >&2
       echo "Option -x expects an argument (the path to the xorriso program)" >&2
       exit 31
fi

if [ ! "${1}" ]; then
cat << HLP
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
${SELF} runs executables from CWD starting 
with releng_*, passing them its own options.
stdout/stderr output stored in:
 ${CLOG}
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
self-generated data are stored in ${GEN_DATA_DIR}.
required space for these data is about 300 megabytes.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
examples:
# run xorriso and keep the self-generated data
 $ ./${SELF} -x path/to/xorriso [-k]

# clean up self-generated data from previous run
 $ ./${SELF} -c
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
HLP
 exit 31
fi

########################################################
 if [ -f "${CLOG}" ]; then
   mv "${CLOG}" "${CLOG}".prev
 fi
 > ${CLOG}
 if [ -x "${RELENG_XORRISO}" ]; then
    echo -e "_OVERVIEW_______________________________________________________________" >> ${CLOG}
    date --utc                                                                         >> ${CLOG}
    ${RELENG_XORRISO} --version                                                        >> ${CLOG}
    echo -e "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~" >> ${CLOG}
 fi
 DSTART=`date --utc`
 echo -ne "${SELF}: Started at ${DSTART}" | tee -a ${CLOG}
 E1=`date '+%s'`
 # require ^releng_, avoid running (your)self explicitly
 for s in `ls | grep ^releng_ | grep -v ${SELF} | sort -n`; do
  if [ -x ${s} -a ! -d ${s} ]; then
    echo -ne "\n\n_STARTING_TEST_________________________________________________________"      >> ${CLOG}
    echo -ne "\n${SELF}: Running ./${s} ${PASSED_OPTIONS} :\n" \
    | tee -a ${CLOG}
    T1=`date '+%s'`
    set +e

    if test -n "$PIPESTATUS"
    then
      # PIPESTATUS[0] should be available in bash
      ./${s} ${PASSED_OPTIONS} 2>&1 | count_lines >> ${CLOG}
      RET="${PIPESTATUS[0]}"
    else
      # a more portable method which uses a temporary file to record exit value
      return_wrapper ./${s} ${PASSED_OPTIONS} 2>&1 | count_lines >> ${CLOG}
      RET=$(cat "$return_value_file")
      rm "$return_value_file"
    fi
#   echo "RET='$RET'" >/dev/tty

    T2=`date '+%s'`
    let TS="${T2} - ${T1}"
    case ${RET} in
         0)
           printf "done in ${TS} sec. ok."
           ;;
         *)
	   printf "done in ${TS} sec. "
           which tput >/dev/null 2>&1 && tput smso
           printf "FAIL -> EXIT CODE $RET"
           which tput >/dev/null 2>&1 && tput rmso
           ;;
    esac
    set -e
  fi
 done

 DEND=`date --utc`
 echo -ne "\n${SELF}: Stopped at ${DEND}." | tee -a ${CLOG}
 if   [ "${CLEANUP_LOG}" -eq 1 ]; then
      if [ -f "${CLOG}" ]; then
	 rm -f "${CLOG}"
         echo -ne "\n${SELF}: Removed my own log ${CLOG}." # | tee -a ${CLOG}
      fi
      if [ -f "${CLOG}".prev ]; then
         rm -f "${CLOG}".prev
         echo -e "\n${SELF}: Removed my own log ${CLOG}.prev." # | tee -a ${CLOG}
      fi
 else
      E2=`date '+%s'`
      if [ ${E2} -eq ${E1} ]; then
        echo -e " Total elapsed 0 sec." | tee -a ${CLOG}
      else
        let ES="${E2} - ${E1}"
        echo -e " Total elapsed ${ES} sec." | tee -a ${CLOG}
      fi
      #####
      echo -e "\n_SUMMARY________________________________________________________________" >> ${CLOG}
      echo -e "${SELF}: Trivial log examination: ${CLOG}" | tee -a ${CLOG}
      echo -e "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~" | tee -a ${CLOG}
      # severity classes of libdax_msgs.h in libburn and libisofs
      # List of boring keywords:
      #   'UPDATE' A pacifier message during long running operations.
      # List of interesting keywords:
        # thrown by xorriso and underlying libraries
      LIST_KWD="(NEVER|ABORT|FATAL|FAILURE|MISHAP|SORRY|WARNING|HINT|NOTE|DEBUG|ALL"
        # thrown by others
      LIST_KWD+="|FAIL|ERROR|WRONG)"

      if [ -f "${CLOG}" ]; then
          set +e
	  # lines, perl regex, leading tabs
          grep -n -PT "${LIST_KWD}" "${CLOG}" | tee -a ${CLOG}
	  RET_GREP="$?"
          case ${RET_GREP} in
              0) # found
                 ;;
              1) # not found
		 echo -e "\n${SELF}: Log file looks clear.\n" | tee -a ${CLOG}
                 ;;
	      *) #
                 echo -e "\n${SELF}: grep returned EXIT CODE: ${RET_GREP}.\n" | tee -a ${CLOG}
		 ;;
          esac
	  set -e
      fi
      echo -e "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~" | tee -a ${CLOG}

      ##### TODO: work out a less noisy diff'ing technique!
      if [ -f "${CLOG}".prev -a -f "${CLOG}" ]; then
        echo -e "${SELF}: See diff against previous log file (might be long):" | tee -a ${CLOG}
	echo -e "diff -Naur ${CLOG}.prev ${CLOG} | less" | tee -a ${CLOG}
      fi

 fi
 
 #
 which tput >/dev/null 2>&1 && tput smso
 echo -e "\n${SELF}: Leaving the following cruft in ${GEN_DATA_DIR}:" # | tee -a ${CLOG}
 which tput >/dev/null 2>&1 && tput rmso
 ls -lth "${GEN_DATA_DIR}" # | tee -a ${CLOG}

 # Fin
 exit 0