Files
linux/tools/testing/selftests/run_kselftest.sh
Brendan Jackman d9e6269e33 selftests/run_kselftest.sh: exit with error if tests fail
Parsing KTAP is quite an inconvenience, but most of the time the thing
you really want to know is "did anything fail"?

Let's give the user the his information without them needing
to parse anything.

Because of the use of subshells and namespaces, this needs to be
communicated via a file. Just write arbitrary data into the file and
treat non-empty content as a signal that something failed.

In case any user depends on the current behaviour, such as running this
from a script with `set -e` and parsing the result for failures
afterwards, add a flag they can set to get the old behaviour, namely
--no-error-on-fail.

Link: https://lore.kernel.org/r/20251111-b4-ksft-error-on-fail-v3-1-0951a51135f6@google.com
Signed-off-by: Brendan Jackman <jackmanb@google.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
2025-11-19 15:00:22 -07:00

128 lines
3.0 KiB
Bash
Executable File

#!/bin/sh
# SPDX-License-Identifier: GPL-2.0
#
# Run installed kselftest tests.
#
# Fallback to readlink if realpath is not available
if which realpath > /dev/null; then
BASE_DIR=$(realpath $(dirname $0))
else
BASE_DIR=$(readlink -f $(dirname $0))
fi
cd $BASE_DIR
TESTS="$BASE_DIR"/kselftest-list.txt
if [ ! -r "$TESTS" ] ; then
echo "$0: Could not find list of tests to run ($TESTS)" >&2
available=""
else
available="$(cat "$TESTS")"
fi
. ./kselftest/runner.sh
ROOT=$PWD
usage()
{
cat <<EOF
Usage: $0 [OPTIONS]
-s | --summary Print summary with detailed log in output.log (conflict with -p)
-p | --per-test-log Print test log in /tmp with each test name (conflict with -s)
-t | --test COLLECTION:TEST Run TEST from COLLECTION
-c | --collection COLLECTION Run all tests from COLLECTION
-l | --list List the available collection:test entries
-d | --dry-run Don't actually run any tests
-f | --no-error-on-fail Don't exit with an error just because tests failed
-n | --netns Run each test in namespace
-h | --help Show this usage info
-o | --override-timeout Number of seconds after which we timeout
EOF
exit $1
}
COLLECTIONS=""
TESTS=""
dryrun=""
kselftest_override_timeout=""
ERROR_ON_FAIL=true
while true; do
case "$1" in
-s | --summary)
logfile="$BASE_DIR"/output.log
cat /dev/null > $logfile
shift ;;
-p | --per-test-log)
per_test_logging=1
shift ;;
-t | --test)
TESTS="$TESTS $2"
shift 2 ;;
-c | --collection)
COLLECTIONS="$COLLECTIONS $2"
shift 2 ;;
-l | --list)
echo "$available"
exit 0 ;;
-d | --dry-run)
dryrun="echo"
shift ;;
-f | --no-error-on-fail)
ERROR_ON_FAIL=false
shift ;;
-n | --netns)
RUN_IN_NETNS=1
shift ;;
-o | --override-timeout)
kselftest_override_timeout="$2"
shift 2 ;;
-h | --help)
usage 0 ;;
"")
break ;;
*)
usage 1 ;;
esac
done
# Add all selected collections to the explicit test list.
if [ -n "$COLLECTIONS" ]; then
for collection in $COLLECTIONS ; do
found="$(echo "$available" | grep "^$collection:")"
if [ -z "$found" ] ; then
echo "No such collection '$collection'" >&2
exit 1
fi
TESTS="$TESTS $found"
done
fi
# Replace available test list with explicitly selected tests.
if [ -n "$TESTS" ]; then
valid=""
for test in $TESTS ; do
found="$(echo "$available" | grep "^${test}$")"
if [ -z "$found" ] ; then
echo "No such test '$test'" >&2
exit 1
fi
valid="$valid $found"
done
available="$(echo "$valid" | sed -e 's/ /\n/g')"
fi
kselftest_failures_file="$(mktemp --tmpdir kselftest-failures-XXXXXX)"
export kselftest_failures_file
collections=$(echo "$available" | cut -d: -f1 | sort | uniq)
for collection in $collections ; do
[ -w /dev/kmsg ] && echo "kselftest: Running tests in $collection" >> /dev/kmsg
tests=$(echo "$available" | grep "^$collection:" | cut -d: -f2)
($dryrun cd "$collection" && $dryrun run_many $tests)
done
failures="$(cat "$kselftest_failures_file")"
rm "$kselftest_failures_file"
if "$ERROR_ON_FAIL" && [ "$failures" ]; then
exit 1
fi