2 # shellcheck disable=SC2154
6 # The contents of this file are subject to the terms of the
7 # Common Development and Distribution License, Version 1.0 only
8 # (the "License"). You may not use this file except in compliance
11 # You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
12 # or http://www.opensolaris.org/os/licensing.
13 # See the License for the specific language governing permissions
14 # and limitations under the License.
16 # When distributing Covered Code, include this CDDL HEADER in each
17 # file and include the License file at usr/src/OPENSOLARIS.LICENSE.
18 # If applicable, add the following below this CDDL HEADER, with the
19 # fields enclosed by brackets "[]" replaced with your own identifying
20 # information: Portions Copyright [yyyy] [name of copyright owner]
26 # Copyright 2020 OmniOS Community Edition (OmniOSce) Association.
29 BASE_DIR
=$
(dirname "$0")
30 SCRIPT_COMMON
=common.sh
31 if [ -f "${BASE_DIR}/${SCRIPT_COMMON}" ]; then
32 .
"${BASE_DIR}/${SCRIPT_COMMON}"
34 echo "Missing helper script ${SCRIPT_COMMON}" && exit 1
45 DEFAULT_RUNFILES
="common.run,$(uname | tr '[:upper:]' '[:lower:]').run"
46 RUNFILES
=${RUNFILES:-$DEFAULT_RUNFILES}
47 FILEDIR
=${FILEDIR:-/var/tmp}
53 ZFS_DBGMSG
="$STF_SUITE/callbacks/zfs_dbgmsg.ksh"
54 ZFS_DMESG
="$STF_SUITE/callbacks/zfs_dmesg.ksh"
59 # Override some defaults if on FreeBSD
60 if [ "$UNAME" = "FreeBSD" ] ; then
61 TESTFAIL_CALLBACKS
=${TESTFAIL_CALLBACKS:-"$ZFS_DMESG"}
62 LOSETUP
=/sbin
/mdconfig
65 ZFS_MMP
="$STF_SUITE/callbacks/zfs_mmp.ksh"
66 TESTFAIL_CALLBACKS
=${TESTFAIL_CALLBACKS:-"$ZFS_DBGMSG:$ZFS_DMESG:$ZFS_MMP"}
67 LOSETUP
=${LOSETUP:-/sbin/losetup}
68 DMSETUP
=${DMSETUP:-/sbin/dmsetup}
72 # Log an informational message when additional verbosity is enabled.
75 if [ "$VERBOSE" = "yes" ]; then
81 # Log a failure message, cleanup, and return an error.
89 cleanup_freebsd_loopback
() {
90 for TEST_LOOPBACK
in ${LOOPBACKS}; do
91 if [ -c "/dev/${TEST_LOOPBACK}" ]; then
92 sudo
"${LOSETUP}" -d -u "${TEST_LOOPBACK}" ||
93 echo "Failed to destroy: ${TEST_LOOPBACK}"
98 cleanup_linux_loopback
() {
99 for TEST_LOOPBACK
in ${LOOPBACKS}; do
100 LOOP_DEV
="${TEST_LOOPBACK##*/}"
101 DM_DEV
=$
(sudo
"${DMSETUP}" ls 2>/dev
/null | \
102 grep "${LOOP_DEV}" | cut
-f1)
104 if [ -n "$DM_DEV" ]; then
105 sudo
"${DMSETUP}" remove
"${DM_DEV}" ||
106 echo "Failed to remove: ${DM_DEV}"
109 if [ -n "${TEST_LOOPBACK}" ]; then
110 sudo
"${LOSETUP}" -d "${TEST_LOOPBACK}" ||
111 echo "Failed to remove: ${TEST_LOOPBACK}"
117 # Attempt to remove loopback devices and files which where created earlier
118 # by this script to run the test framework. The '-k' option may be passed
119 # to the script to suppress cleanup for debugging purposes.
122 if [ "$CLEANUP" = "no" ]; then
127 if [ "$LOOPBACK" = "yes" ]; then
128 if [ "$UNAME" = "FreeBSD" ] ; then
129 cleanup_freebsd_loopback
131 cleanup_linux_loopback
135 for TEST_FILE
in ${FILES}; do
136 rm -f "${TEST_FILE}" >/dev
/null
2>&1
139 if [ "$STF_PATH_REMOVE" = "yes" ] && [ -d "$STF_PATH" ]; then
146 # Attempt to remove all testpools (testpool.XXX), unopened dm devices,
147 # loopback devices, and files. This is a useful way to cleanup a previous
148 # test run failure which has left the system in an unknown state. This can
149 # be dangerous and should only be used in a dedicated test environment.
152 TEST_POOLS
=$
(sudo env ASAN_OPTIONS
=detect_leaks
=false
"$ZPOOL" list
-H -o name |
grep testpool
)
153 if [ "$UNAME" = "FreeBSD" ] ; then
154 TEST_LOOPBACKS
=$
(sudo
"${LOSETUP}" -l)
156 TEST_LOOPBACKS
=$
(sudo
"${LOSETUP}" -a|
grep file-vdev|cut
-f1 -d:)
158 TEST_FILES
=$
(ls /var
/tmp
/file-vdev
* 2>/dev
/null
)
161 msg
"--- Cleanup ---"
162 msg
"Removing pool(s): $(echo "${TEST_POOLS}" | tr '\n' ' ')"
163 for TEST_POOL
in $TEST_POOLS; do
164 sudo env ASAN_OPTIONS
=detect_leaks
=false
"$ZPOOL" destroy
"${TEST_POOL}"
167 if [ "$UNAME" != "FreeBSD" ] ; then
168 msg
"Removing dm(s): $(sudo "${DMSETUP}" ls |
169 grep loop | tr '\n' ' ')"
170 sudo
"${DMSETUP}" remove_all
173 msg
"Removing loopback(s): $(echo "${TEST_LOOPBACKS}" | tr '\n' ' ')"
174 for TEST_LOOPBACK
in $TEST_LOOPBACKS; do
175 if [ "$UNAME" = "FreeBSD" ] ; then
176 sudo
"${LOSETUP}" -d -u "${TEST_LOOPBACK}"
178 sudo
"${LOSETUP}" -d "${TEST_LOOPBACK}"
182 msg
"Removing files(s): $(echo "${TEST_FILES}" | tr '\n' ' ')"
183 for TEST_FILE
in $TEST_FILES; do
184 sudo
rm -f "${TEST_FILE}"
189 # Takes a name as the only arguments and looks for the following variations
190 # on that name. If one is found it is returned.
192 # $RUNFILE_DIR/<name>
193 # $RUNFILE_DIR/<name>.run
201 if [ -f "$RUNFILE_DIR/$NAME" ]; then
202 RESULT
="$RUNFILE_DIR/$NAME"
203 elif [ -f "$RUNFILE_DIR/$NAME.run" ]; then
204 RESULT
="$RUNFILE_DIR/$NAME.run"
205 elif [ -f "$NAME" ]; then
207 elif [ -f "$NAME.run" ]; then
215 # Symlink file if it appears under any of the given paths.
221 [ -n "$STF_PATH" ] || fail
"STF_PATH wasn't correctly set"
223 for i
in $file_list; do
224 for j
in $dir_list; do
225 [ ! -e "$STF_PATH/$i" ] ||
continue
227 if [ ! -d "$j/$i" ] && [ -e "$j/$i" ]; then
228 ln -sf "$j/$i" "$STF_PATH/$i" || \
229 fail
"Couldn't link $i"
234 [ ! -e "$STF_PATH/$i" ] && \
235 STF_MISSING_BIN
="$STF_MISSING_BIN $i"
237 STF_MISSING_BIN
=${STF_MISSING_BIN# }
241 # Constrain the path to limit the available binaries to a known set.
242 # When running in-tree a top level ./bin/ directory is created for
243 # convenience, otherwise a temporary directory is used.
246 .
"$STF_SUITE/include/commands.cfg"
248 # On FreeBSD, base system zfs utils are in /sbin and OpenZFS utils
249 # install to /usr/local/sbin. To avoid testing the wrong utils we
250 # need /usr/local to come before / in the path search order.
251 SYSTEM_DIRS
="/usr/local/bin /usr/local/sbin"
252 SYSTEM_DIRS
="$SYSTEM_DIRS /usr/bin /usr/sbin /bin /sbin $LIBEXEC_DIR"
254 if [ "$INTREE" = "yes" ]; then
255 # Constrained path set to ./zfs/bin/
259 if [ ! -d "$STF_PATH" ]; then
261 chmod 755 "$STF_PATH" || fail
"Couldn't chmod $STF_PATH"
264 # Special case links for standard zfs utilities
265 DIRS
="$(find "$CMD_DIR" -type d \( ! -name .deps -a \
266 ! -name .libs \) -print | tr '\n' ' ')"
267 create_links
"$DIRS" "$ZFS_FILES"
269 # Special case links for zfs test suite utilities
270 DIRS
="$(find "$STF_SUITE" -type d \( ! -name .deps -a \
271 ! -name .libs \) -print | tr '\n' ' ')"
272 create_links
"$DIRS" "$ZFSTEST_FILES"
274 # Constrained path set to /var/tmp/constrained_path.*
275 SYSTEMDIR
=${SYSTEMDIR:-/var/tmp/constrained_path.XXXXXX}
276 STF_PATH
=$
(mktemp
-d "$SYSTEMDIR")
277 STF_PATH_REMOVE
="yes"
280 chmod 755 "$STF_PATH" || fail
"Couldn't chmod $STF_PATH"
282 # Special case links for standard zfs utilities
283 create_links
"$SYSTEM_DIRS" "$ZFS_FILES"
285 # Special case links for zfs test suite utilities
286 create_links
"$STF_SUITE/bin" "$ZFSTEST_FILES"
289 # Standard system utilities
290 SYSTEM_FILES
="$SYSTEM_FILES_COMMON"
291 if [ "$UNAME" = "FreeBSD" ] ; then
292 SYSTEM_FILES
="$SYSTEM_FILES $SYSTEM_FILES_FREEBSD"
294 SYSTEM_FILES
="$SYSTEM_FILES $SYSTEM_FILES_LINUX"
296 create_links
"$SYSTEM_DIRS" "$SYSTEM_FILES"
299 ln -fs "$STF_PATH/awk" "$STF_PATH/nawk"
300 if [ "$UNAME" = "Linux" ] ; then
301 ln -fs /sbin
/fsck.ext4
"$STF_PATH/fsck"
302 ln -fs /sbin
/mkfs.ext4
"$STF_PATH/newfs"
303 ln -fs "$STF_PATH/gzip" "$STF_PATH/compress"
304 ln -fs "$STF_PATH/gunzip" "$STF_PATH/uncompress"
305 ln -fs "$STF_PATH/exportfs" "$STF_PATH/share"
306 ln -fs "$STF_PATH/exportfs" "$STF_PATH/unshare"
307 elif [ "$UNAME" = "FreeBSD" ] ; then
308 ln -fs /usr
/local
/bin
/ksh93
"$STF_PATH/ksh"
313 # Output a useful usage message.
318 $0 [-hvqxkfS] [-s SIZE] [-r RUNFILES] [-t PATH] [-u USER]
321 ZFS Test Suite launch script
325 -v Verbose zfs-tests.sh output
326 -q Quiet test-runner output
327 -x Remove all testpools, dm, lo, and files (unsafe)
328 -k Disable cleanup after test failure
329 -f Use files only, disables block device tests
330 -S Enable stack tracer (negative performance impact)
331 -c Only create and populate constrained path
332 -R Automatically rerun failing tests
333 -m Enable kmemleak reporting (Linux only)
334 -n NFSFILE Use the nfsfile to determine the NFS configuration
335 -I NUM Number of iterations
336 -d DIR Use DIR for files and loopback devices
337 -s SIZE Use vdevs of SIZE (default: 4G)
338 -r RUNFILES Run tests in RUNFILES (default: ${DEFAULT_RUNFILES})
339 -t PATH Run single test at PATH relative to test suite
340 -T TAGS Comma separated list of tags (default: 'functional')
341 -u USER Run single test as USER (default: root)
344 # Run the default (linux) suite of tests and output the configuration used.
347 # Run a smaller suite of tests designed to run more quickly.
351 $0 -t tests/functional/cli_root/zfs_bookmark/zfs_bookmark_cliargs.ksh
353 # Cleanup a previous run of the test suite prior to testing, run the
354 # default (linux) suite of tests and perform no cleanup on exit.
360 while getopts 'hvqxkfScRmn:d:s:r:?t:T:u:I:' OPTION
; do
396 [ -f "$nfsfile" ] || fail
"Cannot read file: $nfsfile"
405 if [ "$ITERATIONS" -le 0 ]; then
406 fail
"Iterations must be greater than 0."
416 if [ -n "$SINGLETEST" ]; then
417 fail
"-t can only be provided once."
425 SINGLETESTUSER
="$OPTARG"
438 FILES
=${FILES:-"$FILEDIR/file-vdev0 $FILEDIR/file-vdev1 $FILEDIR/file-vdev2"}
439 LOOPBACKS
=${LOOPBACKS:-""}
441 if [ -n "$SINGLETEST" ]; then
442 if [ -n "$TAGS" ]; then
443 fail
"-t and -T are mutually exclusive."
445 RUNFILE_DIR
="/var/tmp"
446 RUNFILES
="zfs-tests.$$.run"
449 if [ -n "$QUIET" ]; then
453 cat >"${RUNFILE_DIR}/${RUNFILES}" << EOF
458 user = $SINGLETESTUSER
462 outputdir = /var/tmp/test_results
464 SINGLETESTDIR
=$
(dirname "$SINGLETEST")
465 SINGLETESTFILE
=$
(basename "$SINGLETEST")
469 if [ -f "$STF_SUITE/$SINGLETESTDIR/setup.ksh" ]; then
473 if [ -f "$STF_SUITE/$SINGLETESTDIR/cleanup.ksh" ]; then
474 CLEANUPSCRIPT
="cleanup"
477 cat >>"${RUNFILE_DIR}/${RUNFILES}" << EOF
480 tests = ['$SINGLETESTFILE']
482 post = $CLEANUPSCRIPT
483 tags = ['functional']
488 # Use default tag if none was specified
490 TAGS
=${TAGS:='functional'}
493 # Attempt to locate the runfiles describing the test workload.
497 for RUNFILE
in $RUNFILES; do
498 if [ -n "$RUNFILE" ]; then
499 SAVED_RUNFILE
="$RUNFILE"
500 RUNFILE
=$
(find_runfile
"$RUNFILE")
501 [ -z "$RUNFILE" ] && fail
"Cannot find runfile: $SAVED_RUNFILE"
505 if [ ! -r "$RUNFILE" ]; then
506 fail
"Cannot read runfile: $RUNFILE"
513 # This script should not be run as root. Instead the test user, which may
514 # be a normal user account, needs to be configured such that it can
515 # run commands via sudo passwordlessly.
517 if [ "$(id -u)" = "0" ]; then
518 fail
"This script must not be run as root."
521 if [ "$(sudo whoami)" != "root" ]; then
522 fail
"Passwordless sudo access required."
526 # Constrain the available binaries to a known set.
531 # Check if ksh exists
533 if [ "$UNAME" = "FreeBSD" ]; then
534 sudo
ln -fs /usr
/local
/bin
/ksh93
/bin
/ksh
536 [ -e "$STF_PATH/ksh" ] || fail
"This test suite requires ksh."
537 [ -e "$STF_SUITE/include/default.cfg" ] || fail \
538 "Missing $STF_SUITE/include/default.cfg file."
541 # Verify the ZFS module stack is loaded.
543 if [ "$STACK_TRACER" = "yes" ]; then
544 sudo
"${ZFS_SH}" -S >/dev
/null
2>&1
546 sudo
"${ZFS_SH}" >/dev
/null
2>&1
550 # Attempt to cleanup all previous state for a new test run.
552 if [ "$CLEANUPALL" = "yes" ]; then
557 # By default preserve any existing pools
558 # NOTE: Since 'zpool list' outputs a newline-delimited list convert $KEEP from
559 # space-delimited to newline-delimited.
561 if [ -z "${KEEP}" ]; then
562 KEEP
="$(sudo env ASAN_OPTIONS=detect_leaks=false "$ZPOOL" list -H -o name)"
563 if [ -z "${KEEP}" ]; then
567 KEEP
="$(echo "$KEEP" | tr '[:blank:]' '\n')"
571 # NOTE: The following environment variables are undocumented
572 # and should be used for testing purposes only:
574 # __ZFS_POOL_EXCLUDE - don't iterate over the pools it lists
575 # __ZFS_POOL_RESTRICT - iterate only over the pools it lists
577 # See libzfs/libzfs_config.c for more information.
579 if [ "$UNAME" = "FreeBSD" ] ; then
580 __ZFS_POOL_EXCLUDE
="$(echo "$KEEP" | tr -s '\n' ' ')"
582 __ZFS_POOL_EXCLUDE
="$(echo "$KEEP" | sed ':a;N;s/\n/ /g;ba')"
585 .
"$STF_SUITE/include/default.cfg"
588 # No DISKS have been provided so a basic file or loopback based devices
589 # must be created for the test suite to use.
591 if [ -z "${DISKS}" ]; then
593 # If this is a performance run, prevent accidental use of
596 [ "$TAGS" = "perf" ] && fail
"Running perf tests without disks."
599 # Create sparse files for the test suite. These may be used
600 # directory or have loopback devices layered on them.
602 for TEST_FILE
in ${FILES}; do
603 [ -f "$TEST_FILE" ] && fail
"Failed file exists: ${TEST_FILE}"
604 truncate
-s "${FILESIZE}" "${TEST_FILE}" ||
605 fail
"Failed creating: ${TEST_FILE} ($?)"
609 # If requested setup loopback devices backed by the sparse files.
611 if [ "$LOOPBACK" = "yes" ]; then
612 test -x "$LOSETUP" || fail
"$LOSETUP utility must be installed"
614 for TEST_FILE
in ${FILES}; do
615 if [ "$UNAME" = "FreeBSD" ] ; then
616 MDDEVICE
=$
(sudo
"${LOSETUP}" -a -t vnode
-f "${TEST_FILE}")
617 if [ -z "$MDDEVICE" ] ; then
618 fail
"Failed: ${TEST_FILE} -> loopback"
620 DISKS
="$DISKS $MDDEVICE"
621 LOOPBACKS
="$LOOPBACKS $MDDEVICE"
623 TEST_LOOPBACK
=$
(sudo
"${LOSETUP}" -f)
624 sudo
"${LOSETUP}" "${TEST_LOOPBACK}" "${TEST_FILE}" ||
625 fail
"Failed: ${TEST_FILE} -> ${TEST_LOOPBACK}"
626 BASELOOPBACK
="${TEST_LOOPBACK##*/}"
627 DISKS
="$DISKS $BASELOOPBACK"
628 LOOPBACKS
="$LOOPBACKS $TEST_LOOPBACK"
632 LOOPBACKS
=${LOOPBACKS# }
639 # It may be desirable to test with fewer disks than the default when running
640 # the performance tests, but the functional tests require at least three.
642 NUM_DISKS
=$
(echo "${DISKS}" |
awk '{print NF}')
643 if [ "$TAGS" != "perf" ]; then
644 [ "$NUM_DISKS" -lt 3 ] && fail
"Not enough disks ($NUM_DISKS/3 minimum)"
648 # Disable SELinux until the ZFS Test Suite has been updated accordingly.
650 if [ -x "$STF_PATH/setenforce" ]; then
651 sudo setenforce permissive
>/dev
/null
2>&1
655 # Enable internal ZFS debug log and clear it.
657 if [ -e /sys
/module
/zfs
/parameters
/zfs_dbgmsg_enable
]; then
658 sudo
/bin
/sh
-c "echo 1 >/sys/module/zfs/parameters/zfs_dbgmsg_enable"
659 sudo
/bin
/sh
-c "echo 0 >/proc/spl/kstat/zfs/dbgmsg"
663 msg
"--- Configuration ---"
664 msg
"Runfiles: $RUNFILES"
665 msg
"STF_TOOLS: $STF_TOOLS"
666 msg
"STF_SUITE: $STF_SUITE"
667 msg
"STF_PATH: $STF_PATH"
668 msg
"FILEDIR: $FILEDIR"
670 msg
"LOOPBACKS: $LOOPBACKS"
672 msg
"NUM_DISKS: $NUM_DISKS"
673 msg
"FILESIZE: $FILESIZE"
674 msg
"ITERATIONS: $ITERATIONS"
676 msg
"STACK_TRACER: $STACK_TRACER"
677 msg
"Keep pool(s): $KEEP"
678 msg
"Missing util(s): $STF_MISSING_BIN"
687 export __ZFS_POOL_EXCLUDE
688 export TESTFAIL_CALLBACKS
689 export PATH
=$STF_PATH
692 if [ "$UNAME" = "FreeBSD" ]; then
693 mktemp
-u "${FILEDIR}/$1.XXXXXX"
695 mktemp
-ut "$1.XXXXXX" -p "$FILEDIR"
698 mkdir
-p "$FILEDIR" ||
:
699 RESULTS_FILE
=$
(mktemp_file zts-results
)
700 REPORT_FILE
=$
(mktemp_file zts-report
)
703 # Run all the tests as specified.
705 msg
"${TEST_RUNNER}" \
708 "-c \"${RUNFILES}\"" \
710 "-i \"${STF_SUITE}\"" \
711 "-I \"${ITERATIONS}\""
719 2>&1; echo $?
>"$REPORT_FILE"; } |
tee "$RESULTS_FILE"
720 read -r RUNRESULT
<"$REPORT_FILE"
723 # Analyze the results.
725 ${ZTS_REPORT} ${RERUN:+--no-maybes} "$RESULTS_FILE" >"$REPORT_FILE"
728 if [ "$RESULT" -eq "2" ] && [ -n "$RERUN" ]; then
729 MAYBES
="$($ZTS_REPORT --list-maybes)"
730 TEMP_RESULTS_FILE
=$
(mktemp_file zts-results-tmp
)
731 TEST_LIST
=$
(mktemp_file test-list
)
732 grep "^Test:.*\[FAIL\]" "$RESULTS_FILE" >"$TEMP_RESULTS_FILE"
733 for test_name
in $MAYBES; do
734 grep "$test_name " "$TEMP_RESULTS_FILE" >>"$TEST_LIST"
744 2>&1; echo $?
>"$REPORT_FILE"; } |
tee "$RESULTS_FILE"
745 read -r RUNRESULT
<"$REPORT_FILE"
747 # Analyze the results.
749 ${ZTS_REPORT} --no-maybes "$RESULTS_FILE" >"$REPORT_FILE"
756 RESULTS_DIR
=$
(awk '/^Log directory/ { print $3 }' "$RESULTS_FILE")
757 if [ -d "$RESULTS_DIR" ]; then
758 cat "$RESULTS_FILE" "$REPORT_FILE" >"$RESULTS_DIR/results"
761 rm -f "$RESULTS_FILE" "$REPORT_FILE"
763 if [ -n "$SINGLETEST" ]; then
764 rm -f "$RUNFILES" >/dev
/null
2>&1
767 [ "$RUNRESULT" -gt 3 ] && exit "$RUNRESULT" ||
exit "$RESULT"