run_all_scratch_tests.sh

#! /bin/bash

# ##########################################################
# functions - 1

sis_cmake_is_truey() {
  case "$(printf '%s' "${1:-}" | tr '[:upper:]' '[:lower:]')" in

    1|ok|on|true|yes|y)

      return 0
    ;;
    *)

      return 1
      ;;
  esac
}


# ##########################################################
# constants and variables

Basename=$(basename "$0")
Dir=$(cd "$(dirname "$0")" && pwd)
CMakeDir=${SIS_CMAKE_BUILD_DIR:-$Dir/_build}
ProjectNameFile="$Dir/.sis/project_name.txt"
ProjectName=$(tr -d '[:space:]' < "$ProjectNameFile")
ScriptPath=$0
AllowedToFailFile="$Dir/.sis/ci_scratch_tests_allowed_to_fail.txt"
SkipInteractiveFile="$Dir/.sis/ci_scratch_tests_skip_interactive.txt"

AlwaysUseColours=${SIS_CMAKE_ALWAYS_USE_COLOURS:-${SIS_ALWAYS_USE_COLOURS:-0}}
ListOnly=0
RunMake=1
SkipInteractive=0
SisUseColours=0


# ##########################################################
# colours
#
# Enable when tput is available and either:
#   - AlwaysUseColours is set (overrides NO_COLOR; may set TERM if
#     empty/dumb), or
#   - NO_COLOR is unset, stdout is a TTY, and TERM is not dumb (union of
#     collect-c's "TERM set + TTY" and cstring's "TTY" — empty TERM on a
#     TTY is OK).

SisClr_Blue=
SisClr_Bold=
SisClr_Green=
SisClr_None=
SisClr_Red=
SisClr_Yellow=

for arg in "$@"; do

  case $arg in
    --always-use-colors|--always-use-colours|-A)

      AlwaysUseColours=1
      ;;
  esac
done

if command -v tput >/dev/null 2>&1; then

  if [ $AlwaysUseColours -ne 0 ]; then

    if [ -z "${TERM:-}" ] || [ "$TERM" = "dumb" ]; then

      TERM=xterm-256color
    fi

    SisUseColours=1
  elif [ -z "${NO_COLOR:-}" ] && [ -t 1 ] && [ "${TERM:-}" != "dumb" ]; then

    SisUseColours=1
  fi
fi

if [ $SisUseColours -ne 0 ]; then

  SisClr_Blue=${FG_BLUE:-$(tput setaf 4)}
  SisClr_Bold=${FD_BOLD:-$(tput bold)}
  SisClr_Green=${FG_GREEN:-$(tput setaf 2)}
  SisClr_None=${FD_NONE:-$(tput sgr0)}
  SisClr_Red=${FG_RED:-$(tput setaf 1)}
  SisClr_Yellow=${FG_YELLOW:-$(tput setaf 3)}
fi

CMakeDirClr="${SisClr_Blue}${SisClr_Bold}${CMakeDir}${SisClr_None}"
ProjectNameClr="${SisClr_Blue}${SisClr_Bold}${ProjectName}${SisClr_None}"
ScriptPathClr="${SisClr_Blue}${SisClr_Bold}${ScriptPath}${SisClr_None}"


# ##########################################################
# functions - 2

sis_cmake_build() {

  local config="${SIS_CMAKE_CONFIG:-Release}"
  local args=(--build "$CMakeDir")
  if [ -f "$CMakeDir/CMakeCache.txt" ] && grep -q '^CMAKE_CONFIGURATION_TYPES:' "$CMakeDir/CMakeCache.txt" 2>/dev/null; then

    args+=(--config "$config")
  fi
  if [ "$#" -gt 0 ]; then

    local t
    for t in "$@"; do

      args+=(--target "$t")
    done
  fi

  cmake "${args[@]}"
}

# Reduces a program path to its (lowercase) name, without any directory or
# .exe suffix.
sis_program_stem() {

  local p="${1//\\//}"

  p="${p##*/}"

  case "$p" in
    *.exe|*.EXE) p="${p%.*}" ;;
  esac

  printf '%s' "$p" | tr '[:upper:]' '[:lower:]'
}

# Succeeds if the program is named (by name or stem, case-insensitively) in
# the optional .sis/ci_scratch_tests_allowed_to_fail.txt file; blank lines
# and lines beginning with '#' are ignored.
sis_is_allowed_to_fail() {

  local name line

  [ -f "$AllowedToFailFile" ] || return 1

  name=$(sis_program_stem "$1")

  while IFS= read -r line || [ -n "$line" ]; do

    line="${line//$'\r'/}"

    case "$line" in
      ''|\#*) continue ;;
    esac

    if [ "$name" = "$(sis_program_stem "$line")" ]; then

      return 0
    fi
  done < "$AllowedToFailFile"

  return 1
}

# Succeeds if --skip-interactive is active and the program is named in
# .sis/ci_scratch_tests_skip_interactive.txt (GUI / speech / similar).
sis_is_skipped_interactive() {

  local name line

  [ $SkipInteractive -ne 0 ] || return 1

  [ -f "$SkipInteractiveFile" ] || return 1

  name=$(sis_program_stem "$1")

  while IFS= read -r line || [ -n "$line" ]; do

    line="${line//$'\r'/}"

    case "$line" in
      ''|\#*) continue ;;
    esac

    if [ "$name" = "$(sis_program_stem "$line")" ]; then

      return 0
    fi
  done < "$SkipInteractiveFile"

  return 1
}


# ##########################################################
# command-line handling

while [[ $# -gt 0 ]]; do

  case $1 in
    --always-use-colors|--always-use-colours|-A)

      # AlwaysUseColours=1 - this is handled by the for loop above
      ;;
    --list-only|-l)

      ListOnly=1
      ;;
    --no-make|-M)

      RunMake=0
      ;;
    --skip-interactive)

      SkipInteractive=1
      ;;
    --help)

      [ -f "$Dir/.sis/script_info_lines.txt" ] && cat "$Dir/.sis/script_info_lines.txt"
      cat << EOF
Runs all (matching) scratch-test programs

${ScriptPath} [ ... flags/options ... ]

Flags/options:

    behaviour:

    -A
    --always-use-colors
    --always-use-colours
        forces use of colours even when stdout is not a TTY

    -l
    --list-only
        lists the target programs but does not execute them

    -M
    --no-make
        does not execute a build before running programs

    --skip-interactive
        skips programs listed in .sis/ci_scratch_tests_skip_interactive.txt
        (GUI / speech / desktop-interactive programs unsuitable for headless
        CI; principally Windows MessageBox and speech sinks)


    files:

    .sis/ci_scratch_tests_allowed_to_fail.txt
        optional list of scratch-test programs (one name per line; blank
        lines and lines beginning with '#' are ignored) that are allowed to
        fail; such a program is still executed, but a non-zero exit is
        reported as anticipated and neither stops the run nor affects the
        exit status

    .sis/ci_scratch_tests_skip_interactive.txt
        list of scratch-test programs skipped when --skip-interactive is
        given (one name per line; blank lines and '#' comments ignored)


    standard flags:

    --help
        displays this help and terminates

EOF

      exit 0
      ;;
    *)

      >&2 echo "${ScriptPathClr}: unrecognised argument '${SisClr_Red}${SisClr_Bold}$1${SisClr_None}'; use --help for usage"

      exit 1
      ;;
  esac

  shift
done

if [ $SkipInteractive -ne 0 ] && [ ! -f "$SkipInteractiveFile" ]; then

  >&2 echo "${ScriptPath}: --skip-interactive: skip list not found at '$SkipInteractiveFile'"

  exit 1
fi


# ##########################################################
# main()

status=0

if [ $RunMake -ne 0 ]; then

  if [ $ListOnly -eq 0 ]; then

    echo
    echo "Executing build of ${ProjectNameClr} (via cmake --build) and then running all scratch-test programs"

    mkdir -p "$CMakeDir" || exit 1

    if [ ! -f "$CMakeDir/CMakeCache.txt" ]; then

      >&2 echo "${ScriptPathClr}: '${CMakeDirClr}' is not configured; use prepare_cmake.sh first"

      exit 1
    fi

    sis_cmake_build
    status=$?
  fi
else

  if [ ! -d "$CMakeDir" ] || [ ! -f "$CMakeDir/CMakeCache.txt" ]; then

    >&2 echo "${ScriptPathClr}: cannot run in '--no-make' mode without a previous successful configure/build"

    exit 1
  fi
fi

if [ $status -eq 0 ]; then

  if [ $ListOnly -ne 0 ]; then

    echo
    echo "Listing all ${ProjectNameClr} scratch-test programs"
  else

    echo
    echo "Running all ${ProjectNameClr} scratch-test programs"
  fi

  NumPrograms=0

  while IFS= read -r -d '' f; do

    case "$f" in
      *.pdb|*.ilk|*.log|*.obj|*.o)
        continue
        ;;
    esac

    NumPrograms=$((NumPrograms + 1))

    fClr="${SisClr_Blue}${SisClr_Bold}${f}${SisClr_None}"

    if sis_is_skipped_interactive "$f"; then

      if [ $ListOnly -ne 0 ]; then

        echo "would skip ${fClr} (interactive; --skip-interactive)"
      else

        echo
        echo "skipping ${fClr} (interactive; --skip-interactive)"
      fi

      continue
    fi

    if [ $ListOnly -ne 0 ]; then

      if sis_is_allowed_to_fail "$f"; then

        echo "would execute ${fClr} (allowed to fail):"
      else

        echo "would execute ${fClr}:"
      fi

      continue
    fi

    echo
    echo "executing ${fClr}:"

    if "$f"; then

      :
    else

      fStatus=$?

      if sis_is_allowed_to_fail "$f"; then

        echo "${SisClr_Yellow}${SisClr_Bold}anticipated failure${SisClr_None}: ${fClr} exited with status ${fStatus}; it is listed in .sis/ci_scratch_tests_allowed_to_fail.txt"

        continue
      fi

      status=$fStatus

      break 1
    fi
  done < <(find "$CMakeDir" -type f \( -name 'test_scratch*' -o -name 'test.scratch.*' \) \
    ! -path '*/CMakeFiles/*' \
    ! -name '*.a' \
    ! -name '*.d' \
    ! -name '*.lib' \
    ! -name '*.log' \
    \( -perm -100 -o -name '*.exe' \) -print0 2>/dev/null | sort -z)

  if [ $NumPrograms -eq 0 ]; then

    echo "${ScriptPathClr}: found no scratch-test programs under '${CMakeDirClr}' (none found)"

    exit 0
  fi
fi

exit $status


# ############################## end of file ############################# #