-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Expose CoverageOutputGenerator on a Fragment (#14997)
This allows Starlark rules to define _lcov_merger as a late-bound Starlark configuration_field in order not to pay the cost of building it when coverage isn't enabled. Fixes #8736 Fixes #10642 Closes #14724. RELNOTES: Add coverage configuration fragment, used to expose output_generator label. PiperOrigin-RevId: 433156089
- Loading branch information
Showing
7 changed files
with
225 additions
and
13 deletions.
There are no files selected for viewing
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
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
78 changes: 78 additions & 0 deletions
78
src/main/java/com/google/devtools/build/lib/analysis/test/CoverageConfiguration.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| // Copyright 2022 The Bazel Authors. All rights reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package com.google.devtools.build.lib.analysis.test; | ||
|
|
||
| import com.google.devtools.build.lib.analysis.config.BuildOptions; | ||
| import com.google.devtools.build.lib.analysis.config.CoreOptionConverters.LabelConverter; | ||
| import com.google.devtools.build.lib.analysis.config.CoreOptions; | ||
| import com.google.devtools.build.lib.analysis.config.Fragment; | ||
| import com.google.devtools.build.lib.analysis.config.FragmentOptions; | ||
| import com.google.devtools.build.lib.analysis.config.RequiresOptions; | ||
| import com.google.devtools.build.lib.analysis.starlark.annotations.StarlarkConfigurationField; | ||
| import com.google.devtools.build.lib.cmdline.Label; | ||
| import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable; | ||
| import com.google.devtools.build.lib.starlarkbuildapi.test.CoverageConfigurationApi; | ||
| import com.google.devtools.common.options.Option; | ||
| import com.google.devtools.common.options.OptionDocumentationCategory; | ||
| import com.google.devtools.common.options.OptionEffectTag; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| /** The coverage configuration fragment. */ | ||
| @Immutable | ||
| @RequiresOptions(options = {CoreOptions.class, CoverageConfiguration.CoverageOptions.class}) | ||
| public class CoverageConfiguration extends Fragment implements CoverageConfigurationApi { | ||
|
|
||
| /** Command-line options. */ | ||
| public static class CoverageOptions extends FragmentOptions { | ||
|
|
||
| @Option( | ||
| name = "coverage_output_generator", | ||
| converter = LabelConverter.class, | ||
| defaultValue = "@bazel_tools//tools/test:lcov_merger", | ||
| documentationCategory = OptionDocumentationCategory.TOOLCHAIN, | ||
| effectTags = { | ||
| OptionEffectTag.CHANGES_INPUTS, | ||
| OptionEffectTag.AFFECTS_OUTPUTS, | ||
| OptionEffectTag.LOADING_AND_ANALYSIS | ||
| }, | ||
| help = | ||
| "Location of the binary that is used to postprocess raw coverage reports. This must " | ||
| + "currently be a filegroup that contains a single file, the binary. Defaults to " | ||
| + "'//tools/test:lcov_merger'.") | ||
| public Label coverageOutputGenerator; | ||
| } | ||
|
|
||
| private final CoverageOptions coverageOptions; | ||
|
|
||
| public CoverageConfiguration(BuildOptions buildOptions) { | ||
| if (!buildOptions.get(CoreOptions.class).collectCodeCoverage) { | ||
| this.coverageOptions = null; | ||
| return; | ||
| } | ||
| this.coverageOptions = buildOptions.get(CoverageOptions.class); | ||
| } | ||
|
|
||
| @Override | ||
| @StarlarkConfigurationField( | ||
| name = "output_generator", | ||
| doc = "Label for the coverage output generator.") | ||
| @Nullable | ||
| public Label outputGenerator() { | ||
| if (coverageOptions == null) { | ||
| return null; | ||
| } | ||
| return coverageOptions.coverageOutputGenerator; | ||
| } | ||
| } |
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
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
50 changes: 50 additions & 0 deletions
50
...in/java/com/google/devtools/build/lib/starlarkbuildapi/test/CoverageConfigurationApi.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| // Copyright 2022 The Bazel Authors. All rights reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package com.google.devtools.build.lib.starlarkbuildapi.test; | ||
|
|
||
| import com.google.devtools.build.docgen.annot.DocCategory; | ||
| import com.google.devtools.build.lib.cmdline.Label; | ||
| import javax.annotation.Nullable; | ||
| import net.starlark.java.annot.StarlarkBuiltin; | ||
| import net.starlark.java.annot.StarlarkMethod; | ||
| import net.starlark.java.eval.StarlarkValue; | ||
|
|
||
| /** Coverage configuration fragment API. */ | ||
| @StarlarkBuiltin( | ||
| name = "coverage", | ||
| category = DocCategory.CONFIGURATION_FRAGMENT, | ||
| doc = "A configuration fragment representing the coverage configuration.") | ||
| public interface CoverageConfigurationApi extends StarlarkValue { | ||
|
|
||
| @StarlarkMethod( | ||
| name = "output_generator", | ||
| allowReturnNones = true, | ||
| structField = true, | ||
| doc = | ||
| "Returns the label pointed to by the" | ||
| + " <a href=\"../../user-manual.html#flag--coverage_output_generator\">" | ||
| + "<code>--coverage_output_generator</code></a> option if coverage collection is" | ||
| + " enabled, otherwise returns <code>None</code>. Can be accessed with" | ||
| + " <a href=\"globals.html#configuration_field\"><code>configuration_field" | ||
| + "</code></a>:<br/>" | ||
| + "<pre>attr.label(<br/>" | ||
| + " default = configuration_field(<br/>" | ||
| + " fragment = \"coverage\",<br/>" | ||
| + " name = \"output_generator\"<br/>" | ||
| + " )<br/>" | ||
| + ")</pre>") | ||
| @Nullable | ||
| Label outputGenerator(); | ||
| } |
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