From 77c6cc98579a00bd4db829996286b928c8a07ea7 Mon Sep 17 00:00:00 2001 From: Iker Pedrosa Date: Tue, 14 Mar 2023 16:42:22 +0100 Subject: [PATCH] doc: add tests Signed-off-by: Iker Pedrosa --- doc/contributions/tests.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 doc/contributions/tests.md 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`. +```