| // Copyright 2019 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.skylarkbuildapi.test; |
| |
| import com.google.devtools.build.lib.skylarkbuildapi.SkylarkRuleContextApi; |
| import com.google.devtools.build.lib.skylarkbuildapi.platform.ConstraintValueInfoApi; |
| import com.google.devtools.build.lib.skylarkinterface.Param; |
| import com.google.devtools.build.lib.skylarkinterface.SkylarkCallable; |
| import com.google.devtools.build.lib.skylarkinterface.SkylarkModule; |
| import com.google.devtools.build.lib.syntax.EvalException; |
| import com.google.devtools.build.lib.syntax.Sequence; |
| import com.google.devtools.build.lib.syntax.StarlarkValue; |
| |
| /** Helper functions for Starlark to access coverage-related infrastructure */ |
| @SkylarkModule( |
| name = "coverage_common", |
| doc = "Helper functions to access coverage-related infrastructure.") |
| public interface CoverageCommonApi< |
| ConstraintValueT extends ConstraintValueInfoApi, |
| RuleContextT extends SkylarkRuleContextApi<ConstraintValueT>> |
| extends StarlarkValue { |
| |
| @SkylarkCallable( |
| name = "instrumented_files_info", |
| doc = |
| "Creates a new " |
| + "<a class=\"anchor\" href=\"InstrumentedFilesInfo.html\">InstrumentedFilesInfo</a> " |
| + "instance. Use this provider to communicate coverage-related attributes of the " |
| + "current build rule.", |
| parameters = { |
| @Param( |
| name = "ctx", |
| positional = true, |
| named = true, |
| type = SkylarkRuleContextApi.class, |
| doc = "The rule context."), |
| @Param( |
| name = "source_attributes", |
| doc = "A list of attribute names which contain source files for this rule.", |
| positional = false, |
| named = true, |
| defaultValue = "[]", |
| type = Sequence.class), |
| @Param( |
| name = "dependency_attributes", |
| doc = |
| "A list of attribute names which contain dependencies that might include " |
| + "instrumented files.", |
| positional = false, |
| named = true, |
| defaultValue = "[]", |
| type = Sequence.class), |
| @Param( |
| name = "extensions", |
| doc = |
| "File extensions used to filter files from source_attributes. For example, 'js'. " |
| + "If not provided (or None), then all files from source_attributes will be " |
| + "added to instrumented files, if an empty list is provided, then " |
| + "no files from source attributes will be added.", |
| positional = false, |
| named = true, |
| noneable = true, |
| defaultValue = "None", |
| type = Sequence.class), |
| }) |
| InstrumentedFilesInfoApi instrumentedFilesInfo( |
| RuleContextT skylarkRuleContext, |
| Sequence<?> sourceAttributes, // <String> expected |
| Sequence<?> dependencyAttributes, // <String> expected |
| Object extensions) |
| throws EvalException; |
| } |