Provide hints to Gradle Task.onlyIf declarations (#94953)

* Update gradle enterprise plugin to show skip reasons in build scans
* Unify OS specific handling in build logic

Author: breskeby

build-conventions/src/main/java/org/elasticsearch/gradle/internal/conventions/BuildToolsConventionsPlugin.java

@@ -25,7 +25,8 @@ public void apply(Project project) {
         project.getPlugins().apply(LicenseHeadersPrecommitPlugin.class);
         int defaultParallel = ParallelDetector.findDefaultParallel(project);
         project.getTasks().withType(Test.class).configureEach(test -> {
-            test.onlyIf((t) -> Util.getBooleanProperty("tests.fips.enabled", false) == false);
+            test.onlyIf("FIPS mode disabled",
+                    (t) -> Util.getBooleanProperty("tests.fips.enabled", false) == false);
             test.setMaxParallelForks(defaultParallel);
         });
         // we put all our distributable files under distributions

build-tools-internal/src/main/groovy/elasticsearch.bwc-test.gradle

@@ -33,7 +33,7 @@ tasks.register("bwcTest") {
 
 plugins.withType(ElasticsearchTestBasePlugin) {
   tasks.withType(Test).matching { it.name ==~ /v[0-9\.]+#.*/ }.configureEach {
-    onlyIf { project.bwc_tests_enabled }
+    onlyIf("BWC tests enabled") { project.bwc_tests_enabled }
     nonInputProperties.systemProperty 'tests.bwc', 'true'
   }
 }

build-tools-internal/src/main/groovy/elasticsearch.stable-api.gradle

@@ -1,4 +1,4 @@
-import org.apache.tools.ant.taskdefs.condition.Os
+import org.elasticsearch.gradle.OS
 import org.elasticsearch.gradle.Version
 import org.elasticsearch.gradle.VersionProperties
 import org.elasticsearch.gradle.internal.BwcVersions
@@ -45,8 +45,8 @@ BuildParams.bwcVersions.withIndexCompatible({ it.onOrAfter(Version.fromString(ex
   }
 
   jarApiComparisonTask.configure {
-    onlyIf {
-      !Os.isFamily(Os.FAMILY_WINDOWS)
+    onlyIf("OS != windows") {
+      OS.current() != OS.WINDOWS
     }
   }
 }

build-tools-internal/src/main/groovy/org/elasticsearch/gradle/internal/AntFixtureStop.groovy

@@ -8,8 +8,8 @@
 
 package org.elasticsearch.gradle.internal
 
-import org.apache.tools.ant.taskdefs.condition.Os
 import org.elasticsearch.gradle.LoggedExec
+import org.elasticsearch.gradle.OS
 import org.elasticsearch.gradle.internal.test.AntFixture
 import org.gradle.api.file.FileSystemOperations
 import org.gradle.api.file.ProjectLayout
@@ -32,12 +32,12 @@ abstract class AntFixtureStop extends LoggedExec implements FixtureStop {
         assert this.fixture == null
         this.fixture = fixture;
         final Object pid = "${ -> this.fixture.pid }"
-        onlyIf { fixture.pidFile.exists() }
+        onlyIf("pidFile exists") { fixture.pidFile.exists() }
         doFirst {
             logger.info("Shutting down ${fixture.name} with pid ${pid}")
         }
 
-        if (Os.isFamily(Os.FAMILY_WINDOWS)) {
+        if (OS.current() == OS.WINDOWS) {
             getExecutable().set('Taskkill')
             args('/PID', pid, '/F')
         } else {

build-tools-internal/src/main/groovy/org/elasticsearch/gradle/internal/test/AntFixture.groovy

@@ -8,10 +8,9 @@
 
 package org.elasticsearch.gradle.internal.test
 
-import org.apache.tools.ant.taskdefs.condition.Os
+import org.elasticsearch.gradle.OS
 import org.elasticsearch.gradle.internal.AntFixtureStop
 import org.elasticsearch.gradle.internal.AntTask
-import org.elasticsearch.gradle.internal.test.Fixture
 import org.gradle.api.GradleException
 import org.gradle.api.tasks.Internal
 import org.gradle.api.tasks.TaskProvider
@@ -95,7 +94,7 @@ class AntFixture extends AntTask implements Fixture {
         // We need to choose which executable we are using. In shell mode, or when we
         // are spawning and thus using the wrapper script, the executable is the shell.
         if (useShell || spawn) {
-            if (Os.isFamily(Os.FAMILY_WINDOWS)) {
+            if (OS.current() == OS.WINDOWS) {
                 realExecutable = 'cmd'
                 realArgs.add('/C')
                 realArgs.add('"') // quote the entire command
@@ -111,7 +110,7 @@ class AntFixture extends AntTask implements Fixture {
             realArgs.add(wrapperScript)
             realArgs.addAll(arguments)
         }
-        if (Os.isFamily(Os.FAMILY_WINDOWS) && (useShell || spawn)) {
+        if (OS.current() == OS.WINDOWS && (useShell || spawn)) {
             realArgs.add('"')
         }
         commandString.eachLine { line -> logger.info(line) }
@@ -183,7 +182,7 @@ class AntFixture extends AntTask implements Fixture {
         wrapperScript.parentFile.mkdirs()
         String argsPasser = '"$@"'
         String exitMarker = "; if [ \$? != 0 ]; then touch run.failed; fi"
-        if (Os.isFamily(Os.FAMILY_WINDOWS)) {
+        if (OS.current() == OS.WINDOWS) {
             argsPasser = '%*'
             exitMarker = "\r\n if \"%errorlevel%\" neq \"0\" ( type nul >> run.failed )"
         }
@@ -267,7 +266,7 @@ class AntFixture extends AntTask implements Fixture {
     /** Returns a file that wraps around the actual command when {@code spawn == true}. */
     @Internal
     protected File getWrapperScript() {
-        return new File(cwd, Os.isFamily(Os.FAMILY_WINDOWS) ? 'run.bat' : 'run')
+        return new File(cwd, (OS.current() == OS.WINDOWS) ? 'run.bat' : 'run')
     }
 
     /** Returns a file that the wrapper script writes when the command failed. */

build-tools-internal/src/main/java/org/elasticsearch/gradle/internal/BwcSetupExtension.java

@@ -9,8 +9,8 @@
 package org.elasticsearch.gradle.internal;
 
 import org.apache.commons.io.FileUtils;
-import org.apache.tools.ant.taskdefs.condition.Os;
 import org.elasticsearch.gradle.LoggedExec;
+import org.elasticsearch.gradle.OS;
 import org.elasticsearch.gradle.Version;
 import org.elasticsearch.gradle.internal.info.BuildParams;
 import org.gradle.api.Action;
@@ -74,12 +74,12 @@ private TaskProvider<LoggedExec> createRunBwcGradleTask(
                 return getJavaHome(Integer.parseInt(minimumCompilerVersion));
             }));
 
-            if (BuildParams.isCi() && Os.isFamily(Os.FAMILY_WINDOWS) == false) {
+            if (BuildParams.isCi() && OS.current() != OS.WINDOWS) {
                 // TODO: Disabled for now until we can figure out why files are getting corrupted
                 // loggedExec.getEnvironment().put("GRADLE_RO_DEP_CACHE", System.getProperty("user.home") + "/gradle_ro_cache");
             }
 
-            if (Os.isFamily(Os.FAMILY_WINDOWS)) {
+            if (OS.current() == OS.WINDOWS) {
                 loggedExec.getExecutable().set("cmd");
                 loggedExec.args("/C", "call", new File(checkoutDir.get(), "gradlew").toString());
             } else {

build-tools-internal/src/main/java/org/elasticsearch/gradle/internal/InternalBwcGitPlugin.java

@@ -68,7 +68,7 @@ public void apply(Project project) {
 
         TaskContainer tasks = project.getTasks();
         TaskProvider<LoggedExec> createCloneTaskProvider = tasks.register("createClone", LoggedExec.class, createClone -> {
-            createClone.onlyIf(task -> this.gitExtension.getCheckoutDir().get().exists() == false);
+            createClone.onlyIf("git checkout dir missing", task -> this.gitExtension.getCheckoutDir().get().exists() == false);
             createClone.commandLine("git", "clone", buildLayout.getRootDirectory(), gitExtension.getCheckoutDir().get());
         });
 
@@ -83,7 +83,7 @@ public void apply(Project project) {
 
         TaskProvider<LoggedExec> addRemoteTaskProvider = tasks.register("addRemote", LoggedExec.class, addRemote -> {
             addRemote.dependsOn(findRemoteTaskProvider);
-            addRemote.onlyIf(task -> ((boolean) extraProperties.get("remoteExists")) == false);
+            addRemote.onlyIf("remote exists", task -> ((boolean) extraProperties.get("remoteExists")) == false);
             addRemote.getWorkingDir().set(gitExtension.getCheckoutDir().get());
             String remoteRepo = remote.get();
             // for testing only we can override the base remote url
@@ -103,7 +103,7 @@ public void apply(Project project) {
                 }
                 throw new GradleException("tests.bwc.git_fetch_latest must be [true] or [false] but was [" + fetchProp + "]");
             });
-            fetchLatest.onlyIf(t -> isOffline == false && gitFetchLatest.get());
+            fetchLatest.onlyIf("online and gitFetchLatest == true", t -> isOffline == false && gitFetchLatest.get());
             fetchLatest.dependsOn(addRemoteTaskProvider);
             fetchLatest.getWorkingDir().set(gitExtension.getCheckoutDir().get());
             fetchLatest.commandLine("git", "fetch", "--all");

build-tools-internal/src/main/java/org/elasticsearch/gradle/internal/info/BuildParams.java

@@ -10,6 +10,7 @@
 import org.elasticsearch.gradle.internal.BwcVersions;
 import org.gradle.api.Action;
 import org.gradle.api.JavaVersion;
+import org.gradle.api.Task;
 import org.gradle.api.provider.Provider;
 import org.gradle.jvm.toolchain.JavaToolchainSpec;
 
@@ -92,6 +93,10 @@ public static Boolean isInFipsJvm() {
         return value(inFipsJvm);
     }
 
+    public static void withFipsEnabledOnly(Task task) {
+        task.onlyIf("FIPS mode disabled", task1 -> isInFipsJvm() == false);
+    }
+
     public static String getGitRevision() {
         return value(gitRevision);
     }

build-tools-internal/src/main/java/org/elasticsearch/gradle/internal/precommit/FilePermissionsTask.java

@@ -7,7 +7,7 @@
  */
 package org.elasticsearch.gradle.internal.precommit;
 
-import org.apache.tools.ant.taskdefs.condition.Os;
+import org.elasticsearch.gradle.OS;
 import org.gradle.api.DefaultTask;
 import org.gradle.api.GradleException;
 import org.gradle.api.file.FileCollection;
@@ -88,7 +88,7 @@ public FileCollection getFiles() {
 
     @TaskAction
     public void checkInvalidPermissions() throws IOException {
-        if (Os.isFamily(Os.FAMILY_WINDOWS)) {
+        if (OS.current() == OS.WINDOWS) {
             throw new StopExecutionException();
         }
         List<String> failures = getFiles().getFiles()

build-tools-internal/src/main/java/org/elasticsearch/gradle/internal/test/rest/compat/compat/AbstractYamlRestCompatTestPlugin.java

@@ -127,7 +127,8 @@ public void apply(Project project) {
                             .resolve(RELATIVE_API_PATH)
                     )
                 );
-                task.onlyIf(t -> isEnabled(extraProperties));
+                onlyIfBwcEnabled(task, extraProperties);
+                // task.onlyIf(t -> isEnabled(extraProperties));
             });
 
         // copy compatible rest tests
@@ -165,7 +166,7 @@ public void apply(Project project) {
                     )
                 );
                 task.dependsOn(copyCompatYamlSpecTask);
-                task.onlyIf(t -> isEnabled(extraProperties));
+                onlyIfBwcEnabled(task, extraProperties);
             });
 
         // copy both local source set apis and compat apis to a single location to be exported as an artifact
@@ -189,7 +190,7 @@ public void apply(Project project) {
                 task.getSourceDirectory().set(copyCompatYamlTestTask.flatMap(CopyRestTestsTask::getOutputResourceDir));
                 task.getOutputDirectory()
                     .set(project.getLayout().getBuildDirectory().dir(compatTestsDir.resolve("transformed").toString()));
-                task.onlyIf(t -> isEnabled(extraProperties));
+                onlyIfBwcEnabled(task, extraProperties);
             });
 
         // Register compat rest resources with source set
@@ -234,7 +235,7 @@ public void apply(Project project) {
 
             // run compatibility tests after "normal" tests
             testTask.mustRunAfter(project.getTasks().named(LegacyYamlRestTestPlugin.SOURCE_SET_NAME));
-            testTask.onlyIf(t -> isEnabled(extraProperties));
+            onlyIfBwcEnabled(testTask, extraProperties);
         });
 
         setupYamlRestTestDependenciesDefaults(project, yamlCompatTestSourceSet, true);
@@ -260,6 +261,10 @@ public void apply(Project project) {
 
     public abstract Class<? extends Plugin<Project>> getBasePlugin();
 
+    private void onlyIfBwcEnabled(Task task, ExtraPropertiesExtension extraProperties) {
+        task.onlyIf("BWC tests disabled", t -> isEnabled(extraProperties));
+    }
+
     private boolean isEnabled(ExtraPropertiesExtension extraProperties) {
         Object bwcEnabled = extraProperties.getProperties().get("bwc_tests_enabled");
         return bwcEnabled == null || (Boolean) bwcEnabled;