Instantly share code, notes, and snippets.

Embed
What would you like to do?
COMP207P Shell Test Runner, works best with `.gitignore` from here: https://gist.github.com/TimboKZ/868cc0a23fdd217da2e581e59531172b
#!/usr/bin/env bash
#######################################################################
#
# tim-test.sh - UCL CS COMP207P Test Runner
# Timur Kuzhagaliyev 2017, https://foxypanda.me/
# Public version 1.1
#
#######################################################################
#
# Description of this script:
#
# Run the script without any arguments to see help.
#
# This script recursively runs all tests from the specified directory
# or file. If run on a directory, only runs tests from files with `.s`
# extension.
#
# Put this script into the root folder of your COMP207P project (same
# folder as `Makefile`). Script runs `make clean` and `make` before
# running tests, and will abort testing if any of these 2 commands
# fails.
#
# All files whose names begin with `p` should be parsed without errors,
# `n` should cause your parser to throw errors and tests beginning with
# `i` will be ignored.
#
# By default, looks for tests in `./tests/custom/` folder, you can
# change this below. This script is also CI friendly as it reports
# failed tests correctly. Example `.travis.yml`:
#
# language: java
# jdk:
# - oraclejdk8
# script:
# - "cd $TRAVIS_BUILD_DIR"
# - "./tim-test.sh all"
#
#######################################################################
program_name=$0
program_dir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
default_test_dir="./tests/custom/"
temp_file="./test.temp"
# Success by default
exit_code=0
# Colors
GREEN="\033[32m"
YELLOW="\033[33m"
GRAY="\033[37m"
CYAN="\033[36m"
RED="\033[31m"
RESET="\033[0m"
# Stats
success_tests=0
fail_tests=0
ignored_tests=0
function usage {
echo "usage: $program_name <mode> [path]"
echo " <mode> 'all', 'dir' or 'one':"
echo " 'all' - runs all tests from '$default_test_dir'"
echo " 'dir' - runs all tests from directory at [path]"
echo " 'one' - runs test file at [path]"
echo " [path] path to test directory or test file"
}
function separator {
neutral "■━━━━━━━━━━━━━■"
}
function pre_test {
separator
neutral "Rebuilding project before testing..."
separator
echo ""
cd "$program_dir"
make clean
local clean_status=$?
make
local make_status=$?
if [ ${clean_status} -ne 0 ] || [ ${make_status} -ne 0 ]
then
neutral ""
separator
danger "Failed to make project! Testing aborted."
separator
exit 1
fi
}
function test_overview {
neutral ""
separator
if [ "$exit_code" == "0" ]
then
success "All tests succeeded!"
else
danger "Some tests failed!"
fi
neutral "${success_tests} succeeded, ${fail_tests} failed, ${ignored_tests} ignored."
separator
}
function post_test {
rm -f ${temp_file}
}
function success {
echo -e "$GREEN$1$RESET"
}
function warning {
echo -e "$YELLOW$1$RESET"
}
function danger {
echo -e "$RED$1$RESET"
}
function neutral {
echo -e "$CYAN$1$RESET"
}
function disabled {
echo -e "$GRAY$1$RESET"
}
function count_tests {
local dir=$1
local counter=0
for test_file in ${dir}*.s
do
if [ -f "${test_file}" ]
then
counter=$((counter+1))
fi
done
echo ${counter}
}
function count_dirs {
local dir=$1
local counter=0
for test_dir in ${dir}*/
do
if [ -d "${test_dir}" ]
then
counter=$((counter+1))
fi
done
echo ${counter}
}
function ensure_trailing_slash {
local dir=$1
local dir_length=$((${#dir}-1))
local last_char=${dir:${dir_length}:1}
if [ ! ${last_char} == "/" ]
then
dir="$dir/"
fi
echo ${dir}
}
function run_test_dir {
local indent=$1
local dir=$(ensure_trailing_slash $2)
local test_count=$(count_tests ${dir})
local dir_count=$(count_dirs ${dir})
local symbol=""
if [ "$(($test_count))" -eq "0" ]
then
symbol=""
fi
echo ""
neutral "$indent$symbol━■ $dir [$test_count tests]"
local index=0
for testfile in ${dir}*.s
do
if [ -f "$testfile" ]
then
index=$((index+1))
local last=""
if [ "$index" -eq "$test_count" ]
then
last="1"
fi
run_test_file "$indent" ${testfile} ${last}
fi
done
for testdir in $dir*/
do
if [ -d "$testdir" ]
then
run_test_dir " $indent" ${testdir}
fi
done
}
function run_test_file {
local indent=$1
local filepath=$2
local last=$3
local filename=$(basename ${filepath})
local type=${filename:0:1}
local command="java -cp bin/:lib/java-cup-11b-runtime.jar SC $filepath"
local out=$(eval "${command}" 2> ${temp_file})
local err=$(cat ${temp_file})
if [ "$type" == "i" ]
then
ignored_tests=$((ignored_tests+1))
if [ -z "$last" ]
then
disabled "${indent}┣━━ IGNR $filename"
else
disabled "${indent}┗━━ IGNR $filename"
fi
return 0;
fi
if [[ "$type" == "p" && "$out" == *"parsing successful"* ]] || [[ "$type" == "n" && ! "$out" == *"parsing successful"* ]]
then
success_tests=$((success_tests+1))
if [ -z "$last" ]
then
success "${indent}┣━━ PASS $filename"
else
success "${indent}┗━━ PASS $filename"
fi
else
fail_tests=$((fail_tests+1))
local symbol="";
if [ -z "$last" ]
then
symbol=""
else
symbol=" "
fi
local message=""
local output=${indent}${symbol}
if [ ! -z "$out" ]; then output=${output}${out//$'\n'/\\n${indent}${symbol}${indent}}; fi
if [ ! -z "$err" ]; then output=${output}${err//$'\n'/\\n${indent}${symbol}${indent}}; fi
if [ "$type" == "p" ]
then
message="Was supposed to succeed but failed."
else
message="Was supposed to fail but succeeded."
fi
if [ -z "$last" ]
then
danger "${indent}┣━┓ FAIL $filename"
danger "${indent}┃ ┗━━ Error: $message"
else
danger "${indent}┗━┓ FAIL $filename"
danger "${indent} ┗━━ Error: $message"
fi
printf "$output\n"
exit_code=1
fi
}
# Print usage instructions if no arguments are supplied
if [ "$#" -eq 0 ]
then
usage
exit 0
fi
# Check that the mode is correct
if [ "$1" != "all" ] && [ "$1" != "dir" ] && [ "$1" != "one" ]
then
danger "Invalid mode!"
exit 1
fi
# Check that the amount of arguments is correct
if [[ ("$1" == "dir" || "$1" == "one") && (! "$#" -eq 2) ]] || [[ "$1" == "all" && (! "$#" -eq 1) ]]
then
danger "Invalid amount of arguments!"
exit 1
fi
pre_test
neutral ""
separator
neutral "Starting tests!"
separator
# Run all tests
if [ "$1" == "all" ]
then
run_test_dir "" ${default_test_dir}
fi
# Run tests dir
if [ "$1" == "dir" ]
then
if [ ! -d "$2" ]
then
danger "'$2' is not a directory!"
exit 1
else
run_test_dir "" $2
fi
fi
# Run test file
if [ "$1" == "one" ]
then
if [ ! -f "$2" ]
then
danger "'$2' is not a file!"
exit 1
else
run_test_file "" $2
fi
fi
test_overview
post_test
exit ${exit_code}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment