From ca2533f7cc5d624dec1a04bb11dad5a1b0d2d9b3 Mon Sep 17 00:00:00 2001 From: Rob van der Linde Date: Thu, 7 Mar 2024 23:59:47 +1300 Subject: [PATCH] readme: fill out details on how to run tests In particular there is a warning to not run this against a production host. Which should be obvious for tests anyway. --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c3de3cf..2274553 100644 --- a/README.md +++ b/README.md @@ -51,9 +51,16 @@ is installed: pip install -e .[test] -Then just run pytest: +The tests need a real Redis instance to and a Samba host or Active Directory +domain to connect to as the Administrator or admin user. - pytest +WARNING: The tests will be creating users and various other objects +on the domain, so should never be run again a production server. + +The Makefile contains the lint and test commands which run pytest and ruff: + + make lint + make test Coverage reports end up in the `reports` folder.