From 9bb8c919951e8877e34be48e46bc6607bd629ca2 Mon Sep 17 00:00:00 2001 From: Robbie Luijben <luijben@astron.nl> Date: Tue, 21 Nov 2023 10:39:59 +0100 Subject: [PATCH] Update README with documentation on running tests --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 12198e55..efc57cf9 100644 --- a/README.md +++ b/README.md @@ -112,3 +112,16 @@ This is the procedure for that. See the integration instructions in the [astronauth repo](https://git.astron.nl/astron-sdc/astronauth) +### Running tests + +To run tests, you can spin up a dedicated test database locally using the the provided `docker-compose-ci.yml` file. This test database will not interfere with your local development database. For example, you can run this command from the `atdb/docker` folder: + +` docker compose -f .\docker-compose-ci.yml up -d` + +After spinning up the database, you can execute the tests with the following command: + +`python manage.py test --settings atdb.settings.ci` + +Dedicated settings for running the tests are provided in the `atdb/settings/ci.dev` file. For convenience, `test.bat` is provided to run the above command (Windows only). + +Finally, these tests are also executed in the CI pipeline through the test stage in the `.gitlab-ci.yml` file. \ No newline at end of file -- GitLab