Skip to content

Commit

Permalink
Merge pull request #380 from balena-io/update_test_instructions
Browse files Browse the repository at this point in the history
Clarify/Warn how to setup and run tests
  • Loading branch information
kb2ma authored Feb 7, 2025
2 parents 64b9d5f + 1e8dbd3 commit df1f1da
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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
-------
Expand Down

0 comments on commit df1f1da

Please sign in to comment.