run-test.sh

#!/usr/bin/env bash

# This is the entrypoint to the testing system, written for Baystation12 and
# inspired by Rust's configure system
#
# Warn: this is modified version of run-test.sh that Baystation12 uses, so keep that in mind.
#
# The general structure of the test execution is as follows:
# - find_code:              Look for the project root directory and fail fast if
#                           it can't be found. Assumes that it is in . or ..;
#                           custom locations can be specified in CODEPATH
#                           environment variable.
# - run_all_tests:          Run every test group in sequence.
# - run_xxx_tests:          Run the tests for $xxx, doing any necessary setup
#                           first, including calling find_xxx_deps.
# - find_xxx_deps:          Using need_cmd, ensure that programs needed to run
#                           tests that are part of $xxx are available.
# - need_cmd:               Checks availability of command passed as the single
#                           argument. Fails fast if it's not available.
# - err:                    Prints arguments as text, exits indicating failure.
# - warn:                   Prints arguments as text, indicating a warning
#                           condition.
# - msg:                    Used by all printing, formats text nicely.
# - run_test:               Runs a test. The first argument is the friendly name
#                           of the test. The remaining arguments are the shell
#                           command(s) to run. If a test fails, a global counter
#                           is incremented and a warning is emitted.
# - run_test_fail:          Exactly as run_test, but considers failure of the
#                           command to be a successful test.
# - exec_test:              Called by run_test{,fail}, actually executes the
#                           test and returns its resulti.
# - check_fail:             Called at the end of the run, prints final report
# and sets exit status appropriately.
# !!!!!!!! Instructions for adding tests:
# In general, if you want to add a test, it will probably belong to one of the
# groups that already exists. Add it to the relevant run_xxx_tests function, and
# if it introduces any new dependencies, add them to the check_xxx_deps
# function. Some dependencies are guaranteed to be on CI platforms by outside
# means (like .travis.yml), others will need to be installed by this script.
# You'll see plenty of examples of checking for CI and gating tests on that,
# installing instead of checking when running on CI.
#
# If you are *SURE* you need to add a new test group, you'll want to add it
# first to the case at the end of the file, and then add the run_xxx_tests and
# find_xxx_deps for it, adding things to them as appropriate. Importantly, make
# sure to also call run_xxx_tests from run_all_tests. Make sure also to call
# your find_xxx_deps from run_xxx_tests.
#
# Good luck!
# - xales

# Global counter of failed tests
FAILED=0
# List of names of failed tests
FAILED_BYNAME=()
# Global counter of passed tests
PASSED=0

function msg {
    echo -e "\t\e[34mtest\e[0m: $*"
}

function msg_bad {
    echo -e "\e[31m$*\e[0m"
}

function msg_good {
    echo -e "\e[32m$*\e[0m"
}

function msg_meh {
    echo -e "\e[33m$*\e[0m"
}

function warn {
    msg_meh "WARNING: $*"
}

function err {
    msg_bad "error: $*"
    exit 1
}

function fail {
    warn "test \"$1\" failed: $2"
    ((FAILED++))
    FAILED_BYNAME+=("$1")
}

function need_cmd {
    if command -v $1 >/dev/null 2>&1
    then msg "found '$1'"
    else err "program '$1' is missing, please install it"
    fi
}

function run_test {
    msg "running \"$1\""
    name=$1
    shift
    exec_test "$*"
    ret=$?
    if [[ ret -ne 0 ]]
    then fail "$name" $ret
    else ((PASSED++))
    fi
}

function run_test_fail {
    msg "running(fail) \"$1\""
    name=$1
    shift
    exec_test "$*"
    ret=$?
    if [[ ret -eq 0 ]]
    then fail "$name" $ret
    else ((PASSED++))
    fi
}

function check_fail {
    if [[ $FAILED -ne 0 ]]; then
        for t in "${FAILED_BYNAME[@]}"; do
            msg_bad "TEST FAILED: \"$t\""
        done
        err "$FAILED tests failed"
    else msg_good "$PASSED tests passed"
    fi
}

function exec_test {
    eval "$*"
    ret=$?
    return $ret
}

function find_tool_deps {
    need_cmd grep
    need_cmd awk
    need_cmd md5sum
    need_cmd python2
    need_cmd python3
}

function find_byond_deps {
    [[ "$CI" != "true" ]] && need_cmd DreamDaemon
}

function find_code {
    if [[ -z ${CODEPATH+x} ]]; then
        if [[ -d ./code ]]
        then CODEPATH=.
        else if [[ -d ../code ]]
            then CODEPATH=..
            fi
        fi
    fi
    cd $CODEPATH
    if [[ ! -d ./code ]]
    then err "invalid CODEPATH: $PWD"
    else msg "found code at $PWD"
    fi
}

function run_code_tests {
    msg "*** running code tests ***"
    run_test_fail "code contains no byond escapes" "grep -REnr --include='*.dm' '\\\\(red|blue|green|black|b|i)\s' code/"
    run_test_fail "ensure code, nanoui templates, icons unique" "find code/ nano/templates/ icons/ -type f -exec md5sum {} + | sort | uniq -D -w 32 | grep -w 'code\|nano\|icons'"
    run_test_fail "ensure code, nanoui templates, icons has no empty files" "find code/ nano/templates/ icons/ -empty -type f | grep -w 'code\|nano\|icons'"
    run_test_fail "no invalid spans" "grep -REnr --include='*.dm' \"<\s*span\s+class\s*=\s*('[^'>]+|[^'>]+')\s*>\" code/"
    run_test_fail "code contains path as string \"/path/\"" "grep -P '\"/(obj|datum|atom|turf|area|mob)/[^\[\s\(]*\"' code/**/*.dm"
    run_test_fail "changed files contains proc argument starting with 'var'" "grep -P '^/[\w/]\S+\(.*(var/|, ?var/.*).*\)' code/**/*.dm"
    run_test "indentation check" "awk -f scripts/indentation.awk **/*.dm"
    run_test "check tags" "python2 scripts/tag-matcher.py ."
    run_test "check color hex" "python2 scripts/color-hex-checker.py ."
    run_test "check playsound volume_channel argument" "python2 scripts/playsound-checker.py ."
}

function run_map_tests {
    msg "*** running map tests ***"
    run_test "maps contains TGM header" "python3 scripts/maps-tgm-checker.py maps/"
    run_test_fail "maps contains no step_[xy]" "grep -REnr --include='*.dmm' 'step_[xy]' maps/"
    run_test_fail "maps contains no tag" "grep -REnr --include='*.dmm' '\<tag =' maps/"
}

function run_build_tests {
    find_byond_deps
    msg "*** running build tests ***"
    echo '#include "additional_files.dm"' >> taucetistation.dme # include file with additional includes
    python3 scripts/include-additional-files.py maps/ ".+\.dmm$" # create file itself
    run_test "simple build test" "scripts/dm.sh taucetistation.dme"
    run_test "check no warnings in build" "grep ', 0 warnings' build_log.txt"
}

function run_unit_tests {
    find_byond_deps
    cp config/example/* config/
    mkdir -p data/ && cp maps/$MAP_META.json data/next_map.json
    msg "*** running unit tests ***"
    run_test "build unit tests" "scripts/dm.sh -DUNIT_TEST taucetistation.dme"
    run_test "unit tests" "DreamDaemon taucetistation.dmb -invisible -trusted -core 2>&1 | tee log.txt"
    run_test "check correct map loaded" "grep 'Loading $MAP_NAME' log.txt"
    run_test "check tests passed" "grep 'All Unit Tests Passed' log.txt"
    run_test "check no runtimes" "grep 'Caught 0 Runtimes' log.txt"
    run_test_fail "check no runtimes 2" "grep 'runtime error:' log.txt"
    run_test_fail "check no warnings" "grep 'WARNING:' log.txt"
    run_test_fail "check no errors" "grep 'ERROR:' log.txt"
}

function run_configured_tests {
    if [[ -z ${TEST+z} ]]; then
        msg_bad "You must provide TEST in environment; valid options: LINTING, COMPILE, UNIT"
        exit 1
    fi

    case $TEST in
        "LINTING")
            shopt -s globstar
            find_tool_deps
            run_code_tests
            run_map_tests
        ;;
        "COMPILE") run_build_tests ;;
        "UNIT")
            if [[ -z ${MAP_META+z} || -z ${MAP_NAME+z} ]]; then
                msg_bad "You must provide MAP_META and MAP_NAME in environment to use with unit tests"
                exit 1
            fi

            run_unit_tests
        ;;
        *) fail "invalid option for \$TEST: '$TEST'" ;;
    esac
}

find_code
run_configured_tests
check_fail