Testing Blivet

Note: The test suite documented here is available only from the git repository not as part of any installable packages.

In order to execute blivet’s test suite from inside the source directory execute the command:

make test

There are three separate test suites available:

  • Unit tests located in the unit_tests folder. These tests don’t require root privileges to run and don’t use any existing block devices. These tests can be run separately using make unit-test.

  • Storage tests located in the storage_tests folder. These tests require root privileges and create block devices to run tests on. These tests can be run separately using make storage-test.

To execute the Pylint code analysis tool run:

make check

Running Pylint doesn’t require root privileges but requires Python3 due to usage of pocket-lint.

It is also possible to generate test coverage reports using the Python coverage tool. To do that execute:

make coverage

It is also possible to check all external links in the documentation for integrity. To do this:

cd doc/
make linkcheck

Test Suite Architecture

Blivet’s test suite relies on several base classes listed below. All test cases inherit from them.

  • unittest.TestCase - the standard unit test class in Python. Used for tests which don’t touch disk space;

  • BlivetTestCase - intended as a base class for higher-level tests. Most of what it does is stub out operations that touch disks. Currently it is only used in DeviceActionTestCase;

  • LoopBackedTestCase and StorageTestCase - these classes represent actual storage space. Usually LoopBackedTestCase is used for stacks of limited depth (eg: md array with two loop members) and StorageTestCase for stacks of greater or arbitrary depth. StorageTestCase uses targetcli to create virtual SCSI drives for full stack tests on “real” hardware.

In order to get a high level view of how test classes inherit from each other you can generate an inheritance diagram:

PYTHONPATH=.:tests/ python3-pyreverse -p "Blivet_Tests" -o svg -SkAmy tests/