Set up coverage report in CI.

[JayWhite2357]

Background and Motivation

Coverage reports help a lot with code quality and review.

Changes Required

Add a code coverage workflow to the CI. There is no single way to do this, and some work will be needed to figure out a good reporting mechanism.

• References with varying ways to set it up:
  • https://doc.rust-lang.org/rustc/instrument-coverage.html#instrumentation-based-code-coverage
  • https://marco-c.github.io/2020/11/24/rust-source-based-code-coverage.html
• Tools:
  • https://crates.io/crates/grcov
  • https://crates.io/crates/cargo-tarpaulin
  • https://crates.io/crates/cargo-llvm-cov
• Services that help with reporting and perhaps other things:
  • codecov.io
  • coveralls.io

Some more clarification:

• The CI job should fail if the code coverage does not meet a threshold. (i.e. at least 90% coverage, or something similar).
• The CI logs should show some human readable output.
• I would much prefer to not need an external service like Codecov to do the above. That should only be for visualization and deeper dives into job failures. (And should be added in a separate CP.)
• There are several features. We should make sure we are checking for coverage for all of the combinations of features. (i.e. are we actually testing all code?)
• For Codecov, etc. I will need to be the one setting up tokens/accounts, etc. So, be sure to add some documentation that explains how to do this, or links to a how to.

[JayWhite2357]

/bounty $200

[algora-pbc[bot]]

💎 $200 bounty • Space and Time

Steps to solve:

1. Start working: (Optional) Comment /attempt #239 with your implementation plan. Note: we will only assign an issue if you include an implementation plan with a time estimate. Additionally, to be assigned an issue, you must have previously contributed to the project. You can still work on an issue and submit a PR without being assigned.
2. Submit work: Create a pull request including /claim #239 in the PR body to claim the bounty
3. Receive payment: 100% of the bounty is received 2-5 days post-reward. Make sure you are eligible for payouts

Thank you for contributing to spaceandtimelabs/sxt-proof-of-sql!

Add a bounty • Share on socials

Attempt	Started (GMT+0)	Solution
🟢 @varshith257	Oct 9, 2024, 1:41:34 PM	#246

[varshith257]

/attempt #239

Implementation Plan:

To set up the coverage report in the CI pipeline, I am thinking of the following steps:

• [ ] I plan to use llvm as the coverage tool for this setup. It's widely used for Rust projects and provides good integration for CI environments.

• [ ] I will also update the existing CI pipeline by adding a new job that runs tests with coverage. I will also ensure cargo-tarpaulin is installed and coverage reports will be generated.

• [ ] We can integrate Codecov as the coverage reporting tool. Once the coverage report is generated, it will be uploaded to Codecov for detailed insights and visualization.

[algora-pbc[bot]]

💡 @varshith257 submitted a pull request that claims the bounty. You can visit your bounty board to reward.

[JayWhite2357]

/attempt #239

Implementation Plan:

To set up the coverage report in the CI pipeline, I am thinking of the following steps:

* [ ]   I plan to use llvm as the coverage tool for this setup. It's widely used for Rust projects and provides good integration for CI environments.

* [ ]  I will also update the existing CI pipeline by adding a new job that runs tests with coverage. I will also ensure cargo-tarpaulin is installed and coverage reports will be generated.

* [ ]  We can  integrate Codecov as the coverage reporting tool. Once the coverage report is generated, it will be uploaded to Codecov for detailed insights and visualization.

Sounds reasonable. Here's a few concerns (partially related to your PR). I'll add these to the original issue as clarification.

• The CI job should fail if the code coverage does not meet a threshold. (i.e. at least 90% coverage, or something similar).
• The CI logs should show some human readable output.
• I would much prefer to not need an external service like Codecov to do the above. That should only be for visualization and deeper dives into job failures.
• There are several features. We should make sure we are checking for coverage for all of the combinations of features. (i.e. are we actually testing all code?)
• For Codecov, etc. I will need to be the one setting up tokens/accounts, etc. So, be sure to add some documentation that explains how to do this, or links to a how to.

[JayWhite2357]

Follow up issues

• [ ] We should update the CI so that the tests run more efficiently. (By removing long-running tests and/or ensuring there are no redundant runs.)
• [ ] We should add tests to bring the code coverage higher. (Perhaps one issue for each of 95%, 96%, 97%, etc.)

@varshith257 feel free to create these issues based on our conversations

[github-actions[bot]]

:tada: This issue has been resolved in version 0.30.1 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket:

[varshith257]

@JayWhite2357 Okay! I will create issues for the above.

I think the bounty need to be approved on algora dashboard still it shows pending