Skip to content

Commit

Permalink
doc(readme): add section about testing
Browse files Browse the repository at this point in the history
  • Loading branch information
MR2011 authored Jul 25, 2024
1 parent 2db7c6c commit 1697936
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,10 @@ Heureka uses [Ginkgo](https://onsi.github.io/ginkgo/) for behavior-driven develo

- Database Tests: These tests are found in the ./internal/database/db directory. Database tests ensure that the application correctly interacts with the database. They test database queries, updates, deletions, and other related operations.

If `LOCAL_TEST_DB` is set to `true` in `.test.env`, the tests will interact with a local database; otherwise, they will run against a containerized database.
In the `.test.env` file, the `LOCAL_TEST_DB` variable controls the database used for testing:

- If `LOCAL_TEST_DB=true`, tests will interact with a **local database**. Please ensure your local database server is running before executing the tests.
- If `LOCAL_TEST_DB=false`, tests will run against a **containerized database**.

Run all tests:
```
Expand Down

0 comments on commit 1697936

Please sign in to comment.