cover: use Z instead of underscore for variable name separator #2995
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
During the invocation of `bazel coverage`, rules_go will rewrite the source fils using `go tool cover -var ...` so that the variable can be extracted for coverage statistic after test execution. For more information on this, review the relevant Official Go Team's blog post (1) The variable used by rules_go is following the `Cover_snake_case` naming convention, which is natural to starlark and python, but not Golang. For this reason, some static analysis could get triggered by the usage of snake case naming variable while running over coverage source code. The correct solution for this problem should be to make rules_go's static analysis framework `nogo` to NOT run on the generated source code and instead only run on the original source code. However, replacing underscore separators with character `Z` is a relatively cheap fix that would let us unblock static analysis run during `bazel coverage` for now. See discussion in (2) for more details. (1): https://go.dev/blog/cover (2): bazelbuild#2984
This was referenced Oct 31, 2021
|
created #2996 to propose a longer term fix. I would still suggest to merge this first as 2996 can take some iterations to get right |
|
Thanks |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
During the invocation of
bazel coverage, rules_go will rewrite thesource fils using
go tool cover -var ...so that the variable can beextracted for coverage statistic after test execution. For more
information on this, review the relevant Official Go Team's blog post (1)
The variable used by rules_go is following the
Cover_snake_casenamingconvention, which is natural to starlark and python, but not Golang.
For this reason, some static analysis could get triggered by the usage
of snake case naming variable while running over coverage source code.
The correct solution for this problem should be to make rules_go's
static analysis framework
nogoto NOT run on the generated source codeand instead only run on the original source code. However, replacing
underscore separators with character
Zis a relatively cheap fix thatwould let us unblock static analysis run during
bazel coveragefornow. See discussion in (2) for more details.
(1): https://go.dev/blog/cover
(2): #2984
What type of PR is this?
Uncomment one line below and remove others.
Bug fix
Feature
Documentation
Other
What does this PR do? Why is it needed?
Which issues(s) does this PR fix?
Fixes #2982
Replaces #2984