run_tests.sh

#!/bin/bash

. ./src/kw_include.sh --source-only
include './tests/utils.sh'
include './src/kwio.sh'

declare -r PATH_TO_TESTS_EXTERNALS='tests/external'

function show_help()
{
  printf '%s\n' "Usage: $0 [help] [list] [test <tfile1> ...] [prepare [-f|--force-update]]" \
    'Run tests for kworkflow.' \
    "Example: $0 test kw_test" \
    '' \
    '  help - displays this help message' \
    '  list - lists all test files under tests/' \
    '  test - runs the given test files' \
    '  prepare - prepare environment for tests. -f will update environment, even if already prepared.'
}

function download_stuff()
{
  local URL="$1"
  local PATH_TO="$2"
  local OVERWRITE="$3"

  if "$OVERWRITE"; then
    ret=$(wget -N "$URL" -P "$PATH_TO")
  else
    ret=$(wget -nc "$URL" -P "$PATH_TO")
  fi

  if [[ "$?" != 0 ]]; then
    return 113 # Host unreachable errno
  fi
}

function get_external_scripts()
{
  local OVERWRITE="$1"
  local ret
  local -r CHECKPATCH_URL='https://raw.githubusercontent.com/torvalds/linux/master/scripts/checkpatch.pl'
  local -r MAINTAINER_URL='https://raw.githubusercontent.com/torvalds/linux/master/scripts/get_maintainer.pl'
  local -r CHECKPATCH_CONST_STRUCTS='https://raw.githubusercontent.com/torvalds/linux/master/scripts/const_structs.checkpatch'
  local -r CHECKPATCH_SPELLING='https://raw.githubusercontent.com/torvalds/linux/master/scripts/spelling.txt'
  local DOWNLOAD_URLS=(
    CHECKPATCH_URL
    CHECKPATCH_CONST_STRUCTS
    CHECKPATCH_SPELLING
    MAINTAINER_URL
  )

  say $'Downloading external scripts...\n'

  mkdir -p "$PATH_TO_TESTS_EXTERNALS"
  for url in "${DOWNLOAD_URLS[@]}"; do
    download_stuff "${!url}" "$PATH_TO_TESTS_EXTERNALS" "$OVERWRITE"
    if [[ "$?" -eq 113 ]]; then
      return 113 # Host unreachable errno
    fi
  done
}

# Check and downloads required files for testing. Argument is $1 = true|false,
# whether to update required files even if they exist already (true) or just
# download if they don't exist (false). Default, when no argument is given, is
# false.
function check_required_files()
{
  local force_update="$1"

  force_update=${force_update:-'false'}

  if [[ "$force_update" == 'false' && -f "$PATH_TO_TESTS_EXTERNALS/checkpatch.pl" && -f "$PATH_TO_TESTS_EXTERNALS/const_structs.checkpatch" && -f "$PATH_TO_TESTS_EXTERNALS/spelling.txt" && -f "$PATH_TO_TESTS_EXTERNALS/get_maintainer.pl" ]]; then
    # Errno code for File exist
    return 17
  else
    say '--> Preparing unit test'
    get_external_scripts "$force_update"
    if [[ "$?" -eq 113 ]]; then
      complain 'Failed to download external scripts. Check your connection.'
      complain 'Cannot run kw tests'
      exit 1
    fi
  fi
}

# Reports tests results.
# Arguments are: $1: # of tests, $2: # of succeeded tests, $3: # of notfound tests and
# $4: # of failed tests
function report_results()
{
  local -i total="$1"
  local -i success="$2"
  local -i notfound="$3"
  local -i fail="$4"
  local test_failure_list="$5"

  if [[ "$total" -eq 0 ]]; then
    printf '%s\n' 'No test files.'
  elif [[ "$success" -eq "$total" ]]; then
    success "$SEPARATOR"
    success "Total: $total test file(s)"
    success 'Test file(s) SUCCEEDED'
  else
    complain "$SEPARATOR"
    complain "Total: $total test file(s)"
    if [[ "$fail" -gt 0 ]]; then
      complain "$fail test file(s) FAILED"
    fi
    if [[ "$notfound" -gt 0 ]]; then
      complain "$notfound test file(s) NOT FOUND"
    fi

    if [[ -n "$test_failure_list" ]]; then
      complain $'\nTake a look at:'
      IF=' ' read -r -a test_failure_array <<< "$test_failure_list"
      for failed in "${test_failure_array[@]}"; do
        complain "-> $failed"
      done
    fi

    return 1
  fi
}

function run_tests()
{
  local -i total=${#TESTS[@]}
  local -i success=0
  local -i notfound=0
  local -i fail=0
  local test_failure_list=''

  for current_test in "${TESTS[@]}"; do
    target=$(find ./tests -name "$current_test*.sh")
    if [[ -f "$target" ]]; then
      say "Running test [${current_test}]"
      say "$SEPARATOR"
      (
        init_env
        "$target"
      )
      if [[ "$?" -eq 0 ]]; then
        success+=1
      else
        fail+=1
        test_failure_list="$target $test_failure_list"
      fi
    else
      if [[ -n "$target" ]]; then
        complain "Test file $target not found."
      else
        complain "Test file '$current_test' not found."
      fi
      notfound+=1
    fi
  done
  report_results "$total" "$success" "$notfound" "$fail" "$test_failure_list"
}

declare -a TESTS
function strip_path()
{
  local base
  TESTS=()
  for file in "$@"; do
    base=$(basename "${file}")
    TESTS+=("${base%.*}")
  done
}

check_required_files
check_files="$?"
#shellcheck disable=SC2086
if [[ "$#" -eq 0 ]]; then
  check_required_files
  files_list=$(find ./tests -name '*_test.sh' | grep -Ev 'samples/.*|/shunit2/')
  # Note: Usually we want to use double-quotes on bash variables, however,
  # in this case we want a set of parameters instead of a single one.
  strip_path $files_list
  run_tests
elif [[ "$1" == 'list' ]]; then
  index=0
  files_list=$(find ./tests/ -name '*_test.sh')
  strip_path $files_list
  for test_name in "${TESTS[@]}"; do
    ((index++))
    say "$index) ${test_name}"
  done
elif [[ "$1" == 'test' ]]; then
  strip_path "${@:2}"
  run_tests
elif [[ "$1" == 'prepare' ]]; then
  if [[ "$#" -gt 1 && ("$2" == '--force-update' || "$2" == '-f') ]]; then
    check_required_files true
    check_files="$?"
  fi

  if [[ "$check_files" -eq 17 ]]; then
    say 'You are ready to run the unit test'
  fi
else
  show_help
fi