This repository has been archived by the owner on Jan 11, 2024. It is now read-only.
Add a coverage test #215
Merged
Add a coverage test #215
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adlrocha
approved these changes
Oct 2, 2023
There was a problem hiding this comment.
This is really useful. Thanks!
Just a few questions:
- The pipeline checks the coverage threshold for all the lines of code in the project, right? Not for the ones changed in the PRs. This means that before we enforce this check we should have a baseline threshold over the one we currently have because if not CI will always be unhappy. The issue with this is that if we set the threshold initially too low, new PRs may only cover that small threshold. In any case, this is useful, and we can merge and try to dedicate a sprint to improve coverage.
- Also, I guess the new bindings included in the repo have been auto-generated, right? I am asking to understand if this may be an issue: Update rust binding #211 (review)
Merged
Correct. I believe it is very easy to find that threshold, especially in our case. The main idea is to be sure we do not decrease the coverage by adding new code.
Will fix. |
|
Created an issue to track the coverage threshold consensus-shipyard/ipc#56 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a simple tool to measure test coverage by running
make coverageand running the same as a workflow on CI/CD.The current threshold is 10 %. If the coverage of line, blocks, or functions is low, then the threshold then the workflow panics.