Skip to content

Commit

Permalink
Update CONTRIBUTING.md with information about CI/CD tests and test co…
Browse files Browse the repository at this point in the history
…verage
  • Loading branch information
Timozen committed Jan 22, 2024
1 parent 0373f65 commit 16c740a
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,18 @@ We use `pytest` and `pytest-cov` for our tests. We run the following command man
pytest -rA -vv -W ignore::DeprecationWarning --cov=jefapato --cov-report term-missing
```

We are working on a GitHub action to run the tests automatically.
The automatic CI/CD pipeline currently only runs the tests for parts of the coding library, as in GitHub actions no OpenGL context can be created. Therefore, the extraction of the facial features and the blink detection are not tested automatically. We are working on a solution for this problem.
The CI/CD tests runs the following subset of the tests:

```bash
pytest -rA -vv -W ignore::DeprecationWarning --cov=jefapato --cov-report term-missing tests/test_blinking.py tests/test_earfeature.py
```

Therefore, we would be very happy if you could run the tests locally before you create a pull request. If you are unsure, please open an issue and we will help you.
We expect to see a coverage of a high in the coding library. If you want to contribute a new feature, please also add tests for your code and if necessary test files. A proof via an image and correct CI/CD tests is enough until we have a solution for the OpenGL context problem.

Here is the current test coverage of the coding library (as of 2024-01-22):
![Expected full test coverage](assets/test_coverage.png)

## Coding Library

Expand Down
Binary file added assets/test_coverage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 16c740a

Please sign in to comment.