doc: add tests
Signed-off-by: Iker Pedrosa <ipedrosa@redhat.com>
This commit is contained in:
parent
d40c58dc3b
commit
77c6cc9857
18
doc/contributions/tests.md
Normal file
18
doc/contributions/tests.md
Normal file
@ -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`.
|
||||||
|
```
|
Loading…
Reference in New Issue
Block a user