The ./check
script executes tests. ./check
exits with a zero exit status if all tests passed and non-zero otherwise.
Tests are split up into various groups, which are the subdirectories of the tests
directory. For example, tests/loop
contains tests for loop devices, and tests/block
contains generic block layer tests.
./check
can execute individual tests or test groups. For example,
./check loop block/002
will run all tests in the loop
group and the block/002
test.
Test configuration goes in the config
file at the top-level directory of the blktests repository. A different file can be specified with the -c
command line option. The -c
option can be used multiple times; the files will all be loaded in the order that they are specified on the command line.
Test configuration options can also be set as environment variables. The configuration file has precedence over environment variables, and command line options have precedence over the configuration file.
The TEST_DEVS
variable is an array of block devices to test on. Tests will be run on all of these devices where applicable. Note that tests are destructive and will overwrite any data on these devices.
TEST_DEVS=(/dev/nvme0n1 /dev/sdb)
If TEST_DEVS
is not defined or is empty, only tests which do not require a device will be run. If TEST_DEVS
is defined as a normal variable instead of an array, it will be converted to an array by splitting on whitespace.
The EXCLUDE
variable is an array of tests or test groups to exclude. This corresponds to the -x
command line option.
EXCLUDE=(loop block/001)
Tests specified explicitly on the command line will always run even if they are in EXCLUDE
.
If EXCLUDE
is defined as a normal variable instead of an array, it will be converted to an array by splitting on whitespace.
Many tests can take a long time to run. By setting the TIMEOUT
variable, you can limit the runtime of each test to a specific length (in seconds).
TIMEOUT=60
Note that not all tests honor this timeout. You can define the QUICK_RUN
variable in addition to TIMEOUT
to specify that only tests which honor the timeout or are otherwise “quick” should run. This corresponds to the -q
command line option.
QUICK_RUN=1 TIMEOUT=30
Sometimes it's useful to only run tests which exercise the configured test devices (e.g., in order to test the device driver itself). This can be done by passing the -d
command line option or setting the DEVICE_ONLY
variable.
DEVICE_ONLY=1
To run test cases for zoned block devices, set the RUN_ZONED_TESTS
variable. When this variable is set and a test case can prepare a virtual device such as null_blk
with zoned mode, the test case is executed twice: first in non-zoned mode and second in zoned mode. The use of the RUN_ZONED_TESTS
variable requires that the kernel be compiled with CONFIG_BLK_DEV_ZONED
enabled.
RUN_ZONED_TESTS=1
The config
file is really just a bash file that is sourced at the beginning of the test run, so it can be used to do any special setup you need. For example, you could configure PATH
to find an executable you built from source:
export PATH="/root/fio:$PATH"
Or, if your setup doesn't mount configfs
automatically (it probably does), you could mount it:
if ! findmnt -t configfs /sys/kernel/config > /dev/null; then mount -t configfs configfs /sys/kernel/config fi