Add --skip_incompatible_explicit_targets option

This adds an argument to skip incompatible targets even if they were explicitly requested on the command line. This is useful for CI to allow it to build changed targets from rdeps queries without needing to filter them all through a cquery to check if they are compatible.

Closes bazelbuild#17403

RELNOTES: Add `--skip_incompatible_explicit_targets` option

Closes bazelbuild#17404.

PiperOrigin-RevId: 519636134
Change-Id: I16d6a4896cf920f42364cba162001b1bb7658e65

site/en/extending/platforms.md

@@ -172,6 +172,9 @@ ERROR: Target //:target_incompatible_with_myplatform is incompatible and cannot
 FAILED: Build did NOT complete successfully
 ```
 
+Incompatible explicit targets are silently skipped if
+`--skip_incompatible_explicit_targets` is enabled.
+
 ### More expressive constraints {:#expressive-constraints}
 
 For more flexibility in expressing constraints, use the

src/main/java/com/google/devtools/build/lib/analysis/AnalysisOptions.java

@@ -51,6 +51,18 @@ public class AnalysisOptions extends OptionsBase {
   )
   public int maxConfigChangesToShow;
 
+  @Option(
+      name = "skip_incompatible_explicit_targets",
+      defaultValue = "false",
+      documentationCategory = OptionDocumentationCategory.EXECUTION_STRATEGY,
+      effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS},
+      help =
+          "Skip incompatible targets that are explicitly listed on the command line. "
+              + "By default, building such targets results in an error but they are "
+              + "silently skipped when this option is enabled. See: "
+              + "https://bazel.build/extending/platforms#skipping-incompatible-targets")
+  public boolean skipIncompatibleExplicitTargets;
+
   @Option(
       name = "experimental_extra_action_filter",
       defaultValue = "",

src/main/java/com/google/devtools/build/lib/analysis/BuildView.java

@@ -211,6 +211,7 @@ public AnalysisResult update(
       ImmutableMap<String, String> aspectsParameters,
       AnalysisOptions viewOptions,
       boolean keepGoing,
+      boolean skipIncompatibleExplicitTargets,
       boolean checkForActionConflicts,
       QuiescingExecutors executors,
       TopLevelArtifactContext topLevelOptions,
@@ -426,6 +427,7 @@ public AnalysisResult update(
                     getCoverageArtifactsHelper(
                         configuredTargets, allTargetsToTest, eventHandler, eventBus, loadingResult),
                 keepGoing,
+                skipIncompatibleExplicitTargets,
                 targetOptions.get(CoreOptions.class).strictConflictChecks,
                 checkForActionConflicts,
                 executors,
@@ -492,7 +494,10 @@ public AnalysisResult update(
 
         PlatformRestrictionsResult platformRestrictions =
             topLevelConstraintSemantics.checkPlatformRestrictions(
-                skyframeAnalysisResult.getConfiguredTargets(), explicitTargetPatterns, keepGoing);
+                skyframeAnalysisResult.getConfiguredTargets(),
+                explicitTargetPatterns,
+                keepGoing,
+                skipIncompatibleExplicitTargets);
 
         if (!platformRestrictions.targetsWithErrors().isEmpty()) {
           // If there are any errored targets (e.g. incompatible targets that are explicitly

src/main/java/com/google/devtools/build/lib/analysis/constraints/TopLevelConstraintSemantics.java

@@ -112,7 +112,8 @@ public static PlatformCompatibility compatibilityWithPlatformRestrictions(
       ConfiguredTarget configuredTarget,
       ExtendedEventHandler eventHandler,
       boolean eagerlyThrowError,
-      boolean explicitlyRequested)
+      boolean explicitlyRequested,
+      boolean skipIncompatibleExplicitTargets)
       throws TargetCompatibilityCheckException {
 
     RuleContextConstraintSemantics.IncompatibleCheckResult incompatibleCheckResult =
@@ -124,7 +125,7 @@ public static PlatformCompatibility compatibilityWithPlatformRestrictions(
     // We need the label in unambiguous form here. I.e. with the "@" prefix for targets in the
     // main repository. explicitTargetPatterns is also already in the unambiguous form to make
     // comparison succeed regardless of the provided form.
-    if (explicitlyRequested) {
+    if (!skipIncompatibleExplicitTargets && explicitlyRequested) {
       if (eagerlyThrowError) {
         // Use the slightly simpler form for printing error messages. I.e. no "@" prefix for
         // targets in the main repository.
@@ -136,7 +137,8 @@ public static PlatformCompatibility compatibilityWithPlatformRestrictions(
               String.format(TARGET_INCOMPATIBLE_ERROR_TEMPLATE, configuredTarget.getLabel(), "")));
       return PlatformCompatibility.INCOMPATIBLE_EXPLICIT;
     }
-    // If this is not an explicitly requested target we can safely skip it.
+    // We can safely skip this target if it wasn't explicitly requested or we've been instructed
+    // to skip explicitly requested targets.
     return PlatformCompatibility.INCOMPATIBLE_IMPLICIT;
   }
 
@@ -240,8 +242,8 @@ public static EnvironmentCompatibility compatibilityWithTargetEnvironment(
    * the command line should be skipped.
    *
    * <p>Targets that are incompatible with the target platform and *are* explicitly requested on the
-   * command line are errored. Having one or more errored targets will cause the entire build to
-   * fail with an error message.
+   * command line are errored unless --skip_incompatible_explicit_targets is enabled. Having one or
+   * more errored targets will cause the entire build to fail with an error message.
    *
    * @param topLevelTargets the build's top-level targets
    * @param explicitTargetPatterns the set of explicit target patterns specified by the user on the
@@ -254,7 +256,8 @@ public static EnvironmentCompatibility compatibilityWithTargetEnvironment(
   public PlatformRestrictionsResult checkPlatformRestrictions(
       ImmutableSet<ConfiguredTarget> topLevelTargets,
       ImmutableSet<Label> explicitTargetPatterns,
-      boolean keepGoing)
+      boolean keepGoing,
+      boolean skipIncompatibleExplicitTargets)
       throws ViewCreationFailedException {
     ImmutableSet.Builder<ConfiguredTarget> incompatibleTargets = ImmutableSet.builder();
     ImmutableSet.Builder<ConfiguredTarget> incompatibleButRequestedTargets = ImmutableSet.builder();
@@ -265,8 +268,9 @@ public PlatformRestrictionsResult checkPlatformRestrictions(
             compatibilityWithPlatformRestrictions(
                 target,
                 eventHandler,
-                /*eagerlyThrowError=*/ !keepGoing,
-                explicitTargetPatterns.contains(target.getLabel()));
+                /* eagerlyThrowError= */ !keepGoing,
+                explicitTargetPatterns.contains(target.getLabel()),
+                skipIncompatibleExplicitTargets);
         if (PlatformCompatibility.INCOMPATIBLE_EXPLICIT.equals(platformCompatibility)) {
           incompatibleButRequestedTargets.add(target);
         } else if (PlatformCompatibility.INCOMPATIBLE_IMPLICIT.equals(platformCompatibility)) {

src/main/java/com/google/devtools/build/lib/buildtool/AnalysisAndExecutionPhaseRunner.java

@@ -241,6 +241,7 @@ private static AnalysisAndExecutionResult runAnalysisAndExecutionPhase(
             request.getAspectsParameters(),
             request.getViewOptions(),
             request.getKeepGoing(),
+            request.getViewOptions().skipIncompatibleExplicitTargets,
             request.getCheckForActionConflicts(),
             env.getQuiescingExecutors(),
             request.getTopLevelArtifactContext(),

src/main/java/com/google/devtools/build/lib/buildtool/AnalysisPhaseRunner.java

@@ -247,6 +247,7 @@ private static AnalysisResult runAnalysisPhase(
               request.getAspectsParameters(),
               request.getViewOptions(),
               request.getKeepGoing(),
+              request.getViewOptions().skipIncompatibleExplicitTargets,
               request.getCheckForActionConflicts(),
               env.getQuiescingExecutors(),
               request.getTopLevelArtifactContext(),

src/main/java/com/google/devtools/build/lib/skyframe/BuildDriverFunction.java

@@ -182,7 +182,8 @@ public SkyValue compute(SkyKey skyKey, Environment env)
                   state,
                   configuredTarget,
                   buildConfigurationValue,
-                  buildDriverKey.isExplicitlyRequested());
+                  buildDriverKey.isExplicitlyRequested(),
+                  buildDriverKey.shouldSkipIncompatibleExplicitTargets());
           if (isConfiguredTargetCompatible == null) {
             return null;
           }
@@ -273,16 +274,18 @@ private Boolean isConfiguredTargetCompatible(
       State state,
       ConfiguredTarget configuredTarget,
       BuildConfigurationValue buildConfigurationValue,
-      boolean isExplicitlyRequested)
+      boolean isExplicitlyRequested,
+      boolean skipIncompatibleExplicitTargets)
       throws InterruptedException, TargetCompatibilityCheckException {
 
     if (!state.checkedForPlatformCompatibility) {
       PlatformCompatibility platformCompatibility =
           TopLevelConstraintSemantics.compatibilityWithPlatformRestrictions(
               configuredTarget,
               env.getListener(),
-              /*eagerlyThrowError=*/ true,
-              isExplicitlyRequested);
+              /* eagerlyThrowError= */ true,
+              isExplicitlyRequested,
+              skipIncompatibleExplicitTargets);
       state.checkedForPlatformCompatibility = true;
       switch (platformCompatibility) {
         case INCOMPATIBLE_EXPLICIT:

src/main/java/com/google/devtools/build/lib/skyframe/BuildDriverKey.java

@@ -29,19 +29,22 @@ public final class BuildDriverKey implements CPUHeavySkyKey {
   private final TestType testType;
   private final boolean strictActionConflictCheck;
   private final boolean explicitlyRequested;
+  private final boolean skipIncompatibleExplicitTargets;
   private final boolean isTopLevelAspectDriver;
 
   private BuildDriverKey(
       ActionLookupKey actionLookupKey,
       TopLevelArtifactContext topLevelArtifactContext,
       boolean strictActionConflictCheck,
       boolean explicitlyRequested,
+      boolean skipIncompatibleExplicitTargets,
       boolean isTopLevelAspectDriver,
       TestType testType) {
     this.actionLookupKey = actionLookupKey;
     this.topLevelArtifactContext = topLevelArtifactContext;
     this.strictActionConflictCheck = strictActionConflictCheck;
     this.explicitlyRequested = explicitlyRequested;
+    this.skipIncompatibleExplicitTargets = skipIncompatibleExplicitTargets;
     this.isTopLevelAspectDriver = isTopLevelAspectDriver;
     this.testType = testType;
   }
@@ -50,13 +53,15 @@ public static BuildDriverKey ofTopLevelAspect(
       ActionLookupKey actionLookupKey,
       TopLevelArtifactContext topLevelArtifactContext,
       boolean strictActionConflictCheck,
-      boolean explicitlyRequested) {
+      boolean explicitlyRequested,
+      boolean skipIncompatibleExplicitTargets) {
     return new BuildDriverKey(
         actionLookupKey,
         topLevelArtifactContext,
         strictActionConflictCheck,
         explicitlyRequested,
-        /*isTopLevelAspectDriver=*/ true,
+        skipIncompatibleExplicitTargets,
+        /* isTopLevelAspectDriver= */ true,
         TestType.NOT_TEST);
   }
 
@@ -65,13 +70,15 @@ public static BuildDriverKey ofConfiguredTarget(
       TopLevelArtifactContext topLevelArtifactContext,
       boolean strictActionConflictCheck,
       boolean explicitlyRequested,
+      boolean skipIncompatibleExplicitTargets,
       TestType testType) {
     return new BuildDriverKey(
         actionLookupKey,
         topLevelArtifactContext,
         strictActionConflictCheck,
         explicitlyRequested,
-        /*isTopLevelAspectDriver=*/ false,
+        skipIncompatibleExplicitTargets,
+        /* isTopLevelAspectDriver= */ false,
         testType);
   }
 
@@ -99,6 +106,10 @@ public boolean isExplicitlyRequested() {
     return explicitlyRequested;
   }
 
+  public boolean shouldSkipIncompatibleExplicitTargets() {
+    return skipIncompatibleExplicitTargets;
+  }
+
   public boolean isTopLevelAspectDriver() {
     return isTopLevelAspectDriver;
   }

src/main/java/com/google/devtools/build/lib/skyframe/SkyframeBuildView.java

@@ -537,6 +537,7 @@ public SkyframeAnalysisResult analyzeAndExecuteTargets(
       BuildResultListener buildResultListener,
       CoverageReportActionsWrapperSupplier coverageReportActionsWrapperSupplier,
       boolean keepGoing,
+      boolean skipIncompatibleExplicitTargets,
       boolean strictConflictCheck,
       boolean checkForActionConflicts,
       QuiescingExecutors executors,
@@ -573,6 +574,7 @@ public SkyframeAnalysisResult analyzeAndExecuteTargets(
                         strictConflictCheck,
                         /* explicitlyRequested= */ explicitTargetPatterns.contains(
                             ctKey.getLabel()),
+                        skipIncompatibleExplicitTargets,
                         determineTestType(
                             testsToRun,
                             labelTargetMap,
@@ -589,7 +591,8 @@ public SkyframeAnalysisResult analyzeAndExecuteTargets(
                         k,
                         topLevelArtifactContext,
                         strictConflictCheck,
-                        /*explicitlyRequested=*/ explicitTargetPatterns.contains(k.getLabel())))
+                        /* explicitlyRequested= */ explicitTargetPatterns.contains(k.getLabel()),
+                        skipIncompatibleExplicitTargets))
             .collect(ImmutableSet.toImmutableSet());
     List<DetailedExitCode> detailedExitCodes = new ArrayList<>();
     MultiThreadPoolsQuiescingExecutor executor =

src/test/java/com/google/devtools/build/lib/analysis/util/BuildViewForTesting.java

@@ -211,6 +211,7 @@ public AnalysisResult update(
         aspectsParameters,
         viewOptions,
         keepGoing,
+        /* skipIncompatibleExplicitTargets= */ false,
         /* checkForActionConflicts= */ true,
         QuiescingExecutorsImpl.forTesting(),
         topLevelOptions,

src/test/shell/integration/target_compatible_with_test.sh

@@ -507,6 +507,34 @@ EOF
   expect_log 'Target //target_skipping:always_incompatible build was skipped'
 }
 
+# Validates that incompatible target skipping works with top level targets when
+# --skip_incompatible_explicit_targets is enabled.
+function test_success_on_incompatible_top_level_target_with_skipping() {
+  cd target_skipping || fail "couldn't cd into workspace"
+
+  # Validate a variety of ways to refer to the same target.
+  local -r -a incompatible_targets=(
+      :pass_on_foo1_bar2
+      //target_skipping:pass_on_foo1_bar2
+      @//target_skipping:pass_on_foo1_bar2
+  )
+
+  for incompatible_target in "${incompatible_targets[@]}"; do
+    echo "Testing ${incompatible_target}"
+
+    bazel test \
+      --show_result=10 \
+      --host_platform=@//target_skipping:foo1_bar1_platform \
+      --platforms=@//target_skipping:foo1_bar1_platform \
+      --build_event_text_file="${TEST_log}".build.json \
+      --skip_incompatible_explicit_targets \
+      "${incompatible_target}" &> "${TEST_log}" \
+      || fail "Bazel failed unexpectedly."
+
+    expect_log '^//target_skipping:pass_on_foo1_bar2  *  SKIPPED$'
+  done
+}
+
 # Crudely validates that the build event protocol contains useful information
 # when targets are skipped due to incompatibilities.
 function test_build_event_protocol() {