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.

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

chore: generate coverage report #46

Merged
merged 1 commit into from
Aug 8, 2024
Merged

chore: generate coverage report #46

merged 1 commit into from
Aug 8, 2024

Conversation

sripwoud
Copy link
Member

@sripwoud sripwoud commented Aug 8, 2024

  • Add a coverage make task to generate a coverage report to STDOUT
  • Generate a coverage lcov.info report when running the tests in the CI and upload that to coveralls

Closes #43

@sripwoud sripwoud force-pushed the ci/coverage branch 7 times, most recently from f583f9c to ece3edd Compare August 8, 2024 08:26
@@ -38,7 +38,7 @@ maybe_install_local() {

install_dev_deps() {
log "Installing development dependencies..."
crates="convco dprint cargo-nextest"
crates="convco dprint cargo-llvm-cov cargo-nextest"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sripwoud sripwoud self-assigned this Aug 8, 2024
@sripwoud sripwoud marked this pull request as ready for review August 8, 2024 08:29
@sripwoud sripwoud requested a review from cedoor as a code owner August 8, 2024 08:29
@sripwoud sripwoud added devops 🔧 Operations management and dev tools tests 🧪 Adding missing or correcting existing tests labels Aug 8, 2024
Copy link
Member

@cedoor cedoor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍🏽

@sripwoud sripwoud merged commit a0ca234 into main Aug 8, 2024
5 checks passed
@sripwoud sripwoud deleted the ci/coverage branch August 8, 2024 10:27
sripwoud added a commit that referenced this pull request Aug 8, 2024
I had deliberately ommitted the checkout step in the coverage job in #46
because I thought it was sufficient for `coveralls` to only have a
coverage report file (`lcov.info`) in order to be able to report the
coverage.
But it is not, it needs to read the src files too, otherwise it fails
with a [`nothing to report`
error](https://github.com/privacy-scaling-explorations/zk-kit.rust/actions/runs/10300402250/job/28509727109#step:3:60).
So we need to checkout.

The [coverage job execution on this test
branch](https://github.com/privacy-scaling-explorations/zk-kit.rust/actions/runs/10301338228/job/28512666893?pr=48#step:4:62)
demonstrated that the fix is effective.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devops 🔧 Operations management and dev tools tests 🧪 Adding missing or correcting existing tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

chore: include coverage in ci checks
2 participants