Update BWC Test Version and Enhance Code Coverage

This PR updates the BWC test version to 2.16 in the build.gradle file and includes additional integration and unit tests to improve code coverage.

Testing Performed:
* Executed gradle build to ensure successful build and integration.

Signed-off-by: Kaituo Li <[email protected]>

.github/workflows/benchmark.yml

@@ -58,12 +58,12 @@ jobs:
               su `id -un 1000` -c "./gradlew ':test' --tests 'org.opensearch.ad.ml.HCADModelPerfTests' \
                 -Dtests.seed=2AEBDBBAE75AC5E0 -Dtests.security.manager=false \
                 -Dtests.locale=es-CU -Dtests.timezone=Chile/EasterIsland -Dtest.logs=true \
-                -Dmodel-benchmark=true"
+                -Dtests.timeoutSuite=3600000! -Dmodel-benchmark=true"
               ;;
             single_stream)
               su `id -un 1000` -c "./gradlew integTest --tests 'org.opensearch.ad.e2e.SingleStreamModelPerfIT' \
                 -Dtests.seed=60CDDB34427ACD0C -Dtests.security.manager=false \
                 -Dtests.locale=kab-DZ -Dtests.timezone=Asia/Hebron -Dtest.logs=true \
-                -Dmodel-benchmark=true"
+                -Dtests.timeoutSuite=3600000! -Dmodel-benchmark=true"
               ;;
           esac

.github/workflows/test_security.yml

@@ -37,9 +37,9 @@ jobs:
       - name: Pull and Run Docker
         run: |
           plugin=`basename $(ls build/distributions/*.zip)`
-          version=`echo $plugin|awk -F- '{print $5}'| cut -d. -f 1-3`
-          plugin_version=`echo $plugin|awk -F- '{print $5}'| cut -d. -f 1-4`
-          qualifier=`echo $plugin|awk -F- '{print $6}'| cut -d. -f 1-1`
+          version=`echo $plugin|awk -F- '{print $4}'| cut -d. -f 1-3`
+          plugin_version=`echo $plugin|awk -F- '{print $4}'| cut -d. -f 1-4`
+          qualifier=`echo $plugin|awk -F- '{print $5}'| cut -d. -f 1-1`
 
           if $qualifier!=SNAPSHOT
           then

build-tools/coverage.gradle

@@ -0,0 +1,49 @@
+/*
+ *  Copyright OpenSearch Contributors
+ *  SPDX-License-Identifier: Apache-2.0
+ */
+
+apply plugin: 'jacoco'
+
+jacoco {
+    toolVersion = "0.8.10"
+}
+
+/**
+ * This code sets up coverage reporting manually for the k-NN plugin tests. This is complicated because:
+ *  1. The OS integTest Task doesn't implement Gradle's JavaForkOptions so we have to manually start the jacoco agent with the test JVM
+ *  2. The cluster nodes are stopped using 'kill -9' which means jacoco can't dump it's execution output to a file on VM shutdown
+ *  3. The Java Security Manager prevents JMX from writing execution output to the file.
+ *
+ *  To workaround these we start the cluster with jmx enabled and then use Jacoco's JMX MBean to get the execution data before the
+ *  cluster is stopped and dump it to a file. Luckily our current security policy seems to allow this. This will also probably
+ *  break if there are multiple nodes in the integTestCluster. But for now... it sorta works.
+ */
+integTest {
+    jacoco {
+        jmx = true
+    }
+
+    systemProperty 'jacoco.dir', project.layout.buildDirectory.get().file("jacoco").asFile.absolutePath
+    systemProperty 'jmx.serviceUrl', "service:jmx:rmi:///jndi/rmi://127.0.0.1:7777/jmxrmi"
+}
+
+jacocoTestReport {
+    dependsOn integTest, test
+    executionData.from = [integTest.jacoco.destinationFile, test.jacoco.destinationFile]
+    reports {
+        html.getRequired().set(true) // human readable
+        csv.getRequired().set(true)
+        xml.getRequired().set(true) // for coverlay
+    }
+}
+
+testClusters.integTest {
+    jvmArgs " ${integTest.jacoco.getAsJvmArg()}"
+
+    systemProperty 'com.sun.management.jmxremote', "true"
+    systemProperty 'com.sun.management.jmxremote.authenticate', "false"
+    systemProperty 'com.sun.management.jmxremote.port', "7777"
+    systemProperty 'com.sun.management.jmxremote.ssl', "false"
+    systemProperty 'java.rmi.server.hostname', "127.0.0.1"
+}

build.gradle

@@ -35,7 +35,7 @@ buildscript {
         js_resource_folder = "src/test/resources/job-scheduler"
         common_utils_version = System.getProperty("common_utils.version", opensearch_build)
         job_scheduler_version = System.getProperty("job_scheduler.version", opensearch_build)
-        bwcVersionShort = "2.15.0"
+        bwcVersionShort = "2.16.0"
         bwcVersion = bwcVersionShort + ".0"
         bwcOpenSearchADDownload = 'https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/' + bwcVersionShort + '/latest/linux/x64/tar/builds/' +
                 'opensearch/plugins/opensearch-anomaly-detection-' + bwcVersion + '.zip'
@@ -662,6 +662,13 @@ task release(type: Copy, group: 'build') {
     eachFile { it.path = it.path - "opensearch/" }
 }
 
+def usingRemoteCluster = System.properties.containsKey('tests.rest.cluster') || System.properties.containsKey('tests.cluster')
+def usingMultiNode = project.properties.containsKey('numNodes')
+// Only apply jacoco test coverage if we are running a local single node cluster
+if (!usingRemoteCluster && !usingMultiNode) {
+    apply from: 'build-tools/coverage.gradle'
+}
+
 List<String> jacocoExclusions = [
         // code for configuration, settings, etc is excluded from coverage
         'org.opensearch.timeseries.TimeSeriesAnalyticsPlugin',
@@ -701,6 +708,8 @@ List<String> jacocoExclusions = [
 
 
 jacocoTestCoverageVerification {
+    dependsOn(jacocoTestReport)
+    executionData.from = [integTest.jacoco.destinationFile, test.jacoco.destinationFile]
     violationRules {
         rule {
             element = 'CLASS'
@@ -722,13 +731,6 @@ jacocoTestCoverageVerification {
     }
 }
 
-jacocoTestReport {
-    reports {
-        xml.required = true // for coverlay
-        html.required = true // human readable
-    }
-}
-
 check.dependsOn jacocoTestCoverageVerification
 jacocoTestCoverageVerification.dependsOn jacocoTestReport
 

src/main/java/org/opensearch/forecast/settings/ForecastEnabledSetting.java

@@ -27,7 +27,8 @@ public class ForecastEnabledSetting extends DynamicNumericSetting {
      */
     public static final String FORECAST_ENABLED = "plugins.forecast.enabled";
 
-    public static final boolean enabled = false;
+    // TODO: remove the field when releasing forecasting
+    public static boolean enabled = false;
 
     public static final Map<String, Setting<?>> settings = unmodifiableMap(new HashMap<String, Setting<?>>() {
         {
@@ -55,8 +56,10 @@ public static synchronized ForecastEnabledSetting getInstance() {
      * @return whether forecasting is enabled.
      */
     public static boolean isForecastEnabled() {
-        // return ForecastEnabledSetting.getInstance().getSettingValue(ForecastEnabledSetting.FORECAST_ENABLED);
+        // keep the dynamic setting in main branch to enable writing tests.
+        // will make it hardcoded false in the 2.x branch.
+        return ForecastEnabledSetting.getInstance().getSettingValue(ForecastEnabledSetting.FORECAST_ENABLED);
         // TODO: enable forecasting before released
-        return enabled;
+        // return enabled;
     }
 }

src/main/java/org/opensearch/timeseries/JobProcessor.java

@@ -579,5 +579,9 @@ private void releaseLock(Job jobParameter, LockService lockService, LockModel lo
             );
     }
 
+    public Integer getEndRunExceptionCount(String configId) {
+        return endRunExceptionCount.getOrDefault(configId, 0);
+    }
+
     protected abstract ResultRequest createResultRequest(String configID, long start, long end);
 }

src/test/java/org/opensearch/action/admin/indices/mapping/get/IndexAnomalyDetectorActionHandlerTests.java

@@ -122,8 +122,6 @@ public void setUp() throws Exception {
         clientUtil = new SecurityClientUtil(nodeStateManager, settings);
         transportService = mock(TransportService.class);
 
-        // channel = mock(ActionListener.class);
-
         anomalyDetectionIndices = mock(ADIndexManagement.class);
         when(anomalyDetectionIndices.doesConfigIndexExist()).thenReturn(true);