diff mbox series

[8/8] Toaster: Added pytest.init file

Message ID 20231030195132.235083-8-alassane.yattara@savoirfairelinux.com
State New
Headers show
Series [1/8] Toaster: Update toaster-requirements.txt to add pytest and some plugin's | expand

Commit Message

Alassane Yattara Oct. 30, 2023, 7:51 p.m. UTC 
Added pytest init file to configure pytest and generate test reports.

Objective
- We propose to integrate the plugin Pytest to generate test reports for Toaster application.
- To keep configurations to a minimal, we propose to integrate Pytest with Tox(tox.ini).
- Tox will automate the execution of the Pytest test cases.  

Pros
- Generate test reports
- Create a historical record of test results over time
- Track Toasters stability and quality 
- Documentation and Transparency
- Debugging, troubleshooting  : identify regressions (input, output,) 

Cons
- Limited predefined report options. Although Pytest provides different report
formats, its default reports are rather straightforward, We might have to put extra effort into crafting them ourselves.

Signed-off-by: Alassane Yattara <alassane.yattara@savoirfairelinux.com>
---
 lib/toaster/pytest.ini | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 lib/toaster/pytest.ini
diff mbox series

Patch

diff --git a/lib/toaster/pytest.ini b/lib/toaster/pytest.ini
new file mode 100644
index 00000000..f07076b7
--- /dev/null
+++ b/lib/toaster/pytest.ini
@@ -0,0 +1,19 @@ 
+# -- FILE: pytest.ini (or tox.ini)
+[pytest]
+DJANGO_SETTINGS_MODULE = toastermain.settings_test
+
+python_files = db/test_*.py commands/test_*.py views/test_*.py browser/test_*.py functional/test_*.py
+
+# --create-db - force re creation of the test database
+# https://pytest-django.readthedocs.io/en/latest/database.html#create-db-force-re-creation-of-the-test-database
+
+# --html=report.html --self-contained-html
+# https://docs.pytest.org/en/latest/usage.html#creating-html-reports
+# https://pytest-html.readthedocs.io/en/latest/user_guide.html#creating-a-self-contained-report
+addopts = --create-db --html="Toaster Tests Report.html" --self-contained-html 
+
+# Define environment variables using pytest-env
+# A pytest plugin that enables you to set environment variables in the pytest.ini file.
+# https://pypi.org/project/pytest-env/
+env =
+    TOASTER_BUILDSERVER=1