From b109578ec1e8635aeb9f12c3a913108232347935 Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Tue, 6 Jun 2023 17:46:24 +0200
Subject: Working on documentation architecture.

---
 docs/contributor_guide/unitary_test.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 docs/contributor_guide/unitary_test.md

(limited to 'docs/contributor_guide/unitary_test.md')

diff --git a/docs/contributor_guide/unitary_test.md b/docs/contributor_guide/unitary_test.md
new file mode 100644
index 0000000..42cf24c
--- /dev/null
+++ b/docs/contributor_guide/unitary_test.md
@@ -0,0 +1,33 @@
+Unitary test
+============
+
+ArGaze package unitary tests are based on [unittest](https://docs.python.org/fr/3.10/library/unittest.html) module.  
+Test files tree structure is mirroring the file tree structure of src/argaze folder.
+
+!!! note
+
+    *Consider that all inline commands below have to be executed into ArGaze root folder.*
+
+
+To run all unitary tests:
+
+```shell
+python -m unittest discover ./src/argaze.test "*.py"
+```
+
+To run only submodule unitary tests:
+
+```shell
+python -m unittest discover ./src/argaze.test/SUBMODULE "*.py"
+```
+
+To run only a single unitary test file from a submodule:
+
+```shell
+python -m unittest discover ./src/argaze.test/SUBMODULE/ TEST_FILE.py
+```
+
+!!! note
+
+    **Verbose mode**  
+    *Use -v option to get more details.*
-- 
cgit v1.1