feat: Integrate automated test coverage comments on pull requests #419
Conversation
This commit implements the integration of the Python Coverage Comment Action into the GitHub workflow for the kleinanzeigen-bot project. This enhancement addresses the lack of automated test coverage reports on pull requests, making it easier for reviewers to assess the impact of proposed changes on code coverage. Changes made: - Modified the `addopts` in `pytest.ini_options` to include XML coverage reporting. This enhancement is in response to issue Second-Hand-Friends#418.
- Removed obsolete coverage workflow file and configuration. - Updated build workflow to run unit and integration tests with coverage. - Added steps to store coverage files and combine them in a new merge-coverage job. - Configured coverage settings in `pyproject.toml` to enable parallel runs and specify source files. - Ensured coverage reports are generated and uploaded as artifacts for pull requests.
enh: set thresholds lower for coverage checks.
|
|
||
|
|
||
| ########################################################### | ||
| merge-coverage: |
There was a problem hiding this comment.
I am not sure if that even is required. I would expect the coverage is the same in all jobs. maybe just use coverage from one of the jobs and control which job via a matrix parameter?
There was a problem hiding this comment.
Yes, the coverage currently is the same - but we need to merge pdm utest and pdm itest or just run pdm test.
The merge of all isn't any more work than just itest and utest.
| @@ -141,23 +141,36 @@ jobs: | |||
| run: pdm run lint | |||
|
|
|||
|
|
|||
| - name: Run unit tests | |||
There was a problem hiding this comment.
I think adding " with coverage" to the title is not necessary
There was a problem hiding this comment.
It's a mess at this point and definitely needs cleanup.
| # SPDX-ArtifactOfProjectHomePage: https://github.com/Second-Hand-Friends/kleinanzeigen-bot | ||
| # | ||
| # .github/workflows/coverage.yml | ||
| name: Post coverage comment |
There was a problem hiding this comment.
does this need to be a separate workflow?
There was a problem hiding this comment.
Well as you can see workflows aren't my expertise :-)
I followed this advisory to separate it into a new workflow: https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
But I can't get it to trigger in this repo.
There was a problem hiding this comment.
We are not relying on pull_request_target and we set token permissions on job level so I don't think this setup is actually required.
There was a problem hiding this comment.
as far as I can recreate these issues on test repos the workflow_run is only triggered on the main branch. The workflow will not trigger on this PR as long as it isn't pushed to the main branch.
ℹ️ Description
This Pull Request enhances the automated test coverage reporting for the kleinanzeigen-bot project. It uses the
pytest-covpackage to provide detailed coverage metrics during testing as xml.📋 Changes Summary
addoptsinpytest.ini_optionsto include XML coverage reporting..github/workflows/test-coverage.ymlto utilize the new coverage reporting features.⚙️ Type of Change
Select the type(s) of change(s) included in this pull request:
✅ Checklist
Before requesting a review, confirm the following:
pdm run test).pdm run lint).pdm run audit).By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.