test.sh

#!/bin/bash -e
# runs all (or selected) test suite(s) in test/ and aggregates results
# Usage:
#	./test.sh
#	./test.sh gofmt

# library of utility functions
# shellcheck disable=SC1091
. test/util.sh

# allow specifying a single testsuite to run
testsuite="$1"

# print environment when running all testsuites
fold_start environment
test -z "$testsuite" && (echo "ENV:"; env | sort; echo;)
fold_end environment

# make it easy to split test into blocks
label-block() {
	if $(env | grep -q -e '^TEST_BLOCK='"$1"'$') || $(! env | grep -q -e '^TEST_BLOCK=') || $(env | grep -q -e '^TEST_BLOCK=$'); then
		return 0
	else
		return 1	# not my block
	fi
}

# run a test and record failures
function run-testsuite() {
	testname="$(basename "$1" .sh)"
	# if not running all tests or if this test is not explicitly selected, skip it
	if test -z "$testsuite" || test "test-$testsuite" = "$testname"; then
		fold_start "$testname"
		description="$testname ($@)"
		"$@" || failures=$([ -n "$failures" ] && echo "$failures\\n$description" || echo "$description")
		fold_end "$testname"
	fi
}

# only run test if it is explicitly selected, otherwise report it is skipped
function skip-testsuite() {
	testname=$(basename "$1" .sh)
	# show skip message only when running full suite
	if test -z "$testsuite"; then
		echo skipping "$@" "($REASON)"
		echo 'SKIP'
	else
		# if a skipped suite is explicity called, run it anyway
		if test "test-$testsuite" == "$testname"; then
			run-testsuite "$@"
		fi
	fi
}

# used at the end to tell if everything went fine
failures=''

if label-block "basic"; then
	run-testsuite ./test/test-vet.sh
	run-testsuite ./test/test-misc.sh
	run-testsuite ./test/test-gofmt.sh
	run-testsuite ./test/test-mclfmt.sh
	run-testsuite ./test/test-yamlfmt.sh
	run-testsuite ./test/test-bashfmt.sh
	run-testsuite ./test/test-headerfmt.sh
	run-testsuite ./test/test-markdownlint.sh
	run-testsuite ./test/test-commit-message.sh
	run-testsuite ./test/test-govet.sh
	run-testsuite ./test/test-examples.sh
	run-testsuite ./test/test-gotest.sh
	# FIXME: this fails with go.mod
	skip-testsuite ./test/test-gometalinter.sh
	run-testsuite ./test/test-golint.sh	# test last, because this test is somewhat arbitrary
	# FIXME: this now fails everywhere :(
	skip-testsuite ./test/test-reproducible.sh
fi

# skipping: https://github.com/purpleidea/mgmt/issues/327
# run-test ./test/test-crossbuild.sh

# do these longer tests only when running on ci
if in_env; then
	if label-block "shell"; then
		run-testsuite ./test/test-shell.sh
	fi
	if label-block "race"; then
		run-testsuite ./test/test-gotest.sh --race
		run-testsuite ./test/test-integration.sh --race
	fi

	# XXX: fix and enable these on travis (sudo: go: command not found)
	#run-testsuite ./test/test-gotest.sh --root
	#run-testsuite ./test/test-gotest.sh --root --race
	#run-testsuite ./test/test-integration.sh --root
	#run-testsuite ./test/test-integration.sh --root --race
else
	REASON="CI server only test" skip-testsuite ./test/test-shell.sh
	REASON="CI server only test" skip-testsuite ./test/test-gotest.sh --race
	REASON="CI server only test" skip-testsuite ./test/test-integration.sh
	REASON="CI server only test" skip-testsuite ./test/test-integration.sh --race

	REASON="CI server only test" skip-testsuite ./test/test-gotest.sh --root
	REASON="CI server only test" skip-testsuite ./test/test-gotest.sh --root --race
	REASON="CI server only test" skip-testsuite ./test/test-integration.sh --root
	REASON="CI server only test" skip-testsuite ./test/test-integration.sh --root --race
fi


# run omv tests on jenkins physical hosts only
if env | grep -q -e '^JENKINS_URL=' -e '^BUILD_TAG=jenkins'; then
	run-testsuite ./test/test-omv.sh
else
	REASON="CI server only test" skip-testsuite ./test/test-omv.sh
fi

REASON="https://github.com/purpleidea/mgmt/issues/327" skip-testsuite ./test/test-crossbuild.sh

if [[ -n "$failures" ]]; then
	echo 'FAIL'
	echo 'The following tests have failed:'
	echo -e "$failures"
	echo
	echo 'You can rerun a single suite like so:'
	echo
	echo '`make test-gofmt` or `make test-shell-<testname>`'
	exit 1
fi
echo 'ALL PASSED'