fstests: btrfs/244: add test case to verify the behavior of deleting non-existing device
PATCH v2 1/1 fstests: btrfs/244: add test case to verify the behavior of deleting non-existing device
There is a kernel regression for btrfs, that when passing non-existing devid to "btrfs device remove" command, kernel will crash due to NULL pointer dereference.
The test case is for such regression, it will:
- Create and mount an empty single-device btrfs
- Try to remove devid 3, which doesn't exist for above fs
- Make sure the command exits properly with expected error message
The kernel fix is titled "btrfs: fix NULL pointer dereference when deleting device by invalid id".
---
Changelog:
v2:
- Change the subject to also verify the error behavior
- Include the error message into golden output
- Also verify the return value of btrfs command
--- tests/btrfs/244 | 47 +++++++++++++++++++++++++++++++++++++++++++++ tests/btrfs/244.out | 2 ++ 2 files changed, 49 insertions(+) create mode 100755 tests/btrfs/244 create mode 100644 tests/btrfs/244.out
tests/btrfs/244 new file +47 -0
@@ -0,0 +1,47 @@ +#! /bin/bash +# SPDX-License-Identifier: GPL-2.0 +# Copyright (c) 2021 SUSE Linux Products GmbH. All Rights Reserved. +# +# FS QA Test 244 +# +# Make sure "btrfs device remove" won't crash when non-existing devid +# is provided +# +. ./common/preamble +_begin_fstest auto quick volume dangerous + +# Override the default cleanup function. +# _cleanup() +# { +# cd / +# rm -r -f $tmp.* +# } + +# Import common functions. +# . ./common/filter + +# real QA test starts here + +# Modify as appropriate. +_supported_fs btrfs +_require_scratch + +_scratch_mkfs >> $seqres.full 2>&1 +_scratch_mount + +# Above created fs only contains one device with devid 1, device remove 3 +# should just fail with proper error message showing devid 3 can't be found. +# Although on unpatched kernel, this will trigger a NULL pointer dereference. +$BTRFS_UTIL_PROG device remove 3 $SCRATCH_MNT +ret=$? + +if [ $ret -ne 1 ]; then + echo "Unexpected return value from btrfs command, has $ret expected 1" +fi + +# Fstests will automatically check the filesystem to make sure metadata is not +# corrupted. + +# success, all done +status=0 +exit
tests/btrfs/244.out new file +2 -0
@@ -0,0 +1,2 @@ +QA output created by 244 +ERROR: error removing devid 3: No such file or directory
Signature · 1 line
2.31.1
Quoted 63 lines · Qu Wenruo
There is a kernel regression for btrfs, that when passing non-existing devid to "btrfs device remove" command, kernel will crash due to NULL pointer dereference.
The test case is for such regression, it will:
- Create and mount an empty single-device btrfs
- Try to remove devid 3, which doesn't exist for above fs
- Make sure the command exits properly with expected error messageThe kernel fix is titled "btrfs: fix NULL pointer dereference when deleting device by invalid id".
Signed-off-by Qu Wenruo <[email protected]>---
Changelog:
v2:
- Change the subject to also verify the error behavior
- Include the error message into golden output
- Also verify the return value of btrfs command--- tests/btrfs/244 | 47 +++++++++++++++++++++++++++++++++++++++++++++ tests/btrfs/244.out | 2 ++ 2 files changed, 49 insertions(+) create mode 100755 tests/btrfs/244 create mode 100644 tests/btrfs/244.outtests/btrfs/244 new file +30
-0@@ -0,0 +1,47 @@ +#! /bin/bash +# SPDX-License-Identifier: GPL-2.0 +# Copyright (c) 2021 SUSE Linux Products GmbH. All Rights Reserved. +# +# FS QA Test 244 +# +# Make sure "btrfs device remove" won't crash when non-existing devid +# is provided +# +. ./common/preamble +_begin_fstest auto quick volume dangerous + +# Override the default cleanup function. +# _cleanup() +# { +# cd / +# rm -r -f $tmp.* +# } + +# Import common functions. +# . ./common/filter + +# real QA test starts here + +# Modify as appropriate. +_supported_fs btrfs +_require_scratch + +_scratch_mkfs >> $seqres.full 2>&1 +_scratch_mount
tests/btrfs/244 line 40
Quoted 10 lines
tests/btrfs/244 new file +10
-0+ +# Above created fs only contains one device with devid 1, device remove 3 +# should just fail with proper error message showing devid 3 can't be found. +# Although on unpatched kernel, this will trigger a NULL pointer dereference. +$BTRFS_UTIL_PROG device remove 3 $SCRATCH_MNT +ret=$? + +if [ $ret -ne 1 ]; then + echo "Unexpected return value from btrfs command, has $ret expected 1" +fi
<rant>
This just shows how broken progs are w.r.t return values. The generally accepted return value is 0 on success, yet it returns 1 on success since the functions implementing this functionality in progs treat the return value as a boolean.
</rant>
Quoted 16 lines
tests/btrfs/244 new file +7
-0+ +# Fstests will automatically check the filesystem to make sure metadata is not +# corrupted. + +# success, all done +status=0 +exittests/btrfs/244.out new file +2
-0@@ -0,0 +1,2 @@ +QA output created by 244 +ERROR: error removing devid 3: No such file or directory
Quoted 75 lines · Nikolay Borisov
Quoted 72 lines · Qu Wenruo
There is a kernel regression for btrfs, that when passing non-existing devid to "btrfs device remove" command, kernel will crash due to NULL pointer dereference.
The test case is for such regression, it will:
- Create and mount an empty single-device btrfs
- Try to remove devid 3, which doesn't exist for above fs
- Make sure the command exits properly with expected error messageThe kernel fix is titled "btrfs: fix NULL pointer dereference when deleting device by invalid id".
Signed-off-by Qu Wenruo <[email protected]>---
Changelog:
v2:
- Change the subject to also verify the error behavior
- Include the error message into golden output
- Also verify the return value of btrfs command--- tests/btrfs/244 | 47 +++++++++++++++++++++++++++++++++++++++++++++ tests/btrfs/244.out | 2 ++ 2 files changed, 49 insertions(+)create mode 100755 tests/btrfs/244
create mode 100644 tests/btrfs/244.outtests/btrfs/244 new file +39
-0@@ -0,0 +1,47 @@ +#! /bin/bash +# SPDX-License-Identifier: GPL-2.0 +# Copyright (c) 2021 SUSE Linux Products GmbH. All Rights Reserved. +# +# FS QA Test 244 +# +# Make sure "btrfs device remove" won't crash when non-existing devid +# is provided +# +. ./common/preamble +_begin_fstest auto quick volume dangerous + +# Override the default cleanup function. +# _cleanup() +# { +# cd / +# rm -r -f $tmp.* +# } + +# Import common functions. +# . ./common/filter + +# real QA test starts here + +# Modify as appropriate. +_supported_fs btrfs +_require_scratch + +_scratch_mkfs >> $seqres.full 2>&1 +_scratch_mount + +# Above created fs only contains one device with devid 1, device remove 3 +# should just fail with proper error message showing devid 3 can't be found. +# Although on unpatched kernel, this will trigger a NULL pointer dereference. +$BTRFS_UTIL_PROG device remove 3 $SCRATCH_MNT +ret=$? + +if [ $ret -ne 1 ]; then + echo "Unexpected return value from btrfs command, has $ret expected 1"
Quoted 8 lines
tests/btrfs/244 line 40
Quoted 1 line
tests/btrfs/244 new file +1
-0+fi<rant>
This just shows how broken progs are w.r.t return values. The generally accepted return value is 0 on success, yet it returns 1 on success since the functions implementing this functionality in progs treat the return value as a boolean.
</rant>
Nope, we're testing a failure case, thus returning 1 is what we expect.
Thanks,
Qu
Quoted 19 lines
Quoted 19 lines
tests/btrfs/244 new file +7
-0+ +# Fstests will automatically check the filesystem to make sure metadata is not +# corrupted. + +# success, all done +status=0 +exittests/btrfs/244.out new file +2
-0@@ -0,0 +1,2 @@ +QA output created by 244 +ERROR: error removing devid 3: No such file or directory
Quoted 10 lines · Nikolay Borisov
tests/btrfs/244 line 40
Quoted 3 lines
tests/btrfs/244 new file +3
-0+if [ $ret -ne 1 ]; then + echo "Unexpected return value from btrfs command, has $ret expected 1" +fi<rant>
This just shows how broken progs are w.r.t return values. The generally accepted return value is 0 on success, yet it returns 1 on success since the functions implementing this functionality in progs treat the return value as a boolean.
</rant>
Heh, not following the common convention of 0 for success, !0 for errors would be crazy and hardly left unnoticed by users.
Quoted 64 lines · Qu Wenruo
There is a kernel regression for btrfs, that when passing non-existing devid to "btrfs device remove" command, kernel will crash due to NULL pointer dereference.
The test case is for such regression, it will:
- Create and mount an empty single-device btrfs
- Try to remove devid 3, which doesn't exist for above fs
- Make sure the command exits properly with expected error messageThe kernel fix is titled "btrfs: fix NULL pointer dereference when deleting device by invalid id".
Signed-off-by Qu Wenruo <[email protected]>---
Changelog:
v2:
- Change the subject to also verify the error behavior
- Include the error message into golden output
- Also verify the return value of btrfs command--- tests/btrfs/244 | 47 +++++++++++++++++++++++++++++++++++++++++++++ tests/btrfs/244.out | 2 ++ 2 files changed, 49 insertions(+) create mode 100755 tests/btrfs/244 create mode 100644 tests/btrfs/244.outtests/btrfs/244 new file +30
-0@@ -0,0 +1,47 @@ +#! /bin/bash +# SPDX-License-Identifier: GPL-2.0 +# Copyright (c) 2021 SUSE Linux Products GmbH. All Rights Reserved. +# +# FS QA Test 244 +# +# Make sure "btrfs device remove" won't crash when non-existing devid +# is provided +# +. ./common/preamble +_begin_fstest auto quick volume dangerous + +# Override the default cleanup function. +# _cleanup() +# { +# cd / +# rm -r -f $tmp.* +# } + +# Import common functions. +# . ./common/filter + +# real QA test starts here + +# Modify as appropriate. +_supported_fs btrfs +_require_scratch + +_scratch_mkfs >> $seqres.full 2>&1 +_scratch_mount
tests/btrfs/244 line 40
Quoted 10 lines
tests/btrfs/244 new file +10
-0+ +# Above created fs only contains one device with devid 1, device remove 3 +# should just fail with proper error message showing devid 3 can't be found. +# Although on unpatched kernel, this will trigger a NULL pointer dereference. +$BTRFS_UTIL_PROG device remove 3 $SCRATCH_MNT +ret=$? + +if [ $ret -ne 1 ]; then + echo "Unexpected return value from btrfs command, has $ret expected 1" +fi
I think I would just do "-eq 0" instead, but it's more about a preferred style than anything else, and can always be changed later if needed.
Looks good, thanks.
Quoted 18 lines
tests/btrfs/244 new file +7
-0+ +# Fstests will automatically check the filesystem to make sure metadata is not +# corrupted. + +# success, all done +status=0 +exittests/btrfs/244.out new file +2
-1@@ -0,0 +1,2 @@ +QA output created by 244 +ERROR: error removing devid 3: No such file or directory --2.31.1
Signature · 3 lines
Filipe David Manana, “Whether you think you can, or you think you can't — you're right.”