Bwc test

.github/workflows/backwards_compatibility_tests_workflow.yml

@@ -0,0 +1,147 @@
+name: Backwards Compatibility Tests NeuralSearch
+on:
+  push:
+    branches:
+      - "*"
+      - "feature/**"
+  pull_request:
+    branches:
+      - "*"
+      - "feature/**"
+
+jobs:
+  Restart-Upgrade-BWCTests-NeuralSearch:
+    strategy:
+      matrix:
+        java: [ 11, 17 ]
+        os: [ubuntu-latest]
+        bwc_version : [ "2.0.1", "2.1.0", "2.2.1", "2.3.0", "2.4.1", "2.5.0", "2.6.0", "2.7.0", "2.8.0", "2.9.0", "2.10.0", "2.11.0-SNAPSHOT"]
+        opensearch_version : [ "3.0.0-SNAPSHOT" ]
+        exclude:
+          - os: windows-latest
+            bwc_version: "2.0.1"
+          - os: windows-latest
+            bwc_version: "2.1.0"
+          - os: windows-latest
+            bwc_version: "2.2.1"
+          - os: windows-latest
+            bwc_version: "2.3.0"
+
+    name: NeuralSearch Restart-Upgrade BWC Tests
+    runs-on: ${{ matrix.os }}
+    env:
+      BWC_VERSION_RESTART_UPGRADE: ${{ matrix.bwc_version }}
+
+    steps:
+      - name: Checkout NeuralSearch
+        uses: actions/checkout@v1
+
+      - name: Setup Java ${{ matrix.java }}
+        uses: actions/setup-java@v1
+        with:
+          java-version: ${{ matrix.java }}
+
+      - if: startsWith(matrix.os,'ubuntu')
+        name: Install dependencies on ubuntu
+        run: |
+          sudo apt-get install libopenblas-dev gfortran -y
+
+      - if: startsWith(matrix.os,'windows')
+        name: Install MinGW Using Scoop on Windows
+        run: |
+          iex "& {$(irm get.scoop.sh)} -RunAsAdmin"
+          scoop bucket add main
+          scoop install mingw
+
+      - if: startsWith(matrix.os,'windows')
+        name: Add MinGW to PATH on Windows
+        run: |
+          echo "C:/Users/runneradmin/scoop/apps/mingw/current/bin" >> $env:GITHUB_PATH
+          refreshenv
+
+      - if: startsWith(matrix.os,'windows')
+        name: Download OpenBLAS on Windows
+        run: |
+          curl -L -O https://github.com/xianyi/OpenBLAS/releases/download/v0.3.21/OpenBLAS-0.3.21-x64.zip
+          mkdir OpenBLAS
+          Expand-Archive -Path .\OpenBLAS-0.3.21-x64.zip -DestinationPath .\OpenBLAS\
+          mkdir ./src/main/resources/windowsDependencies
+          cp ./OpenBLAS/bin/libopenblas.dll ./src/main/resources/windowsDependencies/
+          rm .\OpenBLAS-0.3.21-x64.zip
+          rm -r .\OpenBLAS\
+
+      - if: startsWith(matrix.os,'windows')
+        name: Run NeuralSearch Restart-Upgrade BWC Tests from BWCVersion-${{ matrix.bwc_version }} to OpenSearch Version-${{ matrix.opensearch_version }} on Windows
+        run: |
+          echo "Running restart-upgrade backwards compatibility tests ..."
+          ./gradlew :qa:restart-upgrade:testRestartUpgrade -D'tests.bwc.version=${{ matrix.bwc_version }}'
+
+      - if: startsWith(matrix.os,'ubuntu')
+        name: Run NeuralSearch Restart-Upgrade BWC Tests from BWCVersion-${{ matrix.bwc_version }} to OpenSearch Version-${{ matrix.opensearch_version }} on Ubuntu
+        run: |
+          echo "Running restart-upgrade backwards compatibility tests ..."
+          ./gradlew :qa:restart-upgrade:testRestartUpgrade -Dtests.bwc.version=$BWC_VERSION_RESTART_UPGRADE
+
+
+  Rolling-Upgrade-BWCTests-NeuralSearch:
+    strategy:
+      matrix:
+        java: [ 11, 17 ]
+        os: [ubuntu-latest]
+        bwc_version: [ "2.11.0-SNAPSHOT" ]
+        opensearch_version: [ "3.0.0-SNAPSHOT" ]
+
+    name: NeuralSearch Rolling-Upgrade BWC Tests
+    runs-on: ${{ matrix.os }}
+    env:
+      BWC_VERSION_ROLLING_UPGRADE: ${{ matrix.bwc_version }}
+
+    steps:
+      - name: Checkout NeuralSearch
+        uses: actions/checkout@v1
+
+      - name: Setup Java ${{ matrix.java }}
+        uses: actions/setup-java@v1
+        with:
+          java-version: ${{ matrix.java }}
+
+      - if: startsWith(matrix.os,'ubuntu')
+        name: Install dependencies on ubuntu
+        run: |
+          sudo apt-get install libopenblas-dev gfortran -y
+
+      - if: startsWith(matrix.os,'windows')
+        name: Install MinGW Using Scoop on Windows
+        run: |
+          iex "& {$(irm get.scoop.sh)} -RunAsAdmin"
+          scoop bucket add main
+          scoop install mingw
+
+      - if: startsWith(matrix.os,'windows')
+        name: Add MinGW to PATH on Windows
+        run: |
+          echo "C:/Users/runneradmin/scoop/apps/mingw/current/bin" >> $env:GITHUB_PATH
+          refreshenv
+
+      - if: startsWith(matrix.os,'windows')
+        name: Download OpenBLAS on Windows
+        run: |
+          curl -L -O https://github.com/xianyi/OpenBLAS/releases/download/v0.3.21/OpenBLAS-0.3.21-x64.zip
+          mkdir OpenBLAS
+          Expand-Archive -Path .\OpenBLAS-0.3.21-x64.zip -DestinationPath .\OpenBLAS\
+          mkdir ./src/main/resources/windowsDependencies
+          cp ./OpenBLAS/bin/libopenblas.dll ./src/main/resources/windowsDependencies/
+          rm .\OpenBLAS-0.3.21-x64.zip
+          rm -r .\OpenBLAS\
+
+      - if: startsWith(matrix.os,'windows')
+        name: Run NeuralSearch Rolling-Upgrade BWC Tests from BWCVersion-${{ matrix.bwc_version }} to OpenSearch Version-${{ matrix.opensearch_version }} on Windows
+        run: |
+          echo "Running rolling-upgrade backwards compatibility tests ..."
+          ./gradlew :qa:rolling-upgrade:testRollingUpgrade -D'tests.bwc.version=${{ matrix.bwc_version }}'
+
+      - if: startsWith(matrix.os,'ubuntu')
+        name: Run NeuralSearch Rolling-Upgrade BWC Tests from BWCVersion-${{ matrix.bwc_version }} to OpenSearch Version-${{ matrix.opensearch_version }} on Ubuntu
+        run: |
+          echo "Running rolling-upgrade backwards compatibility tests ..."
+          ./gradlew :qa:rolling-upgrade:testRollingUpgrade -Dtests.bwc.version=$BWC_VERSION_ROLLING_UPGRADE

build.gradle

@@ -11,6 +11,7 @@ import org.opensearch.gradle.test.RestIntegTestTask
 import java.util.concurrent.Callable
 
 apply plugin: 'java'
+apply plugin: 'java-test-fixtures'
 apply plugin: 'idea'
 apply plugin: 'opensearch.opensearchplugin'
 apply plugin: 'opensearch.pluginzip'
@@ -123,6 +124,25 @@ allprojects {
     version = "${opensearch_build}"
     targetCompatibility = JavaVersion.VERSION_11
     sourceCompatibility = JavaVersion.VERSION_11
+    apply from: rootProject.file('repositories.gradle').absoluteFile
+    plugins.withId('java') {
+        sourceCompatibility = targetCompatibility = "11"
+    }
+
+    afterEvaluate {
+        project.dependencyLicenses.enabled = false
+        project.thirdPartyAudit.enabled = false
+        project.loggerUsageCheck.enabled = false
+        project.forbiddenApis.ignoreFailures = true
+        project.forbiddenPatterns {
+            setEnabled(false)
+        }
+        project.testingConventions.enabled = false
+        project.validateNebulaPom.enabled = false
+        project.licenseFile = rootProject.file('LICENSE.txt')
+        project.noticeFile = rootProject.file('NOTICE.txt')
+        project.forbiddenApis.ignoreFailures = true
+    }
 }
 
 repositories {
@@ -145,6 +165,7 @@ dependencies {
     compileOnly fileTree(dir: knnJarDirectory, include: '*.jar')
     api group: 'org.opensearch', name:'opensearch-ml-client', version: "${opensearch_build}"
     implementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.10'
+    testFixturesImplementation "org.opensearch.test:framework:${opensearch_version}"
     // ml-common excluded reflection for runtime so we need to add it by ourselves.
     // https://github.com/opensearch-project/ml-commons/commit/464bfe34c66d7a729a00dd457f03587ea4e504d9
     // TODO: Remove following three lines of dependencies if ml-common include them in their jar
@@ -154,6 +175,10 @@ dependencies {
     runtimeOnly group: 'org.apache.commons', name: 'commons-text', version: '1.10.0'
     runtimeOnly group: 'com.google.code.gson', name: 'gson', version: '2.10.1'
     runtimeOnly group: 'org.json', name: 'json', version: '20231013'
+    testFixturesImplementation "org.opensearch:common-utils:${version}"
+    testFixturesImplementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.10'
+    testFixturesCompileOnly group: 'com.google.guava', name: 'guava', version:'32.0.1-jre'
+    testFixturesCompileOnly fileTree(dir: knnJarDirectory, include: '*.jar')
 }
 
 // In order to add the jar to the classpath, we need to unzip the
@@ -173,6 +198,9 @@ compileJava {
 compileTestJava {
     options.compilerArgs.addAll(["-processor", 'lombok.launch.AnnotationProcessorHider$AnnotationProcessor'])
 }
+compileTestFixturesJava {
+    options.compilerArgs.addAll(["-processor", 'lombok.launch.AnnotationProcessorHider$AnnotationProcessor'])
+}
 
 def opensearch_tmp_dir = rootProject.file('build/private/opensearch_tmp').absoluteFile
 opensearch_tmp_dir.mkdirs()

gradle.properties

@@ -3,6 +3,9 @@
 # SPDX-License-Identifier: Apache-2.0
 #
 
+version=1.0.0
+systemProp.bwc.version=1.3.4
+
 # For fixing Spotless check with Java 17
 org.gradle.jvmargs=--add-exports jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED \
   --add-exports jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED \

qa/build.gradle

@@ -0,0 +1,108 @@
+/*
+ *  Copyright OpenSearch Contributors
+ *  SPDX-License-Identifier: Apache-2.0
+ */
+
+import org.apache.tools.ant.taskdefs.condition.Os
+import java.nio.file.Files
+
+apply plugin: 'opensearch.testclusters'
+apply plugin: 'opensearch.build'
+apply plugin: 'opensearch.rest-test'
+apply plugin: 'io.freefair.lombok'
+
+// Disable a few tasks that come with build
+build.enabled = false
+integTest.enabled = false
+test.enabled = false
+assemble.enabled = false
+dependenciesInfo.enabled = false
+
+dependencies {
+    api "org.opensearch:opensearch:${opensearch_version}"
+    compileOnly group: 'org.opensearch.plugin', name: 'opensearch-knn', version: "${opensearch_build}"
+    api group: 'commons-lang', name: 'commons-lang', version: '2.6'
+    api "org.apache.logging.log4j:log4j-api:${versions.log4j}"
+    api "org.apache.logging.log4j:log4j-core:${versions.log4j}"
+    api "junit:junit:${versions.junit}"
+    testImplementation "org.opensearch.test:framework:${opensearch_version}"
+    testImplementation(testFixtures(rootProject))
+}
+
+ext {
+    licenseFile = rootProject.file('LICENSE.txt')
+    noticeFile = rootProject.file('NOTICE.txt')
+}
+
+def tmp_dir = project.file('build/private/artifact_tmp').absoluteFile
+tmp_dir.mkdirs()
+String default_bwc_version = System.getProperty("bwc.version")
+String neural_search_bwc_version = System.getProperty("tests.bwc.version", default_bwc_version)
+boolean isSnapshot = neural_search_bwc_version.contains("-SNAPSHOT")
+String neural_search_bwc_version_no_qualifier = isSnapshot ? neural_search_bwc_version - "-SNAPSHOT" : neural_search_bwc_version
+
+String os_platform = "linux"
+String artifact_type = "tar"
+String file_ext = "tar.gz"
+
+if (Os.isFamily(Os.FAMILY_WINDOWS)) {
+    os_platform = "windows"
+    artifact_type = "zip"
+    file_ext = "zip"
+}
+
+// Task to pull k-NN plugin from archive
+task pullBwcPlugin {
+    doFirst {
+        File[] tempFiles = tmp_dir.listFiles()
+        for (File child : tempFiles) {
+            if (child.exists() && child.toString().contains("opensearch-")) {
+                Files.delete(child.toPath());
+            }
+        }
+    }
+
+    doLast {
+        ext{
+            if (isSnapshot) {
+                srcUrl = "https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/${neural_search_bwc_version_no_qualifier}/latest/${os_platform}/x64/${artifact_type}/dist/opensearch/opensearch-${neural_search_bwc_version_no_qualifier}-${os_platform}-x64.${file_ext}"
+            } else {
+                srcUrl = "https://artifacts.opensearch.org/releases/bundle/opensearch/${neural_search_bwc_version}/opensearch-${neural_search_bwc_version}-${os_platform}-x64.${file_ext}"
+            }
+        }
+        ant.get(
+                src: srcUrl,
+                dest: tmp_dir.absolutePath,
+                httpusecaches: false
+        )
+        copy {
+            if (Os.isFamily(Os.FAMILY_WINDOWS)) {
+                from zipTree(java.nio.file.Path.of(tmp_dir.absolutePath, "opensearch-${neural_search_bwc_version_no_qualifier}-${os_platform}-x64.${file_ext}"))
+            } else {
+                from tarTree(java.nio.file.Path.of(tmp_dir.absolutePath, "opensearch-${neural_search_bwc_version_no_qualifier}-${os_platform}-x64.${file_ext}"))
+            }
+            into tmp_dir.absolutePath
+        }
+        copy {
+            from(java.nio.file.Path.of(tmp_dir.absolutePath, "opensearch-${neural_search_bwc_version_no_qualifier}", "plugins", "opensearch-neural-search"))
+            into java.nio.file.Path.of(tmp_dir.absolutePath, "opensearch-neural-search")
+        }
+        delete java.nio.file.Path.of(tmp_dir.absolutePath, "opensearch-${neural_search_bwc_version_no_qualifier}"), java.nio.file.Path.of(tmp_dir.absolutePath, "opensearch-${neural_search_bwc_version_no_qualifier}-${os_platform}-x64.${file_ext}")
+    }
+}
+
+// Task to zip plugin from archive
+task zipBwcPlugin(type: Zip) {
+    dependsOn "pullBwcPlugin"
+    from(java.nio.file.Path.of(tmp_dir.absolutePath, "opensearch-neural-search"))
+    destinationDirectory = tmp_dir
+    archiveFileName = "opensearch-neural-search-${neural_search_bwc_version_no_qualifier}.zip"
+    doLast {
+        delete java.nio.file.Path.of(tmp_dir.absolutePath, "opensearch-neural-search")
+    }
+}
+
+task bwcTestSuite {
+    dependsOn ":qa:restart-upgrade:testRestartUpgrade"
+    dependsOn ":qa:rolling-upgrade:testRollingUpgrade"
+}