Skip to content

Testing

After updating the code, ensure that all tests pass. To run the tests, use the following command. 

hatch run test:run

If you would like to run the tests in your IDE, use the test virtual environment.

To generate a coverage report with the tests, run the following command.

hatch run test:run-and-report

Once new commits are pushed to the main branch, the test.yaml workflow will be automatically triggered, and the tests will run.

About 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.