From 89365b585cf4db03c28d7d03c5a33f74aec56cf8 Mon Sep 17 00:00:00 2001
From: deeplow <deeplower@protonmail.com>
Date: Mon, 10 Jul 2023 09:17:34 +0100
Subject: [PATCH] Add tests documentation

---
 docs/developer/TESTING.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 docs/developer/TESTING.md

diff --git a/docs/developer/TESTING.md b/docs/developer/TESTING.md
new file mode 100644
index 0000000..9cb8205
--- /dev/null
+++ b/docs/developer/TESTING.md
@@ -0,0 +1,38 @@
+# Dangerzone Testing
+
+Dangerzone has some automated testing under `tests/`.
+
+The following assumes that you have already setup the development environment.
+
+## Run tests
+
+Unit / integration tests are run with:
+
+```bash
+poetry run make test
+```
+
+## Run large tests
+
+We also have a larger set of tests that can take a day or more to run, where we evaluate the completeness of Dangerzone conversions.
+
+```bash
+poetry run make test-large
+```
+
+### Test report generation
+After running the large tests, a report is stored under `tests/test_docs_large/results/junit/` and it is composed of the JUnit XML file describing the pytest run.
+
+This report can be analysed for errors. It is obtained by running:
+
+```bash
+cd tests/docs_test_large
+make report
+```
+
+If you want to run the report on some historical test result, you can call:
+
+```bash
+cd tests/docs_test_large
+python report.py tests/test_docs_large/results/junit/commit_<COMMIT_ID>.junit.xml
+```