Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ci: add test coverage report to tests and upload to Circle? #84

Closed
Tracked by #3
robbkidd opened this issue Feb 14, 2023 · 0 comments · Fixed by #93
Closed
Tracked by #3

ci: add test coverage report to tests and upload to Circle? #84

robbkidd opened this issue Feb 14, 2023 · 0 comments · Fixed by #93
Assignees
@emilyashley
Labels
type: discussion Requests for comments, discussions about possible enhancements.

Comments

@robbkidd
Copy link
Member

robbkidd commented Feb 14, 2023 •
edited
Loading

We've got coverage in as a dev dependency.

Options:

  1. Leave it as an interesting easter egg for a developer to discover.
  2. Add coverage reporting to the test suite and, in CI, upload the result as an HTML report in a test job's artifacts.
  3. Remove coverage as a dependency.
@robbkidd robbkidd added the type: discussion Requests for comments, discussions about possible enhancements. label Feb 14, 2023
@emilyashley emilyashley mentioned this issue Feb 14, 2023
Closed
33 tasks
@emilyashley emilyashley mentioned this issue Feb 25, 2023
Merged
@emilyashley emilyashley self-assigned this Feb 25, 2023
emilyashley added a commit that referenced this issue Feb 27, 2023
@emilyashley
maint: add coverage report html to circleci artifacts (#93)
d0aa7cb 
<!--
Thank you for contributing to the project! 💜
Please see our [OSS process
document](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md#)
to get an idea of how we operate.
-->

## Which problem is this PR solving?

- Closes #84 

## Short description of the changes
Improves maintainability! Uses coverage.py to run our test suite and
compare it to our src directory to find un-covered features. Uploads the
report as an interactive html to CircleCI artifacts.

## How to verify that this has the expected result
In CircleCI, under a test workflow, go to the Artifacts tab and find the
[htmlcov/index.html](https://output.circle-artifacts.com/output/job/ff865a0e-797d-4482-998f-e33a1ef90b7d/artifacts/0/htmlcov/index.html)
for code coverage. It's interactive to find different functions in files
we haven't covered in testing!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@emilyashley emilyashley

Labels
type: discussion Requests for comments, discussions about possible enhancements.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

maint: add coverage report html to circleci artifacts honeycombio/honeycomb-opentelemetry-python
2 participants
@robbkidd @emilyashley