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
- Change CI coverage command from
--cov=pymqrest to include examples
(e.g., --cov=pymqrest --cov=examples or adjust source paths)
- Run coverage — identify any uncovered lines in example modules
- Add tests or adjust examples to reach 100% coverage on example code
- 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
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/— correcttests/integration/test_examples.py— correct--cov=pymqrestwhich excludesexamples/Work required
--cov=pymqrestto include examples(e.g.,
--cov=pymqrest --cov=examplesor adjust source paths)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