From 1e8dbd3a89e8d71517b10520f02b964a605c7394 Mon Sep 17 00:00:00 2001 From: Ken Bannister Date: Wed, 5 Feb 2025 12:47:22 -0500 Subject: [PATCH] Clarify/Warn how to setup and run tests Change-type: patch Signed-off-by: Ken Bannister --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 41b06482..0ce01b28 100755 --- a/README.md +++ b/README.md @@ -97,7 +97,7 @@ To verify linting you can run `poetry run flake8 --max-line-length=120` Tests ----- -To run the tests, first create a `.env` file with your test user configuration, e.g.: +To run the tests, first create a `.env` file with your test user configuration, like below. **Do not** use credentials for a user with active fleets, as the tests may be destructive. ``` [Credentials] @@ -108,7 +108,7 @@ password=123456my_password You can optionally change the target API endpoint too, e.g. `api_endpoint=https://api.balena-cloud.com`. -Then run `python -m unittest discover tests -v`. +Then run `poetry run python -m unittest discover tests -v`. Use of poetry to run tests ensures use of its virtual environment. Support -------