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

fix(coverage): add test attributes in transition module #1649

Merged
merged 5 commits into from
Dec 21, 2023

Conversation

tanan
Copy link
Contributor

@tanan tanan commented Dec 21, 2023

This PR is to fix an issue that coverage report is empty when using transition module.
This is due to the absence of the _lcov_merger and _collect_cc_coverage attributes.
Coverage reports will be created adding these attributes.

Fixes #1600

@tanan tanan requested a review from rickeylev as a code owner December 21, 2023 06:33
@tanan tanan changed the title fix(coverage): add test attr in transition module fix(coverage): add test attributes in transition module Dec 21, 2023
Copy link
Collaborator

@rickeylev rickeylev left a comment

Choose a reason for hiding this comment

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

Just some textual updates, otherwise LGTM.

I'd ask for a test, but I don't think we have any infrastructure setup to verify the coverage command is working.

CHANGELOG.md Outdated
Comment on lines 49 to 50
* (coverage): `_lcov_merger` attr added in `_transition_py_test` and
coverage reports are now created when using the transition module.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
* (coverage): `_lcov_merger` attr added in `_transition_py_test` and
coverage reports are now created when using the transition module.
* (coverage): coverage reports are now created when the version-aware
rules are used.
([#1600](https://github.com/bazelbuild/rules_python/issues/1600))

Comment on lines 145 to 156
_PY_TEST_ATTRS = {
"_collect_cc_coverage": attr.label(
default = "@bazel_tools//tools/test:collect_cc_coverage",
executable = True,
cfg = "exec",
),
"_lcov_merger": attr.label(
default = configuration_field(fragment = "coverage", name = "output_generator"),
executable = True,
cfg = "exec",
),
}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Yay magic attributes. I'm guessing you copied this from the files in python/private/common? Lets also copy the comment over so we can give what little context we have about them. Based on your analysis in the issue, I updated the text a bit.

Suggested change
_PY_TEST_ATTRS = {
"_collect_cc_coverage": attr.label(
default = "@bazel_tools//tools/test:collect_cc_coverage",
executable = True,
cfg = "exec",
),
"_lcov_merger": attr.label(
default = configuration_field(fragment = "coverage", name = "output_generator"),
executable = True,
cfg = "exec",
),
}
_PY_TEST_ATTRS = {
# Magic attribute to help C++ coverage work. There's no
# docs about this; see TestActionBuilder.java
"_collect_cc_coverage": attr.label(
default = "@bazel_tools//tools/test:collect_cc_coverage",
executable = True,
cfg = "exec",
),
# Magic attribute to make coverage work. There's no
# docs about this; see TestActionBuilder.java
"_lcov_merger": attr.label(
default = configuration_field(fragment = "coverage", name = "output_generator"),
executable = True,
cfg = "exec",
),
}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for your suggestion.
These attributes are also written In python/private/common/py_binary_rule_bazel.bzl, but there is no comment.
So, I'll copy the comment in it as well.

_transition_py_binary = rule(
_transition_py_impl,
attrs = _COMMON_ATTRS,
attrs = _COMMON_ATTRS | _PY_TEST_ATTRS,
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why is it needed in both, py_binary and py_test as opposed just py_test?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@aignas My understanding is that code coverage is collected from py_binary targets as well.
One of the reference is in https://bazel.build/reference/be/python#py_runtime.coverage_tool

These attributes are defined in common py_binary rule in this repo.
https://github.com/bazelbuild/rules_python/blob/main/python/private/common/py_binary_rule_bazel.bzl

Copy link
Collaborator

Choose a reason for hiding this comment

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

Ah, thank you, makes sense, just wanted to double check.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yeah, if a test runs a binary, then the binary needs to be instrumented so it can produce the coverage rules (which the outer test can collect and process)

@tanan tanan requested a review from rickeylev December 21, 2023 09:16
@rickeylev rickeylev enabled auto-merge December 21, 2023 15:40
@rickeylev rickeylev added this pull request to the merge queue Dec 21, 2023
Merged via the queue into bazelbuild:main with commit df234d9 Dec 21, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bazel coverage report file is empty when loading py_binary with Python version specified
3 participants