Skip to content

Include examples in code coverage metrics #408

Description

@wphillipmoore

Context

Part of the cross-port examples consistency effort tracked in
mq-rest-admin-project/mq-rest-admin-common#119.

Ruby is the only port that includes examples in coverage metrics today.
All ports should follow this standard.

Current state

  • Examples live in examples/ — correct
  • Examples are importable modules with typed results — correct
  • 7 integration tests exist in tests/integration/test_examples.py — correct
  • Coverage command uses --cov=pymqrest which excludes examples/

Work required

  1. Change CI coverage command from --cov=pymqrest to include examples
    (e.g., --cov=pymqrest --cov=examples or adjust source paths)
  2. Run coverage — identify any uncovered lines in example modules
  3. Add tests or adjust examples to reach 100% coverage on example code
  4. Update coverage enforcement to include examples in the threshold

Files to modify

  • .github/workflows/ci.yml (coverage command)
  • pyproject.toml (coverage source paths, if configured there)
  • tests/integration/test_examples.py (if additional tests needed)

References

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions