diff options
| author | Iker Pedrosa <ipedrosa@redhat.com> | 2023-03-14 16:42:22 +0100 |
|---|---|---|
| committer | Serge Hallyn <serge@hallyn.com> | 2023-04-03 10:42:22 -0500 |
| commit | 77c6cc98579a00bd4db829996286b928c8a07ea7 (patch) | |
| tree | 895ac56408941e4b3f266d8e43fef1a5c0774921 | |
| parent | d40c58dc3be57b4d97030ab8d340d17fc74e18cd (diff) | |
doc: add tests
Signed-off-by: Iker Pedrosa <ipedrosa@redhat.com>
| -rw-r--r-- | doc/contributions/tests.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/contributions/tests.md b/doc/contributions/tests.md new file mode 100644 index 00000000..db7218d9 --- /dev/null +++ b/doc/contributions/tests.md @@ -0,0 +1,18 @@ +# Tests + +Currently, shadow only provides system tests. + +## System tests + +These type of tests are written in shell. Unfortunately, the testing framework +is tightly coupled to the Ubuntu distribution and it can only be run in this +distribution. Besides, if anything fails during the execution the system can +be left in an unstable state. Taking that into account you shouldn't run this +workflow in your host machine, we recommend to use a disposable system like a +VM or a container instead. + +You can execute system tests by running: + +``` +cd tests && ./run_all`. +``` |