From: Iker Pedrosa <ipedrosa@redhat.com>
Date: Tue, 14 Mar 2023 15:42:22 +0000 (+0100)
Subject: doc: add tests
X-Git-Tag: 4.14.0-rc1~111
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=77c6cc98579a00bd4db829996286b928c8a07ea7;p=thirdparty%2Fshadow.git

doc: add tests

Signed-off-by: Iker Pedrosa <ipedrosa@redhat.com>
---

diff --git a/doc/contributions/tests.md b/doc/contributions/tests.md
new file mode 100644
index 000000000..db7218d95
--- /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`.
+```