mirror of
https://github.com/rendercv/rendercv.git
synced 2026-01-18 02:08:22 -05:00
4bcf00af58
* update the developer guide * rename changelog * update changelog in navbar * update readme.md * update docs/index.md * improve
37 lines
1.4 KiB
Markdown
37 lines
1.4 KiB
Markdown
# Testing
|
|
|
|
After implementing a new feature or fixing a bug, one can run all the tests to see if anything is broken.
|
|
|
|
To run all the tests with each Python version (3.10, 3.11, 3.12, and 3.13), use the following command.
|
|
|
|
```bash
|
|
hatch run test:test
|
|
```
|
|
|
|
To run the tests with a specific Python version, use the following command.
|
|
|
|
```bash
|
|
hatch run test.py3.10:test
|
|
```
|
|
|
|
To run the tests with Python 3.13 and generate a coverage report, use the following command.
|
|
|
|
```bash
|
|
hatch run test-and-report
|
|
```
|
|
Once new commits are pushed to the `main` branch, the [`test.yaml`](https://github.com/rendercv/rendercv/blob/main/.github/workflows/test.yaml) workflow will be automatically triggered, and the tests will run.
|
|
|
|
## About [`testdata`](https://github.com/rendercv/rendercv/tree/main/tests/testdata) folder
|
|
|
|
In some of the tests:
|
|
|
|
- RenderCV generates an output with a sample input.
|
|
- Then, the output is compared with a reference output, which has been manually generated and stored in `testdata`. If the files differ, the tests fail.
|
|
|
|
|
|
When the `testdata` folder needs to be updated, it can be manually regenerated by setting `update_testdata` to `True` in `conftest.py` and running the tests.
|
|
|
|
!!! warning
|
|
- Whenever the `testdata` folder is generated, the files should be reviewed manually to ensure everything works as expected.
|
|
- `update_testdata` should be set to `False` before committing the changes.
|