3 # Common routines for all tests
6 # assert that argument is not empty and is an existing path (file or directory)
12 if [ -z "$path" ]; then
13 echo "ASSERTION FAIL: $path is not valid"
17 if [ -f "$path" -o -d "$path" -o -b "$path" ]; then
20 echo "ASSERTION FAIL: $path is not valid"
24 # $1: this string gets matched to files, absolute or relative path, or a
25 # systemwide command available via $PATH
31 if [ -z "$msg" ]; then
35 if [ -f "$msg" -o -d "$msg" -o -b "$msg" ]; then
38 msg
=$
(type -p -- "$msg")
39 if [ -f "$msg" ]; then
47 echo "$*" |
tee -a "$RESULTS"
51 # log a message to the results file
54 echo "$*" |
tee -a "$RESULTS"
57 # copy stdout to log and pass to stdout, eg. another stdout consumer, commands
58 # should redirect stderr to stdout if this is consmed by further commands
76 echo "DUMP args for ${FUNCNAME[1]}:"
77 while [ $# -gt 0 ]; do
84 # read arguments, look if we're calling btrfs and if there's a known
85 # subcommand, return argument index to insert, taking root helper into
86 # consideration, returns 2 for unknown subcommand
89 if [ "$1" = 'root_helper' ]; then
90 if [[ $2 =~
/btrfs$
]]; then
95 if [[ $1 =~
/btrfs$
]]; then
103 # return command-specific arguments if enabled
106 if [ "$TEST_ENABLE_OVERRIDE" = 'true' ]; then
107 # if defined via common.local, use it, otherwise pass make
109 if [ "$(type -t _skip_spec)" = 'function' ]; then
110 if _skip_spec
"$@"; then
115 check
) echo -n "$TEST_ARGS_CHECK" ;;
120 # Argument passing magic:
121 # the command passed to run_* helpers is inspected, if there's 'btrfs command'
122 # found and there are defined additional arguments, they're inserted just after
123 # the command name, ie. any arguments in the test could override them.
125 # The root helper is recognized. Unrecognized subcommands or external tools
134 ins
=$
(_get_spec_ins
"$@")
136 cmd
=$
(eval echo "\${$spec}")
137 spec
=$
(_cmd_spec
"${@:$spec}")
138 set -- "${@:1:$(($ins-1))}" $spec "${@: $ins}"
139 echo "====== RUN CHECK $@" >> "$RESULTS" 2>&1
140 if [[ $TEST_LOG =~ tty
]]; then echo "CMD: $@" > /dev
/tty
; fi
141 if [ "$1" = 'root_helper' ]; then
142 "$@" >> "$RESULTS" 2>&1 || _fail
"failed: $@"
144 $INSTRUMENT "$@" >> "$RESULTS" 2>&1 || _fail
"failed: $@"
148 # same as run_check but the stderr+stdout output is duplicated on stdout and
149 # can be processed further
156 ins
=$
(_get_spec_ins
"$@")
158 cmd
=$
(eval echo "\${$spec}")
159 spec
=$
(_cmd_spec
"${@:$spec}")
160 set -- "${@:1:$(($ins-1))}" $spec "${@: $ins}"
161 echo "====== RUN CHECK $@" >> "$RESULTS" 2>&1
162 if [[ $TEST_LOG =~ tty
]]; then echo "CMD(stdout): $@" > /dev
/tty
; fi
163 if [ "$1" = 'root_helper' ]; then
164 "$@" 2>&1 |
tee -a "$RESULTS"
166 $INSTRUMENT "$@" 2>&1 |
tee -a "$RESULTS"
168 if [ ${PIPESTATUS[0]} -ne 0 ]; then
173 # same as run_check but does not fail the test if it's handled gracefully by
174 # the tool, unexpected failure like segfault or abor will exit forcibly
183 ins
=$
(_get_spec_ins
"$@")
185 cmd
=$
(eval echo "\${$spec}")
186 spec
=$
(_cmd_spec
"${@:$spec}")
187 set -- "${@:1:$(($ins-1))}" $spec "${@: $ins}"
188 echo "====== RUN MAYFAIL $@" >> "$RESULTS" 2>&1
189 if [[ $TEST_LOG =~ tty
]]; then echo "CMD(mayfail): $@" > /dev
/tty
; fi
190 if [ "$1" = 'root_helper' ]; then
191 "$@" >> "$RESULTS" 2>&1
193 $INSTRUMENT "$@" >> "$RESULTS" 2>&1
196 if [ $ret != 0 ]; then
197 echo "failed (ignored, ret=$ret): $@" >> "$RESULTS"
198 if [ $ret == 139 ]; then
199 _fail
"mayfail: returned code 139 (SEGFAULT), not ignored"
200 elif [ $ret == 134 ]; then
201 _fail
"mayfail: returned code 134 (SIGABRT), not ignored"
207 # first argument is error message to print if it fails, otherwise
208 # same as run_check but expects the command to fail, output is logged
219 if _is_file_or_command
"$msg"; then
220 echo "ASSERTION FAIL: 1st argument of run_mustfail must be a message"
224 ins
=$
(_get_spec_ins
"$@")
226 cmd
=$
(eval echo "\${$spec}")
227 spec
=$
(_cmd_spec
"${@:$spec}")
228 set -- "${@:1:$(($ins-1))}" $spec "${@: $ins}"
229 echo "====== RUN MUSTFAIL $@" >> "$RESULTS" 2>&1
230 if [[ $TEST_LOG =~ tty
]]; then echo "CMD(mustfail): $@" > /dev
/tty
; fi
231 if [ "$1" = 'root_helper' ]; then
232 "$@" >> "$RESULTS" 2>&1
234 $INSTRUMENT "$@" >> "$RESULTS" 2>&1
237 echo "failed (expected): $@" >> "$RESULTS"
240 echo "succeeded (unexpected!): $@" >> "$RESULTS"
241 _fail
"unexpected success: $msg"
246 # The first parameter is error message to print if it fails, just like
248 # NOTE: we don't use pipefail to avoid disturbing other script, so here we
249 # use a temporary output file.
250 # So it doesn't support pipeline in the @cmd
251 run_mustfail_stdout
()
260 tmp_output
=$
(mktemp
--tmpdir btrfs-progs-test--mustfail-stdtout.XXXXXX
)
265 if _is_file_or_command
"$msg"; then
266 echo "ASSERTION FAIL: 1st argument of run_mustfail_stdout must be a message"
270 ins
=$
(_get_spec_ins
"$@")
272 cmd
=$
(eval echo "\${$spec}")
273 spec
=$
(_cmd_spec
"${@:$spec}")
274 set -- "${@:1:$(($ins-1))}" $spec "${@: $ins}"
275 echo "====== RUN MUSTFAIL $@" >> "$RESULTS" 2>&1
276 if [[ $TEST_LOG =~ tty
]]; then echo "CMD(mustfail): $@" > /dev
/tty
; fi
277 if [ "$1" = 'root_helper' ]; then
278 "$@" 2>&1 > "$tmp_output"
280 $INSTRUMENT "$@" 2>&1 > "$tmp_output"
284 cat "$tmp_output" >> "$RESULTS"
288 if [ "$ret" != 0 ]; then
289 echo "failed (expected): $@" >> "$RESULTS"
292 echo "succeeded (unexpected!): $@" >> "$RESULTS"
293 _fail
"unexpected success: $msg"
300 if [ "$1" = "btrfs-corrupt-block" -o "$1" = "fssum" ]; then
301 if ! [ -f "$INTERNAL_BIN/$1" ]; then
302 _fail
"Failed prerequisites: $INTERNAL_BIN/$1";
304 elif ! [ -f "$TOP/$1" ]; then
305 _fail
"Failed prerequisites: $TOP/$1";
309 check_global_prereq
()
311 which $1 &> /dev
/null
312 if [ $?
-ne 0 ]; then
313 _fail
"Failed system wide prerequisities: $1";
322 echo "testing image $(basename $image)" >> "$RESULTS"
323 "$TOP/btrfs" check
"$image" >> "$RESULTS" 2>&1
324 [ $?
-eq 0 ] && _fail
"btrfs check should have detected corruption"
326 run_check
"$TOP/btrfs" check
--repair "$image"
327 run_check
"$TOP/btrfs" check
"$image"
330 # Extract a usable image from packed formats
331 # - raw btrfs filesystem images, suffix .raw
332 # - dtto compressed by XZ, suffix .raw.xz
333 # - meta-dump images with suffix .img
334 # - dtto compressed by XZ, suffix .img.xz
335 # - compressed send stream, .stream.xz
344 rm -f "$image.restored"
347 xz
--decompress --keep "$image" || \
348 _fail
"failed to decompress image $image" >&2
350 rm -f "$image.restored"
354 cp --sparse=auto
"$image" "$image.restored"
357 xz
--decompress --keep "$image" || \
358 _fail
"failed to decompress image $image" >&2
360 mv "$image" "$image.restored"
363 xz
--decompress --keep "$image" || \
364 _fail
"failed to decompress file $image" >&2
366 mv "$image" "$image.restored"
370 if ! [ -f "$image.restored" ]; then
371 echo "restoring image $(basename $image)" >> "$RESULTS"
372 "$TOP/btrfs-image" -r "$image" "$image.restored" \
374 || _fail
"failed to restore image $image" >&2
377 [ -f "$cleanme" ] && rm -f "$cleanme"
379 echo "$image.restored"
382 # Process all image dumps in a given directory
389 if [ -z "$dir" ]; then
393 for image
in $
(find "$dir" \
( -iname '*.img' -o \
394 -iname '*.img.xz' -o \
396 -iname '*.raw.xz' \
) |
sort)
398 extracted
=$
(extract_image
"$image")
399 check_image
"$extracted"
404 # some tests need to mount the recovered image and do verifications call
405 # 'setup_root_helper' and then check for have_root_helper == 1 if the test
406 # needs to fail otherwise; using sudo by default for now
408 NEED_SUDO_VALIDATE
=unknown
410 export NEED_SUDO_VALIDATE
413 if [ $UID -eq 0 ]; then
416 if [ "$NEED_SUDO_VALIDATE" = 'yes' ]; then
417 sudo
-v -n &>/dev
/null || \
418 _not_run
"Need to validate sudo credentials"
420 elif [ "$NEED_SUDO_VALIDATE" = 'no' ]; then
421 sudo
-n /bin
/true
&> /dev
/null || \
422 _not_run
"Need to validate sudo user settings"
426 _not_run
"Need to validate root privileges"
433 if [ $UID -eq 0 -o -n "$SUDO_HELPER" ]; then
437 # Test for old sudo or special settings, which make sudo -v fail even
438 # if user setting is NOPASSWD
439 sudo
-n /bin
/true
&>/dev
/null
&& NEED_SUDO_VALIDATE
=no
441 # Newer sudo or default sudo setting
442 sudo
-v -n &>/dev
/null
&& NEED_SUDO_VALIDATE
=yes
444 if [ "$NEED_SUDO_VALIDATE" = 'unknown' ]; then
445 _not_run
"Need to validate root privileges"
447 SUDO_HELPER
=root_helper
455 [[ "$size" ]] || size
='2G'
456 # Still truncate it to new size
457 if [ -n "$TEST_DEV" ]; then
458 truncate
-s 0 "$TEST_DEV"
459 truncate
-s "$size" "$TEST_DEV"
463 echo "\$TEST_DEV not given, using $TEST_TOP/test.img as fallback" >> \
465 TEST_DEV
="$TEST_TOP/test.img"
467 truncate
-s 0 "$TEST_DEV"
468 truncate
-s "$size" "$TEST_DEV" || _not_run
"create file for loop device failed"
471 run_check_mount_test_dev
()
476 if [[ -b "$TEST_DEV" ]]; then
478 elif [[ -f "$TEST_DEV" ]]; then
481 _fail
"Invalid \$TEST_DEV: $TEST_DEV"
484 [[ -d "$TEST_MNT" ]] ||
{
485 _fail
"Invalid \$TEST_MNT: $TEST_MNT"
488 run_check
$SUDO_HELPER mount
-t btrfs
$loop_opt "$@" "$TEST_DEV" "$TEST_MNT"
491 # $1-$n: optional paths to unmount, otherwise fallback to TEST_DEV
492 run_check_umount_test_dev
()
495 if [ "$#" = 0 ]; then
498 run_check
$SUDO_HELPER umount
"$@"
501 check_kernel_support
()
503 if ! grep -iq 'btrfs' /proc
/filesystems
; then
504 run_check
$SUDO_HELPER modprobe btrfs
505 if ! grep -iq 'btrfs' /proc
/filesystems
; then
507 "WARNING: btrfs filesystem not found in /proc/filesystems, some tests might fail"
514 # how many files to create.
520 dirpath
=$TEST_MNT/$dataset_type
521 run_check
$SUDO_HELPER mkdir
-p "$dirpath"
523 case "$dataset_type" in
525 for num
in $
(seq 1 "$DATASET_SIZE"); do
526 run_check
$SUDO_HELPER dd if=/dev
/urandom of
="$dirpath/$dataset_type.$num" bs
=10K \
527 count
=1 >/dev
/null
2>&1
532 for num
in $
(seq 1 "$DATASET_SIZE"); do
533 run_check
$SUDO_HELPER touch "$dirpath/$dataset_type.$num"
534 run_check
$SUDO_HELPER ln "$dirpath/$dataset_type.$num" "$dirpath/hlink.$num"
539 for num
in $
(seq 1 "$DATASET_SIZE"); do
540 run_check
$SUDO_HELPER touch "$dirpath/$dataset_type.$num"
541 run_check
cd "$dirpath" && \
542 $SUDO_HELPER ln -s "$dataset_type.$num" "$dirpath/slink.$num" && \
548 for num
in $
(seq 1 "$DATASET_SIZE"); do
549 run_check
$SUDO_HELPER ln -s "$dirpath/$dataset_type.$num" "$dirpath/blink.$num"
554 for modes
in 777 775 755 750 700 666 664 644 640 600 444 440 400 000 \
555 1777 1775 1755 1750 1700 1666 1664 1644 1640 1600 1444 1440 1400 1000 \
556 2777 2775 2755 2750 2700 2666 2664 2644 2640 2600 2444 2440 2400 2000 \
557 4777 4775 4755 4750 4700 4666 4664 4644 4640 4600 4444 4440 4400 4000; do
558 run_check
$SUDO_HELPER touch "$dirpath/$dataset_type.$modes"
559 run_check
$SUDO_HELPER chmod "$modes" "$dirpath/$dataset_type.$modes"
564 for num
in $
(seq 1 "$DATASET_SIZE"); do
565 run_check
$SUDO_HELPER dd if=/dev
/urandom of
="$dirpath/$dataset_type.$num" bs
=10K \
566 count
=1 >/dev
/null
2>&1
567 run_check
$SUDO_HELPER truncate
-s 500K
"$dirpath/$dataset_type.$num"
568 run_check
$SUDO_HELPER dd if=/dev
/urandom of
="$dirpath/$dataset_type.$num" bs
=10K \
569 oflag
=append conv
=notrunc count
=1 >/dev
/null
2>&1
570 run_check
$SUDO_HELPER truncate
-s 800K
"$dirpath/$dataset_type.$num"
575 for num
in $
(seq 1 "$DATASET_SIZE"); do
576 run_check
$SUDO_HELPER touch "$dirpath/$dataset_type.$num"
577 run_check
$SUDO_HELPER setfacl
-m "u:root:x" "$dirpath/$dataset_type.$num"
578 run_check
$SUDO_HELPER setfattr
-n user.foo
-v "bar$num" "$dirpath/$dataset_type.$num"
583 for num
in $
(seq 1 "$DATASET_SIZE"); do
584 run_check
$SUDO_HELPER mkfifo "$dirpath/$dataset_type.$num"
589 long_filename
=`date +%s | sha256sum | cut -f1 -d ' '`
590 run_check
$SUDO_HELPER touch "$dirpath/$long_filename"
591 for num
in $
(seq 1 "$DATASET_SIZE"); do
592 run_check
$SUDO_HELPER ln -s "$dirpath/$long_filename" "$dirpath/slow_slink.$num"
596 run_check
$SUDO_HELPER dd if=/dev
/urandom bs
=32M count
=1 \
597 of
="$dirpath/$dataset_type" >/dev
/null
2>&1
602 # prepare environment for loop devices, set up the following variables
603 # - nloopdevs -- number of desired devices
604 # - loopdevs -- array containing paths to all devices (after prepare is called)
605 # - loopdev_prefix -- file backed images starting with this string, 'img' by default
607 # $1: number of loop devices to be set up
611 _fail
"setup_loopdevs needs a number"
619 # create all loop devices from a given loopdev environment
622 for i
in `seq $nloopdevs`; do
623 touch $loopdev_prefix$i
624 chmod a
+rw
$loopdev_prefix$i
625 truncate
-s0 $loopdev_prefix$i
626 truncate
-s2g $loopdev_prefix$i
627 loopdevs
[$i]=`run_check_stdout $SUDO_HELPER losetup --find --show $loopdev_prefix$i`
631 # detach loop devices and reset their size to 0, delete the files afterwards
634 for dev
in ${loopdevs[@]}; do
635 run_check
$SUDO_HELPER losetup
-d $dev
637 for i
in `seq $nloopdevs`; do
638 truncate
-s0 $loopdev_prefix$i
639 rm -- "$loopdev_prefix$i"
641 run_check
$SUDO_HELPER losetup
--all
646 TEST_MNT
="${TEST_MNT:-$TEST_TOP/mnt}"
648 mkdir
-p "$TEST_MNT" ||
{ echo "Failed mkdir -p $TEST_MNT"; exit 1; }
650 source $TEST_TOP/common.
local
652 if [ "$TEST_ENABLE_OVERRIDE" = 'true' -a -n "$RESULTS" ]; then
653 echo "INCLUDE common.local" >> "$RESULTS"
654 echo " check: $TEST_ARGS_CHECK" >> "$RESULTS"