From 5f4fcebdbb376c35b3570a96abdd7a71c7b3c24f Mon Sep 17 00:00:00 2001 From: Jedrzej Rybicki <j.rybicki@fz-juelich.de> Date: Thu, 10 Jun 2021 09:43:26 +0000 Subject: [PATCH] Update README.md (testing_requirements + nose) --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 27b54ca..4f3909b 100644 --- a/README.md +++ b/README.md @@ -70,9 +70,13 @@ More information about uvicorn settings (including information about how to bind ### Testing -First ensure that the `pytest` package is installed (It is included in the `requirements.txt`). +First ensure that the `pytest` package is installed (It is included in the `testing_requirements.txt`). -Tests are located in the `apiserver_tests` directory. They can be executed by simply running `pytest` while in the project folder. +Tests are located in the `apiserver_tests` directory. They can be executed by simply running `pytest` while in the project folder. You can also use +nose for test (also included in `testing_requirements.txt`), for instance for tests with coverage report in html format run following: +```bash +nosetests --with-coverage --cover-package=apiserver --cover-html +``` If more test-files should be added, they should be named with a `test_` prefix and put into a similarily named folder, so that they can be auto-detected. @@ -80,7 +84,6 @@ The `context.py` file helps with importing the apiserver-packages, so that the t - ### Using the docker image #### Building the docker image -- GitLab