[PROBLEM]
We want to inject $INSTRUMENT (mostly valgrind) before btrfs command but
after root_helper.
Currently we won't inject $INSTRUMENT at all if we are using
root_helper.
This means the coverage is not good enough.
[FIX]
This patch introduce a new function, expand_command(), to handle all
parameter/argument injection, including existing 'btrfs check' inject.
This function will:
- Detect where to inject $INSTRUMENT
If we have root_helper and the command is target command
(btrfs/mkfs.btrfs/btrfs-convert), then we inject $INSTRUMENT after
root_helper.
If we don't have root_helper, and the command is target command,
we inject $INSTRUMENT before the command.
Or we don't inject $INSTRUMENT (it's not the target command).
- Use existing spec facility to inject extra arguments
- Use an array to restore to result
To avoid bash interpret the IFS inside path/commands.
Now we can make sure no matter if we use root_helper, $INSTRUMENT is
always injected corrected.
Signed-off-by: Qu Wenruo <wqu@xxxxxxxx>
---
tests/common | 182 ++++++++++++++++++++++++++-------------------------
1 file changed, 94 insertions(+), 88 deletions(-)
diff --git a/tests/common b/tests/common
index 71661e950db0..36e2eeb0a372 100644
--- a/tests/common
+++ b/tests/common
@@ -3,6 +3,9 @@
# Common routines for all tests
#
+# Temporary command array for building real command
+declare -a cmd_array
+
# assert that argument is not empty and is an existing path (file or directory)
_assert_path()
{
@@ -135,6 +138,60 @@ _cmd_spec()
fi
}
+_is_target_command()
+{
+ if [[ $1 =~ /btrfs$ ]]; then
+ return 0
+ fi
+ if [[ $1 =~ /mkfs.btrfs$ ]]; then
+ return 0
+ fi
+ if [[ $1 =~ /btrfs-convert$ ]]; then
+ return 0
+ fi
+ return 1
+}
+
+# Expanding extra commands/options for current command string
+# This function is responsible for inserting the following things:
+# - @INSTRUMENT before btrfs commands
+# To ensure that @INSTRUMENT is not executed for things like sudo/mount
+# which normally has setuid/setgid which will not be traced.
+#
+# - Add extra arguments for 'btrfs check'/'mkfs.btrfs'/'btrfs-convert'
+# This allows us to test certain function like lowmem mode for btrfs check
+expand_command()
+{
+ local command_index
+ local ins
+ local spec
+
+ ins=$(_get_spec_ins "$@")
+ spec=$(($ins-1))
+ spec=$(_cmd_spec "${@:$spec}")
+
+ if [ "$1" = 'root_helper' ] && _is_target_command "$2" ; then
+ command_index=2
+ elif _is_target_command "$1" ; then
+ command_index=1
+ else
+ # Since we iterate from offset 1, this never get hit,
+ # thus we won't insert $INSTRUMENT
+ command_index=0
+ fi
+
+ for ((i = 1; i <= $#; i++ )); do
+ if [ $i -eq $command_index -a ! -z "$INSTRUMENT" ]; then
+ cmd_array+=("$INSTRUMENT")
+ fi
+ if [ $i -eq $ins -a ! -z "$spec" ]; then
+ cmd_array+=("$spec")
+ fi
+ cmd_array+=("${!i}")
+
+ done
+}
+
# Argument passing magic:
# the command passed to run_* helpers is inspected, if there's 'btrfs command'
# found and there are defined additional arguments, they're inserted just after
@@ -145,49 +202,28 @@ _cmd_spec()
run_check()
{
- local spec
- local ins
+ expand_command "$@"
+ echo "====== RUN CHECK ${cmd_array[@]}" >> "$RESULTS" 2>&1
+ if [[ $TEST_LOG =~ tty ]]; then echo "CMD: ${cmd_array[@]}" > /dev/tty; fi
- ins=$(_get_spec_ins "$@")
- spec=$(($ins-1))
- spec=$(_cmd_spec "${@:$spec}")
- set -- "${@:1:$(($ins-1))}" $spec "${@: $ins}"
- echo "====== RUN CHECK $@" >> "$RESULTS" 2>&1
- if [[ $TEST_LOG =~ tty ]]; then echo "CMD: $@" > /dev/tty; fi
-
- # If the command is `root_helper` or mount/umount, don't call INSTRUMENT
- # as most profiling tool like valgrind can't handle setuid/setgid/setcap
- # which mount normally has.
- # And since mount/umount is only called with run_check(), we don't need
- # to do the same check on other run_*() functions.
- if [ "$1" = 'root_helper' -o "$1" = 'mount' -o "$1" = 'umount' ]; then
- "$@" >> "$RESULTS" 2>&1 || _fail "failed: $@"
- else
- $INSTRUMENT "$@" >> "$RESULTS" 2>&1 || _fail "failed: $@"
- fi
+ "${cmd_array[@]}" >> "$RESULTS" 2>&1 || _fail "failed: ${cmd_array[@]}"
+ unset cmd_array
}
# same as run_check but the stderr+stdout output is duplicated on stdout and
# can be processed further
run_check_stdout()
{
- local spec
- local ins
- ins=$(_get_spec_ins "$@")
- spec=$(($ins-1))
- spec=$(_cmd_spec "${@:$spec}")
- set -- "${@:1:$(($ins-1))}" $spec "${@: $ins}"
- echo "====== RUN CHECK $@" >> "$RESULTS" 2>&1
- if [[ $TEST_LOG =~ tty ]]; then echo "CMD(stdout): $@" > /dev/tty; fi
- if [ "$1" = 'root_helper' ]; then
- "$@" 2>&1 | tee -a "$RESULTS"
- else
- $INSTRUMENT "$@" 2>&1 | tee -a "$RESULTS"
- fi
+ expand_command "$@"
+ echo "====== RUN CHECK ${cmd_array[@]}" >> "$RESULTS" 2>&1
+ if [[ $TEST_LOG =~ tty ]]; then echo "CMD(stdout): ${cmd_array[@]}" \
+ > /dev/tty; fi
+ "${cmd_array[@]}" 2>&1 | tee -a "$RESULTS"
if [ ${PIPESTATUS[0]} -ne 0 ]; then
_fail "failed: $@"
fi
+ unset cmd_array
}
# same as run_check but does not fail the test if it's handled gracefully by
@@ -195,22 +231,13 @@ run_check_stdout()
# output is logged
run_mayfail()
{
- local spec
- local ins
- local ret
-
- ins=$(_get_spec_ins "$@")
- spec=$(($ins-1))
- spec=$(_cmd_spec "${@:$spec}")
- set -- "${@:1:$(($ins-1))}" $spec "${@: $ins}"
- echo "====== RUN MAYFAIL $@" >> "$RESULTS" 2>&1
- if [[ $TEST_LOG =~ tty ]]; then echo "CMD(mayfail): $@" > /dev/tty; fi
- if [ "$1" = 'root_helper' ]; then
- "$@" >> "$RESULTS" 2>&1
- else
- $INSTRUMENT "$@" >> "$RESULTS" 2>&1
- fi
+ expand_command "$@"
+ echo "====== RUN MAYFAIL ${cmd_array[@]}" >> "$RESULTS" 2>&1
+ if [[ $TEST_LOG =~ tty ]]; then echo "CMD(mayfail): ${cmd_array[@]}" \
+ > /dev/tty; fi
+ "${cmd_array[@]}" >> "$RESULTS" 2>&1
ret=$?
+ unset cmd_array
if [ $ret != 0 ]; then
echo "failed (ignored, ret=$ret): $@" >> "$RESULTS"
if [ $ret == 139 ]; then
@@ -231,24 +258,15 @@ run_mayfail()
# store the output to a variable for further processing.
run_mayfail_stdout()
{
- local spec
- local ins
- local ret
-
tmp_output=$(mktemp --tmpdir btrfs-progs-test--mayfail-stdtout.XXXXXX)
- ins=$(_get_spec_ins "$@")
- spec=$(($ins-1))
- spec=$(_cmd_spec "${@:$spec}")
- set -- "${@:1:$(($ins-1))}" $spec "${@: $ins}"
- echo "====== RUN MAYFAIL $@" >> "$RESULTS" 2>&1
- if [[ $TEST_LOG =~ tty ]]; then echo "CMD(mayfail): $@" > /dev/tty; fi
- if [ "$1" = 'root_helper' ]; then
- "$@" 2>&1 > "$tmp_output"
- else
- $INSTRUMENT "$@" 2>&1 > "$tmp_output"
- fi
+ expand_command "$@"
+ echo "====== RUN MAYFAIL ${cmd_array[@]}" >> "$RESULTS" 2>&1
+ if [[ $TEST_LOG =~ tty ]]; then echo "CMD(mayfail): ${cmd_array[@]}" \
+ > /dev/tty; fi
+ "${cmd_array[@]}" 2>&1 > "$tmp_output"
ret=$?
+ unset cmd_array
cat "$tmp_output" >> "$RESULTS"
cat "$tmp_output"
@@ -272,8 +290,6 @@ run_mayfail_stdout()
# same as run_check but expects the command to fail, output is logged
run_mustfail()
{
- local spec
- local ins
local msg
msg="$1"
@@ -284,23 +300,20 @@ run_mustfail()
exit 1
fi
- ins=$(_get_spec_ins "$@")
- spec=$(($ins-1))
- spec=$(_cmd_spec "${@:$spec}")
- set -- "${@:1:$(($ins-1))}" $spec "${@: $ins}"
- echo "====== RUN MUSTFAIL $@" >> "$RESULTS" 2>&1
- if [[ $TEST_LOG =~ tty ]]; then echo "CMD(mustfail): $@" > /dev/tty; fi
- if [ "$1" = 'root_helper' ]; then
- "$@" >> "$RESULTS" 2>&1
- else
- $INSTRUMENT "$@" >> "$RESULTS" 2>&1
- fi
+
+ expand_command "$@"
+ echo "====== RUN MUSTFAIL ${cmd_array[@]}" >> "$RESULTS" 2>&1
+ if [[ $TEST_LOG =~ tty ]]; then echo "CMD(mustfail): ${cmd_array[@]}" \
+ > /dev/tty; fi
+ "${cmd_array[@]}" >> "$RESULTS" 2>&1
if [ $? != 0 ]; then
echo "failed (expected): $@" >> "$RESULTS"
+ unset cmd_array
return 0
else
echo "succeeded (unexpected!): $@" >> "$RESULTS"
_fail "unexpected success: $msg"
+ unset cmd_array
return 1
fi
}
@@ -312,8 +325,6 @@ run_mustfail()
# So it doesn't support pipeline in the @cmd
run_mustfail_stdout()
{
- local spec
- local ins
local msg
local ret
local tmp_output
@@ -328,18 +339,13 @@ run_mustfail_stdout()
exit 1
fi
- ins=$(_get_spec_ins "$@")
- spec=$(($ins-1))
- spec=$(_cmd_spec "${@:$spec}")
- set -- "${@:1:$(($ins-1))}" $spec "${@: $ins}"
- echo "====== RUN MUSTFAIL $@" >> "$RESULTS" 2>&1
- if [[ $TEST_LOG =~ tty ]]; then echo "CMD(mustfail): $@" > /dev/tty; fi
- if [ "$1" = 'root_helper' ]; then
- "$@" 2>&1 > "$tmp_output"
- else
- $INSTRUMENT "$@" 2>&1 > "$tmp_output"
- fi
+ expand_command "$@"
+ echo "====== RUN MUSTFAIL ${cmd_array[@]}" >> "$RESULTS" 2>&1
+ if [[ $TEST_LOG =~ tty ]]; then echo "CMD(mustfail): ${cmd_array[@]}" \
+ > /dev/tty; fi
+ "${cmd_array[@]}" 2>&1 > "$tmp_output"
ret=$?
+ unset cmd_array
cat "$tmp_output" >> "$RESULTS"
cat "$tmp_output"
--
2.26.0
