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

Add Code Coverage Reporting #426

Open
XAMPPRocky opened this issue Oct 19, 2021 · 3 comments
Open

Add Code Coverage Reporting #426

XAMPPRocky opened this issue Oct 19, 2021 · 3 comments
Labels
area/build-tools Development tooling. area/tests Unit tests, integration tests, anything to make sure things don't break kind/feature New feature or request

Comments

@XAMPPRocky
Copy link
Collaborator

Currently it can be difficult to know how much testing is needed for a PR. Especially when it's a type used across the codebase, as there can already be enough tests in other areas to not warrant adding more tests. So I'd like to propose that we add some code coverage reporting to PRs so that we can get insight into how much untested code is being added.

I'm not proposing that we actually require 100% coverage in PRs (or requiring any percentage), only that we expose that information in the PR through something like a bot to help the reviewer and author.

@XAMPPRocky XAMPPRocky added the kind/feature New feature or request label Oct 19, 2021
@markmandel
Copy link
Contributor

Love it!

Is there specific tooling for Rust that you would recommend?

Given that we have some Go code in our examples, should we try and combine or just focus on the Rust code for now?

@markmandel markmandel added area/tests Unit tests, integration tests, anything to make sure things don't break area/build-tools Development tooling. labels Oct 21, 2021
@XAMPPRocky
Copy link
Collaborator Author

XAMPPRocky commented Oct 22, 2021

Is there specific tooling for Rust that you would recommend?

Given that we have some Go code in our examples, should we try and combine or just focus on the Rust code for now?

No I have no recommendations, I admit I don't have much experience with code coverage tools. This idea came from watching the https://github.com/russelltg/srt-rs repository and seeing them using codecov.

@XAMPPRocky
Copy link
Collaborator Author

Was recently made aware of this code coverage tool by Mozilla. https://github.com/mozilla/grcov

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/build-tools Development tooling. area/tests Unit tests, integration tests, anything to make sure things don't break kind/feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants