[8.0] Introduce explicit API for configure test cluster feature flags (…

…#83876) (#83982)

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

@@ -8,6 +8,7 @@
 
 package org.elasticsearch.gradle.internal;
 
+import org.elasticsearch.gradle.VersionProperties;
 import org.elasticsearch.gradle.internal.info.BuildParams;
 import org.elasticsearch.gradle.testclusters.TestClustersPlugin;
 import org.gradle.api.Plugin;
@@ -31,6 +32,10 @@ public void apply(Project project) {
         project.getRootProject().getPluginManager().apply(InternalReaperPlugin.class);
         TestClustersPlugin testClustersPlugin = project.getPlugins().apply(TestClustersPlugin.class);
         testClustersPlugin.setRuntimeJava(providerFactory.provider(() -> BuildParams.getRuntimeJavaHome()));
+        testClustersPlugin.setIsReleasedVersion(
+            version -> (version.equals(VersionProperties.getElasticsearchVersion()) && BuildParams.isSnapshotBuild() == false)
+                || BuildParams.getBwcVersions().unreleasedInfo(version) == null
+        );
     }
 
 }

build-tools/src/main/java/org/elasticsearch/gradle/Version.java

@@ -7,14 +7,15 @@
  */
 package org.elasticsearch.gradle;
 
+import java.io.Serializable;
 import java.util.Objects;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
 /**
  * Encapsulates comparison and printing logic for an x.y.z version.
  */
-public final class Version implements Comparable<Version> {
+public final class Version implements Comparable<Version>, Serializable {
     private final int major;
     private final int minor;
     private final int revision;

build-tools/src/main/java/org/elasticsearch/gradle/testclusters/ElasticsearchCluster.java

@@ -10,6 +10,7 @@
 import org.elasticsearch.gradle.FileSupplier;
 import org.elasticsearch.gradle.PropertyNormalization;
 import org.elasticsearch.gradle.ReaperService;
+import org.elasticsearch.gradle.Version;
 import org.gradle.api.Named;
 import org.gradle.api.NamedDomainObjectContainer;
 import org.gradle.api.Project;
@@ -61,6 +62,7 @@ public class ElasticsearchCluster implements TestClusterConfiguration, Named {
     private final ArchiveOperations archiveOperations;
     private final ExecOperations execOperations;
     private final Provider<File> runtimeJava;
+    private final Function<Version, Boolean> isReleasedVersion;
     private int nodeIndex = 0;
 
     public ElasticsearchCluster(
@@ -73,7 +75,8 @@ public ElasticsearchCluster(
         ExecOperations execOperations,
         FileOperations fileOperations,
         File workingDirBase,
-        Provider<File> runtimeJava
+        Provider<File> runtimeJava,
+        Function<Version, Boolean> isReleasedVersion
     ) {
         this.path = path;
         this.clusterName = clusterName;
@@ -85,6 +88,7 @@ public ElasticsearchCluster(
         this.fileOperations = fileOperations;
         this.workingDirBase = workingDirBase;
         this.runtimeJava = runtimeJava;
+        this.isReleasedVersion = isReleasedVersion;
         this.nodes = project.container(ElasticsearchNode.class);
         this.nodes.add(
             new ElasticsearchNode(
@@ -98,7 +102,8 @@ public ElasticsearchCluster(
                 execOperations,
                 fileOperations,
                 workingDirBase,
-                runtimeJava
+                runtimeJava,
+                isReleasedVersion
             )
         );
 
@@ -131,7 +136,8 @@ public void setNumberOfNodes(int numberOfNodes) {
                     execOperations,
                     fileOperations,
                     workingDirBase,
-                    runtimeJava
+                    runtimeJava,
+                    isReleasedVersion
                 )
             );
         }
@@ -422,6 +428,16 @@ public void rolesFile(File rolesYml) {
         nodes.all(node -> node.rolesFile(rolesYml));
     }
 
+    @Override
+    public void requiresFeature(String feature, Version from) {
+        nodes.all(node -> node.requiresFeature(feature, from));
+    }
+
+    @Override
+    public void requiresFeature(String feature, Version from, Version until) {
+        nodes.all(node -> node.requiresFeature(feature, from, until));
+    }
+
     private void writeUnicastHostsFiles() {
         String unicastUris = nodes.stream().flatMap(node -> node.getAllTransportPortURI().stream()).collect(Collectors.joining("\n"));
         nodes.forEach(node -> {

build-tools/src/main/java/org/elasticsearch/gradle/testclusters/ElasticsearchNode.java

@@ -148,6 +148,7 @@ public class ElasticsearchNode implements TestClusterConfiguration {
     private final LazyPropertyList<FileCollection> extraJarConfigurations = new LazyPropertyList<>("Extra jar files", this);
     private final List<Map<String, String>> credentials = new ArrayList<>();
     private final List<File> roleFiles = new ArrayList<>();
+    private final List<FeatureFlag> featureFlags = new ArrayList<>();
     final LinkedHashMap<String, String> defaultConfig = new LinkedHashMap<>();
 
     private final Path confPathRepo;
@@ -159,6 +160,7 @@ public class ElasticsearchNode implements TestClusterConfiguration {
     private final Path esStdinFile;
     private final Path tmpDir;
     private final Provider<File> runtimeJava;
+    private final Function<Version, Boolean> isReleasedVersion;
 
     private int currentDistro = 0;
     private TestDistribution testDistribution;
@@ -185,7 +187,8 @@ public class ElasticsearchNode implements TestClusterConfiguration {
         ExecOperations execOperations,
         FileOperations fileOperations,
         File workingDirBase,
-        Provider<File> runtimeJava
+        Provider<File> runtimeJava,
+        Function<Version, Boolean> isReleasedVersion
     ) {
         this.clusterName = clusterName;
         this.path = path;
@@ -197,6 +200,7 @@ public class ElasticsearchNode implements TestClusterConfiguration {
         this.execOperations = execOperations;
         this.fileOperations = fileOperations;
         this.runtimeJava = runtimeJava;
+        this.isReleasedVersion = isReleasedVersion;
         workingDir = workingDirBase.toPath().resolve(safeName(name)).toAbsolutePath();
         confPathRepo = workingDir.resolve("repo");
         configFile = workingDir.resolve("config/elasticsearch.yml");
@@ -773,6 +777,16 @@ public void rolesFile(File rolesYml) {
         roleFiles.add(rolesYml);
     }
 
+    @Override
+    public void requiresFeature(String feature, Version from) {
+        featureFlags.add(new FeatureFlag(feature, from, null));
+    }
+
+    @Override
+    public void requiresFeature(String feature, Version from, Version until) {
+        featureFlags.add(new FeatureFlag(feature, from, until));
+    }
+
     private void runElasticsearchBinScriptWithInput(String input, String tool, CharSequence... args) {
         if (Files.exists(getDistroDir().resolve("bin").resolve(tool)) == false
             && Files.exists(getDistroDir().resolve("bin").resolve(tool + ".bat")) == false) {
@@ -820,19 +834,30 @@ private Map<String, String> getESEnvironment() {
         defaultEnv.put("ES_PATH_CONF", configFile.getParent().toString());
         String systemPropertiesString = "";
         if (systemProperties.isEmpty() == false) {
-            systemPropertiesString = " "
-                + systemProperties.entrySet()
-                    .stream()
-                    .map(entry -> "-D" + entry.getKey() + "=" + entry.getValue())
-                    // ES_PATH_CONF is also set as an environment variable and for a reference to ${ES_PATH_CONF}
-                    // to work ES_JAVA_OPTS, we need to make sure that ES_PATH_CONF before ES_JAVA_OPTS. Instead,
-                    // we replace the reference with the actual value in other environment variables
-                    .map(p -> p.replace("${ES_PATH_CONF}", configFile.getParent().toString()))
-                    .collect(Collectors.joining(" "));
+            systemPropertiesString = " " + systemProperties.entrySet().stream().peek(entry -> {
+                if (entry.getKey().contains("feature_flag")) {
+                    throw new TestClustersException("Invalid system property `" + entry.getKey() + "`. Use `requiresFeature` instead.");
+                }
+            })
+                .map(entry -> "-D" + entry.getKey() + "=" + entry.getValue())
+                // ES_PATH_CONF is also set as an environment variable and for a reference to ${ES_PATH_CONF}
+                // to work ES_JAVA_OPTS, we need to make sure that ES_PATH_CONF before ES_JAVA_OPTS. Instead,
+                // we replace the reference with the actual value in other environment variables
+                .map(p -> p.replace("${ES_PATH_CONF}", configFile.getParent().toString()))
+                .collect(Collectors.joining(" "));
         }
         if (systemProperties.containsKey("io.netty.leakDetection.level") == false) {
             systemPropertiesString = systemPropertiesString + " -Dio.netty.leakDetection.level=paranoid";
         }
+
+        String featureFlagsString = "";
+        if (featureFlags.isEmpty() == false && isReleasedVersion.apply(getVersion())) {
+            featureFlagsString = featureFlags.stream()
+                .filter(f -> getVersion().onOrAfter(f.getFrom()) && (f.getUntil() == null || getVersion().before(f.getUntil())))
+                .map(f -> "-D" + f.getFeature() + "=true")
+                .collect(Collectors.joining(" "));
+        }
+
         String jvmArgsString = "";
         if (jvmArgs.isEmpty() == false) {
             jvmArgsString = " " + jvmArgs.stream().peek(argument -> {
@@ -846,8 +871,19 @@ private Map<String, String> getESEnvironment() {
         String heapSize = System.getProperty("tests.heap.size", "512m");
         defaultEnv.put(
             "ES_JAVA_OPTS",
-            "-Xms" + heapSize + " -Xmx" + heapSize + " -ea -esa " + systemPropertiesString + " " + jvmArgsString + " " +
-            // Support passing in additional JVM arguments
+            "-Xms"
+                + heapSize
+                + " -Xmx"
+                + heapSize
+                + " -ea -esa "
+                + systemPropertiesString
+                + " "
+                + featureFlagsString
+                + " "
+                + jvmArgsString
+                + " "
+                +
+                // Support passing in additional JVM arguments
                 System.getProperty("tests.jvm.argline", "")
         );
         defaultEnv.put("ES_TMPDIR", tmpDir.toString());
@@ -1466,6 +1502,11 @@ public List<?> getExtraConfigFiles() {
         return extraConfigFiles.getNormalizedCollection();
     }
 
+    @Nested
+    public List<FeatureFlag> getFeatureFlags() {
+        return featureFlags;
+    }
+
     @Override
     @Internal
     public boolean isProcessAlive() {
@@ -1599,6 +1640,34 @@ public CharSequence[] getArgs() {
         }
     }
 
+    private static class FeatureFlag {
+        private final String feature;
+        private final Version from;
+        private final Version until;
+
+        public FeatureFlag(String feature, Version from, Version until) {
+            this.feature = feature;
+            this.from = from;
+            this.until = until;
+        }
+
+        @Input
+        public String getFeature() {
+            return feature;
+        }
+
+        @Input
+        public Version getFrom() {
+            return from;
+        }
+
+        @Input
+        @Optional
+        public Version getUntil() {
+            return until;
+        }
+    }
+
     private static class LinkCreationException extends UncheckedIOException {
         LinkCreationException(String message, IOException cause) {
             super(message, cause);

build-tools/src/main/java/org/elasticsearch/gradle/testclusters/TestClusterConfiguration.java

@@ -9,6 +9,7 @@
 
 import org.elasticsearch.gradle.FileSupplier;
 import org.elasticsearch.gradle.PropertyNormalization;
+import org.elasticsearch.gradle.Version;
 import org.gradle.api.file.FileCollection;
 import org.gradle.api.file.RegularFile;
 import org.gradle.api.logging.Logging;
@@ -97,6 +98,10 @@ public interface TestClusterConfiguration {
 
     void rolesFile(File rolesYml);
 
+    void requiresFeature(String feature, Version from);
+
+    void requiresFeature(String feature, Version from, Version until);
+
     String getHttpSocketURI();
 
     String getTransportPortURI();

build-tools/src/main/java/org/elasticsearch/gradle/testclusters/TestClustersPlugin.java

@@ -10,6 +10,7 @@
 import org.elasticsearch.gradle.DistributionDownloadPlugin;
 import org.elasticsearch.gradle.ReaperPlugin;
 import org.elasticsearch.gradle.ReaperService;
+import org.elasticsearch.gradle.Version;
 import org.elasticsearch.gradle.util.GradleUtils;
 import org.gradle.api.NamedDomainObjectContainer;
 import org.gradle.api.Plugin;
@@ -30,6 +31,7 @@
 import org.gradle.process.ExecOperations;
 
 import java.io.File;
+import java.util.function.Function;
 
 import javax.inject.Inject;
 
@@ -45,6 +47,7 @@ public class TestClustersPlugin implements Plugin<Project> {
     private static final Logger logger = Logging.getLogger(TestClustersPlugin.class);
     private final ProviderFactory providerFactory;
     private Provider<File> runtimeJavaProvider;
+    private Function<Version, Boolean> isReleasedVersion = v -> true;
 
     @Inject
     protected FileSystemOperations getFileSystemOperations() {
@@ -75,6 +78,10 @@ public void setRuntimeJava(Provider<File> runtimeJava) {
         this.runtimeJavaProvider = runtimeJava;
     }
 
+    public void setIsReleasedVersion(Function<Version, Boolean> isReleasedVersion) {
+        this.isReleasedVersion = isReleasedVersion;
+    }
+
     @Override
     public void apply(Project project) {
         project.getPlugins().apply(DistributionDownloadPlugin.class);
@@ -124,7 +131,8 @@ private NamedDomainObjectContainer<ElasticsearchCluster> createTestClustersConta
                 getExecOperations(),
                 getFileOperations(),
                 new File(project.getBuildDir(), "testclusters"),
-                runtimeJavaProvider
+                runtimeJavaProvider,
+                isReleasedVersion
             );
         });
         project.getExtensions().add(EXTENSION_NAME, container);