2 # SPDX-License-Identifier: GPL-2.0
3 # Copyright (c) 2000-2002,2006 Silicon Graphics, Inc. All Rights Reserved.
5 # Control script for QA
26 brief_test_summary=false
31 # This is a global variable used to pass test failure text to reporting gunk
34 # start the initialisation work now
37 export MSGVERB="text:action"
38 export QA_CHECK_FS=${QA_CHECK_FS:=true}
40 # number of diff lines from a failed test, 0 for whole output
41 export DIFF_LENGTH=${DIFF_LENGTH:=10}
43 # by default don't output timestamps
44 timestamp=${TIMESTAMP:=false}
46 rm -f $tmp.list $tmp.tmp $tmp.grep $here/$iam.out $tmp.xlist $tmp.report.*
48 SRC_GROUPS="generic shared"
49 export SRC_DIR="tests"
53 echo "Usage: $0 [options] [testlist]"'
57 -glusterfs test GlusterFS
60 -virtiofs test virtiofs
66 -udiff show unified diff (default)
67 -n show me, do not run tests
69 -r randomize test order
70 -i <n> iterate the test list <n> times
71 -d dump test output to stdout
73 -R fmt[,fmt] generate report in formats specified. Supported format: [xunit]
74 --large-fs optimise scratch device for large filesystems
75 -s section run only specified section from config file
76 -S section exclude the specified section from the config file
79 -g group[,group...] include tests from these groups
80 -x group[,group...] exclude tests from these groups
81 -X exclude_file exclude individual tests
82 -E external_file exclude individual tests
83 [testlist] include tests matching names in testlist
85 testlist argument is a list of tests in the form of <test dir>/<test name>.
87 <test dir> is a directory under tests that contains a group file,
88 with a list of the names of the tests in that directory.
90 <test name> may be either a specific test file name (e.g. xfs/001) or
91 a test file name match pattern (e.g. xfs/*).
93 group argument is either a name of a tests group to collect from all
94 the test dirs (e.g. quick) or a name of a tests group to collect from
95 a specific tests dir in the form of <test dir>/<group name> (e.g. xfs/quick).
96 If you want to run all the tests in the test suite, use "-g all" to specify all
99 exclude_file argument refers to a name of a file inside each test directory.
100 for every test dir where this file is found, the listed test names are
101 excluded from the list of tests to run from that test dir.
103 external_file argument is a path to a single file containing a list of tests
104 to exclude in the form of <test dir>/<test name>.
110 check -x stress xfs/*
111 check -X .exclude -g auto
112 check -E ~/.xfstests.exclude
122 test -s "$SRC_DIR/$d/group" || return 1
124 local grpl=$(sed -n < $SRC_DIR/$d/group \
127 -e "s;^\($VALID_TEST_NAME\).* $grp .*;$SRC_DIR/$d/\1;p")
135 local sub=$(dirname $grp)
136 local fsgroup="$FSTYP"
138 if [ -n "$sub" -a "$sub" != "." -a -d "$SRC_DIR/$sub" ]; then
139 # group is given as <subdir>/<group> (e.g. xfs/quick)
141 get_sub_group_list $sub $grp
145 if [ "$FSTYP" = ext2 -o "$FSTYP" = ext3 ]; then
148 for d in $SRC_GROUPS $fsgroup; do
149 if ! test -d "$SRC_DIR/$d" ; then
152 grpl="$grpl $(get_sub_group_list $d $grp)"
157 # Find all tests, excluding files that are test metadata such as group files.
158 # It matches test names against $VALID_TEST_NAME defined in common/rc
162 for d in $SRC_GROUPS $FSTYP; do
163 if ! test -d "$SRC_DIR/$d" ; then
168 grep "^$SRC_DIR/$d/$VALID_TEST_NAME"| \
169 grep -v "group\|Makefile" >> $tmp.list 2>/dev/null
173 # takes the list of tests to run in $tmp.list, and removes the tests passed to
174 # the function from that list.
183 if [ $numsed -gt 100 ]; then
184 grep -v -f $tmp.grep <$tmp.list >$tmp.tmp
185 mv $tmp.tmp $tmp.list
189 echo "^$t\$" >>$tmp.grep
190 numsed=`expr $numsed + 1`
192 grep -v -f $tmp.grep <$tmp.list >$tmp.tmp
193 mv $tmp.tmp $tmp.list
212 # Tests specified on the command line
213 if [ -s $tmp.arglist ]; then
214 cat $tmp.arglist > $tmp.list
219 # Specified groups to include
220 # Note that the CLI processing adds a leading space to the first group
221 # parameter, so we have to catch that here checking for "all"
222 if ! $have_test_arg && [ "$GROUP_LIST" == " all" ]; then
223 # no test numbers, do everything
226 for group in $GROUP_LIST; do
227 list=$(get_group_list $group)
228 if [ -z "$list" ]; then
229 echo "Group \"$group\" is empty or not defined?"
234 grep -s "^$t\$" $tmp.list >/dev/null || \
235 echo "$t" >>$tmp.list
240 # Specified groups to exclude
241 for xgroup in $XGROUP_LIST; do
242 list=$(get_group_list $xgroup)
243 if [ -z "$list" ]; then
244 echo "Group \"$xgroup\" is empty or not defined?"
251 # sort the list of tests into numeric order
253 if type shuf >& /dev/null; then
256 sorter="awk -v seed=$RANDOM -f randomize.awk"
261 list=`sort -n $tmp.list | uniq | $sorter`
265 # Process command arguments first.
266 while [ $# -gt 0 ]; do
268 -\? | -h | --help) usage ;;
271 -glusterfs) FSTYP=glusterfs ;;
274 -virtiofs) FSTYP=virtiofs ;;
275 -overlay) FSTYP=overlay; export OVERLAY=true ;;
276 -pvfs2) FSTYP=pvfs2 ;;
277 -tmpfs) FSTYP=tmpfs ;;
278 -ubifs) FSTYP=ubifs ;;
280 -g) group=$2 ; shift ;
281 GROUP_LIST="$GROUP_LIST ${group//,/ }"
284 -x) xgroup=$2 ; shift ;
285 XGROUP_LIST="$XGROUP_LIST ${xgroup//,/ }"
288 -X) subdir_xfile=$2; shift ;
290 -E) xfile=$2; shift ;
291 if [ -f $xfile ]; then
292 sed "s/#.*$//" "$xfile" >> $tmp.xlist
295 -s) RUN_SECTION="$RUN_SECTION $2"; shift ;;
296 -S) EXCLUDE_SECTION="$EXCLUDE_SECTION $2"; shift ;;
298 -udiff) diff="$diff -u" ;;
301 -r) randomize=true ;;
302 -i) iterations=$2; shift ;;
303 -T) timestamp=true ;;
304 -d) DUMP_OUTPUT=true ;;
305 -b) brief_test_summary=true;;
306 -R) report_fmt=$2 ; shift ;
307 REPORT_LIST="$REPORT_LIST ${report_fmt//,/ }"
310 --large-fs) export LARGE_SCRATCH_DEV=yes ;;
311 --extra-space=*) export SCRATCH_DEV_EMPTY_SPACE=${r#*=} ;;
314 *) # not an argument, we've got tests now.
315 have_test_arg=true ;;
318 # if we've found a test specification, the break out of the processing
319 # loop before we shift the arguments so that this is the first argument
320 # that we process in the test arg loop below.
321 if $have_test_arg; then
328 # we need common/rc, that also sources common/config. We need to source it
329 # after processing args, overlay needs FSTYP set before sourcing common/config
330 if ! . ./common/rc; then
331 echo "check: failed to source common/rc"
335 if [ -n "$subdir_xfile" ]; then
336 for d in $SRC_GROUPS $FSTYP; do
337 [ -f $SRC_DIR/$d/$subdir_xfile ] || continue
338 for f in `sed "s/#.*$//" $SRC_DIR/$d/$subdir_xfile`; do
339 echo $d/$f >> $tmp.xlist
344 # Process tests from command line now.
345 if $have_test_arg; then
346 while [ $# -gt 0 ]; do
348 -*) echo "Arguments before tests, please!"
352 *) # Expand test pattern (e.g. xfs/???, *fs/001)
353 list=$(cd $SRC_DIR; echo $1)
355 test_dir=`dirname $t`
356 test_dir=${test_dir#$SRC_DIR/*}
357 test_name=`basename $t`
358 group_file=$SRC_DIR/$test_dir/group
360 if egrep -q "^$test_name" $group_file; then
361 # in group file ... OK
362 echo $SRC_DIR/$test_dir/$test_name \
366 echo "$t - unknown test, ignored"
374 elif [ -z "$GROUP_LIST" ]; then
375 # default group list is the auto group. If any other group or test is
376 # specified, we use that instead.
382 echo "check: QA must be run as root"
397 check="$RESULT_BASE/check"
407 if [ -f $check.time -a -f $tmp.time ]; then
408 cat $check.time $tmp.time \
413 for (i in t) print i " " t[i]
417 mv $tmp.out $check.time
423 echo "SECTION -- $section" >>$tmp.summary
424 echo "=========================" >>$tmp.summary
425 if [ ! -z "$n_try" -a $n_try != 0 ]; then
426 if [ $brief_test_summary == "false" ]; then
428 echo "Ran:$try" >>$tmp.summary
430 echo "Ran:$try" >>$check.log
433 $interrupt && echo "Interrupted!" | tee -a $check.log
435 if [ ! -z "$notrun" ]; then
436 if [ $brief_test_summary == "false" ]; then
437 echo "Not run:$notrun"
438 echo "Not run:$notrun" >>$tmp.summary
440 echo "Not run:$notrun" >>$check.log
443 if [ ! -z "$n_bad" -a $n_bad != 0 ]; then
445 echo "Failed $n_bad of $n_try tests"
446 echo "Failures:$bad" >>$check.log
447 echo "Failed $n_bad of $n_try tests" >>$check.log
448 echo "Failures:$bad" >>$tmp.summary
449 echo "Failed $n_bad of $n_try tests" >>$tmp.summary
451 echo "Passed all $n_try tests"
452 echo "Passed all $n_try tests" >>$check.log
453 echo "Passed all $n_try tests" >>$tmp.summary
455 echo "" >>$tmp.summary
462 sum_bad=`expr $sum_bad + $n_bad`
464 rm -f /tmp/*.rawout /tmp/*.out /tmp/*.err /tmp/*.time
465 if ! $OPTIONS_HAVE_SECTIONS; then
476 count=`wc -L $tmp.summary | cut -f1 -d" "`
485 if [ -f ${RESULT_DIR}/require_test ]; then
486 _check_test_fs || err=true
487 rm -f ${RESULT_DIR}/require_test*
489 _test_unmount 2> /dev/null
491 if [ -f ${RESULT_DIR}/require_scratch ]; then
492 _check_scratch_fs || err=true
493 rm -f ${RESULT_DIR}/require_scratch*
495 _scratch_unmount 2> /dev/null
501 if [ -s $tmp.xlist ]; then
502 if grep -q $TEST_ID $tmp.xlist; then
510 # Make the check script unattractive to the OOM killer...
511 OOM_SCORE_ADJ="/proc/self/oom_score_adj"
512 test -w ${OOM_SCORE_ADJ} && echo -1000 > ${OOM_SCORE_ADJ}
514 # ...and make the tests themselves somewhat more attractive to it, so that if
515 # the system runs out of memory it'll be the test that gets killed and not the
518 bash -c "test -w ${OOM_SCORE_ADJ} && echo 250 > ${OOM_SCORE_ADJ}; exec ./$seq"
524 if $OPTIONS_HAVE_SECTIONS; then
525 trap "_summary; exit \$status" 0 1 2 3 15
527 trap "_wrapup; exit \$status" 0 1 2 3 15
530 function run_section()
535 OLD_TEST_FS_MOUNT_OPTS=$TEST_FS_MOUNT_OPTS
536 get_next_config $section
538 # Do we need to run only some sections ?
539 if [ ! -z "$RUN_SECTION" ]; then
541 for s in $RUN_SECTION; do
542 if [ $section == $s ]; then
552 # Did this section get excluded?
553 if [ ! -z "$EXCLUDE_SECTION" ]; then
555 for s in $EXCLUDE_SECTION; do
556 if [ $section == $s ]; then
566 mkdir -p $RESULT_BASE
567 if [ ! -d $RESULT_BASE ]; then
568 echo "failed to create results directory $RESULT_BASE"
573 if $OPTIONS_HAVE_SECTIONS; then
574 echo "SECTION -- $section"
577 sect_start=`_wallclock`
578 if $RECREATE_TEST_DEV || [ "$OLD_FSTYP" != "$FSTYP" ]; then
579 echo "RECREATING -- $FSTYP on $TEST_DEV"
580 _test_unmount 2> /dev/null
581 if ! _test_mkfs >$tmp.err 2>&1
583 echo "our local _test_mkfs routine ..."
585 echo "check: failed to mkfs \$TEST_DEV using specified options"
591 echo "check: failed to mount $TEST_DEV on $TEST_DIR"
596 elif [ "$OLD_TEST_FS_MOUNT_OPTS" != "$TEST_FS_MOUNT_OPTS" ]; then
597 _test_unmount 2> /dev/null
600 echo "check: failed to mount $TEST_DEV on $TEST_DIR"
609 check="$RESULT_BASE/check"
611 # don't leave old full output behind on a clean run
614 [ -f $check.time ] || touch $check.time
616 # print out our test configuration
617 echo "FSTYP -- `_full_fstyp_details`"
618 echo "PLATFORM -- `_full_platform_details`"
619 if [ ! -z "$SCRATCH_DEV" ]; then
620 echo "MKFS_OPTIONS -- `_scratch_mkfs_options`"
621 echo "MOUNT_OPTIONS -- `_scratch_mount_options`"
626 if [ ! -z "$SCRATCH_DEV" ]; then
627 _scratch_unmount 2> /dev/null
628 # call the overridden mkfs - make sure the FS is built
629 # the same as we'll create it later.
631 if ! _scratch_mkfs >$tmp.err 2>&1
633 echo "our local _scratch_mkfs routine ..."
635 echo "check: failed to mkfs \$SCRATCH_DEV using specified options"
640 # call the overridden mount - make sure the FS mounts with
641 # the same options that we'll mount with later.
642 if ! _try_scratch_mount >$tmp.err 2>&1
644 echo "our local mount routine ..."
646 echo "check: failed to mount \$SCRATCH_DEV using specified options"
660 for seq in $list ; do
661 # Run report for previous test!
664 n_bad=`expr $n_bad + 1`
667 if $do_report && ! $first_test ; then
668 if [ $tc_status != "expunge" ] ; then
669 _make_testcase_report "$prev_seq" "$tc_status"
676 if [ ! -f $seq ]; then
677 # Try to get full name in case the user supplied only
678 # seq id and the test has a name. A bit of hassle to
679 # find really the test and not its sample output or
681 bname=$(basename $seq)
682 full_seq=$(find $(dirname $seq) -name $bname* -executable |
683 awk '(NR == 1 || length < length(shortest)) { shortest = $0 }\
684 END { print shortest }')
685 if [ -f $full_seq ] && \
686 [ x$(echo $bname | grep -o "^$VALID_TEST_ID") != x ]; then
691 # the filename for the test and the name output are different.
692 # we don't include the tests/ directory in the name output.
693 export seqnum=`echo $seq | sed -e "s;$SRC_DIR/;;"`
695 # Similarly, the result directory needs to replace the tests/
696 # part of the test location.
698 if $OPTIONS_HAVE_SECTIONS; then
699 export RESULT_DIR=`echo $group | sed -e "s;$SRC_DIR;${RESULT_BASE}/$section;"`
700 REPORT_DIR="$RESULT_BASE/$section"
702 export RESULT_DIR=`echo $group | sed -e "s;$SRC_DIR;$RESULT_BASE;"`
703 REPORT_DIR="$RESULT_BASE"
705 seqres="$REPORT_DIR/$seqnum"
708 rm -f ${RESULT_DIR}/require_scratch*
709 rm -f ${RESULT_DIR}/require_test*
713 _expunge_test $seqnum
714 if [ $? -eq 1 ]; then
722 n_notrun=`expr $n_notrun + 1`
727 if [ ! -f $seq ]; then
728 echo " - no such test?"
732 # really going to try and run this one
733 rm -f $seqres.out.bad
735 # check if we really should run it
736 _expunge_test $seqnum
737 if [ $? -eq 1 ]; then
742 # record that we really tried to run this test.
744 n_try=`expr $n_try + 1`
746 # slashes now in names, sed barfs on them so use grep
747 lasttime=`grep -w ^$seqnum $check.time | awk '// {print $2}'`
748 if [ "X$lasttime" != X ]; then
749 echo -n " ${lasttime}s ... "
751 echo -n " " # prettier output with timestamps.
753 rm -f core $seqres.notrun
756 $timestamp && echo -n " ["`date "+%T"`"]"
757 [ ! -x $seq ] && chmod u+x $seq # ensure we can run it
758 $LOGGER_PROG "run xfstest $seqnum"
759 if [ -w /dev/kmsg ]; then
760 export date_time=`date +"%F %T"`
761 echo "run fstests $seqnum at $date_time" > /dev/kmsg
762 # _check_dmesg depends on this log in dmesg
763 touch ${RESULT_DIR}/check_dmesg
765 _try_wipe_scratch_devs > /dev/null 2>&1
767 # clear the WARN_ONCE state to allow a potential problem
768 # to be reported for each test
769 (echo 1 > $DEBUGFS_MNT/clear_warn_once) > /dev/null 2>&1
771 if [ "$DUMP_OUTPUT" = true ]; then
772 _run_seq 2>&1 | tee $tmp.out
773 # Because $? would get tee's return code
776 _run_seq >$tmp.out 2>&1
781 _dump_err_cont "[dumped core]"
782 mv core $RESULT_BASE/$seqnum.core
786 if [ -f $seqres.notrun ]; then
787 $timestamp && _timestamp
789 $timestamp || echo -n "[not run] "
790 $timestamp && echo " [not run]" && \
791 echo -n " $seqnum -- "
793 notrun="$notrun $seqnum"
794 n_notrun=`expr $n_notrun + 1`
799 if [ $sts -ne 0 ]; then
800 _dump_err_cont "[failed, exit status $sts]"
801 _test_unmount 2> /dev/null
802 _scratch_unmount 2> /dev/null
803 rm -f ${RESULT_DIR}/require_test*
804 rm -f ${RESULT_DIR}/require_scratch*
807 # the test apparently passed, so check for corruption
808 # and log messages that shouldn't be there.
810 _check_dmesg || err=true
813 # Reload the module after each test to check for leaks or
815 if [ -n "${TEST_FS_MODULE_RELOAD}" ]; then
816 _test_unmount 2> /dev/null
817 _scratch_unmount 2> /dev/null
818 modprobe -r fs-$FSTYP
822 # Scan for memory leaks after every test so that associating
823 # a leak to a particular test will be as accurate as possible.
824 _check_kmemleak || err=true
826 # test ends after all checks are done.
827 $timestamp && _timestamp
830 if [ ! -f $seq.out ]; then
831 _dump_err "no qualified output"
836 # coreutils 8.16+ changed quote formats in error messages
837 # from `foo' to 'foo'. Filter old versions to match the new
839 sed -i "s/\`/\'/g" $tmp.out
840 if diff $seq.out $tmp.out >/dev/null 2>&1 ; then
842 echo "$seqnum `expr $stop - $start`" >>$tmp.time
843 echo -n " `expr $stop - $start`s"
847 _dump_err "- output mismatch (see $seqres.out.bad)"
848 mv $tmp.out $seqres.out.bad
849 $diff $seq.out $seqres.out.bad | {
850 if test "$DIFF_LENGTH" -le 0; then
853 head -n "$DIFF_LENGTH"
855 echo "(Run '$diff $here/$seq.out $seqres.out.bad'" \
856 " to see the entire diff)"
857 fi; } | sed -e 's/^\(.\)/ \1/'
862 # make sure we record the status of the last test we ran.
865 n_bad=`expr $n_bad + 1`
868 if $do_report && ! $first_test ; then
869 if [ $tc_status != "expunge" ] ; then
870 _make_testcase_report "$prev_seq" "$tc_status"
874 sect_stop=`_wallclock`
880 _test_unmount 2> /dev/null
881 _scratch_unmount 2> /dev/null
884 for ((iters = 0; iters < $iterations; iters++)) do
885 for section in $HOST_OPTIONS_SECTIONS; do
891 status=`expr $sum_bad != 0`