test: add some helper function and cleanup test script
cover test: add some helper function and cleanup test script
Some test scripts have same function. So, let's cleanup to stop the duplication by intoducing 'test/common' file. Test scripts includes the common file to use the functions.
Masayoshi Mizuma (2):
test: add some helper function for test script
test: cleanup test scripts
test/blk-exhaust.sh | 21 +++------------ test/btt-check.sh | 35 +++++++----------------- test/btt-errors.sh | 20 ++++---------- test/btt-pad-compat.sh | 52 +++++++++++++---------------------- test/clear.sh | 21 +++------------ test/common | 57 +++++++++++++++++++++++++++++++++++++++ test/create.sh | 21 +++------------ test/daxdev-errors.sh | 19 +++---------- test/firmware-update.sh | 25 ++++------------- test/inject-error.sh | 31 ++++++--------------- test/label-compat.sh | 21 +++------------ test/multi-dax.sh | 19 +++---------- test/pmem-errors.sh | 20 +++++--------- test/rescan-partitions.sh | 44 ++++++++---------------------- test/sector-mode.sh | 5 +--- 15 files changed, 146 insertions(+), 265 deletions(-) create mode 100644 test/common
Signature · 5 lines
2.17.1 _______________________________________________ Linux-nvdimm mailing list [email protected] https://lists.01.org/mailman/listinfo/linux-nvdimm
PATCH 1/2 test: add some helper function for test script
From: Masayoshi Mizuma <[email protected]>
Some test scripts have same function. So, this patch introduces the functions to 'test/common' new file.
--- test/common | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 test/common
test/common new file +57 -0
@@ -0,0 +1,57 @@ + +# Global variables + +# ndctl +# +if [ -f "../ndctl/ndctl" ] && [ -x "../ndctl/ndctl" ]; then + export ndctl=../ndctl/ndctl +elif [ -f "./ndctl/ndctl" ] && [ -x "./ndctl/ndctl" ]; then + export ndctl=./ndctl/ndctl +else + echo "Couldn't find an ndctl binary" + exit 1 +fi + +# Functions + +# err +# $1: line number which error detected +# $2: cleanup function (optional) +# +err() +{ + echo test/$(basename $0): failed at line $1 + [ -n "$2" ] && "$2" + exit $rc +} + +# check_min_kver +# $1: Supported kernel version. format: X.Y +# +check_min_kver() +{ + local ver="$1" + : "${KVER:=$(uname -r)}" + + [ -n "$ver" ] || return 1 + [[ "$ver" == "$(echo -e "$ver\n$KVER" | sort -V | head -1)" ]] +} + +# do_skip +# $1: Skip message +# +do_skip() +{ + echo kernel $(uname -r): $1 + exit 77 +} + +# check_prereq +# $1: command to check +# +check_prereq() +{ + if ! command -v "$1" >/dev/null; then + do_skip "missing $1, skipping..." + fi +}
Signature · 6 lines
2.17.1 _______________________________________________ Linux-nvdimm mailing list [email protected] https://lists.01.org/mailman/listinfo/linux-nvdimm
PATCH 2/2 test: cleanup test scripts
In reply to Masayoshi MizumaFrom: Masayoshi Mizuma <[email protected]>
Include 'common' file to use some fucntions for test scripts.
--- test/blk-exhaust.sh | 21 +++------------- test/btt-check.sh | 35 ++++++++------------------ test/btt-errors.sh | 20 ++++----------- test/btt-pad-compat.sh | 52 ++++++++++++++------------------------- test/clear.sh | 21 +++------------- test/create.sh | 21 +++------------- test/daxdev-errors.sh | 19 +++----------- test/firmware-update.sh | 25 ++++--------------- test/inject-error.sh | 31 ++++++----------------- test/label-compat.sh | 21 +++------------- test/multi-dax.sh | 19 +++----------- test/pmem-errors.sh | 20 +++++---------- test/rescan-partitions.sh | 44 +++++++++------------------------ test/sector-mode.sh | 5 +--- 14 files changed, 89 insertions(+), 265 deletions(-)
test/blk-exhaust.sh +4 -17
@@ -11,30 +11,17 @@ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # General Public License for more details. +set -e + NDCTL="../ndctl/ndctl" BUS="-b nfit_test.0" BUS1="-b nfit_test.1" rc=77 -set -e - -err() { - echo "test/label-compat.sh: failed at line $1" - exit $rc -} +. ./common -check_min_kver() -{ - local ver="$1" - : "${KVER:=$(uname -r)}" +check_min_kver "4.11" || do_skip "may lack blk-exhaustion fix" - [ -n "$ver" ] || return 1 - [[ "$ver" == "$(echo -e "$ver\n$KVER" | sort -V | head -1)" ]] -} - -check_min_kver "4.11" || { echo "kernel $KVER may lack blk-exhaustion fix"; exit $rc; } - -set -e trap 'err $LINENO' ERR # setup (reset nfit_test dimms)
test/btt-check.sh +10 -25
@@ -24,6 +24,8 @@ blockdev="" bs=4096 rc=77 +. ./common + trap 'err $LINENO' ERR # sample json:
@@ -36,36 +38,19 @@ trap 'err $LINENO' ERR # "blockdev":"pmem5s" # } -# $1: Line number -# $2: exit code -err() -{ - [ -n "$2" ] && rc="$2" - echo "test/btt-check: failed at line $1" - exit "$rc" -} - -check_min_kver() -{ - local ver="$1" - : "${KVER:=$(uname -r)}" - - [ -n "$ver" ] || return 1 - [[ "$ver" == "$(echo -e "$ver\n$KVER" | sort -V | head -1)" ]] -} - -check_min_kver "4.14" || { echo "kernel $KVER may not support badblocks clearing on pmem via btt"; exit $rc; } +check_min_kver "4.14" || do_skip "may not support badblocks clearing on pmem via btt" create() { json=$($ndctl create-namespace -b "$bus" -t pmem -m sector) + rc=2 eval "$(echo "$json" | sed -e "$json2var")" - [ -n "$dev" ] || err "$LINENO" 2 - [ "$mode" = "sector" ] || err "$LINENO" 2 - [ -n "$size" ] || err "$LINENO" 2 - [ -n "$sector_size" ] || err "$LINENO" 2 - [ -n "$blockdev" ] || err "$LINENO" 2 - [ $size -gt 0 ] || err "$LINENO" 2 + [ -n "$dev" ] || err "$LINENO" + [ "$mode" = "sector" ] || err "$LINENO" + [ -n "$size" ] || err "$LINENO" + [ -n "$sector_size" ] || err "$LINENO" + [ -n "$blockdev" ] || err "$LINENO" + [ $size -gt 0 ] || err "$LINENO" } reset()
test/btt-errors.sh +5 -15
@@ -19,10 +19,10 @@ json2var="s/[{}\",]//g; s/:/=/g" blockdev="" rc=77 -err() { - rc=1 - echo "test/btt-errors: failed at line $1" +. ./common +cleaup() +{ rm -f $FILE rm -f $MNT/$FILE if [ -n "$blockdev" ]; then
@@ -31,16 +31,6 @@ err() { rc=77 fi rmdir $MNT - exit $rc -} - -check_min_kver() -{ - local ver="$1" - : "${KVER:=$(uname -r)}" - - [ -n "$ver" ] || return 1 - [[ "$ver" == "$(echo -e "$ver\n$KVER" | sort -V | head -1)" ]] } force_raw()
@@ -59,11 +49,11 @@ force_raw() fi } -check_min_kver "4.15" || { echo "kernel $KVER may lack BTT error handling"; exit $rc; } +check_min_kver "4.15" || do_skip "may lack BTT error handling" set -e mkdir -p $MNT -trap 'err $LINENO' ERR +trap 'err $LINENO cleanup' ERR # setup (reset nfit_test dimms) modprobe nfit_test
test/btt-pad-compat.sh +19 -33
83 lines not on this page · raw message
test/clear.sh +4 -17
@@ -11,6 +11,8 @@ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # General Public License for more details. +set -e + DEV="" NDCTL="../ndctl/ndctl" BUS="-b nfit_test.0"
@@ -18,25 +20,10 @@ BUS1="-b nfit_test.1" json2var="s/[{}\",]//g; s/:/=/g" rc=77 -set -e - -err() { - echo "test/clear: failed at line $1" - exit $rc -} +. ./common -check_min_kver() -{ - local ver="$1" - : "${KVER:=$(uname -r)}" +check_min_kver "4.6" || do_skip "lacks clear poison support" - [ -n "$ver" ] || return 1 - [[ "$ver" == "$(echo -e "$ver\n$KVER" | sort -V | head -1)" ]] -} - -check_min_kver "4.6" || { echo "kernel $KVER lacks clear poison support"; exit $rc; } - -set -e trap 'err $LINENO' ERR # setup (reset nfit_test dimms)
test/create.sh +4 -17
@@ -11,6 +11,8 @@ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # General Public License for more details. +set -e + DEV="" NDCTL="../ndctl/ndctl" BUS="-b nfit_test.0"
@@ -18,25 +20,10 @@ json2var="s/[{}\",]//g; s/:/=/g" SECTOR_SIZE="4096" rc=77 -set -e - -err() { - echo "test/create: failed at line $1" - exit $rc -} +. ./common -check_min_kver() -{ - local ver="$1" - : "${KVER:=$(uname -r)}" +check_min_kver "4.5" || do_skip "may lack namespace mode attribute" - [ -n "$ver" ] || return 1 - [[ "$ver" == "$(echo -e "$ver\n$KVER" | sort -V | head -1)" ]] -} - -check_min_kver "4.5" || { echo "kernel $KVER may lack namespace mode attribute"; exit $rc; } - -set -e trap 'err $LINENO' ERR # setup (reset nfit_test dimms)
test/daxdev-errors.sh +4 -15
@@ -11,6 +11,8 @@ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # General Public License for more details. +set -e + DEV="" NDCTL="../ndctl/ndctl" DAXCTL="../daxctl/daxctl"
@@ -19,23 +21,10 @@ BUS1="-b nfit_test.1" json2var="s/[{}\",]//g; s/:/=/g" rc=77 -err() { - echo "test/daxdev-errors: failed at line $1" - exit $rc -} - -check_min_kver() -{ - local ver="$1" - : "${KVER:=$(uname -r)}" +. ./common - [ -n "$ver" ] || return 1 - [[ "$ver" == "$(echo -e "$ver\n$KVER" | sort -V | head -1)" ]] -} +check_min_kver "4.12" || do_skip "lacks dax dev error handling" -check_min_kver "4.12" || { echo "kernel $KVER lacks dax dev error handling"; exit $rc; } - -set -e trap 'err $LINENO' ERR # setup (reset nfit_test dimms)
test/firmware-update.sh +5 -20
@@ -12,25 +12,9 @@ rc=77 dev="" image="update-fw.img" -trap 'err $LINENO' ERR +. ./common -# $1: Line number -# $2: exit code -err() -{ - [ -n "$2" ] && rc="$2" - echo "test/firmware-update.sh: failed at line $1" - exit "$rc" -} - -check_min_kver() -{ - local ver="$1" - : "${KVER:=$(uname -r)}" - - [ -n "$ver" ] || return 1 - [[ "$ver" == "$(echo -e "$ver\n$KVER" | sort -V | head -1)" ]] -} +trap 'err $LINENO' ERR reset() {
@@ -52,7 +36,7 @@ cleanup() detect() { dev=$($ndctl list -b "$bus" -D | jq .[0].dev | tr -d '"') - [ -n "$dev" ] || err "$LINENO" 2 + [ -n "$dev" ] || rc=2 && err "$LINENO" } do_tests()
@@ -61,7 +45,8 @@ do_tests() $ndctl update-firmware -f $image $dev } -check_min_kver "4.16" || { echo "kernel $KVER may lack firmware update test handling"; exit $rc; } +check_min_kver "4.16" || do_skip "may lack firmware update test handling" + modprobe nfit_test rc=1 reset
test/inject-error.sh +8 -23
@@ -23,6 +23,8 @@ rc=77 err_block=42 err_count=8 +. ./common + trap 'err $LINENO' ERR # sample json:
@@ -34,34 +36,17 @@ trap 'err $LINENO' ERR # "blockdev":"pmem7", #} -# $1: Line number -# $2: exit code -err() -{ - [ -n "$2" ] && rc="$2" - echo "test/inject-error.sh: failed at line $1" - exit "$rc" -} - -check_min_kver() -{ - local ver="$1" - : "${KVER:=$(uname -r)}" - - [ -n "$ver" ] || return 1 - [[ "$ver" == "$(echo -e "$ver\n$KVER" | sort -V | head -1)" ]] -} - -check_min_kver "4.15" || { echo "kernel $KVER may not support error injection"; exit "$rc"; } +check_min_kver "4.15" || do_skip "kernel $KVER may not support error injection" create() { json=$($ndctl create-namespace -b "$bus" -t pmem --align=4k) + rc=2 eval "$(echo "$json" | sed -e "$json2var")" - [ -n "$dev" ] || err "$LINENO" 2 - [ -n "$size" ] || err "$LINENO" 2 - [ -n "$blockdev" ] || err "$LINENO" 2 - [ $size -gt 0 ] || err "$LINENO" 2 + [ -n "$dev" ] || err "$LINENO" + [ -n "$size" ] || err "$LINENO" + [ -n "$blockdev" ] || err "$LINENO" + [ $size -gt 0 ] || err "$LINENO" } reset()
test/label-compat.sh +4 -17
@@ -11,30 +11,17 @@ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # General Public License for more details. +set -e + NDCTL="../ndctl/ndctl" BUS="-b nfit_test.0" BUS1="-b nfit_test.1" rc=77 -set -e - -err() { - echo "test/label-compat.sh: failed at line $1" - exit $rc -} +. ./common -check_min_kver() -{ - local ver="$1" - : "${KVER:=$(uname -r)}" +check_min_kver "4.11" || do_skip "may not provide reliable isetcookie values" - [ -n "$ver" ] || return 1 - [[ "$ver" == "$(echo -e "$ver\n$KVER" | sort -V | head -1)" ]] -} - -check_min_kver "4.11" || { echo "kernel $KVER may not provide reliable isetcookie values"; exit $rc; } - -set -e trap 'err $LINENO' ERR # setup (reset nfit_test dimms)
test/multi-dax.sh +4 -15
@@ -11,6 +11,8 @@ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # General Public License for more details. +set -e + DEV="" NDCTL="../ndctl/ndctl" DAXCTL="../daxctl/daxctl"
@@ -19,23 +21,10 @@ BUS1="-b nfit_test.1" json2var="s/[{}\",]//g; s/:/=/g" rc=77 -err() { - echo "test/multi-dax: failed at line $1" - exit $rc -} - -check_min_kver() -{ - local ver="$1" - : "${KVER:=$(uname -r)}" +. ./common - [ -n "$ver" ] || return 1 - [[ "$ver" == "$(echo -e "$ver\n$KVER" | sort -V | head -1)" ]] -} +check_min_kver "4.13" || do_skip "may lack multi-dax support" -check_min_kver "4.13" || { echo "kernel $KVER may lack multi-dax support"; exit $rc; } - -set -e trap 'err $LINENO' ERR # setup (reset nfit_test dimms)
test/pmem-errors.sh +6 -14
@@ -11,8 +11,10 @@ FILE=image json2var="s/[{}\",]//g; s/:/=/g" rc=77 -err() { - echo "test/dax-errors: failed at line $1" +. ./common + +cleanup() +{ rm -f $FILE rm -f $MNT/$FILE if [ -n "$blockdev" ]; then
@@ -21,23 +23,13 @@ err() { rc=77 fi rmdir $MNT - exit $rc -} - -check_min_kver() -{ - local ver="$1" - : "${KVER:=$(uname -r)}" - - [ -n "$ver" ] || return 1 - [[ "$ver" == "$(echo -e "$ver\n$KVER" | sort -V | head -1)" ]] } -check_min_kver "4.7" || { echo "kernel $KVER may lack dax error handling"; exit $rc; } +check_min_kver "4.7" || do_skip "may lack dax error handling" set -e mkdir -p $MNT -trap 'err $LINENO' ERR +trap 'err $LINENO cleanup' ERR # setup (reset nfit_test dimms) modprobe nfit_test
test/rescan-partitions.sh +11 -33
77 lines not on this page · raw message
test/sector-mode.sh +1 -4
@@ -17,10 +17,7 @@ BUS1="-b nfit_test.1" TEST=$0 rc=77 -err() { - echo "$TEST: failed at line $1" - exit $rc -} +. ./common set -e trap 'err $LINENO' ERR
Signature · 6 lines
2.17.1 _______________________________________________ Linux-nvdimm mailing list [email protected] https://lists.01.org/mailman/listinfo/linux-nvdimm
Verma, Vishal L
maintainerRe: [PATCH 2/2] test: cleanup test scripts
Quoted 5 lines · Masayoshi Mizuma
From: Masayoshi Mizuma <[email protected]>
Include 'common' file to use some fucntions for test scripts.
Signed-off-by Masayoshi Mizuma <[email protected]>
Quoted 16 lines
--- test/blk-exhaust.sh | 21 +++------------- test/btt-check.sh | 35 ++++++++------------------ test/btt-errors.sh | 20 ++++----------- test/btt-pad-compat.sh | 52 ++++++++++++++------------------------- test/clear.sh | 21 +++------------- test/create.sh | 21 +++------------- test/daxdev-errors.sh | 19 +++----------- test/firmware-update.sh | 25 ++++--------------- test/inject-error.sh | 31 ++++++----------------- test/label-compat.sh | 21 +++------------- test/multi-dax.sh | 19 +++----------- test/pmem-errors.sh | 20 +++++---------- test/rescan-partitions.sh | 44 +++++++++------------------------ test/sector-mode.sh | 5 +--- 14 files changed, 89 insertions(+), 265 deletions(-)
Hi Masayoshi,
This is a welcome cleanup. It looks good except for a couple of nits. First, can you add a SPDX style license header to the new test/common file? Second, see below -
[..]
Quoted 34 lines
test/firmware-update.sh +2
-18@@ -12,25 +12,9 @@ rc=77 dev="" image="update-fw.img" -trap 'err $LINENO' ERR +. ./common -# $1: Line number -# $2: exit code -err() -{ - [ -n "$2" ] && rc="$2" - echo "test/firmware-update.sh: failed at line $1" - exit "$rc" -} - -check_min_kver() -{ - local ver="$1" - : "${KVER:=$(uname -r)}" - - [ -n "$ver" ] || return 1 - [[ "$ver" == "$(echo -e "$ver\n$KVER" | sort -V | head -1)" ]] -} +trap 'err $LINENO' ERR reset() {
test/firmware-update.sh cleanup() · line 39
Quoted 5 lines
test/firmware-update.sh +1
-1@@ -52,7 +36,7 @@ cleanup() detect() { dev=$($ndctl list -b "$bus" -D | jq .[0].dev | tr -d '"') - [ -n "$dev" ] || err "$LINENO" 2 + [ -n "$dev" ] || rc=2 && err "$LINENO"
This || .. && will not work as expected. If $dev is null it will set rc to 2, and if it exists, then it will err(). What we want is
[ -n "$dev" ] || { rc=2 && err "$LINENO"; }
Or even better,
@@ -36,7 +36,7 @@ cleanup()
detect()
{
dev=$($ndctl list -b "$bus" -D | jq .[0].dev | tr -d '"')
- [ -n "$dev" ] || rc=2 && err "$LINENO"
+ [ -n "$dev" ] || err "$LINENO"
} do_tests()
@@ -50,6 +50,7 @@ check_min_kver "4.16" || do_skip "may lack firmware update test handling"
modprobe nfit_test
rc=1
reset +rc=2
detect
do_tests
The rest looks good.
Thanks,
-Vishal
_______________________________________________
Linux-nvdimm mailing list
[email protected]
https://lists.01.org/mailman/listinfo/linux-nvdimm
Re: [PATCH 2/2] test: cleanup test scripts
Hi Vishal,
Thank you for your review! I'll send v2 patch.
- Masa
Quoted 90 lines · Vishal L
Quoted 5 lines · Masayoshi Mizuma
From: Masayoshi Mizuma <[email protected]>
Include 'common' file to use some fucntions for test scripts.
Signed-off-by Masayoshi Mizuma <[email protected]>Quoted 16 lines
--- test/blk-exhaust.sh | 21 +++------------- test/btt-check.sh | 35 ++++++++------------------ test/btt-errors.sh | 20 ++++----------- test/btt-pad-compat.sh | 52 ++++++++++++++------------------------- test/clear.sh | 21 +++------------- test/create.sh | 21 +++------------- test/daxdev-errors.sh | 19 +++----------- test/firmware-update.sh | 25 ++++--------------- test/inject-error.sh | 31 ++++++----------------- test/label-compat.sh | 21 +++------------- test/multi-dax.sh | 19 +++----------- test/pmem-errors.sh | 20 +++++---------- test/rescan-partitions.sh | 44 +++++++++------------------------ test/sector-mode.sh | 5 +--- 14 files changed, 89 insertions(+), 265 deletions(-)Hi Masayoshi,
This is a welcome cleanup. It looks good except for a couple of nits. First, can you add a SPDX style license header to the new test/common file? Second, see below -
[..]
Quoted 34 lines
test/firmware-update.sh +2
-18@@ -12,25 +12,9 @@ rc=77 dev="" image="update-fw.img" -trap 'err $LINENO' ERR +. ./common -# $1: Line number -# $2: exit code -err() -{ - [ -n "$2" ] && rc="$2" - echo "test/firmware-update.sh: failed at line $1" - exit "$rc" -} - -check_min_kver() -{ - local ver="$1" - : "${KVER:=$(uname -r)}" - - [ -n "$ver" ] || return 1 - [[ "$ver" == "$(echo -e "$ver\n$KVER" | sort -V | head -1)" ]] -} +trap 'err $LINENO' ERR reset() {test/firmware-update.sh cleanup() · line 39
Quoted 5 lines
test/firmware-update.sh +1
-1@@ -52,7 +36,7 @@ cleanup() detect() { dev=$($ndctl list -b "$bus" -D | jq .[0].dev | tr -d '"') - [ -n "$dev" ] || err "$LINENO" 2 + [ -n "$dev" ] || rc=2 && err "$LINENO"This || .. && will not work as expected. If $dev is null it will set rc to 2, and if it exists, then it will
err(). What we want is[ -n "$dev" ] || { rc=2 && err "$LINENO"; }
Or even better,@@ -36,7 +36,7 @@ cleanup() detect() { dev=$($ndctl list -b "$bus" -D | jq .[0].dev | tr -d '"') - [ -n "$dev" ] || rc=2 && err "$LINENO" + [ -n "$dev" ] || err "$LINENO" }do_tests() @@ -50,6 +50,7 @@ check_min_kver "4.16" || do_skip "may lack firmware update test handling" modprobe nfit_test rc=1 reset
Quoted 9 lines
+rc=2
detect
do_testsThe rest looks good.
Thanks,
-Vishal
_______________________________________________
Linux-nvdimm mailing list
[email protected]
https://lists.01.org/mailman/listinfo/linux-nvdimm