Add backwards compatibility tests for SQL

.github/workflows/sql-test-and-build-workflow.yml

@@ -21,6 +21,9 @@ jobs:
  - name: Build with Gradle
  run: ./gradlew build assemble -Dopensearch.version=${{ env.OPENSEARCH_VERSION }}
 
+ - name: Run backward compatibility tests
+ run: ./bwctest.sh
+
  - name: Create Artifact Path
  run: |
  mkdir -p opensearch-sql-builds

.gitignore

@@ -10,7 +10,7 @@
 .project
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
-/bin/
+bin/
 /target/
 log/
 elasticsearch-sql.iml

bwctest.sh

@@ -0,0 +1,58 @@
+#!/bin/bash
+
+set -e
+
+function usage() {
+ echo ""
+ echo "This script is used to run Backwards Compatibility tests"
+ echo "--------------------------------------------------------------------------"
+ echo "Usage: $0 [args]"
+ echo ""
+ echo "Required arguments:"
+ echo "None"
+ echo ""
+ echo -e "-h\tPrint this message."
+ echo "--------------------------------------------------------------------------"
+}
+
+while getopts ":h" arg; do
+ case $arg in
+ h)
+ usage
+ exit 1
+ ;;
+ ?)
+ echo "Invalid option: -${OPTARG}"
+ exit 1
+ ;;
+ esac
+done
+
+# Place SQL artifact for the current version for bwc
+function setup_bwc_artifact() {
+ # This gets opensearch version from build.gradle (e.g. 1.2.0-SNAPSHOT),
+ # then converts to plugin version by appending ".0" (e.g. 1.2.0.0-SNAPSHOT),
+ # assuming one line in build.gradle is 'opensearch_version= System.getProperty("opensearch.version", "<opensearch_version>")'.
+ plugin_version=$(grep 'opensearch_version = System.getProperty' build.gradle | \
+ grep -o '[0-9]\+\.[0-9]\+\.[0-9]\+[^"]*' | sed -e 's/\([0-9]\)\([^0-9]*\)$/\1.0\2/')
+ plugin_artifact="./plugin/build/distributions/opensearch-sql-$plugin_version.zip"
+ bwc_artifact_dir="./integ-test/src/test/resources/bwc/$plugin_version"
+
+ if [ -z "${plugin_version// }" ]; then
+ echo "Error: failed to retrieve plugin version from build.gradle." >&2
+ exit 1
+ fi
+
+ # copy current artifact to bwc artifact directory if it's not there
+ if [ ! -f "$bwc_artifact_dir/opensearch-sql-$plugin_version.zip" ]; then
+ if [ ! -f "$plugin_artifact" ]; then
+ ./gradlew assemble
+ fi
+ mkdir -p "$bwc_artifact_dir"
+ cp "$plugin_artifact" "$bwc_artifact_dir"
+ fi
+}
+
+setup_bwc_artifact
+./gradlew bwcTestSuite -Dtests.security.manager=false
+

integ-test/build.gradle

@@ -24,6 +24,9 @@
 
 import org.gradle.nativeplatform.platform.internal.DefaultNativePlatform
 import org.opensearch.gradle.test.RestIntegTestTask
+import org.opensearch.gradle.testclusters.StandaloneRestIntegTestTask
+
+import java.util.concurrent.Callable
 
 apply plugin: 'opensearch.build'
 apply plugin: 'opensearch.rest-test'
@@ -88,6 +91,9 @@ compileTestJava {
 
 testClusters.all {
  testDistribution = 'archive'
+}
+
+testClusters.integTest {
  plugin ":plugin"
 }
 
@@ -113,6 +119,12 @@ integTest {
  jvmArgs '-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=*:5005'
  }
 
+ if (System.getProperty("tests.rest.bwcsuite") == null) {
+ filter {
+ excludeTestsMatching "org.opensearch.sql.bwc.*IT"
+ }
+ }
+
  exclude 'org/opensearch/sql/doctest/**/*IT.class'
  exclude 'org/opensearch/sql/correctness/**'
 
@@ -138,7 +150,7 @@ task docTest(type: RestIntegTestTask) {
 
  // Tell the test JVM if the cluster JVM is running under a debugger so that tests can use longer timeouts for
  // requests. The 'doFirst' delays reading the debug setting on the cluster till execution time.
- doFirst { systemProperty 'cluster.debug', getDebug()}
+ doFirst { systemProperty 'cluster.debug', getDebug() }
 
  if (System.getProperty("test.debug") != null) {
  jvmArgs '-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=*:5005'
@@ -159,7 +171,7 @@ task comparisonTest(type: RestIntegTestTask) {
 
  // Tell the test JVM if the cluster JVM is running under a debugger so that tests can use longer timeouts for
  // requests. The 'doFirst' delays reading the debug setting on the cluster till execution time.
- doFirst { systemProperty 'cluster.debug', getDebug()}
+ doFirst { systemProperty 'cluster.debug', getDebug() }
 
  if (System.getProperty("test.debug") != null) {
  jvmArgs '-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=*:5005'
@@ -180,7 +192,7 @@ task comparisonTest(type: RestIntegTestTask) {
  systemProperty "queries", System.getProperty("queries")
 }
 
-task compileJdbc(type:Exec) {
+task compileJdbc(type: Exec) {
  workingDir '../sql-jdbc/'
 
  if (DefaultNativePlatform.getCurrentOperatingSystem().isWindows()) {
@@ -192,6 +204,146 @@ task compileJdbc(type:Exec) {
  }
 }
 
+String bwcVersion = "1.13.2.0";
+String baseName = "sqlBwcCluster"
+String bwcFilePath = "src/test/resources/bwc/"
+
+2.times { i ->
+ testClusters {
+ "${baseName}$i" {
+ testDistribution = "ARCHIVE"
+ versions = ["7.10.2", "1.2.1-SNAPSHOT"]
+ numberOfNodes = 3
+ plugin(provider(new Callable<RegularFile>() {
+ @Override
+ RegularFile call() throws Exception {
+ return new RegularFile() {
+ @Override
+ File getAsFile() {
+ return fileTree(bwcFilePath + bwcVersion).getSingleFile()
+ }
+ }
+ }
+ }))
+ setting 'path.repo', "${buildDir}/cluster/shared/repo/${baseName}"
+ setting 'http.content_type.required', 'true'
+ }
+ }
+}
+
+List<Provider<RegularFile>> plugins = [
+ provider(new Callable<RegularFile>() {
+ @Override
+ RegularFile call() throws Exception {
+ return new RegularFile() {
+ @Override
+ File getAsFile() {
+ return fileTree(bwcFilePath + project.version).getSingleFile()
+ }
+ }
+ }
+ })
+]
+
+// Creates 2 test clusters with 3 nodes of the old version.
+2.times { i ->
+ task "${baseName}#oldVersionClusterTask$i"(type: StandaloneRestIntegTestTask) {
+ useCluster testClusters."${baseName}$i"
+ filter {
+ includeTestsMatching "org.opensearch.sql.bwc.*IT"
+ }
+ systemProperty 'tests.rest.bwcsuite', 'old_cluster'
+ systemProperty 'tests.rest.bwcsuite_round', 'old'
+ systemProperty 'tests.plugin_bwc_version', bwcVersion
+ nonInputProperties.systemProperty('tests.rest.cluster', "${-> testClusters."${baseName}$i".allHttpSocketURI.join(",")}")
+ nonInputProperties.systemProperty('tests.clustername', "${-> testClusters."${baseName}$i".getName()}")
+ }
+}
+
+// Upgrade one node of the old cluster to new OpenSearch version with upgraded plugin version.
+// This results in a mixed cluster with 2 nodes on the old version and 1 upgraded node.
+// This is also used as a one third upgraded cluster for a rolling upgrade.
+task "${baseName}#mixedClusterTask"(type: StandaloneRestIntegTestTask) {
+ useCluster testClusters."${baseName}0"
+ dependsOn "${baseName}#oldVersionClusterTask0"
+ doFirst {
+ testClusters."${baseName}0".upgradeNodeAndPluginToNextVersion(plugins)
+ }
+ filter {
+ includeTestsMatching "org.opensearch.sql.bwc.*IT"
+ }
+ systemProperty 'tests.rest.bwcsuite', 'mixed_cluster'
+ systemProperty 'tests.rest.bwcsuite_round', 'first'
+ systemProperty 'tests.plugin_bwc_version', bwcVersion
+ nonInputProperties.systemProperty('tests.rest.cluster', "${-> testClusters."${baseName}0".allHttpSocketURI.join(",")}")
+ nonInputProperties.systemProperty('tests.clustername', "${-> testClusters."${baseName}0".getName()}")
+}
+
+// Upgrade the second node to new OpenSearch version with upgraded plugin version after the first node is upgraded.
+// This results in a mixed cluster with 1 node on the old version and 2 upgraded nodes.
+// This is used for rolling upgrade.
+task "${baseName}#twoThirdsUpgradedClusterTask"(type: StandaloneRestIntegTestTask) {
+ dependsOn "${baseName}#mixedClusterTask"
+ useCluster testClusters."${baseName}0"
+ doFirst {
+ testClusters."${baseName}0".upgradeNodeAndPluginToNextVersion(plugins)
+ }
+ filter {
+ includeTestsMatching "org.opensearch.sql.bwc.*IT"
+ }
+ systemProperty 'tests.rest.bwcsuite', 'mixed_cluster'
+ systemProperty 'tests.rest.bwcsuite_round', 'second'
+ systemProperty 'tests.plugin_bwc_version', bwcVersion
+ nonInputProperties.systemProperty('tests.rest.cluster', "${-> testClusters."${baseName}0".allHttpSocketURI.join(",")}")
+ nonInputProperties.systemProperty('tests.clustername', "${-> testClusters."${baseName}0".getName()}")
+}
+
+// Upgrade the third node to new OpenSearch version with upgraded plugin version after the second node is upgraded.
+// This results in a fully upgraded cluster.
+// This is used for rolling upgrade.
+task "${baseName}#rollingUpgradeClusterTask"(type: StandaloneRestIntegTestTask) {
+ dependsOn "${baseName}#twoThirdsUpgradedClusterTask"
+ useCluster testClusters."${baseName}0"
+ doFirst {
+ testClusters."${baseName}0".upgradeNodeAndPluginToNextVersion(plugins)
+ }
+ filter {
+ includeTestsMatching "org.opensearch.sql.bwc.*IT"
+ }
+ mustRunAfter "${baseName}#mixedClusterTask"
+ systemProperty 'tests.rest.bwcsuite', 'mixed_cluster'
+ systemProperty 'tests.rest.bwcsuite_round', 'third'
+ systemProperty 'tests.plugin_bwc_version', bwcVersion
+ nonInputProperties.systemProperty('tests.rest.cluster', "${-> testClusters."${baseName}0".allHttpSocketURI.join(",")}")
+ nonInputProperties.systemProperty('tests.clustername', "${-> testClusters."${baseName}0".getName()}")
+}
+
+// Upgrade all the nodes of the old cluster to new OpenSearch version with upgraded plugin version
+// at the same time resulting in a fully upgraded cluster.
+task "${baseName}#fullRestartClusterTask"(type: StandaloneRestIntegTestTask) {
+ dependsOn "${baseName}#oldVersionClusterTask1"
+ useCluster testClusters."${baseName}1"
+ doFirst {
+ testClusters."${baseName}1".upgradeAllNodesAndPluginsToNextVersion(plugins)
+ }
+ filter {
+ includeTestsMatching "org.opensearch.sql.bwc.*IT"
+ }
+ systemProperty 'tests.rest.bwcsuite', 'upgraded_cluster'
+ systemProperty 'tests.plugin_bwc_version', bwcVersion
+ nonInputProperties.systemProperty('tests.rest.cluster', "${-> testClusters."${baseName}1".allHttpSocketURI.join(",")}")
+ nonInputProperties.systemProperty('tests.clustername', "${-> testClusters."${baseName}1".getName()}")
+}
+
+// A bwc test suite which runs all the bwc tasks combined
+task bwcTestSuite(type: StandaloneRestIntegTestTask) {
+ exclude '**/*Test*'
+ exclude '**/*IT*'
+ dependsOn tasks.named("${baseName}#mixedClusterTask")
+ dependsOn tasks.named("${baseName}#rollingUpgradeClusterTask")
+ dependsOn tasks.named("${baseName}#fullRestartClusterTask")
+}
+
 def opensearch_tmp_dir = rootProject.file('build/private/es_tmp').absoluteFile
 opensearch_tmp_dir.mkdirs()
 

integ-test/lombok.config

@@ -1,2 +1,3 @@
 # This file is generated by the 'io.freefair.lombok' Gradle plugin
 config.stopBubbling = true
+lombok.addLombokGeneratedAnnotation = true