5 # The contents of this file are subject to the terms of the
6 # Common Development and Distribution License, Version 1.0 only
7 # (the "License"). You may not use this file except in compliance
10 # You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
11 # or http://www.opensolaris.org/os/licensing.
12 # See the License for the specific language governing permissions
13 # and limitations under the License.
15 # When distributing Covered Code, include this CDDL HEADER in each
16 # file and include the License file at usr/src/OPENSOLARIS.LICENSE.
17 # If applicable, add the following below this CDDL HEADER, with the
18 # fields enclosed by brackets "[]" replaced with your own identifying
19 # information: Portions Copyright [yyyy] [name of copyright owner]
25 # Copyright 2020 OmniOS Community Edition (OmniOSce) Association.
28 BASE_DIR=$(dirname "$0")
29 SCRIPT_COMMON=common.sh
30 if [ -f "${BASE_DIR}/${SCRIPT_COMMON}" ]; then
31 . "${BASE_DIR}/${SCRIPT_COMMON}"
33 echo "Missing helper script ${SCRIPT_COMMON}" && exit 1
44 DEFAULT_RUNFILES="common.run,$(uname | tr '[:upper:]' '[:lower:]').run"
45 RUNFILES=${RUNFILES:-$DEFAULT_RUNFILES}
46 FILEDIR=${FILEDIR:-/var/tmp}
52 ZFS_DBGMSG="$STF_SUITE/callbacks/zfs_dbgmsg.ksh"
53 ZFS_DMESG="$STF_SUITE/callbacks/zfs_dmesg.ksh"
57 # Override some defaults if on FreeBSD
58 if [ "$UNAME" = "FreeBSD" ] ; then
59 TESTFAIL_CALLBACKS=${TESTFAIL_CALLBACKS:-"$ZFS_DMESG"}
60 LOSETUP=/sbin/mdconfig
63 ZFS_MMP="$STF_SUITE/callbacks/zfs_mmp.ksh"
64 TESTFAIL_CALLBACKS=${TESTFAIL_CALLBACKS:-"$ZFS_DBGMSG:$ZFS_DMESG:$ZFS_MMP"}
65 LOSETUP=${LOSETUP:-/sbin/losetup}
66 DMSETUP=${DMSETUP:-/sbin/dmsetup}
70 # Log an informational message when additional verbosity is enabled.
73 if [ "$VERBOSE" = "yes" ]; then
79 # Log a failure message, cleanup, and return an error.
87 cleanup_freebsd_loopback() {
88 for TEST_LOOPBACK in ${LOOPBACKS}; do
89 if [ -c "/dev/${TEST_LOOPBACK}" ]; then
90 sudo "${LOSETUP}" -d -u "${TEST_LOOPBACK}" ||
91 echo "Failed to destroy: ${TEST_LOOPBACK}"
96 cleanup_linux_loopback() {
97 for TEST_LOOPBACK in ${LOOPBACKS}; do
98 LOOP_DEV=$(basename "$TEST_LOOPBACK")
99 DM_DEV=$(sudo "${DMSETUP}" ls 2>/dev/null | \
100 grep "${LOOP_DEV}" | cut -f1)
102 if [ -n "$DM_DEV" ]; then
103 sudo "${DMSETUP}" remove "${DM_DEV}" ||
104 echo "Failed to remove: ${DM_DEV}"
107 if [ -n "${TEST_LOOPBACK}" ]; then
108 sudo "${LOSETUP}" -d "${TEST_LOOPBACK}" ||
109 echo "Failed to remove: ${TEST_LOOPBACK}"
115 # Attempt to remove loopback devices and files which where created earlier
116 # by this script to run the test framework. The '-k' option may be passed
117 # to the script to suppress cleanup for debugging purposes.
120 if [ "$CLEANUP" = "no" ]; then
125 if [ "$LOOPBACK" = "yes" ]; then
126 if [ "$UNAME" = "FreeBSD" ] ; then
127 cleanup_freebsd_loopback
129 cleanup_linux_loopback
133 for TEST_FILE in ${FILES}; do
134 rm -f "${TEST_FILE}" >/dev/null 2>&1
137 if [ "$STF_PATH_REMOVE" = "yes" ] && [ -d "$STF_PATH" ]; then
144 # Attempt to remove all testpools (testpool.XXX), unopened dm devices,
145 # loopback devices, and files. This is a useful way to cleanup a previous
146 # test run failure which has left the system in an unknown state. This can
147 # be dangerous and should only be used in a dedicated test environment.
150 TEST_POOLS=$(sudo "$ZPOOL" list -H -o name | grep testpool)
151 if [ "$UNAME" = "FreeBSD" ] ; then
152 TEST_LOOPBACKS=$(sudo "${LOSETUP}" -l)
154 TEST_LOOPBACKS=$(sudo "${LOSETUP}" -a|grep file-vdev|cut -f1 -d:)
156 TEST_FILES=$(ls /var/tmp/file-vdev* 2>/dev/null)
159 msg "--- Cleanup ---"
160 msg "Removing pool(s): $(echo "${TEST_POOLS}" | tr '\n' ' ')"
161 for TEST_POOL in $TEST_POOLS; do
162 sudo "$ZPOOL" destroy "${TEST_POOL}"
165 if [ "$UNAME" != "FreeBSD" ] ; then
166 msg "Removing dm(s): $(sudo "${DMSETUP}" ls |
167 grep loop | tr '\n' ' ')"
168 sudo "${DMSETUP}" remove_all
171 msg "Removing loopback(s): $(echo "${TEST_LOOPBACKS}" | tr '\n' ' ')"
172 for TEST_LOOPBACK in $TEST_LOOPBACKS; do
173 if [ "$UNAME" = "FreeBSD" ] ; then
174 sudo "${LOSETUP}" -d -u "${TEST_LOOPBACK}"
176 sudo "${LOSETUP}" -d "${TEST_LOOPBACK}"
180 msg "Removing files(s): $(echo "${TEST_FILES}" | tr '\n' ' ')"
181 for TEST_FILE in $TEST_FILES; do
182 sudo rm -f "${TEST_FILE}"
187 # Takes a name as the only arguments and looks for the following variations
188 # on that name. If one is found it is returned.
190 # $RUNFILE_DIR/<name>
191 # $RUNFILE_DIR/<name>.run
199 if [ -f "$RUNFILE_DIR/$NAME" ]; then
200 RESULT="$RUNFILE_DIR/$NAME"
201 elif [ -f "$RUNFILE_DIR/$NAME.run" ]; then
202 RESULT="$RUNFILE_DIR/$NAME.run"
203 elif [ -f "$NAME" ]; then
205 elif [ -f "$NAME.run" ]; then
213 # Symlink file if it appears under any of the given paths.
219 [ -n "$STF_PATH" ] || fail "STF_PATH wasn't correctly set"
221 for i in $file_list; do
222 for j in $dir_list; do
223 [ ! -e "$STF_PATH/$i" ] || continue
225 if [ ! -d "$j/$i" ] && [ -e "$j/$i" ]; then
226 ln -sf "$j/$i" "$STF_PATH/$i" || \
227 fail "Couldn't link $i"
232 [ ! -e "$STF_PATH/$i" ] && \
233 STF_MISSING_BIN="$STF_MISSING_BIN $i"
235 STF_MISSING_BIN=${STF_MISSING_BIN# }
239 # Constrain the path to limit the available binaries to a known set.
240 # When running in-tree a top level ./bin/ directory is created for
241 # convenience, otherwise a temporary directory is used.
244 . "$STF_SUITE/include/commands.cfg"
246 # On FreeBSD, base system zfs utils are in /sbin and OpenZFS utils
247 # install to /usr/local/sbin. To avoid testing the wrong utils we
248 # need /usr/local to come before / in the path search order.
249 SYSTEM_DIRS="/usr/local/bin /usr/local/sbin"
250 SYSTEM_DIRS="$SYSTEM_DIRS /usr/bin /usr/sbin /bin /sbin $LIBEXEC_DIR"
252 if [ "$INTREE" = "yes" ]; then
253 # Constrained path set to ./zfs/bin/
257 if [ ! -d "$STF_PATH" ]; then
259 chmod 755 "$STF_PATH" || fail "Couldn't chmod $STF_PATH"
262 # Special case links for standard zfs utilities
263 DIRS="$(find "$CMD_DIR" -type d \( ! -name .deps -a \
264 ! -name .libs \) -print | tr '\n' ' ')"
265 create_links "$DIRS" "$ZFS_FILES"
267 # Special case links for zfs test suite utilities
268 DIRS="$(find "$STF_SUITE" -type d \( ! -name .deps -a \
269 ! -name .libs \) -print | tr '\n' ' ')"
270 create_links "$DIRS" "$ZFSTEST_FILES"
272 # Constrained path set to /var/tmp/constrained_path.*
273 SYSTEMDIR=${SYSTEMDIR:-/var/tmp/constrained_path.XXXXXX}
274 STF_PATH=$(mktemp -d "$SYSTEMDIR")
275 STF_PATH_REMOVE="yes"
278 chmod 755 "$STF_PATH" || fail "Couldn't chmod $STF_PATH"
280 # Special case links for standard zfs utilities
281 create_links "$SYSTEM_DIRS" "$ZFS_FILES"
283 # Special case links for zfs test suite utilities
284 create_links "$STF_SUITE/bin" "$ZFSTEST_FILES"
287 # Standard system utilities
288 SYSTEM_FILES="$SYSTEM_FILES_COMMON"
289 if [ "$UNAME" = "FreeBSD" ] ; then
290 SYSTEM_FILES="$SYSTEM_FILES $SYSTEM_FILES_FREEBSD"
292 SYSTEM_FILES="$SYSTEM_FILES $SYSTEM_FILES_LINUX"
294 create_links "$SYSTEM_DIRS" "$SYSTEM_FILES"
297 ln -fs "$STF_PATH/awk" "$STF_PATH/nawk"
298 if [ "$UNAME" = "Linux" ] ; then
299 ln -fs /sbin/fsck.ext4 "$STF_PATH/fsck"
300 ln -fs /sbin/mkfs.ext4 "$STF_PATH/newfs"
301 ln -fs "$STF_PATH/gzip" "$STF_PATH/compress"
302 ln -fs "$STF_PATH/gunzip" "$STF_PATH/uncompress"
303 ln -fs "$STF_PATH/exportfs" "$STF_PATH/share"
304 ln -fs "$STF_PATH/exportfs" "$STF_PATH/unshare"
305 elif [ "$UNAME" = "FreeBSD" ] ; then
306 ln -fs /usr/local/bin/ksh93 "$STF_PATH/ksh"
311 # Output a useful usage message.
316 $0 [-hvqxkfS] [-s SIZE] [-r RUNFILES] [-t PATH] [-u USER]
319 ZFS Test Suite launch script
323 -v Verbose zfs-tests.sh output
324 -q Quiet test-runner output
325 -x Remove all testpools, dm, lo, and files (unsafe)
326 -k Disable cleanup after test failure
327 -f Use files only, disables block device tests
328 -S Enable stack tracer (negative performance impact)
329 -c Only create and populate constrained path
330 -R Automatically rerun failing tests
331 -n NFSFILE Use the nfsfile to determine the NFS configuration
332 -I NUM Number of iterations
333 -d DIR Use DIR for files and loopback devices
334 -s SIZE Use vdevs of SIZE (default: 4G)
335 -r RUNFILES Run tests in RUNFILES (default: ${DEFAULT_RUNFILES})
336 -t PATH Run single test at PATH relative to test suite
337 -T TAGS Comma separated list of tags (default: 'functional')
338 -u USER Run single test as USER (default: root)
341 # Run the default (linux) suite of tests and output the configuration used.
344 # Run a smaller suite of tests designed to run more quickly.
348 $0 -t tests/functional/cli_root/zfs_bookmark/zfs_bookmark_cliargs.ksh
350 # Cleanup a previous run of the test suite prior to testing, run the
351 # default (linux) suite of tests and perform no cleanup on exit.
357 while getopts 'hvqxkfScRn:d:s:r:?t:T:u:I:' OPTION; do
390 [ -f "$nfsfile" ] || fail "Cannot read file: $nfsfile"
399 if [ "$ITERATIONS" -le 0 ]; then
400 fail "Iterations must be greater than 0."
410 if [ -n "$SINGLETEST" ]; then
411 fail "-t can only be provided once."
419 SINGLETESTUSER="$OPTARG"
430 FILES=${FILES:-"$FILEDIR/file-vdev0 $FILEDIR/file-vdev1 $FILEDIR/file-vdev2"}
431 LOOPBACKS=${LOOPBACKS:-""}
433 if [ -n "$SINGLETEST" ]; then
434 if [ -n "$TAGS" ]; then
435 fail "-t and -T are mutually exclusive."
437 RUNFILE_DIR="/var/tmp"
438 RUNFILES="zfs-tests.$$.run"
441 if [ -n "$QUIET" ]; then
445 cat >$RUNFILE_DIR/$RUNFILES << EOF
450 user = $SINGLETESTUSER
454 outputdir = /var/tmp/test_results
456 SINGLETESTDIR=$(dirname "$SINGLETEST")
457 SINGLETESTFILE=$(basename "$SINGLETEST")
461 if [ -f "$STF_SUITE/$SINGLETESTDIR/setup.ksh" ]; then
465 if [ -f "$STF_SUITE/$SINGLETESTDIR/cleanup.ksh" ]; then
466 CLEANUPSCRIPT="cleanup"
469 cat >>$RUNFILE_DIR/$RUNFILES << EOF
472 tests = ['$SINGLETESTFILE']
474 post = $CLEANUPSCRIPT
475 tags = ['functional']
480 # Use default tag if none was specified
482 TAGS=${TAGS:='functional'}
485 # Attempt to locate the runfiles describing the test workload.
489 for RUNFILE in $RUNFILES; do
490 if [ -n "$RUNFILE" ]; then
491 SAVED_RUNFILE="$RUNFILE"
492 RUNFILE=$(find_runfile "$RUNFILE")
493 [ -z "$RUNFILE" ] && fail "Cannot find runfile: $SAVED_RUNFILE"
497 if [ ! -r "$RUNFILE" ]; then
498 fail "Cannot read runfile: $RUNFILE"
505 # This script should not be run as root. Instead the test user, which may
506 # be a normal user account, needs to be configured such that it can
507 # run commands via sudo passwordlessly.
509 if [ "$(id -u)" = "0" ]; then
510 fail "This script must not be run as root."
513 if [ "$(sudo whoami)" != "root" ]; then
514 fail "Passwordless sudo access required."
518 # Constrain the available binaries to a known set.
523 # Check if ksh exists
525 if [ "$UNAME" = "FreeBSD" ]; then
526 sudo ln -fs /usr/local/bin/ksh93 /bin/ksh
528 [ -e "$STF_PATH/ksh" ] || fail "This test suite requires ksh."
529 [ -e "$STF_SUITE/include/default.cfg" ] || fail \
530 "Missing $STF_SUITE/include/default.cfg file."
533 # Verify the ZFS module stack is loaded.
535 if [ "$STACK_TRACER" = "yes" ]; then
536 sudo "${ZFS_SH}" -S >/dev/null 2>&1
538 sudo "${ZFS_SH}" >/dev/null 2>&1
542 # Attempt to cleanup all previous state for a new test run.
544 if [ "$CLEANUPALL" = "yes" ]; then
549 # By default preserve any existing pools
550 # NOTE: Since 'zpool list' outputs a newline-delimited list convert $KEEP from
551 # space-delimited to newline-delimited.
553 if [ -z "${KEEP}" ]; then
554 KEEP="$(sudo "$ZPOOL" list -H -o name)"
555 if [ -z "${KEEP}" ]; then
559 KEEP="$(echo "$KEEP" | tr '[:blank:]' '\n')"
563 # NOTE: The following environment variables are undocumented
564 # and should be used for testing purposes only:
566 # __ZFS_POOL_EXCLUDE - don't iterate over the pools it lists
567 # __ZFS_POOL_RESTRICT - iterate only over the pools it lists
569 # See libzfs/libzfs_config.c for more information.
571 if [ "$UNAME" = "FreeBSD" ] ; then
572 __ZFS_POOL_EXCLUDE="$(echo "$KEEP" | tr -s '\n' ' ')"
574 __ZFS_POOL_EXCLUDE="$(echo "$KEEP" | sed ':a;N;s/\n/ /g;ba')"
577 . "$STF_SUITE/include/default.cfg"
580 # No DISKS have been provided so a basic file or loopback based devices
581 # must be created for the test suite to use.
583 if [ -z "${DISKS}" ]; then
585 # If this is a performance run, prevent accidental use of
588 [ "$TAGS" = "perf" ] && fail "Running perf tests without disks."
591 # Create sparse files for the test suite. These may be used
592 # directory or have loopback devices layered on them.
594 for TEST_FILE in ${FILES}; do
595 [ -f "$TEST_FILE" ] && fail "Failed file exists: ${TEST_FILE}"
596 truncate -s "${FILESIZE}" "${TEST_FILE}" ||
597 fail "Failed creating: ${TEST_FILE} ($?)"
601 # If requested setup loopback devices backed by the sparse files.
603 if [ "$LOOPBACK" = "yes" ]; then
604 test -x "$LOSETUP" || fail "$LOSETUP utility must be installed"
606 for TEST_FILE in ${FILES}; do
607 if [ "$UNAME" = "FreeBSD" ] ; then
608 MDDEVICE=$(sudo "${LOSETUP}" -a -t vnode -f "${TEST_FILE}")
609 if [ -z "$MDDEVICE" ] ; then
610 fail "Failed: ${TEST_FILE} -> loopback"
612 DISKS="$DISKS $MDDEVICE"
613 LOOPBACKS="$LOOPBACKS $MDDEVICE"
615 TEST_LOOPBACK=$(sudo "${LOSETUP}" -f)
616 sudo "${LOSETUP}" "${TEST_LOOPBACK}" "${TEST_FILE}" ||
617 fail "Failed: ${TEST_FILE} -> ${TEST_LOOPBACK}"
618 BASELOOPBACK=$(basename "$TEST_LOOPBACK")
619 DISKS="$DISKS $BASELOOPBACK"
620 LOOPBACKS="$LOOPBACKS $TEST_LOOPBACK"
624 LOOPBACKS=${LOOPBACKS# }
631 # It may be desirable to test with fewer disks than the default when running
632 # the performance tests, but the functional tests require at least three.
634 NUM_DISKS=$(echo "${DISKS}" | awk '{print NF}')
635 if [ "$TAGS" != "perf" ]; then
636 [ "$NUM_DISKS" -lt 3 ] && fail "Not enough disks ($NUM_DISKS/3 minimum)"
640 # Disable SELinux until the ZFS Test Suite has been updated accordingly.
642 if [ -x "$STF_PATH/setenforce" ]; then
643 sudo setenforce permissive >/dev/null 2>&1
647 # Enable internal ZFS debug log and clear it.
649 if [ -e /sys/module/zfs/parameters/zfs_dbgmsg_enable ]; then
650 sudo /bin/sh -c "echo 1 >/sys/module/zfs/parameters/zfs_dbgmsg_enable"
651 sudo /bin/sh -c "echo 0 >/proc/spl/kstat/zfs/dbgmsg"
655 msg "--- Configuration ---"
656 msg "Runfiles: $RUNFILES"
657 msg "STF_TOOLS: $STF_TOOLS"
658 msg "STF_SUITE: $STF_SUITE"
659 msg "STF_PATH: $STF_PATH"
660 msg "FILEDIR: $FILEDIR"
662 msg "LOOPBACKS: $LOOPBACKS"
664 msg "NUM_DISKS: $NUM_DISKS"
665 msg "FILESIZE: $FILESIZE"
666 msg "ITERATIONS: $ITERATIONS"
668 msg "STACK_TRACER: $STACK_TRACER"
669 msg "Keep pool(s): $KEEP"
670 msg "Missing util(s): $STF_MISSING_BIN"
679 export __ZFS_POOL_EXCLUDE
680 export TESTFAIL_CALLBACKS
681 export PATH=$STF_PATH
683 if [ "$UNAME" = "FreeBSD" ] ; then
684 mkdir -p "$FILEDIR" || true
685 RESULTS_FILE=$(mktemp -u "${FILEDIR}/zts-results.XXXXXX")
686 REPORT_FILE=$(mktemp -u "${FILEDIR}/zts-report.XXXXXX")
688 RESULTS_FILE=$(mktemp -u -t zts-results.XXXXXX -p "$FILEDIR")
689 REPORT_FILE=$(mktemp -u -t zts-report.XXXXXX -p "$FILEDIR")
693 # Run all the tests as specified.
695 msg "${TEST_RUNNER} ${QUIET:+-q}" \
696 "-c \"${RUNFILES}\"" \
698 "-i \"${STF_SUITE}\"" \
699 "-I \"${ITERATIONS}\""
700 ${TEST_RUNNER} ${QUIET:+-q} \
705 2>&1 | tee "$RESULTS_FILE"
707 # Analyze the results.
709 ${ZTS_REPORT} ${RERUN:+--no-maybes} "$RESULTS_FILE" >"$REPORT_FILE"
712 if [ "$RESULT" -eq "2" ] && [ -n "$RERUN" ]; then
713 MAYBES="$($ZTS_REPORT --list-maybes)"
714 TEMP_RESULTS_FILE=$(mktemp -u -t zts-results-tmp.XXXXX -p "$FILEDIR")
715 TEST_LIST=$(mktemp -u -t test-list.XXXXX -p "$FILEDIR")
716 grep "^Test:.*\[FAIL\]" "$RESULTS_FILE" >"$TEMP_RESULTS_FILE"
717 for test_name in $MAYBES; do
718 grep "$test_name " "$TEMP_RESULTS_FILE" >>"$TEST_LIST"
720 ${TEST_RUNNER} ${QUIET:+-q} \
726 2>&1 | tee "$RESULTS_FILE"
728 # Analyze the results.
730 ${ZTS_REPORT} --no-maybes "$RESULTS_FILE" >"$REPORT_FILE"
737 RESULTS_DIR=$(awk '/^Log directory/ { print $3 }' "$RESULTS_FILE")
738 if [ -d "$RESULTS_DIR" ]; then
739 cat "$RESULTS_FILE" "$REPORT_FILE" >"$RESULTS_DIR/results"
742 rm -f "$RESULTS_FILE" "$REPORT_FILE"
744 if [ -n "$SINGLETEST" ]; then
745 rm -f "$RUNFILES" >/dev/null 2>&1