tests: Add a Readme describing how to run the swtpm tests

Signed-off-by: Stefan Berger <stefanb@linux.ibm.com>
This commit is contained in:
Stefan Berger 2021-03-17 17:00:14 -04:00 committed by Stefan Berger
parent be6ba388a2
commit 8e30907db2

32
tests/Readme.md Normal file
View File

@ -0,0 +1,32 @@
This directory contains the swtpm tests.
To run the tests you need to build swtpm first and then you can run the
tests using the following command line:
```
SWTPM_TEST_EXPENSIVE=1 SWTPM_TEST_STORE_VOLATILE=1 SWTPM_TEST_IBMTSS2=1 make check
```
You may omit the environment variables if you don't want to run
the more time-consuming tests.
`SWTPM_TEST_EXPENSIVE=1` enables the following tests:
- test_tpm12
- test_tpm2_ibmtss2
`SWTPM_TEST_STORE_VOLATILE=1` enables storing and restoring of the volatile
state at every step of the test_tpm2_ibmtss2 test. This environment
variable only has an effect if `SWTPM_TEST_EXPENSIVE=1` is set.
`SWTPM_TEST_IBMTSS2=1` enables the following tests
- test_tpm2_save_load_state_2
- test_tpm2_save_load_state_3
Some tests require root rights, especially those involving the CUSE TPM
and the vTPM proxy device. To run these and all the other ones you
can use the following command line:
```
sudo bash -c "SWTPM_TEST_EXPENSIVE=1 SWTPM_TEST_STORE_VOLATILE=1 SWTPM_TEST_IBMTSS2=1 make check"
```