Change how we pick bwc versions to check out (#45189)

Prior to this PR we always checked out the latest bwc branches and had
an external mechanism to store the bwc versions used for every CI run so
we could both reproduce those builds and run additional tests using the
same combination.

This adds complexities in setting up and maintaining CI and makes it
difficult to set up multi jobs.

This change replaces that mechanism with a time based approach
that looks at the commit date of the current revision and picks the
newest on the bwc branch that's still older than that.
It also makes sure there are no merge commits in this interval.

This new behavior will is ment to be enabled in CI only, for everything
except PR checks that will still use last available bwc revision.

distribution/bwc/build.gradle

@@ -89,40 +89,69 @@ bwcVersions.forPreviousUnreleased { BwcVersions.UnreleasedVersionInfo unreleased
         commandLine = ['git', 'fetch', '--all']
     }
 
-    String buildMetadataKey = "bwc_refspec_${project.path.substring(1)}"
-    task checkoutBwcBranch(type: LoggedExec) {
-        String refspec = System.getProperty("tests.bwc.refspec.${bwcBranch}", buildMetadata.get(buildMetadataKey, "${remote}/${bwcBranch}"))
-        dependsOn fetchLatest
+    Closure execGit = {   Action<ExecSpec> action ->
+        new ByteArrayOutputStream().withStream { os ->
+            ExecResult result = project.exec { spec ->
                 workingDir = checkoutDir
-        commandLine = ['git', 'checkout', refspec]
-        doFirst {
-            println "Checking out elasticsearch ${refspec} for branch ${bwcBranch}"
+                standardOutput os
+                action.execute(spec)
+            }
+            result.assertNormalExitValue()
+            return os.toString().trim()
+        }
+    }
+    task checkoutBwcBranch() {
+        dependsOn fetchLatest
+        doLast {
+            String refspec = System.getProperty("tests.bwc.refspec.${bwcBranch}", "${remote}/${bwcBranch}")
+            if (System.getProperty("tests.bwc.checkout.align") != null) {
+                /*
+                    We use a time based approach to make the bwc versions built deterministic and compatible with the current hash.
+                    Most of the time we want to test against latest, but when running delayed exhaustive tests or wanting
+                    reproducible builds we want this to be deterministic by using a hash that was the latest when the current
+                    commit was made.
+
+                    This approach doesn't work with merge commits as these can introduce commits in the chronological order
+                    after the fact e.x. a merge done today can add commits dated with yesterday so the result will no longer be
+                    deterministic.
+
+                    We don't use merge commits, but for additional safety we check that no such commits exist in the time period
+                    we are interested in.
+
+                    Timestamps are at seconds resolution. rev-parse --before and --after are inclusive w.r.t the second
+                    passed as input. This means the results might not be deterministic in the current second, but this
+                    should not matter in practice.
+                */
+                String timeOfCurrent = execGit { spec ->
+                    spec.commandLine 'git', 'show', '--no-patch', '--no-notes', "--pretty='%cD'"
+                    spec.workingDir project.rootDir
+                }
+                logger.lifecycle("Commit date of current: {}", timeOfCurrent)
+                String mergeCommits = execGit { spec ->
+                    spec.commandLine "git", "rev-list", refspec, "--after", timeOfCurrent, "--merges"
+                }
+                if (mergeCommits.isEmpty() == false) {
+                    throw new IllegalStateException(
+                            "Found the following merge commits which prevent determining bwc commits: " + mergeCommits
+                    )
+                }
+                refspec = execGit { spec ->
+                    spec.commandLine "git", "rev-list", refspec, "-n", "1", "--before", timeOfCurrent, "--date-order"
                 }
             }
 
-    File buildMetadataFile = project.file("build/${project.name}/build_metadata")
-    task writeBuildMetadata(type: LoggedExec) {
-        dependsOn checkoutBwcBranch
-        workingDir = checkoutDir
-        commandLine = ['git', 'rev-parse', 'HEAD']
-        ignoreExitValue = true
-        ByteArrayOutputStream output = new ByteArrayOutputStream()
-        standardOutput = output
-        doLast {
-            if (execResult.exitValue != 0) {
-                output.toString('UTF-8').eachLine { line -> logger.error(line) }
-                execResult.assertNormalExitValue()
-            }
-            project.mkdir(buildMetadataFile.parent)
-            String commit = output.toString('UTF-8')
-            buildMetadataFile.setText("${buildMetadataKey}=${commit}", 'UTF-8')
-            println "Checked out elasticsearch commit ${commit}"
+            logger.lifecycle("Checkout hash for ${project.path} is ${refspec}")
+            LoggedExec.exec(project) { spec ->
+                spec.workingDir = checkoutDir
+                spec.commandLine "git", "checkout", refspec
             }
         }
+    }
+
 
     Closure createRunBwcGradleTask = { name, extraConfig ->
         return tasks.create(name: "$name", type: LoggedExec) {
-            dependsOn checkoutBwcBranch, writeBuildMetadata
+            dependsOn checkoutBwcBranch
             spoolOutput = true
             workingDir = checkoutDir
             doFirst {