Skip to content

Commit

Permalink
Add README section to run the tests
Browse files Browse the repository at this point in the history
  • Loading branch information
SqAtx committed Sep 21, 2024
1 parent 8a8d749 commit e67dde8
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,28 @@ them locally with `pre-commit run --all-files`.
For more guidelines about contributing, see
[CONTRIBUTING.md](./CONTRIBUTING.md).

### Running the tests

Tests are run using `pytest`.

Normally, `.py.in` files have to first be pre-processed by the meson setup step,
then `pytest` has to be run on the output of the meson build. This is what
the [GitHub Actions
workflow](https://github.com/getting-things-gnome/gtg/blob/master/.github/workflows/unit_tests.yml)
does.

For local development, we can simplify our life and just copy the processed
`.py` files back next to their `.py.in` counterparts:

```
meson setup ./build
cp .build/GTG/core/info.py GTG/core/
```

Then, as long as you have the correct dependencies installed (check out
the GHA workflow for reference), just run `pytest` from the repo root.


# "Where is my user data and config stored?"

It depends:
Expand Down

0 comments on commit e67dde8

Please sign in to comment.