Skip to content

Commit

Permalink
docs: improve unit test docs (#30)
Browse files Browse the repository at this point in the history
* docs: improve unit test docs

* docs: add cd command to docs

Co-authored-by: Aidan Pine <[email protected]>

---------

Co-authored-by: PT Anderson <[email protected]>
Co-authored-by: Aidan Pine <[email protected]>
  • Loading branch information
3 people authored Feb 8, 2024
1 parent fd25908 commit 4ddf6ba
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions docs/developer/unittests.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,28 @@ Test runner is found in `run.py` script.
### Run all tests
If poetry is active, run

`python run.py dev`
python run.py dev

If not in poetry, run

`poetry run python run.py dev`
poetry run python run.py dev

### Run specific tests

You can run individual test files like so:

`poetry run python -m unittest test_cli.py`
poetry run python -m unittest test_cli.py

You can also run individual tests by providing the path to the test method
`poetry run python -m unittest test_sorter.SorterTest.test_sort_formats`

poetry run python -m unittest test_sorter.SorterTest.test_sort_formats

# MotherTongues-UI Unit Tests
TBD

Front end tests are run using `nx` within the *mothertongues-UI* directory

cd mothertongues-UI
npx nx test mtd-mobile-ui

!!! Note
The above command assumes you have already installed the mtd-mobile-ui package. If not, first run `npm install` command

0 comments on commit 4ddf6ba

Please sign in to comment.