CODE CLINIC MEOM 10/04 - tests

[Amine-ouhechou]

tests

• The package has tests:
  • Tests cover essential functions of the package and a reasonable range of inputs and conditions.
• Continuous Integration: Has continuous integration setup (We suggest using Github actions but any CI platform is acceptable for review)

[alexis-barge]

Package has no unit tests and no operating tests.

• Tutorial about testing and continuous integration in Python : https://carpentries-incubator.github.io/python-testing/
• Unit test examples for a Python package : https://github.com/meom-group/eophis/tree/main/tests/unit_tests

It is also a clean procedure to automate operating tests (global behavior tests, in opposition with unit tests that check isolated parts of the code) with a "push button", i.e. with a Makefile or a demonstrator script for example.

Package has no Continuous Integration procedure either.

GitHub workflows are suitable tools to automate testing on merge request or push.

• GitHub documentation about making workflows : https://docs.github.com/en/actions/writing-workflows/about-workflows
• Example of CI workflow that installs a Python package and executes unit tests and operating tests : https://github.com/meom-group/eophis/blob/main/.github/workflows/CI.yml

ChatGPT is also your friend to learn, check and debug GH workflows ;)