Create task for capturing transport versions in TransportVersions.csv (elastic#142183)

When a release is finalized, generateInitialTransportVersion creates a new transport version definition for the next release. In the old transport version system the setCompatibleVersions task would have been called to update TransportVersions.csv with the previous id to save it for lookups from id to release version.

This commit creates a new task to first save the current id into TransportVersions.csv. Additionally, the setCompatibleVersions task no longer does anything, so it is removed, and the generateInitialTransportVersion task
is updated to use the "stack version" terminology for clarity.

Author: rjernst

build-tools-internal/src/integTest/groovy/org/elasticsearch/gradle/internal/transport/AbstractTransportVersionFuncTest.groovy

@@ -133,11 +133,16 @@ class AbstractTransportVersionFuncTest extends AbstractGradleFuncTest {
         referableAndReferencedTransportVersion("older_92", "8122000")
         referableAndReferencedTransportVersion("existing_92", "8123000,8012001")
         unreferableTransportVersion("initial_9.0.0", "8000000")
+        unreferableTransportVersion("initial_9.1.0", "8011000")
         unreferableTransportVersion("initial_8.19.7", "7123001")
         transportVersionUpperBound("9.2", "existing_92", "8123000")
         transportVersionUpperBound("9.1", "existing_92", "8012001")
         transportVersionUpperBound("9.0", "initial_9.0.0", "8000000")
         transportVersionUpperBound("8.19", "initial_8.19.7", "7123001")
+        javaResource("myserver", "org/elasticsearch/TransportVersions.csv", """
+            9.0.0,8000000
+            9.1.0,8012001
+        """)
         // a mock version of TransportVersion, just here so we can compile Dummy.java et al
         javaSource("myserver", "org.elasticsearch", "TransportVersion", "", """
             public static TransportVersion fromName(String name) {

build-tools-internal/src/integTest/groovy/org/elasticsearch/gradle/internal/transport/GenerateInitialTransportVersionFuncTest.groovy

@@ -48,7 +48,7 @@ class GenerateInitialTransportVersionFuncTest extends AbstractTransportVersionFu
 
     def "setup is valid"() {
         when:
-        def result = runGenerateAndValidateTask("--release-version", "9.0.0").build()
+        def result = runGenerateAndValidateTask("--stack-version", "9.1.0").build()
 
         then:
         assertGenerateAndValidateSuccess(result)
@@ -62,9 +62,7 @@ class GenerateInitialTransportVersionFuncTest extends AbstractTransportVersionFu
         versionPropertiesFile.text = versionPropertiesFile.text.replace("9.2.0", "9.3.0")
 
         when:
-        System.out.println("Running generation initial task")
-        def result = runGenerateAndValidateTask("--release-version", "9.2.0").build()
-        System.out.println("Done running generation task")
+        def result = runGenerateAndValidateTask("--stack-version", "9.2.0").build()
 
         then:
         assertGenerateAndValidateSuccess(result)
@@ -75,7 +73,7 @@ class GenerateInitialTransportVersionFuncTest extends AbstractTransportVersionFu
 
     def "patch updates existing upper bound"() {
         when:
-        def result = runGenerateAndValidateTask("--release-version", "9.1.2").build()
+        def result = runGenerateAndValidateTask("--stack-version", "9.1.2").build()
 
         then:
         assertGenerateAndValidateSuccess(result)
@@ -85,7 +83,7 @@ class GenerateInitialTransportVersionFuncTest extends AbstractTransportVersionFu
 
     def "cannot create upper bound file for patch"() {
         when:
-        def result = runGenerateTask("--release-version", "9.3.7").buildAndFail()
+        def result = runGenerateTask("--stack-version", "9.3.7").buildAndFail()
 
         then:
         assertGenerateFailure(result, "Missing upper bound 9.3 for release version 9.3.7")

build-tools-internal/src/integTest/groovy/org/elasticsearch/gradle/internal/transport/UpdateTransportVersionsCSVFuncTest.groovy

@@ -0,0 +1,114 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+package org.elasticsearch.gradle.internal.transport
+
+import org.gradle.testkit.runner.BuildResult
+import org.gradle.testkit.runner.TaskOutcome
+
+class UpdateTransportVersionsCSVFuncTest extends AbstractTransportVersionFuncTest {
+    def runUpdateTask(String... additionalArgs) {
+        List<String> args = new ArrayList<>()
+        args.add(":myserver:updateTransportVersionsCSV")
+        args.addAll(additionalArgs);
+        return gradleRunner(args.toArray())
+    }
+
+    void assertUpdateSuccess(BuildResult result) {
+        assert result.task(":myserver:updateTransportVersionsCSV").outcome == TaskOutcome.SUCCESS
+    }
+
+    void assertUpdateFailure(BuildResult result, String expectedOutput) {
+        assert result.task(":myserver:updateTransportVersionsCSV").outcome == TaskOutcome.FAILED
+        assertOutputContains(result.output, expectedOutput)
+    }
+
+    void assertTransportVersionsCsv(String expectedContent) {
+        File csvFile = file("myserver/src/main/resources/org/elasticsearch/TransportVersions.csv")
+        assert csvFile.exists()
+        // Normalize both sides: strip leading/trailing whitespace from each line and the whole string
+        def actualLines = csvFile.text.readLines().collect { it.strip() }.findAll { it != "" }
+        def expectedLines = expectedContent.readLines().collect { it.strip() }.findAll { it != "" }
+        assert actualLines == expectedLines
+    }
+
+    def "updates csv with minor version"() {
+        when:
+        def result = runUpdateTask("--stack-version", "9.2.0").build()
+
+        then:
+        assertUpdateSuccess(result)
+        assertTransportVersionsCsv("""
+            9.0.0,8000000
+            9.1.0,8012001
+            9.2.0,8123000
+        """)
+    }
+
+    def "updates csv with patch version"() {
+        given:
+        execute("git checkout main")
+        unreferableTransportVersion("initial_9.1.1", "8012002")
+        transportVersionUpperBound("9.1", "initial_9.1.1", "8012002")
+        execute('git commit -a -m "update"')
+
+        when:
+        def result = runUpdateTask("--stack-version", "9.1.1").build()
+
+        then:
+        assertUpdateSuccess(result)
+        assertTransportVersionsCsv("""
+            9.0.0,8000000
+            9.1.0,8012001
+            9.1.1,8012002
+        """)
+    }
+
+    def "fails when upper bound does not exist"() {
+        when:
+        def result = runUpdateTask("--stack-version", "9.3.0").buildAndFail()
+
+        then:
+        assertUpdateFailure(result, "Missing upper bound 9.3 for stack version 9.3.0")
+    }
+
+    def "is idempotent when version already exists"() {
+        when:
+        // Run the task twice with the same version
+        def result1 = runUpdateTask("--stack-version", "9.2.0").build()
+        def result2 = runUpdateTask("--stack-version", "9.2.0").build()
+
+        then:
+        assertUpdateSuccess(result1)
+        assertUpdateSuccess(result2)
+        assertOutputContains(result2.output, "Version 9.2.0 already exists in TransportVersions.csv with correct transport version ID, skipping")
+        // Should only have one entry for 9.2.0
+        assertTransportVersionsCsv("""
+            9.0.0,8000000
+            9.1.0,8012001
+            9.2.0,8123000
+        """)
+    }
+
+    def "fails when existing version has wrong transport version ID"() {
+        given:
+        // Manually add an entry with wrong transport version ID
+        javaResource("myserver", "org/elasticsearch/TransportVersions.csv", """
+            9.0.0,8000000
+            9.1.0,8012001
+            9.2.0,9999999
+        """)
+
+        when:
+        def result = runUpdateTask("--stack-version", "9.2.0").buildAndFail()
+
+        then:
+        assertUpdateFailure(result, "Version 9.2.0 already exists in TransportVersions.csv with transport version ID 9999999, but expected 8123000")
+    }
+}

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

@@ -114,7 +114,6 @@ private static void replaceDefaultJavaParserClassCsm() {
 
     private static final Logger LOGGER = Logging.getLogger(AbstractVersionsTask.class);
 
-    static final String TRANSPORT_VERSION_TYPE = "TransportVersion";
     static final String INDEX_VERSION_TYPE = "IndexVersion";
 
     static final String SERVER_MODULE_PATH = "server/src/main/java/";
@@ -123,7 +122,6 @@ private static void replaceDefaultJavaParserClassCsm() {
     static final String INDEX_VERSIONS_FILE_PATH = SERVER_MODULE_PATH + "org/elasticsearch/index/IndexVersions.java";
 
     static final String SERVER_RESOURCES_PATH = "server/src/main/resources/";
-    static final String TRANSPORT_VERSIONS_RECORD = SERVER_RESOURCES_PATH + "org/elasticsearch/TransportVersions.csv";
     static final String INDEX_VERSIONS_RECORD = SERVER_RESOURCES_PATH + "org/elasticsearch/index/IndexVersions.csv";
 
     final Path rootDir;

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

@@ -52,7 +52,6 @@ public void apply(Project project) {
 
         project.getTasks().register("extractCurrentVersions", ExtractCurrentVersionsTask.class);
         project.getTasks().register("tagVersions", TagVersionsTask.class);
-        project.getTasks().register("setCompatibleVersions", SetCompatibleVersionsTask.class, t -> t.setThisVersion(version));
         project.getTasks().register("updateBranchesJson", UpdateBranchesJsonTask.class);
 
         final Directory changeLogDirectory = projectDirectory.dir("docs/changelog");

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

@@ -66,7 +66,6 @@ public void executeTask() throws IOException {
 
         for (var v : versions.entrySet()) {
             Path recordFile = switch (v.getKey()) {
-                case TRANSPORT_VERSION_TYPE -> rootDir.resolve(TRANSPORT_VERSIONS_RECORD);
                 case INDEX_VERSION_TYPE -> rootDir.resolve(INDEX_VERSIONS_RECORD);
                 default -> throw new IllegalArgumentException("Unknown version type " + v.getKey());
             };
@@ -95,7 +94,7 @@ private static Map<String, Integer> expandV7Version(Map<String, Integer> tagVers
         Integer v7Version = tagVersions.get("Version");
         if (v7Version == null) return tagVersions;
 
-        return Map.of(TRANSPORT_VERSION_TYPE, v7Version, INDEX_VERSION_TYPE, v7Version);
+        return Map.of(INDEX_VERSION_TYPE, v7Version);
     }
 
     private static final Pattern VERSION_LINE = Pattern.compile("(\\d+\\.\\d+\\.\\d+),(\\d+)");

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

@@ -26,37 +26,37 @@ public abstract class GenerateInitialTransportVersionTask extends DefaultTask {
     abstract Property<TransportVersionResourcesService> getResourceService();
 
     @Input
-    @Option(option = "release-version", description = "The Elasticsearch release version this transport version will be associated with")
-    public abstract Property<String> getReleaseVersion();
+    @Option(option = "stack-version", description = "The Elasticsearch version to generate an initial transport version for")
+    public abstract Property<String> getStackVersion();
 
     @Input
     abstract Property<Version> getCurrentVersion();
 
     @TaskAction
     public void run() throws IOException {
-        Version releaseVersion = Version.fromString(getReleaseVersion().get());
-        String upperBoundName = getUpperBoundName(releaseVersion);
+        Version stackVersion = Version.fromString(getStackVersion().get());
+        String upperBoundName = getUpperBoundName(stackVersion);
         TransportVersionResourcesService resources = getResourceService().get();
         TransportVersionUpperBound baseUpperBound = resources.getUpperBoundFromGitBase(upperBoundName);
-        String initialDefinitionName = "initial_" + releaseVersion;
+        String initialDefinitionName = "initial_" + stackVersion;
         TransportVersionDefinition existingDefinition = resources.getUnreferableDefinitionFromGitBase(initialDefinitionName);
 
         // This task runs on main and release branches. In release branches we will generate the exact same
         // upper bound result because we always look at the base branch (ie upstream/main).
         if (existingDefinition == null) {
             if (baseUpperBound == null) {
-                throw new RuntimeException("Missing upper bound " + upperBoundName + " for release version " + releaseVersion);
+                throw new RuntimeException("Missing upper bound " + upperBoundName + " for release version " + stackVersion);
             }
 
             // minors increment by 1000 to create a unique base, patches increment by 1 as other patches do
-            int increment = releaseVersion.getRevision() == 0 ? 1000 : 1;
+            int increment = stackVersion.getRevision() == 0 ? 1000 : 1;
             var id = TransportVersionId.fromInt(baseUpperBound.definitionId().complete() + increment);
             var definition = new TransportVersionDefinition(initialDefinitionName, List.of(id), false);
             resources.writeDefinition(definition);
             var newUpperBound = new TransportVersionUpperBound(upperBoundName, initialDefinitionName, id);
             resources.writeUpperBound(newUpperBound);
 
-            if (releaseVersion.getRevision() == 0) {
+            if (stackVersion.getRevision() == 0) {
                 Version currentVersion = getCurrentVersion().get();
                 String currentUpperBoundName = getUpperBoundName(currentVersion);
                 var currentUpperBound = new TransportVersionUpperBound(currentUpperBoundName, initialDefinitionName, id);

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

@@ -120,10 +120,19 @@ public void apply(Project project) {
         var generateInitialTask = project.getTasks()
             .register("generateInitialTransportVersion", GenerateInitialTransportVersionTask.class, t -> {
                 t.setGroup(taskGroup);
-                t.setDescription("(Re)generates an initial transport version for an Elasticsearch release version");
+                t.setDescription("Generates an initial transport version for an Elasticsearch release version");
                 t.getCurrentVersion().set(currentVersion);
             });
         validateTask.configure(t -> t.mustRunAfter(generateInitialTask));
+
+        var updateTransportVersionsTask = project.getTasks()
+            .register("updateTransportVersionsCSV", UpdateTransportVersionsCSVTask.class, t -> {
+                t.setGroup(taskGroup);
+                t.setDescription("Updates TransportVersions.csv with a new stack version entry");
+                t.getTransportVersionsFile()
+                    .set(project.getLayout().getProjectDirectory().file("src/main/resources/org/elasticsearch/TransportVersions.csv"));
+            });
+        validateTask.configure(t -> t.mustRunAfter(updateTransportVersionsTask));
     }
 
     private static String getResourceRoot(Project project) {