Implementation Complete! 🎉

I've implemented Phase 1 (Local Coverage Setup) and Phase 2 (CI Integration) as discussed in #701.

How to Use

Local Development (Docker):

# Coverage is automatically installed when you start containers
docker compose up -d

# Run tests with coverage
docker compose exec uwsgi python3 -m coverage run --source=greedybear manage.py test tests

# View coverage report in terminal
docker compose exec uwsgi python3 -m coverage report -m

# Generate HTML report (browser-viewable)
docker compose exec uwsgi python3 -m coverage html
# Then open htmlcov/index.html in your browser

# Generate XML report
docker compose exec uwsgi python3 -m coverage xml

Non-Docker Environments:

pip install -r requirements/test.txt
coverage run --source=greedybear manage.py test tests
coverage report -m

CI (Automatic):
When you create a PR:

1. Tests run with coverage automatically
2. Coverage summary appears in the Actions tab (job summary)
3. Download coverage artifacts from the workflow run (available for 30 days)

Hi @mlodic @regulartim

1. Is this approach acceptable?
2. Any other improvements you'd like to see before merging?

Would be soon updating the docs repo once this is merged.

Hi @mlodic
Thanks for the feedback! You're absolutely right - we need coverage tracked by Dependabot.

The Problem

Currently, coverage is installed at runtime via local.override.yml, which means:

• Dependabot can't track it
• Version updates won't be automated

Proposed Solutions

I can implement either of these approaches:

Option A: Add to requirements/project-requirements.txt

+ # Test coverage
+ coverage>=7.3.2

• Dependabot tracks it automatically
• Simplest implementation
• Coverage available everywhere (production, dev, CI)
• Minimal overhead (~240KB)
• Adds test dependency to production image

Option B: Create requirements/dev-requirements.txt

# Development requirements
coverage>=7.3.2

Then update Dockerfile to conditionally install dev requirements:

ARG INSTALL_DEV=false
RUN if [ "$INSTALL_DEV" = "true" ]; then \
      pip install -r requirements/dev-requirements.txt; \
    fi

• Dependabot tracks it automatically
• Clean separation (dev vs production)
• Production image stays lean
• More complex implementation
• Requires Dockerfile changes

Fine with the second option from my perspective

Hi @mlodic the implementation is complete now.
Please review it when you get time.

Re: Is .coveragerc used in GitHub Actions?

Yes! In _python.yml:

• Line 89: coverage_config_path defaults to .coveragerc
• Line 513: coverage run --rcfile=${{ inputs.coverage_config_path }}

Dependabot Tracking

Existing config in .github/dependabot.yml tracks /requirements directory. Since dev-requirements.txt is there, coverage updates are auto-tracked.

Usage (Docker)

docker compose exec uwsgi coverage run --source=greedybear manage.py test tests
docker compose exec uwsgi coverage report -m

Fix for CI failure

I got a notification that CI failed with:

Invalid workflow file: Unrecognized function: 'replace'

The previous commit used Copilot's suggestion replace(matrix.python_version, '.', '-') for the artifact name, but GitHub Actions doesn't have a replace function.

Fixed by using coverage-report-py${{ matrix.python_version }} instead. Periods are actually allowed in artifact names.

Hi @mlodic @regulartim can you run the CI / backend-tests, I just wanted to see whether the test coverage is working or not?
Thanks

the CI requires that at least a random change is pushed in the branch. You can just add a random log.debug() anywhere in the python code and that would do the trick. Then we can delete it before mergin the PR

@mlodic I beleive CI Test was successful
The coverage reporting feature is working. You can download the coverage XML report from:

coverage-report-py3.13

• Tests ran with coverage enabled
• coverage.xml generated successfully (4160 bytes)
• Artifact uploaded with 30-day retention

Note

The last commit added a temporary debug log to trigger CI. Once you confirm everything looks good, I'll push a revert commit to remove it before merging.

it works, you can see the results here: https://github.com/intelowlproject/GreedyBear/actions/runs/21190092088

Thanks @mlodic for testing
The temporary debug log has been reverted.
I think the PR is ready to merge or something is still left?

good job, thanks!

Documentation Question

Hi @mlodic @regulartim,

Since test coverage is primarily a maintainer concern (contributors may not need to know about it), should I still add it to the contributor's section docs repo? Or is this feature internal-only and doesn't require public documentation?

Let me know. Thanks!

To me it is not strictly necessary, thanks for asking