Add Code Coverage Integration

[JP-Ellis]

Have you read the Contributing Guidelines on issues?

• I have read the Contributing Guidelines on issues.

Description

• Make sure that the test.yml workflow includes code coverage.
• Report on the code coverage to an external service. Some services include:

  • Codecov

    A placeholder for this has already been added to the test.yml workflow:

    pact-python/.github/workflows/test.yml

    Lines 53 to 58 in a070978

    	- name: Upload coverage
    	# TODO: Configure code coverage monitoring
    	if: false && matrix.python-version == env.STABLE_PYTHON_VERSION && matrix.os == 'ubuntu-latest'
    	uses: codecov/codecov-action@v2
    	with:
    	token: ${{ secrets.CODECOV_TOKEN }}

  • Coveralls

  • Codacy (maybe?)

To begin with, the code coverage reporting would only be used as extra information, but the idea going forward would be to use the reports to ensure that code added or modified in PRs is covered appropriately.

Has this been requested on Canny?

No response

Motivation

Code coverage shows which lines are and are not covered as part of a test suite. PyTest has support for this through pytest-cov, and most other languages have an equivalent.

While trying to target 100% coverage should not be a target in its own right, having clear and visible code coverage reporting can be a really useful tool during review to help ensure that changed code is behaving as expected.

Have you tried building it?

No response

Self-service

• I'd be willing to contribute this feature to Pact Python myself.