xref: /linux/tools/testing/selftests/kselftest/runner.sh (revision 2634682fdffd9ba6e74b76be8aa91cf8b2e05c41)
1#!/bin/sh
2# SPDX-License-Identifier: GPL-2.0
3#
4# Runs a set of tests in a given subdirectory.
5export skip_rc=4
6export timeout_rc=124
7export logfile=/dev/stdout
8export per_test_logging=
9
10# Defaults for "settings" file fields:
11# "timeout" how many seconds to let each test run before failing.
12export kselftest_default_timeout=45
13
14# There isn't a shell-agnostic way to find the path of a sourced file,
15# so we must rely on BASE_DIR being set to find other tools.
16if [ -z "$BASE_DIR" ]; then
17	echo "Error: BASE_DIR must be set before sourcing." >&2
18	exit 1
19fi
20
21# If Perl is unavailable, we must fall back to line-at-a-time prefixing
22# with sed instead of unbuffered output.
23tap_prefix()
24{
25	if [ ! -x /usr/bin/perl ]; then
26		sed -e 's/^/# /'
27	else
28		"$BASE_DIR"/kselftest/prefix.pl
29	fi
30}
31
32tap_timeout()
33{
34	# Make sure tests will time out if utility is available.
35	if [ -x /usr/bin/timeout ] ; then
36		/usr/bin/timeout --foreground "$kselftest_timeout" "$1"
37	else
38		"$1"
39	fi
40}
41
42run_one()
43{
44	DIR="$1"
45	TEST="$2"
46	NUM="$3"
47
48	BASENAME_TEST=$(basename $TEST)
49
50	# Reset any "settings"-file variables.
51	export kselftest_timeout="$kselftest_default_timeout"
52	# Load per-test-directory kselftest "settings" file.
53	settings="$BASE_DIR/$DIR/settings"
54	if [ -r "$settings" ] ; then
55		while read line ; do
56			# Skip comments.
57			if echo "$line" | grep -q '^#'; then
58				continue
59			fi
60			field=$(echo "$line" | cut -d= -f1)
61			value=$(echo "$line" | cut -d= -f2-)
62			eval "kselftest_$field"="$value"
63		done < "$settings"
64	fi
65
66	TEST_HDR_MSG="selftests: $DIR: $BASENAME_TEST"
67	echo "# $TEST_HDR_MSG"
68	if [ ! -x "$TEST" ]; then
69		echo -n "# Warning: file $TEST is "
70		if [ ! -e "$TEST" ]; then
71			echo "missing!"
72		else
73			echo "not executable, correct this."
74		fi
75		echo "not ok $test_num $TEST_HDR_MSG"
76	else
77		cd `dirname $TEST` > /dev/null
78		((((( tap_timeout ./$BASENAME_TEST 2>&1; echo $? >&3) |
79			tap_prefix >&4) 3>&1) |
80			(read xs; exit $xs)) 4>>"$logfile" &&
81		echo "ok $test_num $TEST_HDR_MSG") ||
82		(rc=$?;	\
83		if [ $rc -eq $skip_rc ]; then	\
84			echo "ok $test_num $TEST_HDR_MSG # SKIP"
85		elif [ $rc -eq $timeout_rc ]; then \
86			echo "#"
87			echo "not ok $test_num $TEST_HDR_MSG # TIMEOUT $kselftest_timeout seconds"
88		else
89			echo "not ok $test_num $TEST_HDR_MSG # exit=$rc"
90		fi)
91		cd - >/dev/null
92	fi
93}
94
95run_many()
96{
97	echo "TAP version 13"
98	DIR="${PWD#${BASE_DIR}/}"
99	test_num=0
100	total=$(echo "$@" | wc -w)
101	echo "1..$total"
102	for TEST in "$@"; do
103		BASENAME_TEST=$(basename $TEST)
104		test_num=$(( test_num + 1 ))
105		if [ -n "$per_test_logging" ]; then
106			logfile="/tmp/$BASENAME_TEST"
107			cat /dev/null > "$logfile"
108		fi
109		run_one "$DIR" "$TEST" "$test_num"
110	done
111}
112