[Build] Require reason for usesDefaultDistribution (#124707)

This makes using usesDefaultDistribution in our test setup for explicit by requiring a reason why it's needed.
This is helpful as part of revisiting the need for all those usages in our code base.

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

@@ -47,7 +47,7 @@ plugins.withType(InternalJavaRestTestPlugin) {
   tasks.withType(StandaloneRestIntegTestTask).configureEach {
     testClassesDirs = sourceSets.javaRestTest.output.classesDirs
     classpath = sourceSets.javaRestTest.runtimeClasspath
-    usesDefaultDistribution()
+    usesDefaultDistribution("BWC tests require full distribution for now")
   }
 }
 

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

@@ -198,6 +198,11 @@ public class RestTestBasePlugin implements Plugin<Project> {
             task.getExtensions().getExtraProperties().set("usesDefaultDistribution", new Closure<Void>(task) {
                 @Override
                 public Void call(Object... args) {
+                    if (reasonForUsageProvided(args) == false) {
+                        throw new IllegalArgumentException(
+                            "Reason for using `usesDefaultDistribution` required.\nUse usesDefaultDistribution(\"reason why default distro is required here\")."
+                        );
+                    }
                     task.dependsOn(defaultDistro);
                     registerDistributionInputs(task, defaultDistro);
 
@@ -212,6 +217,10 @@ public class RestTestBasePlugin implements Plugin<Project> {
 
                     return null;
                 }
+
+                private static boolean reasonForUsageProvided(Object[] args) {
+                    return args.length == 1 && args[0] instanceof String && ((String) args[0]).isBlank() == false;
+                }
             });
 
             // Add `usesBwcDistribution(version)` extension method to test tasks to indicate they require a BWC distribution

modules/data-streams/build.gradle

@@ -26,7 +26,7 @@ dependencies {
 }
 
 tasks.withType(StandaloneRestIntegTestTask).configureEach {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }
 
 if (buildParams.inFipsJvm){

modules/dot-prefix-validation/build.gradle

@@ -21,10 +21,10 @@ restResources {
 }
 
 tasks.named('yamlRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }
 
 tasks.named('yamlRestCompatTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
   systemProperty 'es.queryable_built_in_roles_enabled', 'false'
 }

modules/ingest-common/build.gradle

@@ -33,7 +33,7 @@ restResources {
 }
 
 tasks.withType(StandaloneRestIntegTestTask).configureEach {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }
 
 testClusters.configureEach {

plugins/repository-hdfs/build.gradle

@@ -111,7 +111,7 @@ tasks.named("dependencyLicenses").configure {
 }
 
 tasks.withType(RestIntegTestTask).configureEach {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
   buildParams.withFipsEnabledOnly(it)
   jvmArgs '--add-exports', 'java.security.jgss/sun.security.krb5=ALL-UNNAMED'
 }

qa/ccs-unavailable-clusters/build.gradle

@@ -13,5 +13,5 @@ apply plugin: 'elasticsearch.internal-java-rest-test'
 
 
 tasks.withType(StandaloneRestIntegTestTask).configureEach  {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }

test/external-modules/error-query/build.gradle

@@ -11,7 +11,7 @@ apply plugin: 'elasticsearch.legacy-yaml-rest-test'
 apply plugin: 'elasticsearch.internal-java-rest-test'
 
 tasks.named('javaRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
   it.onlyIf("snapshot build") { buildParams.snapshotBuild }
 }
 

test/external-modules/esql-heap-attack/build.gradle

@@ -19,6 +19,6 @@ esplugin {
 }
 
 tasks.named('javaRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
   it.onlyIf("snapshot build") { buildParams.snapshotBuild }
 }

test/external-modules/jvm-crash/build.gradle

@@ -19,6 +19,6 @@ esplugin {
 }
 
 tasks.named('javaRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
   it.onlyIf("snapshot build") { buildParams.snapshotBuild }
 }

test/external-modules/multi-project/build.gradle

@@ -15,7 +15,7 @@ dependencies {
 }
 
 tasks.withType(StandaloneRestIntegTestTask).configureEach {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }
 
 tasks.named("javaRestTest").configure {

test/test-clusters/src/main/java/org/elasticsearch/test/cluster/local/distribution/LocalDistributionResolver.java

@@ -42,7 +42,7 @@ public class LocalDistributionResolver implements DistributionResolver {
                             + "tasks.named('"
                             + taskName
                             + "') {\n"
-                            + "  usesDefaultDistribution()\n"
+                            + "  usesDefaultDistribution(\"Reason why default distribution is required\")\n"
                             + "}"
                     );
                 } else {

x-pack/plugin/async-search/qa/security/build.gradle

@@ -7,5 +7,5 @@ dependencies {
 }
 
 tasks.named("javaRestTest").configure {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }

x-pack/plugin/build.gradle

@@ -55,7 +55,7 @@ if (buildParams.snapshotBuild == false) {
 }
 
 tasks.withType(StandaloneRestIntegTestTask).configureEach {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }
 
 tasks.named("yamlRestTest").configure {

x-pack/plugin/downsample/qa/mixed-cluster/build.gradle

@@ -31,7 +31,7 @@ def supportedVersion = bwcVersion -> {
 buildParams.bwcVersions.withWireCompatible(supportedVersion) { bwcVersion, baseName ->
 
   def yamlRestTest = tasks.register("v${bwcVersion}#yamlRestTest", StandaloneRestIntegTestTask) {
-    usesDefaultDistribution()
+    usesDefaultDistribution("BWC tests require full distribution for now")
     usesBwcDistribution(bwcVersion)
     systemProperty("tests.old_cluster_version", bwcVersion)
     testClassesDirs = sourceSets.yamlRestTest.output.classesDirs

x-pack/plugin/downsample/qa/rest/build.gradle

@@ -25,10 +25,10 @@ artifacts {
 }
 
 tasks.named('yamlRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }
 tasks.named('yamlRestCompatTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }
 if (buildParams.inFipsJvm){
   // This test cluster is using a BASIC license and FIPS 140 mode is not supported in BASIC

x-pack/plugin/eql/qa/multi-cluster-with-security/build.gradle

@@ -5,6 +5,6 @@ dependencies {
 }
 
 tasks.named('javaRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
   maxParallelForks = 1
 }

x-pack/plugin/eql/qa/rest/build.gradle

@@ -25,14 +25,14 @@ artifacts {
 }
 
 tasks.named('javaRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
   maxParallelForks = 1
 }
 tasks.named('yamlRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }
 tasks.named('yamlRestCompatTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }
 
 if (buildParams.inFipsJvm){

x-pack/plugin/eql/qa/security/build.gradle

@@ -12,7 +12,7 @@ dependencies {
 }
 
 tasks.named('javaRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }
 
 if (buildParams.inFipsJvm){

x-pack/plugin/esql/qa/security/build.gradle

@@ -3,7 +3,7 @@ apply plugin: 'elasticsearch.internal-java-rest-test'
 apply plugin: 'elasticsearch.internal-test-artifact'
 
 tasks.named('javaRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }
 
 dependencies {

x-pack/plugin/esql/qa/server/multi-node/build.gradle

@@ -17,7 +17,7 @@ dependencies {
 GradleUtils.extendSourceSet(project, "javaRestTest", "yamlRestTest")
 
 tasks.named('javaRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }
 
 restResources {
@@ -30,6 +30,6 @@ restResources {
 }
 
 tasks.named('yamlRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
   maxParallelForks = 1
 }

x-pack/plugin/esql/qa/server/single-node/build.gradle

@@ -36,12 +36,12 @@ restResources {
 }
 
 tasks.named('javaRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
   maxParallelForks = 1
   jvmArgs('--add-opens=java.base/java.nio=ALL-UNNAMED')
 }
 
 tasks.named('yamlRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
   maxParallelForks = 1
 }

x-pack/plugin/fleet/qa/rest/build.gradle

@@ -20,10 +20,10 @@ artifacts {
 }
 
 tasks.named('yamlRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }
 tasks.named('yamlRestCompatTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }
 if (buildParams.inFipsJvm){
   // This test cluster is using a BASIC license and FIPS 140 mode is not supported in BASIC

x-pack/plugin/graph/qa/with-security/build.gradle

@@ -15,5 +15,5 @@ restResources {
 }
 
 tasks.named("yamlRestTest") {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }

x-pack/plugin/ilm/qa/with-security/build.gradle

@@ -5,5 +5,5 @@ dependencies {
 }
 
 tasks.named("javaRestTest").configure {
-  usesDefaultDistribution()
-}
+  usesDefaultDistribution("to be triaged")
+}

x-pack/plugin/inference/build.gradle

@@ -398,6 +398,6 @@ tasks.named("thirdPartyAudit").configure {
 }
 
 tasks.named('yamlRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }
 

x-pack/plugin/inference/qa/inference-service-tests/build.gradle

@@ -9,5 +9,5 @@ dependencies {
 }
 
 tasks.named("javaRestTest").configure {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }

x-pack/plugin/inference/qa/test-service-plugin/build.gradle

@@ -16,5 +16,5 @@ dependencies {
 }
 
 tasks.named("javaRestTest").configure {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }

x-pack/plugin/kql/build.gradle

@@ -32,7 +32,7 @@ dependencies {
 }
 
 tasks.named('yamlRestTest').configure {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }
 
 /**********************************

x-pack/plugin/logsdb/build.gradle

@@ -36,9 +36,9 @@ dependencies {
 }
 
 tasks.named("javaRestTest").configure {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }
 
 tasks.named('yamlRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }

x-pack/plugin/logsdb/qa/with-basic/build.gradle

@@ -15,5 +15,5 @@ tasks.named("javaRestTest").configure {
   // This test cluster is using a BASIC license and FIPS 140 mode is not supported in BASIC
   buildParams.withFipsEnabledOnly(it)
 
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }

x-pack/plugin/logsdb/qa/with-custom-cutoff/build.gradle

@@ -15,5 +15,5 @@ tasks.named("javaRestTest").configure {
   // This test cluster is using a BASIC license and FIPS 140 mode is not supported in BASIC
   buildParams.withFipsEnabledOnly(it)
 
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }

x-pack/plugin/ml/qa/ml-inference-service-tests/build.gradle

@@ -8,5 +8,5 @@ dependencies {
 }
 
 tasks.named("javaRestTest").configure {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }

x-pack/plugin/repositories-metering-api/qa/s3/build.gradle

@@ -39,7 +39,7 @@ if (!s3AccessKey && !s3SecretKey && !s3Bucket && !s3BasePath) {
 }
 
 tasks.named("javaRestTest").configure {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
   systemProperty("tests.use.fixture", Boolean.toString(useFixture))
   systemProperty 'test.s3.bucket', s3Bucket
   systemProperty("s3AccessKey", s3AccessKey)

x-pack/plugin/searchable-snapshots/qa/hdfs/build.gradle

@@ -26,7 +26,7 @@ restResources {
 }
 
 tasks.named("javaRestTest").configure {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
   buildParams.withFipsEnabledOnly(it)
   jvmArgs '--add-exports', 'java.security.jgss/sun.security.krb5=ALL-UNNAMED'
 }

x-pack/plugin/searchable-snapshots/qa/minio/build.gradle

@@ -11,7 +11,7 @@ dependencies {
 }
 
 tasks.named('javaRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }
 
 restResources {

x-pack/plugin/searchable-snapshots/qa/s3/build.gradle

@@ -41,7 +41,7 @@ if (!s3AccessKey && !s3SecretKey && !s3Bucket && !s3BasePath) {
 }
 
 tasks.named("javaRestTest").configure {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
   systemProperty("tests.use.fixture", Boolean.toString(useFixture))
   systemProperty 'test.s3.bucket', s3Bucket
   systemProperty("s3AccessKey", s3AccessKey)

x-pack/plugin/searchable-snapshots/qa/url/build.gradle

@@ -15,5 +15,5 @@ restResources {
 }
 
 tasks.named("javaRestTest").configure {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }

x-pack/plugin/security/qa/audit/build.gradle

@@ -8,5 +8,5 @@ dependencies {
 }
 
 tasks.named('javaRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }

x-pack/plugin/security/qa/basic-enable-security/build.gradle

@@ -16,5 +16,5 @@ tasks.named("javaRestTest").configure {
   // This test cluster is using a BASIC license and FIPS 140 mode is not supported in BASIC
   buildParams.withFipsEnabledOnly(it)
 
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }

x-pack/plugin/security/qa/jwt-realm/build.gradle

@@ -17,5 +17,5 @@ dependencies {
 }
 
 tasks.named('javaRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }

x-pack/plugin/security/qa/multi-project/build.gradle

@@ -5,6 +5,6 @@ dependencies {
 }
 
 tasks.named('javaRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
   it.onlyIf("snapshot build") { buildParams.snapshotBuild }
 }

x-pack/plugin/security/qa/operator-privileges-tests/build.gradle

@@ -15,5 +15,5 @@ dependencies {
 }
 
 tasks.named("javaRestTest").configure {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }

x-pack/plugin/security/qa/profile/build.gradle

@@ -15,6 +15,6 @@ dependencies {
 boolean literalUsername = buildParams.random.nextBoolean()
 
 tasks.named("javaRestTest").configure {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
   systemProperty 'test.literalUsername', literalUsername
 }

x-pack/plugin/security/qa/secondary-auth-actions/build.gradle

@@ -25,5 +25,5 @@ dependencies {
 tasks.named("javadoc").configure { enabled = false }
 
 tasks.named('javaRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }

x-pack/plugin/security/qa/security-basic/build.gradle

@@ -23,7 +23,7 @@ dependencies {
 }
 
 tasks.named('javaRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }
 
 tasks.named("javadoc").configure { enabled = false }

x-pack/plugin/security/qa/security-disabled/build.gradle

@@ -21,7 +21,7 @@ dependencies {
 }
 
 tasks.named("javaRestTest").configure {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
   // Test clusters run with security disabled
   buildParams.withFipsEnabledOnly(it)
 }

x-pack/plugin/security/qa/security-trial/build.gradle

@@ -9,6 +9,6 @@ dependencies {
 }
 
 tasks.named('javaRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }
 

x-pack/plugin/security/qa/smoke-test-all-realms/build.gradle

@@ -14,5 +14,5 @@ dependencies {
 }
 
 tasks.named("javaRestTest").configure {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }

x-pack/plugin/slm/qa/with-security/build.gradle

@@ -5,5 +5,5 @@ dependencies {
 }
 
 tasks.named("javaRestTest").configure {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }

x-pack/plugin/snapshot-based-recoveries/qa/s3/build.gradle

@@ -39,7 +39,7 @@ if (!s3AccessKey && !s3SecretKey && !s3Bucket && !s3BasePath) {
 }
 
 tasks.named("javaRestTest").configure {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
   systemProperty("tests.use.fixture", Boolean.toString(useFixture))
   systemProperty 'test.s3.bucket', s3Bucket
   systemProperty("s3AccessKey", s3AccessKey)

x-pack/plugin/snapshot-repo-test-kit/qa/hdfs/build.gradle

@@ -31,7 +31,7 @@ dependencies {
 
 // Disable integration test if Fips mode
 tasks.named("javaRestTest").configure {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
   description = "Runs rest tests against an elasticsearch cluster with HDFS."
   buildParams.withFipsEnabledOnly(it)
   // required for krb5kdc-fixture to work

x-pack/plugin/snapshot-repo-test-kit/qa/minio/build.gradle

@@ -22,5 +22,5 @@ restResources {
 }
 
 tasks.named('javaRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }

x-pack/plugin/snapshot-repo-test-kit/qa/s3/build.gradle

@@ -37,7 +37,7 @@ if (!s3AccessKey && !s3SecretKey && !s3Bucket && !s3BasePath) {
 }
 
 tasks.named("javaRestTest").configure {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
   systemProperty("tests.use.fixture", Boolean.toString(useFixture))
   systemProperty 'test.s3.bucket', s3Bucket
   systemProperty("s3AccessKey", s3AccessKey)

x-pack/plugin/sql/qa/server/build.gradle

@@ -53,7 +53,7 @@ subprojects {
     } else {
       apply plugin: 'elasticsearch.internal-java-rest-test'
       tasks.named('javaRestTest') {
-        usesDefaultDistribution()
+        usesDefaultDistribution("to be triaged")
       }
     }
 

x-pack/qa/kerberos-tests/build.gradle

@@ -8,7 +8,7 @@ dependencies {
 }
 
 tasks.named("javaRestTest").configure {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
   description = "Runs rest tests against an elasticsearch cluster with Kerberos."
   // required for krb5kdc-fixture to work
   jvmArgs '--add-exports', 'java.security.jgss/sun.security.krb5=ALL-UNNAMED'

x-pack/qa/multi-project/xpack-rest-tests-with-multiple-projects/build.gradle

@@ -22,7 +22,7 @@ restResources {
 }
 
 tasks.named("yamlRestTest").configure {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
   ArrayList<String> blacklist = [
     /* These tests don't work on multi-project yet - we need to go through each of them and make them work */
     '^analytics/boxplot/*',

x-pack/qa/oidc-op-tests/build.gradle

@@ -14,7 +14,7 @@ dependencies {
 }
 
 tasks.named('javaRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
   // test suite uses jks which is not supported in fips mode
   buildParams.withFipsEnabledOnly(it)
 }

x-pack/qa/password-protected-keystore/build.gradle

@@ -6,5 +6,5 @@
 apply plugin: 'elasticsearch.internal-java-rest-test'
 
 tasks.named('javaRestTest') {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }

x-pack/qa/reindex-tests-with-security/build.gradle

@@ -1,5 +1,5 @@
 apply plugin: 'elasticsearch.internal-yaml-rest-test'
 
 tasks.named("yamlRestTest") {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }

x-pack/qa/runtime-fields/with-security/build.gradle

@@ -1,5 +1,5 @@
 apply plugin: 'elasticsearch.internal-java-rest-test'
 
 tasks.named("javaRestTest").configure {
-  usesDefaultDistribution()
-}
+  usesDefaultDistribution("to be triaged")
+}

x-pack/qa/saml-idp-tests/build.gradle

@@ -9,5 +9,5 @@ dependencies {
 }
 
 tasks.named("javaRestTest").configure {
-  usesDefaultDistribution()
+  usesDefaultDistribution("to be triaged")
 }