DEV.md

Developer notes

You want to contribute to this project ? Please read the following

IT Tests

This project define integrations tests in .github/workflows/it-test.yml.

Test assertions are done using nick-fields/assert-action.

Side note

At the moment, GitHub branch protection do not allow to define checks based on a REGEX as we can find in other CI tools such as Jenkins.

In order to work around this limitation this project make use of re-actors/alls-green.

All tests have to be declared in .github/workflows/it-test.yml the job called it-tests declares a list of needs:

    ...
    needs:
       ...
      - it-tests-output-logs-failure
      - it-tests-output-logs-success
      - < your new test > <-------------- Add your tests here

PyCharm users

There is currently a bug in pycharm to support pytest properly. To run the tests locally either comment the line:

addopts = --cov=src --cov-report html:build/coverage-html \
--cov-report xml:build/coverage.xml \
--cov-report term

in pytest.ini or delete pytest.ini locally