Allow native repository rules to declare toolchains they want

katre · copybara-github · commit 39401a9efcdb · 2020-07-09T10:14:29.000-07:00
registered. Closes #11728. PiperOrigin-RevId: 320420725
diff --git a/src/main/java/com/google/devtools/build/lib/packages/RuleClass.java b/src/main/java/com/google/devtools/build/lib/packages/RuleClass.java
@@ -141,11 +141,15 @@ public class RuleClass {
 
   @AutoCodec
   static final Function<? super Rule, Map<String, Label>> NO_EXTERNAL_BINDINGS =
-      Functions.<Map<String, Label>>constant(ImmutableMap.<String, Label>of());
+      Functions.constant(ImmutableMap.of());
+
+  @AutoCodec
+  static final Function<? super Rule, List<String>> NO_TOOLCHAINS_TO_REGISTER =
+      Functions.constant(ImmutableList.of());
 
   @AutoCodec
   static final Function<? super Rule, Set<String>> NO_OPTION_REFERENCE =
-      Functions.<Set<String>>constant(ImmutableSet.<String>of());
+      Functions.constant(ImmutableSet.of());
 
   public static final PathFragment THIRD_PARTY_PREFIX = PathFragment.create("third_party");
   public static final PathFragment EXPERIMENTAL_PREFIX = PathFragment.create("experimental");
@@ -674,6 +678,8 @@ public String toString() {
     private BuildSetting buildSetting = null;
     private Function<? super Rule, Map<String, Label>> externalBindingsFunction =
         NO_EXTERNAL_BINDINGS;
+    private Function<? super Rule, ? extends List<String>> toolchainsToRegisterFunction =
+        NO_TOOLCHAINS_TO_REGISTER;
     private Function<? super Rule, ? extends Set<String>> optionReferenceFunction =
         NO_OPTION_REFERENCE;
     /** This field and the next are null iff the rule is native. */
@@ -821,6 +827,7 @@ public RuleClass build(String name, String key) {
           assertStarlarkRuleClassHasEnvironmentLabel();
         }
         Preconditions.checkState(externalBindingsFunction == NO_EXTERNAL_BINDINGS);
+        Preconditions.checkState(toolchainsToRegisterFunction == NO_TOOLCHAINS_TO_REGISTER);
       }
       if (type == RuleClassType.PLACEHOLDER) {
         Preconditions.checkNotNull(ruleDefinitionEnvironmentDigest, this.name);
@@ -885,6 +892,7 @@ public RuleClass build(String name, String key) {
           advertisedProviders.build(),
           configuredTargetFunction,
           externalBindingsFunction,
+          toolchainsToRegisterFunction,
           optionReferenceFunction,
           ruleDefinitionEnvironmentLabel,
           ruleDefinitionEnvironmentDigest,
@@ -1274,6 +1282,12 @@ public Builder setExternalBindingsFunction(Function<? super Rule, Map<String, La
       return this;
     }
 
+    public Builder setToolchainsToRegisterFunction(
+        Function<? super Rule, ? extends List<String>> func) {
+      this.toolchainsToRegisterFunction = func;
+      return this;
+    }
+
     /**
      * Sets the rule definition environment label and transitive digest. Meant for Starlark usage.
      */
@@ -1616,6 +1630,9 @@ public Attribute.Builder<?> copy(String name) {
    */
   private final Function<? super Rule, Map<String, Label>> externalBindingsFunction;
 
+  /** Returns the toolchains a workspace function wants to have registered in the WORKSPACE file. */
+  private final Function<? super Rule, ? extends List<String>> toolchainsToRegisterFunction;
+
   /**
    * Returns the options referenced by this rule's attributes.
    */
@@ -1695,6 +1712,7 @@ public Attribute.Builder<?> copy(String name) {
       AdvertisedProviderSet advertisedProviders,
       @Nullable StarlarkCallable configuredTargetFunction,
       Function<? super Rule, Map<String, Label>> externalBindingsFunction,
+      Function<? super Rule, ? extends List<String>> toolchainsToRegisterFunction,
       Function<? super Rule, ? extends Set<String>> optionReferenceFunction,
       @Nullable Label ruleDefinitionEnvironmentLabel,
       @Nullable byte[] ruleDefinitionEnvironmentDigest,
@@ -1727,6 +1745,7 @@ public Attribute.Builder<?> copy(String name) {
     this.advertisedProviders = advertisedProviders;
     this.configuredTargetFunction = configuredTargetFunction;
     this.externalBindingsFunction = externalBindingsFunction;
+    this.toolchainsToRegisterFunction = toolchainsToRegisterFunction;
     this.optionReferenceFunction = optionReferenceFunction;
     this.ruleDefinitionEnvironmentLabel = ruleDefinitionEnvironmentLabel;
     this.ruleDefinitionEnvironmentDigest = ruleDefinitionEnvironmentDigest;
@@ -2591,6 +2610,16 @@ public Function<? super Rule, Map<String, Label>> getExternalBindingsFunction()
     return externalBindingsFunction;
   }
 
+  /**
+   * Returns a function that computes the toolchains that should be registered for a repository
+   * function.
+   *
+   * @return
+   */
+  public Function<? super Rule, ? extends List<String>> getToolchainsToRegisterFunction() {
+    return toolchainsToRegisterFunction;
+  }
+
   /**
    * Returns a function that computes the options referenced by a rule.
    */
diff --git a/src/main/java/com/google/devtools/build/lib/packages/WorkspaceFactoryHelper.java b/src/main/java/com/google/devtools/build/lib/packages/WorkspaceFactoryHelper.java
@@ -56,6 +56,7 @@ public static Rule createAndAddRepositoryRule(
       Label nameLabel = Label.parseAbsolute("//external:" + entry.getKey(), ImmutableMap.of());
       addBindRule(pkg, bindRuleClass, nameLabel, entry.getValue(), semantics, callstack);
     }
+    pkg.addRegisteredToolchains(ruleClass.getToolchainsToRegisterFunction().apply(rule));
     return rule;
   }
 
diff --git a/src/test/java/com/google/devtools/build/lib/packages/RuleClassTest.java b/src/test/java/com/google/devtools/build/lib/packages/RuleClassTest.java
@@ -22,14 +22,14 @@
 import static com.google.devtools.build.lib.packages.ImplicitOutputsFunction.substitutePlaceholderIntoTemplate;
 import static com.google.devtools.build.lib.packages.RuleClass.Builder.STARLARK_BUILD_SETTING_DEFAULT_ATTR_NAME;
 import static com.google.devtools.build.lib.packages.RuleClass.NO_EXTERNAL_BINDINGS;
+import static com.google.devtools.build.lib.packages.RuleClass.NO_TOOLCHAINS_TO_REGISTER;
 import static com.google.devtools.build.lib.packages.Type.BOOLEAN;
 import static com.google.devtools.build.lib.packages.Type.INTEGER;
 import static com.google.devtools.build.lib.packages.Type.STRING;
 import static com.google.devtools.build.lib.packages.Type.STRING_LIST;
 import static org.junit.Assert.assertThrows;
 import static org.junit.Assert.fail;
 
-import com.google.common.base.Function;
 import com.google.common.base.Predicate;
 import com.google.common.base.Predicates;
 import com.google.common.base.Strings;
@@ -122,7 +122,6 @@ private static RuleClass createRuleClassA() throws LabelSyntaxException {
         PREFERRED_DEPENDENCY_PREDICATE,
         AdvertisedProviderSet.EMPTY,
         null,
-        NO_EXTERNAL_BINDINGS,
         ImmutableSet.<Class<?>>of(),
         MissingFragmentPolicy.FAIL_ANALYSIS,
         true,
@@ -159,7 +158,6 @@ private static RuleClass createRuleClassB(RuleClass ruleClassA) {
         PREFERRED_DEPENDENCY_PREDICATE,
         AdvertisedProviderSet.EMPTY,
         null,
-        NO_EXTERNAL_BINDINGS,
         ImmutableSet.<Class<?>>of(),
         MissingFragmentPolicy.FAIL_ANALYSIS,
         true,
@@ -289,7 +287,6 @@ public void testDuplicatedDeps() throws Exception {
             PREFERRED_DEPENDENCY_PREDICATE,
             AdvertisedProviderSet.EMPTY,
             null,
-            NO_EXTERNAL_BINDINGS,
             ImmutableSet.<Class<?>>of(),
             MissingFragmentPolicy.FAIL_ANALYSIS,
             true,
@@ -336,7 +333,6 @@ public void testCreateRuleWithLegacyPublicVisibility() throws Exception {
             PREFERRED_DEPENDENCY_PREDICATE,
             AdvertisedProviderSet.EMPTY,
             null,
-            NO_EXTERNAL_BINDINGS,
             ImmutableSet.<Class<?>>of(),
             MissingFragmentPolicy.FAIL_ANALYSIS,
             true,
@@ -435,7 +431,6 @@ public void testImplicitOutputs() throws Exception {
             PREFERRED_DEPENDENCY_PREDICATE,
             AdvertisedProviderSet.EMPTY,
             null,
-            NO_EXTERNAL_BINDINGS,
             ImmutableSet.<Class<?>>of(),
             MissingFragmentPolicy.FAIL_ANALYSIS,
             true,
@@ -476,7 +471,6 @@ public void testImplicitOutsWithBasenameDirname() throws Exception {
             PREFERRED_DEPENDENCY_PREDICATE,
             AdvertisedProviderSet.EMPTY,
             null,
-            NO_EXTERNAL_BINDINGS,
             ImmutableSet.<Class<?>>of(),
             MissingFragmentPolicy.FAIL_ANALYSIS,
             true);
@@ -512,7 +506,6 @@ private static RuleClass getRuleClassWithComputedDefault(Attribute computedDefau
         PREFERRED_DEPENDENCY_PREDICATE,
         AdvertisedProviderSet.EMPTY,
         null,
-        NO_EXTERNAL_BINDINGS,
         ImmutableSet.<Class<?>>of(),
         MissingFragmentPolicy.FAIL_ANALYSIS,
         true,
@@ -681,7 +674,6 @@ public void testOutputsAreOrdered() throws Exception {
             PREFERRED_DEPENDENCY_PREDICATE,
             AdvertisedProviderSet.EMPTY,
             null,
-            NO_EXTERNAL_BINDINGS,
             ImmutableSet.<Class<?>>of(),
             MissingFragmentPolicy.FAIL_ANALYSIS,
             true,
@@ -724,7 +716,6 @@ public void testSubstitutePlaceholderIntoTemplate() throws Exception {
             PREFERRED_DEPENDENCY_PREDICATE,
             AdvertisedProviderSet.EMPTY,
             null,
-            NO_EXTERNAL_BINDINGS,
             ImmutableSet.<Class<?>>of(),
             MissingFragmentPolicy.FAIL_ANALYSIS,
             true,
@@ -881,7 +872,6 @@ private static RuleClass newRuleClass(
       Predicate<String> preferredDependencyPredicate,
       AdvertisedProviderSet advertisedProviders,
       @Nullable StarlarkFunction configuredTargetFunction,
-      Function<? super Rule, Map<String, Label>> externalBindingsFunction,
       Set<Class<?>> allowedConfigurationFragments,
       MissingFragmentPolicy missingFragmentPolicy,
       boolean supportsConstraintChecking,
@@ -909,7 +899,8 @@ private static RuleClass newRuleClass(
         preferredDependencyPredicate,
         advertisedProviders,
         configuredTargetFunction,
-        externalBindingsFunction,
+        NO_EXTERNAL_BINDINGS,
+        NO_TOOLCHAINS_TO_REGISTER,
         /*optionReferenceFunction=*/ RuleClass.NO_OPTION_REFERENCE,
         /*ruleDefinitionEnvironmentLabel=*/ null,
         /*ruleDefinitionEnvironmentDigest=*/ null,
@@ -946,7 +937,6 @@ private static RuleClass createParentRuleClass() {
         PREFERRED_DEPENDENCY_PREDICATE,
         AdvertisedProviderSet.EMPTY,
         null,
-        NO_EXTERNAL_BINDINGS,
         ImmutableSet.<Class<?>>of(DummyFragment.class),
         MissingFragmentPolicy.FAIL_ANALYSIS,
         true,

Original file line number	Diff line number	Diff line change
`@@ -56,6 +56,7 @@ public static Rule createAndAddRepositoryRule(`
`56`	`56`	`Label nameLabel = Label.parseAbsolute("//external:" + entry.getKey(), ImmutableMap.of());`
`57`	`57`	`addBindRule(pkg, bindRuleClass, nameLabel, entry.getValue(), semantics, callstack);`
`58`	`58`	`}`
	`59`	`+ pkg.addRegisteredToolchains(ruleClass.getToolchainsToRegisterFunction().apply(rule));`
`59`	`60`	`return rule;`
`60`	`61`	`}`
`61`	`62`