]> git.ipfire.org Git - thirdparty/shadow.git/commitdiff
doc: add tests
authorIker Pedrosa <ipedrosa@redhat.com>
Tue, 14 Mar 2023 15:42:22 +0000 (16:42 +0100)
committerSerge Hallyn <serge@hallyn.com>
Mon, 3 Apr 2023 15:42:22 +0000 (10:42 -0500)
Signed-off-by: Iker Pedrosa <ipedrosa@redhat.com>
doc/contributions/tests.md [new file with mode: 0644]

diff --git a/doc/contributions/tests.md b/doc/contributions/tests.md
new file mode 100644 (file)
index 0000000..db7218d
--- /dev/null
@@ -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`.
+```