add shellcheck support
v2 cover add shellcheck support
Tree here
https://gitlab.com/npiggin/kvm-unit-tests/-/tree/shellcheck
Again on top of the "v8 migration, powerpc improvements" series. I don't plan to rebase the other way around since it's a lot of work. So this is still in RFC until the other big series gets merged.
Thanks to Andrew for a lot of review. A submitted the likely s390x bugs separately ahead of this series, and also disabled one of the tests and dropped its fix patch as-per review comments. Hence 3 fewer patches. Other than that, since last post:
* Tidied commit messages and added some of Andrew's comments.
* Removed the "SC2034 unused variable" blanket disable, and just suppressed the config.mak and a couple of other warnings.
* Blanket disabled "SC2235 Use { ..; } instead of (..)" and dropped the fix for it.
* Change warning suppression comments as per Andrew's review, also mention in the new unittests doc about the "check =" option not allowing whitespace etc in the name since we don't cope with that.
Thanks,
Nick
Nicholas Piggin (14):
Add initial shellcheck checking
shellcheck: Fix SC2223
shellcheck: Fix SC2295
shellcheck: Fix SC2094
shellcheck: Fix SC2006
shellcheck: Fix SC2155
shellcheck: Fix SC2143
shellcheck: Fix SC2013
shellcheck: Fix SC2145
shellcheck: Fix SC2124
shellcheck: Fix SC2294
shellcheck: Fix SC2178
shellcheck: Fix SC2048
shellcheck: Suppress various messages
.shellcheckrc | 30 ++++++++++++++++++++++++ Makefile | 4 ++++ README.md | 3 +++ arm/efi/run | 4 ++-- configure | 2 ++ riscv/efi/run | 4 ++-- run_tests.sh | 11 +++++---- scripts/arch-run.bash | 52 ++++++++++++++++++++++++++++++----------- scripts/common.bash | 5 +++- scripts/mkstandalone.sh | 4 +++- scripts/runtime.bash | 14 +++++++---- 11 files changed, 105 insertions(+), 28 deletions(-) create mode 100644 .shellcheckrc
Signature · 1 line
2.43.0
RFC PATCH v2 1/14 Add initial shellcheck checking
This adds a basic shellcheck sytle file, some directives to help find scripts, and a make shellcheck target.
When changes settle down this could be made part of the standard build / CI flow.
--- .shellcheckrc | 30 ++++++++++++++++++++++++++++++ Makefile | 4 ++++ README.md | 3 +++ scripts/common.bash | 5 ++++- 4 files changed, 41 insertions(+), 1 deletion(-) create mode 100644 .shellcheckrc
.shellcheckrc new file +30 -0
@@ -0,0 +1,30 @@ +# shellcheck configuration file +external-sources=true + +# Optional extras -- https://www.shellcheck.net/wiki/Optional +# Possibilities, e.g., - +# quote?safe?variables +# require-double-brackets +# require-variable-braces +# add-default-case + +# Disable SC2004 style? I.e., +# In run_tests.sh line 67: +# if (( $unittest_run_queues <= 0 )); then +# ^------------------^ SC2004 (style): $/${} is unnecessary on arithmetic variables. +disable=SC2004 + +# Disable SC2086 for now, double quote to prevent globbing and word +# splitting. There are lots of places that use it for word splitting +# (e.g., invoking commands with arguments) that break. Should have a +# more consistent approach for this (perhaps use arrays for such cases) +# but for now disable. +# SC2086 (info): Double quote to prevent globbing and word splitting. +disable=SC2086 + +# Disable SC2235. Most developers are used to seeing expressions +# like a || (b && c), not a || { b && c ; }. The subshell overhead in +# kvm-unit-tests is negligible as it's not shell-heavy in the first +# place (time is dominated by qemu startup/shutdown and test execution) +# SC2235 (style): Use { ..; } instead of (..) to avoid subshell overhead. +disable=SC2235
Makefile +4 -0
@@ -141,6 +141,10 @@ cscope: -name '*.[chsS]' -exec realpath --relative-base=$(CURDIR) {} \; | sort -u > ./cscope.files cscope -bk +.PHONY: shellcheck +shellcheck: + shellcheck -a run_tests.sh */run */efi/run scripts/mkstandalone.sh + .PHONY: tags tags: ctags -R
README.md +3 -0
@@ -193,3 +193,6 @@ with `git config diff.orderFile scripts/git.difforder` enables it. We strive to follow the Linux kernels coding style so it's recommended to run the kernel's ./scripts/checkpatch.pl on new patches. + +Also run make shellcheck before submitting a patch which touches bash +scripts.
scripts/common.bash +4 -1
@@ -82,8 +82,11 @@ function arch_cmd() } # The current file has to be the only file sourcing the arch helper -# file +# file. Shellcheck can't follow this so help it out. There doesn't appear to be a +# way to specify multiple alternatives, so we will have to rethink this if things +# get more complicated. ARCH_FUNC=scripts/${ARCH}/func.bash if [ -f "${ARCH_FUNC}" ]; then +# shellcheck source=scripts/s390x/func.bash source "${ARCH_FUNC}" fi
Signature · 1 line
2.43.0
Re: [RFC kvm-unit-tests PATCH v2 01/14] Add initial shellcheck checking
Quoted 1 line · Nicholas Piggin
This adds a basic shellcheck sytle file, some directives to help
s/sytle/style/
Quoted 9 lines
find scripts, and a make shellcheck target.
When changes settle down this could be made part of the standard build / CI flow.
Suggested-by Andrew Jones <[email protected]>Reviewed-by Andrew Jones <[email protected]>Signed-off-by Nicholas Piggin <[email protected]>---
...
README.md with `git config diff.orderFile scripts/git.difforder` enables it. · line 197
Quoted 10 lines
README.md +2
-0@@ -193,3 +193,6 @@ with `git config diff.orderFile scripts/git.difforder` enables it. We strive to follow the Linux kernels coding style so it's recommended to run the kernel's ./scripts/checkpatch.pl on new patches. + +Also run make shellcheck before submitting a patch which touches bash
I'd maybe put "make shellcheck" in quotes to make the sentence more readable?
Quoted 8 lines
README.md +1
-0+scripts.scripts/common.bash +0
-0@@ -82,8 +82,11 @@ function arch_cmd() }
scripts/common.bash function arch_cmd() · line 92
Quoted 10 lines
scripts/common.bash +4
-1# The current file has to be the only file sourcing the arch helper -# file +# file. Shellcheck can't follow this so help it out. There doesn't appear to be a +# way to specify multiple alternatives, so we will have to rethink this if things +# get more complicated. ARCH_FUNC=scripts/${ARCH}/func.bash if [ -f "${ARCH_FUNC}" ]; then +# shellcheck source=scripts/s390x/func.bash source "${ARCH_FUNC}" fi
Thomas
Re: [RFC kvm-unit-tests PATCH v2 01/14] Add initial shellcheck checking
Quoted 21 lines · Thomas Huth
Quoted 1 line · Nicholas Piggin
This adds a basic shellcheck sytle file, some directives to help
s/sytle/style/
Quoted 9 lines
find scripts, and a make shellcheck target.
When changes settle down this could be made part of the standard build / CI flow.
Suggested-by Andrew Jones <[email protected]>Reviewed-by Andrew Jones <[email protected]>Signed-off-by Nicholas Piggin <[email protected]>---
...
Quoted 6 lines
README.md +0
-0@@ -193,3 +193,6 @@ with `git config diff.orderFile scripts/git.difforder` enables it.
Quoted 6 lines
README.md with `git config diff.orderFile scripts/git.difforder` enables it. · line 197
Quoted 4 lines
README.md +2
-0We strive to follow the Linux kernels coding style so it's recommended to run the kernel's ./scripts/checkpatch.pl on new patches. + +Also run make shellcheck before submitting a patch which touches bashI'd maybe put "make shellcheck" in quotes to make the sentence more readable?
Agreed.
Thanks,
Nick
RFC PATCH v2 2/14 shellcheck: Fix SC2223
In reply to Nicholas PigginSC2223 (info): This default assignment may cause DoS due to globbing. Quote it.
--- run_tests.sh | 4 ++-- scripts/runtime.bash | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-)
run_tests.sh +2 -2
@@ -158,8 +158,8 @@ function run_task() fi } -: ${unittest_log_dir:=logs} -: ${unittest_run_queues:=1} +: "${unittest_log_dir:=logs}" +: "${unittest_run_queues:=1}" config=$TEST_DIR/unittests.cfg print_testname()
scripts/runtime.bash +2 -2
@@ -1,6 +1,6 @@ : "${RUNTIME_arch_run?}" -: ${MAX_SMP:=$(getconf _NPROCESSORS_ONLN)} -: ${TIMEOUT:=90s} +: "${MAX_SMP:=$(getconf _NPROCESSORS_ONLN)}" +: "${TIMEOUT:=90s}" PASS() { echo -ne "\e[32mPASS\e[0m"; } SKIP() { echo -ne "\e[33mSKIP\e[0m"; }
Signature · 1 line
2.43.0
RFC PATCH v2 3/14 shellcheck: Fix SC2295
In reply to Nicholas PigginSC2295 (info): Expansions inside ${..} need to be quoted separately, otherwise they match as patterns.
Doesn't appear to be a bug since the match string does not include patterns.
--- run_tests.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
run_tests.sh +1 -1
@@ -99,7 +99,7 @@ else local testname="$1" CR=$'\r' while read -r line; do - line="${line%$CR}" + line="${line%"$CR"}" case "${line:0:4}" in PASS) echo "ok TEST_NUMBER - ${testname}: ${line#??????}" >&3
Signature · 1 line
2.43.0
RFC PATCH v2 4/14 shellcheck: Fix SC2094
In reply to Nicholas PigginSC2094 (info): Make sure not to read and write the same file in the same pipeline.
This is not as clearly bad as overwriting an input file with >, but could appended characters possibly be read in from the input redirection?
--- scripts/arch-run.bash | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)
scripts/arch-run.bash +4 -1
@@ -492,6 +492,8 @@ env_file () env_errata () { + local new_env + if [ "$ACCEL" = "tcg" ]; then export "ERRATA_FORCE=y" elif [ "$ERRATATXT" ] && [ ! -f "$ERRATATXT" ]; then
@@ -500,7 +502,8 @@ env_errata () elif [ "$ERRATATXT" ]; then env_generate_errata fi - sort <(env | grep '^ERRATA_') <(grep '^ERRATA_' $KVM_UNIT_TESTS_ENV) | uniq -u >>$KVM_UNIT_TESTS_ENV + new_env=$(sort <(env | grep '^ERRATA_') <(grep '^ERRATA_' $KVM_UNIT_TESTS_ENV) | uniq -u) + echo "$new_env" >>$KVM_UNIT_TESTS_ENV } env_generate_errata ()
Signature · 1 line
2.43.0
RFC PATCH v2 5/14 shellcheck: Fix SC2006
In reply to Nicholas PigginSC2006 (style): Use $(...) notation instead of legacy backticks `...`.
No bug identified.
--- scripts/arch-run.bash | 6 +++--- scripts/runtime.bash | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-)
scripts/arch-run.bash +3 -3
@@ -271,16 +271,16 @@ do_migration () qmp ${src_qmp} '"migrate", "arguments": { "uri": "unix:'${dst_incoming}'" }' > ${src_qmpout} # Wait for the migration to complete - migstatus=`qmp ${src_qmp} '"query-migrate"' | grep return` + migstatus=$(qmp ${src_qmp} '"query-migrate"' | grep return) while ! grep -q '"completed"' <<<"$migstatus" ; do sleep 0.1 - if ! migstatus=`qmp ${src_qmp} '"query-migrate"'`; then + if ! migstatus=$(qmp ${src_qmp} '"query-migrate"'); then echo "ERROR: Querying migration state failed." >&2 echo > ${dst_infifo} qmp ${dst_qmp} '"quit"'> ${dst_qmpout} 2>/dev/null return 2 fi - migstatus=`grep return <<<"$migstatus"` + migstatus=$(grep return <<<"$migstatus") if grep -q '"failed"' <<<"$migstatus"; then echo "ERROR: Migration failed." >&2 echo > ${dst_infifo}
scripts/runtime.bash +2 -2
@@ -61,9 +61,9 @@ function print_result() local reason="$4" if [ -z "$reason" ]; then - echo "`$status` $testname $summary" + echo "$($status) $testname $summary" else - echo "`$status` $testname ($reason)" + echo "$($status) $testname ($reason)" fi }
Signature · 1 line
2.43.0
RFC PATCH v2 6/14 shellcheck: Fix SC2155
In reply to Nicholas PigginSC2155 (warning): Declare and assign separately to avoid masking return values.
No bug identified.
--- scripts/arch-run.bash | 10 +++++++--- scripts/runtime.bash | 4 +++- 2 files changed, 10 insertions(+), 4 deletions(-)
scripts/arch-run.bash +7 -3
@@ -411,7 +411,8 @@ initrd_cleanup () { rm -f $KVM_UNIT_TESTS_ENV if [ "$KVM_UNIT_TESTS_ENV_OLD" ]; then - export KVM_UNIT_TESTS_ENV="$KVM_UNIT_TESTS_ENV_OLD" + export KVM_UNIT_TESTS_ENV + KVM_UNIT_TESTS_ENV="$KVM_UNIT_TESTS_ENV_OLD" else unset KVM_UNIT_TESTS_ENV fi
@@ -423,7 +424,8 @@ initrd_create () if [ "$ENVIRON_DEFAULT" = "yes" ]; then trap_exit_push 'initrd_cleanup' [ -f "$KVM_UNIT_TESTS_ENV" ] && export KVM_UNIT_TESTS_ENV_OLD="$KVM_UNIT_TESTS_ENV" - export KVM_UNIT_TESTS_ENV=$(mktemp) + export KVM_UNIT_TESTS_ENV + KVM_UNIT_TESTS_ENV=$(mktemp) env_params env_file env_errata || return $?
@@ -566,7 +568,9 @@ env_generate_errata () trap_exit_push () { - local old_exit=$(trap -p EXIT | sed "s/^[^']*'//;s/'[^']*$//") + local old_exit + + old_exit=$(trap -p EXIT | sed "s/^[^']*'//;s/'[^']*$//") trap -- "$1; $old_exit" EXIT }
scripts/runtime.bash +3 -1
@@ -15,7 +15,9 @@ extract_summary() # We assume that QEMU is going to work if it tried to load the kernel premature_failure() { - local log="$(eval "$(get_cmdline _NO_FILE_4Uhere_)" 2>&1)" + local log + + log="$(eval "$(get_cmdline _NO_FILE_4Uhere_)" 2>&1)" echo "$log" | grep "_NO_FILE_4Uhere_" | grep -q -e "[Cc]ould not \(load\|open\) kernel" \
Signature · 1 line
2.43.0
RFC PATCH v2 7/14 shellcheck: Fix SC2143
In reply to Nicholas PigginSC2143 (style): Use ! grep -q instead of comparing output with [ -z .. ].
Not a bug.
--- scripts/arch-run.bash | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)
scripts/arch-run.bash +5 -1
@@ -61,7 +61,11 @@ run_qemu () # Even when ret==1 (unittest success) if we also got stderr # logs, then we assume a QEMU failure. Otherwise we translate # status of 1 to 0 (SUCCESS) - if [ -z "$(echo "$errors" | grep -vi warning)" ]; then + if [ "$errors" ]; then + if ! grep -qvi warning <<<"$errors" ; then + ret=0 + fi + else ret=0 fi fi
Signature · 1 line
2.43.0
RFC PATCH v2 8/14 shellcheck: Fix SC2013
In reply to Nicholas PigginSC2013 (info): To read lines rather than words, pipe/redirect to a 'while read' loop.
Not a bug.
--- scripts/arch-run.bash | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
scripts/arch-run.bash +1 -1
@@ -487,7 +487,7 @@ env_file () [ ! -f "$KVM_UNIT_TESTS_ENV_OLD" ] && return - for line in $(grep -E '^[[:blank:]]*[[:alpha:]_][[:alnum:]_]*=' "$KVM_UNIT_TESTS_ENV_OLD"); do + grep -E '^[[:blank:]]*[[:alpha:]_][[:alnum:]_]*=' "$KVM_UNIT_TESTS_ENV_OLD" | while IFS= read -r line ; do var=${line%%=*} if ! grep -q "^$var=" $KVM_UNIT_TESTS_ENV; then eval export "$line"
Signature · 1 line
2.43.0
Re: [RFC kvm-unit-tests PATCH v2 08/14] shellcheck: Fix SC2013
Quoted 26 lines · Nicholas Piggin
SC2013 (info): To read lines rather than words, pipe/redirect to a 'while read' loop.
Not a bug.
Signed-off-by Nicholas Piggin <[email protected]>--- scripts/arch-run.bash | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)scripts/arch-run.bash +1
-1@@ -487,7 +487,7 @@ env_file () [ ! -f "$KVM_UNIT_TESTS_ENV_OLD" ] && return - for line in $(grep -E '^[[:blank:]]*[[:alpha:]_][[:alnum:]_]*=' "$KVM_UNIT_TESTS_ENV_OLD"); do + grep -E '^[[:blank:]]*[[:alpha:]_][[:alnum:]_]*=' "$KVM_UNIT_TESTS_ENV_OLD" | while IFS= read -r line ; do var=${line%%=*} if ! grep -q "^$var=" $KVM_UNIT_TESTS_ENV; then eval export "$line"Signature · 1 line
2.43.0
I already gave an r-b on this one. Here it is again,
Re: [RFC kvm-unit-tests PATCH v2 08/14] shellcheck: Fix SC2013
Quoted 30 lines · Andrew Jones
Quoted 26 lines · Nicholas Piggin
SC2013 (info): To read lines rather than words, pipe/redirect to a 'while read' loop.
Not a bug.
Signed-off-by Nicholas Piggin <[email protected]>--- scripts/arch-run.bash | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)scripts/arch-run.bash +1
-1@@ -487,7 +487,7 @@ env_file () [ ! -f "$KVM_UNIT_TESTS_ENV_OLD" ] && return - for line in $(grep -E '^[[:blank:]]*[[:alpha:]_][[:alnum:]_]*=' "$KVM_UNIT_TESTS_ENV_OLD"); do + grep -E '^[[:blank:]]*[[:alpha:]_][[:alnum:]_]*=' "$KVM_UNIT_TESTS_ENV_OLD" | while IFS= read -r line ; do var=${line%%=*} if ! grep -q "^$var=" $KVM_UNIT_TESTS_ENV; then eval export "$line"Signature · 1 line
2.43.0I already gave an r-b on this one. Here it is again,
Quoted 1 line
Reviewed-by Andrew Jones <[email protected]>
Yeah I realised just after sending. Thank you.
Thanks,
Nick
RFC PATCH v2 9/14 shellcheck: Fix SC2145
In reply to Nicholas PigginSC2145 (error): Argument mixes string and array. Use * or separate argument.
Shouldn't be a bug, since the preceding string ends with a space and there aren't any succeeding strings.
--- arm/efi/run | 2 +- riscv/efi/run | 2 +- scripts/mkstandalone.sh | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-)
arm/efi/run +1 -1
@@ -87,7 +87,7 @@ uefi_shell_run() if [ "$EFI_DIRECT" = "y" ]; then $TEST_DIR/run \ $KERNEL_NAME \ - -append "$(basename $KERNEL_NAME) ${cmd_args[@]}" \ + -append "$(basename $KERNEL_NAME) ${cmd_args[*]}" \ -bios "$EFI_UEFI" \ "${qemu_args[@]}" else
riscv/efi/run +1 -1
@@ -97,7 +97,7 @@ if [ "$EFI_DIRECT" = "y" ]; then fi $TEST_DIR/run \ $KERNEL_NAME \ - -append "$(basename $KERNEL_NAME) ${cmd_args[@]}" \ + -append "$(basename $KERNEL_NAME) ${cmd_args[*]}" \ -machine pflash0=pflash0 \ -blockdev node-name=pflash0,driver=file,read-only=on,filename="$EFI_UEFI" \ "${qemu_args[@]}"
scripts/mkstandalone.sh +1 -1
@@ -76,7 +76,7 @@ generate_test () cat scripts/runtime.bash - echo "run ${args[@]}" + echo "run ${args[*]}" } function mkstandalone()
Signature · 1 line
2.43.0
RFC PATCH v2 10/14 shellcheck: Fix SC2124
In reply to Nicholas PigginSC2124 (warning): Assigning an array to a string! Assign as array, or use * instead of @ to concatenate.
Shouldn't be a bug since bash concatenates with space and eval is used on the result.
--- scripts/arch-run.bash | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
scripts/arch-run.bash +3 -3
@@ -150,7 +150,7 @@ run_migration () return 77 fi - migcmdline=$@ + migcmdline=("$@") trap 'trap - TERM ; kill 0 ; exit 2' INT TERM trap 'rm -f ${src_out} ${dst_out} ${src_outfifo} ${dst_outfifo} ${dst_incoming} ${src_qmp} ${dst_qmp} ${src_infifo} ${dst_infifo}' RETURN EXIT
@@ -179,7 +179,7 @@ run_migration () exec {src_infifo_fd}<>${src_infifo} exec {dst_infifo_fd}<>${dst_infifo} - eval "$migcmdline" \ + eval "${migcmdline[@]}" \ -chardev socket,id=mon,path=${src_qmp},server=on,wait=off \ -mon chardev=mon,mode=control \ < ${src_infifo} > ${src_outfifo} &
@@ -219,7 +219,7 @@ run_migration () do_migration () { - eval "$migcmdline" \ + eval "${migcmdline[@]}" \ -chardev socket,id=mon,path=${dst_qmp},server=on,wait=off \ -mon chardev=mon,mode=control -incoming unix:${dst_incoming} \ < ${dst_infifo} > ${dst_outfifo} &
Signature · 1 line
2.43.0
RFC PATCH v2 11/14 shellcheck: Fix SC2294
In reply to Nicholas PigginSC2294 (warning): eval negates the benefit of arrays. Drop eval to preserve whitespace/symbols (or eval as string).
No bug identified.
--- scripts/arch-run.bash | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
scripts/arch-run.bash +3 -3
@@ -179,7 +179,7 @@ run_migration () exec {src_infifo_fd}<>${src_infifo} exec {dst_infifo_fd}<>${dst_infifo} - eval "${migcmdline[@]}" \ + "${migcmdline[@]}" \ -chardev socket,id=mon,path=${src_qmp},server=on,wait=off \ -mon chardev=mon,mode=control \ < ${src_infifo} > ${src_outfifo} &
@@ -219,7 +219,7 @@ run_migration () do_migration () { - eval "${migcmdline[@]}" \ + "${migcmdline[@]}" \ -chardev socket,id=mon,path=${dst_qmp},server=on,wait=off \ -mon chardev=mon,mode=control -incoming unix:${dst_incoming} \ < ${dst_infifo} > ${dst_outfifo} &
@@ -357,7 +357,7 @@ run_panic () qmp=$(mktemp -u -t panic-qmp.XXXXXXXXXX) # start VM stopped so we don't miss any events - eval "$@" -chardev socket,id=mon,path=${qmp},server=on,wait=off \ + "$@" -chardev socket,id=mon,path=${qmp},server=on,wait=off \ -mon chardev=mon,mode=control -S & panic_event_count=$(qmp_events ${qmp} | jq -c 'select(.event == "GUEST_PANICKED")' | wc -l)
Signature · 1 line
2.43.0
RFC PATCH v2 12/14 shellcheck: Fix SC2178
In reply to Nicholas PigginSC2178 (warning): Variable was used as an array but is now assigned a string.
No bug identified.
--- arm/efi/run | 2 +- riscv/efi/run | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)
arm/efi/run +1 -1
@@ -44,7 +44,7 @@ qemu_args=() cmd_args=() while (( "$#" )); do if [ "$1" = "-append" ]; then - cmd_args=$2 + cmd_args=("$2") shift 2 else qemu_args+=("$1")
riscv/efi/run +1 -1
@@ -47,7 +47,7 @@ qemu_args=() cmd_args=() while (( "$#" )); do if [ "$1" = "-append" ]; then - cmd_args=$2 + cmd_args=("$2") shift 2 else qemu_args+=("$1")
Signature · 1 line
2.43.0
RFC PATCH v2 13/14 shellcheck: Fix SC2048
In reply to Nicholas PigginSC2048 (warning): Use "$@" (with quotes) to prevent whitespace problems.
No bug identified.
--- run_tests.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
run_tests.sh +1 -1
@@ -44,7 +44,7 @@ fi only_tests="" list_tests="" -args=$(getopt -u -o ag:htj:vl -l all,group:,help,tap13,parallel:,verbose,list,probe-maxsmp -- $*) +args=$(getopt -u -o ag:htj:vl -l all,group:,help,tap13,parallel:,verbose,list,probe-maxsmp -- "$@") [ $? -ne 0 ] && exit 2; set -- $args; while [ $# -gt 0 ]; do
Signature · 1 line
2.43.0
RFC PATCH v2 14/14 shellcheck: Suppress various messages
In reply to Nicholas PigginVarious info and warnings are suppressed here, where circumstances (commented) warrant.
--- configure | 2 ++ run_tests.sh | 3 +++ scripts/arch-run.bash | 15 +++++++++++++++ scripts/mkstandalone.sh | 2 ++ scripts/runtime.bash | 2 ++ 5 files changed, 24 insertions(+)
configure +2 -0
@@ -437,6 +437,8 @@ ln -sf "$asm" lib/asm # create the config cat <<EOF > config.mak +# Shellcheck does not see these are used +# shellcheck disable=SC2034 SRCDIR=$srcdir PREFIX=$prefix HOST=$host
run_tests.sh +3 -0
@@ -45,6 +45,9 @@ fi only_tests="" list_tests="" args=$(getopt -u -o ag:htj:vl -l all,group:,help,tap13,parallel:,verbose,list,probe-maxsmp -- "$@") +# Shellcheck likes to test commands directly rather than with $? but sometimes they +# are too long to put in the same test. +# shellcheck disable=SC2181 [ $? -ne 0 ] && exit 2; set -- $args; while [ $# -gt 0 ]; do
scripts/arch-run.bash +15 -0
@@ -44,6 +44,8 @@ run_qemu () if [ "$errors" ]; then sig=$(grep 'terminating on signal' <<<"$errors") if [ "$sig" ]; then + # This is too complex for ${var/search/replace} + # shellcheck disable=SC2001 sig=$(sed 's/.*terminating on signal \([0-9][0-9]*\).*/\1/' <<<"$sig") fi fi
@@ -174,9 +176,12 @@ run_migration () # Holding both ends of the input fifo open prevents opens from # blocking and readers getting EOF when a writer closes it. + # These fds appear to be unused to shellcheck so quieten the warning. mkfifo ${src_infifo} mkfifo ${dst_infifo} + # shellcheck disable=SC2034 exec {src_infifo_fd}<>${src_infifo} + # shellcheck disable=SC2034 exec {dst_infifo_fd}<>${dst_infifo} "${migcmdline[@]}" \
@@ -184,6 +189,9 @@ run_migration () -mon chardev=mon,mode=control \ < ${src_infifo} > ${src_outfifo} & live_pid=$! + # Shellcheck complains about useless cat but it is clearer than a + # redirect in this case. + # shellcheck disable=SC2002 cat ${src_outfifo} | tee ${src_out} | filter_quiet_msgs & # Start the first destination QEMU machine in advance of the test
@@ -224,6 +232,9 @@ do_migration () -mon chardev=mon,mode=control -incoming unix:${dst_incoming} \ < ${dst_infifo} > ${dst_outfifo} & incoming_pid=$! + # Shellcheck complains about useless cat but it is clearer than a + # redirect in this case. + # shellcheck disable=SC2002 cat ${dst_outfifo} | tee ${dst_out} | filter_quiet_msgs & # The test must prompt the user to migrate, so wait for the
@@ -467,6 +478,8 @@ env_params () [ -n "$ACCEL" ] && QEMU_ACCEL=$ACCEL fi QEMU_VERSION_STRING="$($qemu -h | head -1)" + # SC does not seee QEMU_MAJOR|MINOR|MICRO are used + # shellcheck disable=SC2034 IFS='[ .]' read -r _ _ _ QEMU_MAJOR QEMU_MINOR QEMU_MICRO rest <<<"$QEMU_VERSION_STRING" fi env_add_params QEMU_ACCEL QEMU_VERSION_STRING QEMU_MAJOR QEMU_MINOR QEMU_MICRO
@@ -597,6 +610,8 @@ hvf_available () set_qemu_accelerator () { + # Shellcheck does not seee ACCEL_PROPS is used + # shellcheck disable=SC2034 ACCEL_PROPS=${ACCEL#"${ACCEL%%,*}"} ACCEL=${ACCEL%%,*}
scripts/mkstandalone.sh +2 -0
@@ -65,6 +65,8 @@ generate_test () fi temp_file bin "$kernel" + # Don't want to expand $bin but print it as-is. + # shellcheck disable=SC2016 args[3]='$bin' (echo "#!/usr/bin/env bash"
scripts/runtime.bash +2 -0
@@ -137,6 +137,8 @@ function run() # the check line can contain multiple files to check separated by a space # but each check parameter needs to be of the form <path>=<value> if [ "$check" ]; then + # There is no globbing or whitespace allowed in check parameters. + # shellcheck disable=SC2206 check=($check) for check_param in "${check[@]}"; do path=${check_param%%=*}
Signature · 1 line
2.43.0
Re: [RFC kvm-unit-tests PATCH v2 14/14] shellcheck: Suppress various messages
Quoted 86 lines · Nicholas Piggin
Various info and warnings are suppressed here, where circumstances (commented) warrant.
Signed-off-by Nicholas Piggin <[email protected]>--- configure | 2 ++ run_tests.sh | 3 +++ scripts/arch-run.bash | 15 +++++++++++++++ scripts/mkstandalone.sh | 2 ++ scripts/runtime.bash | 2 ++ 5 files changed, 24 insertions(+)configure +2
-0@@ -437,6 +437,8 @@ ln -sf "$asm" lib/asm # create the config cat <<EOF > config.mak +# Shellcheck does not see these are used +# shellcheck disable=SC2034 SRCDIR=$srcdir PREFIX=$prefix HOST=$hostrun_tests.sh +3
-0@@ -45,6 +45,9 @@ fi only_tests="" list_tests="" args=$(getopt -u -o ag:htj:vl -l all,group:,help,tap13,parallel:,verbose,list,probe-maxsmp -- "$@") +# Shellcheck likes to test commands directly rather than with $? but sometimes they +# are too long to put in the same test. +# shellcheck disable=SC2181 [ $? -ne 0 ] && exit 2; set -- $args; while [ $# -gt 0 ]; doscripts/arch-run.bash +11
-0@@ -44,6 +44,8 @@ run_qemu () if [ "$errors" ]; then sig=$(grep 'terminating on signal' <<<"$errors") if [ "$sig" ]; then + # This is too complex for ${var/search/replace} + # shellcheck disable=SC2001 sig=$(sed 's/.*terminating on signal \([0-9][0-9]*\).*/\1/' <<<"$sig") fi fi@@ -174,9 +176,12 @@ run_migration () # Holding both ends of the input fifo open prevents opens from # blocking and readers getting EOF when a writer closes it. + # These fds appear to be unused to shellcheck so quieten the warning. mkfifo ${src_infifo} mkfifo ${dst_infifo} + # shellcheck disable=SC2034 exec {src_infifo_fd}<>${src_infifo} + # shellcheck disable=SC2034 exec {dst_infifo_fd}<>${dst_infifo} "${migcmdline[@]}" \@@ -184,6 +189,9 @@ run_migration () -mon chardev=mon,mode=control \ < ${src_infifo} > ${src_outfifo} & live_pid=$! + # Shellcheck complains about useless cat but it is clearer than a + # redirect in this case. + # shellcheck disable=SC2002 cat ${src_outfifo} | tee ${src_out} | filter_quiet_msgs & # Start the first destination QEMU machine in advance of the test@@ -224,6 +232,9 @@ do_migration () -mon chardev=mon,mode=control -incoming unix:${dst_incoming} \ < ${dst_infifo} > ${dst_outfifo} & incoming_pid=$! + # Shellcheck complains about useless cat but it is clearer than a + # redirect in this case. + # shellcheck disable=SC2002 cat ${dst_outfifo} | tee ${dst_out} | filter_quiet_msgs & # The test must prompt the user to migrate, so wait for the
scripts/arch-run.bash env_params () · line 481
Quoted 4 lines
scripts/arch-run.bash +1
-0@@ -467,6 +478,8 @@ env_params () [ -n "$ACCEL" ] && QEMU_ACCEL=$ACCEL fi QEMU_VERSION_STRING="$($qemu -h | head -1)" + # SC does not seee QEMU_MAJOR|MINOR|MICRO are used
Shellcheck does not see
scripts/arch-run.bash hvf_available () · line 613
Quoted 9 lines
scripts/arch-run.bash +2
-0+ # shellcheck disable=SC2034 IFS='[ .]' read -r _ _ _ QEMU_MAJOR QEMU_MINOR QEMU_MICRO rest <<<"$QEMU_VERSION_STRING" fi env_add_params QEMU_ACCEL QEMU_VERSION_STRING QEMU_MAJOR QEMU_MINOR QEMU_MICRO@@ -597,6 +610,8 @@ hvf_available () set_qemu_accelerator () { + # Shellcheck does not seee ACCEL_PROPS is used
see
Quoted 33 lines
scripts/arch-run.bash +1
-0+ # shellcheck disable=SC2034 ACCEL_PROPS=${ACCEL#"${ACCEL%%,*}"} ACCEL=${ACCEL%%,*}scripts/mkstandalone.sh +2
-0@@ -65,6 +65,8 @@ generate_test () fi temp_file bin "$kernel" + # Don't want to expand $bin but print it as-is. + # shellcheck disable=SC2016 args[3]='$bin' (echo "#!/usr/bin/env bash"scripts/runtime.bash +2
-0@@ -137,6 +137,8 @@ function run() # the check line can contain multiple files to check separated by a space # but each check parameter needs to be of the form <path>=<value> if [ "$check" ]; then + # There is no globbing or whitespace allowed in check parameters. + # shellcheck disable=SC2206 check=($check) for check_param in "${check[@]}"; do path=${check_param%%=*}Signature · 1 line
2.43.0
Other than comment fixes,
Quoted 25 lines · Nicholas Piggin
Tree here
https://gitlab.com/npiggin/kvm-unit-tests/-/tree/shellcheck
Again on top of the "v8 migration, powerpc improvements" series. I don't plan to rebase the other way around since it's a lot of work. So this is still in RFC until the other big series gets merged.
Thanks to Andrew for a lot of review. A submitted the likely s390x bugs separately ahead of this series, and also disabled one of the tests and dropped its fix patch as-per review comments. Hence 3 fewer patches. Other than that, since last post:
* Tidied commit messages and added some of Andrew's comments.
* Removed the "SC2034 unused variable" blanket disable, and just suppressed the config.mak and a couple of other warnings.
* Blanket disabled "SC2235 Use { ..; } instead of (..)" and dropped the fix for it.
* Change warning suppression comments as per Andrew's review, also mention in the new unittests doc about the "check =" option not allowing whitespace etc in the name since we don't cope with that.Thanks,
Nick
Quoted 15 lines
Nicholas Piggin (14):
Add initial shellcheck checking
shellcheck: Fix SC2223
shellcheck: Fix SC2295
shellcheck: Fix SC2094
shellcheck: Fix SC2006
shellcheck: Fix SC2155
shellcheck: Fix SC2143
shellcheck: Fix SC2013
shellcheck: Fix SC2145
shellcheck: Fix SC2124
shellcheck: Fix SC2294
shellcheck: Fix SC2178
shellcheck: Fix SC2048
shellcheck: Suppress various messages
I went ahead and pushed a bunch of your patches to the k-u-t master branch now. However, there were also some patches which did not apply cleanly to master anymore, so please rebase the remaining patches and then send them again.
Thanks!
Thomas
Quoted 42 lines · Thomas Huth
Quoted 25 lines · Nicholas Piggin
Tree here
https://gitlab.com/npiggin/kvm-unit-tests/-/tree/shellcheck
Again on top of the "v8 migration, powerpc improvements" series. I don't plan to rebase the other way around since it's a lot of work. So this is still in RFC until the other big series gets merged.
Thanks to Andrew for a lot of review. A submitted the likely s390x bugs separately ahead of this series, and also disabled one of the tests and dropped its fix patch as-per review comments. Hence 3 fewer patches. Other than that, since last post:
* Tidied commit messages and added some of Andrew's comments.
* Removed the "SC2034 unused variable" blanket disable, and just suppressed the config.mak and a couple of other warnings.
* Blanket disabled "SC2235 Use { ..; } instead of (..)" and dropped the fix for it.
* Change warning suppression comments as per Andrew's review, also mention in the new unittests doc about the "check =" option not allowing whitespace etc in the name since we don't cope with that.Thanks,
NickQuoted 15 lines
Nicholas Piggin (14):
Add initial shellcheck checking
shellcheck: Fix SC2223
shellcheck: Fix SC2295
shellcheck: Fix SC2094
shellcheck: Fix SC2006
shellcheck: Fix SC2155
shellcheck: Fix SC2143
shellcheck: Fix SC2013
shellcheck: Fix SC2145
shellcheck: Fix SC2124
shellcheck: Fix SC2294
shellcheck: Fix SC2178
shellcheck: Fix SC2048
shellcheck: Suppress various messages
Quoted 3 lines
I went ahead and pushed a bunch of your patches to the k-u-t master branch now. However, there were also some patches which did not apply cleanly to master anymore, so please rebase the remaining patches and then send them again.
Hey Thomas,
Yeah the sc patches were based on top of the big series, so some collisions expected. I'll look at rebasing.
Thanks,
Nick
Quoted 43 lines · Nicholas Piggin
Quoted 42 lines · Thomas Huth
Quoted 40 lines · Nicholas Piggin
Tree here
https://gitlab.com/npiggin/kvm-unit-tests/-/tree/shellcheck
Again on top of the "v8 migration, powerpc improvements" series. I don't plan to rebase the other way around since it's a lot of work. So this is still in RFC until the other big series gets merged.
Thanks to Andrew for a lot of review. A submitted the likely s390x bugs separately ahead of this series, and also disabled one of the tests and dropped its fix patch as-per review comments. Hence 3 fewer patches. Other than that, since last post:
* Tidied commit messages and added some of Andrew's comments.
* Removed the "SC2034 unused variable" blanket disable, and just suppressed the config.mak and a couple of other warnings.
* Blanket disabled "SC2235 Use { ..; } instead of (..)" and dropped the fix for it.
* Change warning suppression comments as per Andrew's review, also mention in the new unittests doc about the "check =" option not allowing whitespace etc in the name since we don't cope with that.Thanks,
NickNicholas Piggin (14):
Add initial shellcheck checking
shellcheck: Fix SC2223
shellcheck: Fix SC2295
shellcheck: Fix SC2094
shellcheck: Fix SC2006
shellcheck: Fix SC2155
shellcheck: Fix SC2143
shellcheck: Fix SC2013
shellcheck: Fix SC2145
shellcheck: Fix SC2124
shellcheck: Fix SC2294
shellcheck: Fix SC2178
shellcheck: Fix SC2048
shellcheck: Suppress various messages
Quoted 8 lines
Quoted 3 lines
I went ahead and pushed a bunch of your patches to the k-u-t master branch now. However, there were also some patches which did not apply cleanly to master anymore, so please rebase the remaining patches and then send them again.
Hey Thomas,
Yeah the sc patches were based on top of the big series, so some collisions expected. I'll look at rebasing.
Ah, ok, we can also try to get in the big series first ... I just lack enough spare time for reviewing currently, so it might take a while :-/
Thomas
Quoted 48 lines · Thomas Huth
Quoted 47 lines · Nicholas Piggin
Quoted 45 lines · Thomas Huth
Quoted 25 lines · Nicholas Piggin
Tree here
https://gitlab.com/npiggin/kvm-unit-tests/-/tree/shellcheck
Again on top of the "v8 migration, powerpc improvements" series. I don't plan to rebase the other way around since it's a lot of work. So this is still in RFC until the other big series gets merged.
Thanks to Andrew for a lot of review. A submitted the likely s390x bugs separately ahead of this series, and also disabled one of the tests and dropped its fix patch as-per review comments. Hence 3 fewer patches. Other than that, since last post:
* Tidied commit messages and added some of Andrew's comments.
* Removed the "SC2034 unused variable" blanket disable, and just suppressed the config.mak and a couple of other warnings.
* Blanket disabled "SC2235 Use { ..; } instead of (..)" and dropped the fix for it.
* Change warning suppression comments as per Andrew's review, also mention in the new unittests doc about the "check =" option not allowing whitespace etc in the name since we don't cope with that.Thanks,
NickQuoted 15 lines
Nicholas Piggin (14):
Add initial shellcheck checking
shellcheck: Fix SC2223
shellcheck: Fix SC2295
shellcheck: Fix SC2094
shellcheck: Fix SC2006
shellcheck: Fix SC2155
shellcheck: Fix SC2143
shellcheck: Fix SC2013
shellcheck: Fix SC2145
shellcheck: Fix SC2124
shellcheck: Fix SC2294
shellcheck: Fix SC2178
shellcheck: Fix SC2048
shellcheck: Suppress various messagesI went ahead and pushed a bunch of your patches to the k-u-t master branch now. However, there were also some patches which did not apply cleanly to master anymore, so please rebase the remaining patches and then send them again.
Quoted 6 lines
Quoted 4 lines
Hey Thomas,
Yeah the sc patches were based on top of the big series, so some collisions expected. I'll look at rebasing.
Ah, ok, we can also try to get in the big series first ... I just lack
They should have come first, but I'd written the multi migration code before Andrew suggested adding sc, and it looked like hard work to rebase the other way. I'll try again.
Quoted 1 line
enough spare time for reviewing currently, so it might take a while :-/
Understandable. You've done heaps of reviewing already so I really appreciate it.
Thanks,
Nick