[Do not merge]remove ITs to test code coverage

.github/workflows/CI-workflow.yml

@@ -98,102 +98,102 @@ jobs:
           path: ./jacocoTestReport.xml
 
 
-  Test-ml-linux-docker:
-    needs: [Get-Require-Approval, Build-ml-linux, spotless]
-    strategy:
-      matrix:
-        java: [21, 23]
-
-    name: Test MLCommons Plugin on linux docker
-    if: github.repository == 'opensearch-project/ml-commons'
-    environment: ${{ needs.Get-Require-Approval.outputs.is-require-approval }}
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: aws-actions/configure-aws-credentials@v4
-        with:
-          role-to-assume: ${{ secrets.ML_ROLE }}
-          aws-region: us-west-2
-
-      - name: Setup Java ${{ matrix.java }}
-        uses: actions/setup-java@v1
-        with:
-          java-version: ${{ matrix.java }}
-
-      - name: Checkout MLCommons
-        uses: actions/checkout@v4
-        with:
-          ref: ${{ github.event.pull_request.head.sha }}
-
-      - uses: actions/download-artifact@v4
-        with:
-          name: ml-plugin-linux-${{ matrix.java }}
-
-      - name: Pull and Run Docker
-        run: |
-          plugin=${{ needs.Build-ml-linux.outputs.build-test-linux }}
-          version=`echo $plugin|awk -F- '{print $3}'| cut -d. -f 1-3`
-          plugin_version=`echo $plugin|awk -F- '{print $3}'| cut -d. -f 1-4`
-          qualifier=`echo $plugin|awk -F- '{print $4}'| cut -d. -f 1-1`
-
-          if [ -n "$qualifier" ] && [ "$qualifier" != "SNAPSHOT" ]; then
-              qualifier=-${qualifier}
-          else
-              qualifier=""
-          fi
-
-          docker_version=$version$qualifier
-
-          echo plugin version plugin_version qualifier docker_version
-          echo "($plugin) ($version) ($plugin_version) ($qualifier) ($docker_version)"
-
-          pwd && ls -l ./$plugin
-
-          if docker pull opensearchstaging/opensearch:$docker_version
-          then
-            echo "FROM opensearchstaging/opensearch:$docker_version" >> Dockerfile
-            echo "RUN if [ -d /usr/share/opensearch/plugins/opensearch-skills ]; then /usr/share/opensearch/bin/opensearch-plugin remove opensearch-skills; fi" >> Dockerfile
-            echo "RUN if [ -d /usr/share/opensearch/plugins/opensearch-ml ]; then /usr/share/opensearch/bin/opensearch-plugin remove opensearch-ml; fi" >> Dockerfile
-            echo "COPY $plugin /tmp/" >> Dockerfile
-            echo "RUN /usr/share/opensearch/bin/opensearch-plugin install --batch file:/tmp/$plugin" >> Dockerfile
-            docker build -t opensearch-ml:test .
-            echo "imagePresent=true" >> $GITHUB_ENV
-          else
-            echo "imagePresent=false" >> $GITHUB_ENV
-          fi
-      - name: Generate Password For Admin
-        id: genpass
-        run: |
-            PASSWORD=$(openssl rand -base64 20 | tr -dc 'A-Za-z0-9!@#$%^&*()_+=-')
-            echo "password={$PASSWORD}" >> $GITHUB_OUTPUT
-      - name: Run Docker Image
-        if: env.imagePresent == 'true'
-        run: |
-          cd ..
-          docker run -p 9200:9200 -d -p 9600:9600 -e "discovery.type=single-node" -e OPENSEARCH_INITIAL_ADMIN_PASSWORD=${{ steps.genpass.outputs.password }} opensearch-ml:test
-          sleep 90
-      - name: Run MLCommons Test
-        if: env.imagePresent == 'true'
-        run: |
-          security=`curl -XGET https://localhost:9200/_cat/plugins?v -u admin:${{ steps.genpass.outputs.password }} --insecure |grep opensearch-security|wc -l`
-          export OPENAI_KEY=$(aws secretsmanager get-secret-value --secret-id github_openai_key --query SecretString --output text)
-          export COHERE_KEY=$(aws secretsmanager get-secret-value --secret-id github_cohere_key --query SecretString --output text)
-          echo "::add-mask::$OPENAI_KEY"
-          echo "::add-mask::$COHERE_KEY"
-          if [ $security -gt 0 ]
-          then
-            echo "Security plugin is available"
-            ./gradlew integTest -Dtests.rest.cluster=localhost:9200 -Dtests.cluster=localhost:9200 -Dtests.clustername="docker-cluster" -Dhttps=true -Duser=admin -Dpassword=${{ steps.genpass.outputs.password }} -x spotlessJava
-          else
-            echo "Security plugin is NOT available"
-            ./gradlew integTest -Dtests.rest.cluster=localhost:9200 -Dtests.cluster=localhost:9200 -Dtests.clustername="docker-cluster" -x spotlessJava
-          fi
-
-      - name: Upload Coverage Report
-        uses: codecov/codecov-action@v4
-        with:
-          flags: ml-commons
-          token: ${{ secrets.CODECOV_TOKEN }}
+#  Test-ml-linux-docker:
+#    needs: [Get-Require-Approval, Build-ml-linux, spotless]
+#    strategy:
+#      matrix:
+#        java: [21, 23]
+#
+#    name: Test MLCommons Plugin on linux docker
+#    if: github.repository == 'opensearch-project/ml-commons'
+#    environment: ${{ needs.Get-Require-Approval.outputs.is-require-approval }}
+#    runs-on: ubuntu-latest
+#
+#    steps:
+#      - uses: aws-actions/configure-aws-credentials@v4
+#        with:
+#          role-to-assume: ${{ secrets.ML_ROLE }}
+#          aws-region: us-west-2
+#
+#      - name: Setup Java ${{ matrix.java }}
+#        uses: actions/setup-java@v1
+#        with:
+#          java-version: ${{ matrix.java }}
+#
+#      - name: Checkout MLCommons
+#        uses: actions/checkout@v4
+#        with:
+#          ref: ${{ github.event.pull_request.head.sha }}
+#
+#      - uses: actions/download-artifact@v4
+#        with:
+#          name: ml-plugin-linux-${{ matrix.java }}
+#
+#      - name: Pull and Run Docker
+#        run: |
+#          plugin=${{ needs.Build-ml-linux.outputs.build-test-linux }}
+#          version=`echo $plugin|awk -F- '{print $3}'| cut -d. -f 1-3`
+#          plugin_version=`echo $plugin|awk -F- '{print $3}'| cut -d. -f 1-4`
+#          qualifier=`echo $plugin|awk -F- '{print $4}'| cut -d. -f 1-1`
+#
+#          if [ -n "$qualifier" ] && [ "$qualifier" != "SNAPSHOT" ]; then
+#              qualifier=-${qualifier}
+#          else
+#              qualifier=""
+#          fi
+#
+#          docker_version=$version$qualifier
+#
+#          echo plugin version plugin_version qualifier docker_version
+#          echo "($plugin) ($version) ($plugin_version) ($qualifier) ($docker_version)"
+#
+#          pwd && ls -l ./$plugin
+#
+#          if docker pull opensearchstaging/opensearch:$docker_version
+#          then
+#            echo "FROM opensearchstaging/opensearch:$docker_version" >> Dockerfile
+#            echo "RUN if [ -d /usr/share/opensearch/plugins/opensearch-skills ]; then /usr/share/opensearch/bin/opensearch-plugin remove opensearch-skills; fi" >> Dockerfile
+#            echo "RUN if [ -d /usr/share/opensearch/plugins/opensearch-ml ]; then /usr/share/opensearch/bin/opensearch-plugin remove opensearch-ml; fi" >> Dockerfile
+#            echo "COPY $plugin /tmp/" >> Dockerfile
+#            echo "RUN /usr/share/opensearch/bin/opensearch-plugin install --batch file:/tmp/$plugin" >> Dockerfile
+#            docker build -t opensearch-ml:test .
+#            echo "imagePresent=true" >> $GITHUB_ENV
+#          else
+#            echo "imagePresent=false" >> $GITHUB_ENV
+#          fi
+#      - name: Generate Password For Admin
+#        id: genpass
+#        run: |
+#            PASSWORD=$(openssl rand -base64 20 | tr -dc 'A-Za-z0-9!@#$%^&*()_+=-')
+#            echo "password={$PASSWORD}" >> $GITHUB_OUTPUT
+#      - name: Run Docker Image
+#        if: env.imagePresent == 'true'
+#        run: |
+#          cd ..
+#          docker run -p 9200:9200 -d -p 9600:9600 -e "discovery.type=single-node" -e OPENSEARCH_INITIAL_ADMIN_PASSWORD=${{ steps.genpass.outputs.password }} opensearch-ml:test
+#          sleep 90
+#      - name: Run MLCommons Test
+#        if: env.imagePresent == 'true'
+#        run: |
+#          security=`curl -XGET https://localhost:9200/_cat/plugins?v -u admin:${{ steps.genpass.outputs.password }} --insecure |grep opensearch-security|wc -l`
+#          export OPENAI_KEY=$(aws secretsmanager get-secret-value --secret-id github_openai_key --query SecretString --output text)
+#          export COHERE_KEY=$(aws secretsmanager get-secret-value --secret-id github_cohere_key --query SecretString --output text)
+#          echo "::add-mask::$OPENAI_KEY"
+#          echo "::add-mask::$COHERE_KEY"
+#          if [ $security -gt 0 ]
+#          then
+#            echo "Security plugin is available"
+#            ./gradlew integTest -Dtests.rest.cluster=localhost:9200 -Dtests.cluster=localhost:9200 -Dtests.clustername="docker-cluster" -Dhttps=true -Duser=admin -Dpassword=${{ steps.genpass.outputs.password }} -x spotlessJava
+#          else
+#            echo "Security plugin is NOT available"
+#            ./gradlew integTest -Dtests.rest.cluster=localhost:9200 -Dtests.cluster=localhost:9200 -Dtests.clustername="docker-cluster" -x spotlessJava
+#          fi
+#
+#      - name: Upload Coverage Report
+#        uses: codecov/codecov-action@v4
+#        with:
+#          flags: ml-commons
+#          token: ${{ secrets.CODECOV_TOKEN }}
 
   Precommit-codecov:
     needs: Build-ml-linux
@@ -213,44 +213,44 @@ jobs:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: ./jacocoTestReport.xml
 
-  Build-ml-windows:
-    strategy:
-      matrix:
-        java: [21, 23]
-    name: Build and Test MLCommons Plugin on Windows
-    if: github.repository == 'opensearch-project/ml-commons'
-    needs: [Get-Require-Approval, spotless]
-    environment: ${{ needs.Get-Require-Approval.outputs.is-require-approval }}
-    runs-on: windows-latest
-
-    steps:
-      - name: Setup Java ${{ matrix.java }}
-        uses: actions/setup-java@v1
-        with:
-          java-version: ${{ matrix.java }}
-
-      - uses: aws-actions/configure-aws-credentials@v4
-        with:
-          role-to-assume: ${{ secrets.ML_ROLE }}
-          aws-region: us-west-2
-
-      # ml-commons
-      - name: Checkout MLCommons
-        uses: actions/checkout@v4
-        with:
-          ref: ${{ github.event.pull_request.head.sha }}
-
-      - name: Build and Run Tests
-        shell: bash
-        run: |
-          export OPENAI_KEY=$(aws secretsmanager get-secret-value --secret-id github_openai_key --query SecretString --output text)
-          export COHERE_KEY=$(aws secretsmanager get-secret-value --secret-id github_cohere_key --query SecretString --output text)
-          echo "::add-mask::$OPENAI_KEY"
-          echo "::add-mask::$COHERE_KEY"
-          ./gradlew.bat build -x spotlessJava
-      - name: Publish to Maven Local
-        run: |
-          ./gradlew publishToMavenLocal -x spotlessJava
+#  Build-ml-windows:
+#    strategy:
+#      matrix:
+#        java: [21, 23]
+#    name: Build and Test MLCommons Plugin on Windows
+#    if: github.repository == 'opensearch-project/ml-commons'
+#    needs: [Get-Require-Approval, spotless]
+#    environment: ${{ needs.Get-Require-Approval.outputs.is-require-approval }}
+#    runs-on: windows-latest
+#
+#    steps:
+#      - name: Setup Java ${{ matrix.java }}
+#        uses: actions/setup-java@v1
+#        with:
+#          java-version: ${{ matrix.java }}
+#
+#      - uses: aws-actions/configure-aws-credentials@v4
+#        with:
+#          role-to-assume: ${{ secrets.ML_ROLE }}
+#          aws-region: us-west-2
+#
+#      # ml-commons
+#      - name: Checkout MLCommons
+#        uses: actions/checkout@v4
+#        with:
+#          ref: ${{ github.event.pull_request.head.sha }}
+#
+#      - name: Build and Run Tests
+#        shell: bash
+#        run: |
+#          export OPENAI_KEY=$(aws secretsmanager get-secret-value --secret-id github_openai_key --query SecretString --output text)
+#          export COHERE_KEY=$(aws secretsmanager get-secret-value --secret-id github_cohere_key --query SecretString --output text)
+#          echo "::add-mask::$OPENAI_KEY"
+#          echo "::add-mask::$COHERE_KEY"
+#          ./gradlew.bat build -x spotlessJava
+#      - name: Publish to Maven Local
+#        run: |
+#          ./gradlew publishToMavenLocal -x spotlessJava
 #      - name: Multi Nodes Integration Testing
 #        shell: bash
 #        run: |

plugin/build.gradle

@@ -184,9 +184,9 @@ integTest {
     // Only rest case can run with remote cluster
     if (System.getProperty("tests.rest.cluster") != null) {
         filter {
-            includeTestsMatching "org.opensearch.ml.rest.*IT"
+            includeTestsMatching "org.opensearch.ml.tools.VisualizationsToolIT"
             // mock LLM run in localhost, it will not reachable for docker or remote cluster
-            excludeTestsMatching "org.opensearch.ml.tools.VisualizationsToolIT"
+//            excludeTestsMatching "org.opensearch.ml.tools.VisualizationsToolIT"
         }
     }
 
@@ -292,9 +292,9 @@ task integTestRemote(type: RestIntegTestTask) {
     // Only rest case can run with remote cluster
     if (System.getProperty("tests.rest.cluster") != null) {
         filter {
-            includeTestsMatching "org.opensearch.ml.rest.*IT"
+            includeTestsMatching "org.opensearch.ml.tools.VisualizationsToolIT"
             // mock LLM run in localhost, it will not reachable for docker or remote cluster
-            excludeTestsMatching "org.opensearch.ml.tools.VisualizationsToolIT"
+//            excludeTestsMatching "org.opensearch.ml.tools.VisualizationsToolIT"
         }
     }
 }
@@ -381,7 +381,7 @@ jacocoTestCoverageVerification {
             excludes = jacocoExclusions
             limit {
                 counter = 'BRANCH'
-                minimum = 0.7  //TODO: change this value to 0.7
+                minimum = 0.0  //TODO: change this value to 0.7
             }
         }
         rule {
@@ -390,7 +390,7 @@ jacocoTestCoverageVerification {
             limit {
                 counter = 'LINE'
                 value = 'COVEREDRATIO'
-                minimum = 0.8  //TODO: change this value to 0.8
+                minimum = 0.0  //TODO: change this value to 0.8
             }
         }
     }

plugin/src/main/java/org/opensearch/ml/utils/MLNodeUtilsForTesting.java

@@ -0,0 +1,136 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package org.opensearch.ml.utils;
+
+import static org.opensearch.core.xcontent.XContentParserUtils.ensureExpectedToken;
+import static org.opensearch.ml.plugin.MachineLearningPlugin.ML_ROLE_NAME;
+
+import java.io.IOException;
+import java.util.Arrays;
+import java.util.Set;
+import java.util.function.Function;
+
+import org.opensearch.OpenSearchParseException;
+import org.opensearch.cluster.node.DiscoveryNode;
+import org.opensearch.common.xcontent.LoggingDeprecationHandler;
+import org.opensearch.common.xcontent.XContentHelper;
+import org.opensearch.common.xcontent.XContentType;
+import org.opensearch.core.common.breaker.CircuitBreaker;
+import org.opensearch.core.common.breaker.CircuitBreakingException;
+import org.opensearch.core.common.bytes.BytesReference;
+import org.opensearch.core.xcontent.NamedXContentRegistry;
+import org.opensearch.core.xcontent.XContentParser;
+import org.opensearch.ml.breaker.MLCircuitBreakerService;
+import org.opensearch.ml.breaker.ThresholdCircuitBreaker;
+import org.opensearch.ml.stats.MLNodeLevelStat;
+import org.opensearch.ml.stats.MLStats;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.networknt.schema.JsonSchema;
+import com.networknt.schema.JsonSchemaFactory;
+import com.networknt.schema.SpecVersion.VersionFlag;
+import com.networknt.schema.ValidationMessage;
+
+import lombok.experimental.UtilityClass;
+
+@UtilityClass
+public class MLNodeUtilsForTesting {
+    public boolean isMLNode(DiscoveryNode node) {
+        return node.getRoles().stream().anyMatch(role -> role.roleName().equalsIgnoreCase(ML_ROLE_NAME));
+    }
+
+    public static XContentParser createXContentParserFromRegistry(NamedXContentRegistry xContentRegistry, BytesReference bytesReference)
+        throws IOException {
+        return XContentHelper.createParser(xContentRegistry, LoggingDeprecationHandler.INSTANCE, bytesReference, XContentType.JSON);
+    }
+
+    public static void parseArrayField(XContentParser parser, Set<String> set) throws IOException {
+        parseField(parser, set, null, String.class);
+    }
+
+    public static <T> void parseField(XContentParser parser, Set<T> set, Function<String, T> function, Class<T> clazz) throws IOException {
+        ensureExpectedToken(XContentParser.Token.START_ARRAY, parser.currentToken(), parser);
+        while (parser.nextToken() != XContentParser.Token.END_ARRAY) {
+            String value = parser.text();
+            if (function != null) {
+                set.add(function.apply(value));
+            } else {
+                if (clazz.isInstance(value)) {
+                    set.add(clazz.cast(value));
+                }
+            }
+        }
+    }
+
+    public static void validateSchema(String schemaString, String instanceString) throws IOException {
+        ObjectMapper mapper = new ObjectMapper();
+        // parse the schema JSON as string
+        JsonNode schemaNode = mapper.readTree(schemaString);
+        JsonSchema schema = JsonSchemaFactory.getInstance(VersionFlag.V202012).getSchema(schemaNode);
+
+        // JSON data to validate
+        JsonNode jsonNode = mapper.readTree(instanceString);
+
+        // Validate JSON node against the schema
+        Set<ValidationMessage> errors = schema.validate(jsonNode);
+        if (!errors.isEmpty()) {
+            throw new OpenSearchParseException(
+                "Validation failed: "
+                    + Arrays.toString(errors.toArray(new ValidationMessage[0]))
+                    + " for instance: "
+                    + instanceString
+                    + " with schema: "
+                    + schemaString
+            );
+        }
+    }
+
+    /**
+     * This method processes the input JSON string and replaces the string values of the parameters with JSON objects if the string is a valid JSON.
+     * @param inputJson The input JSON string
+     * @return The processed JSON string
+     */
+    public static String processRemoteInferenceInputDataSetParametersValue(String inputJson) throws IOException {
+        ObjectMapper mapper = new ObjectMapper();
+        JsonNode rootNode = mapper.readTree(inputJson);
+
+        if (rootNode.has("parameters") && rootNode.get("parameters").isObject()) {
+            ObjectNode parametersNode = (ObjectNode) rootNode.get("parameters");
+
+            parametersNode.fields().forEachRemaining(entry -> {
+                String key = entry.getKey();
+                JsonNode value = entry.getValue();
+
+                if (value.isTextual()) {
+                    String textValue = value.asText();
+                    try {
+                        // Try to parse the string as JSON
+                        JsonNode parsedValue = mapper.readTree(textValue);
+                        // If successful, replace the string with the parsed JSON
+                        parametersNode.set(key, parsedValue);
+                    } catch (IOException e) {
+                        // If parsing fails, it's not a valid JSON string, so keep it as is
+                        parametersNode.set(key, value);
+                    }
+                }
+            });
+        }
+        return mapper.writeValueAsString(rootNode);
+    }
+
+    public static void checkOpenCircuitBreaker(MLCircuitBreakerService mlCircuitBreakerService, MLStats mlStats) {
+        ThresholdCircuitBreaker openCircuitBreaker = mlCircuitBreakerService.checkOpenCB();
+        if (openCircuitBreaker != null) {
+            mlStats.getStat(MLNodeLevelStat.ML_CIRCUIT_BREAKER_TRIGGER_COUNT).increment();
+            throw new CircuitBreakingException(
+                openCircuitBreaker.getName() + " is open, please check your resources!",
+                CircuitBreaker.Durability.TRANSIENT
+            );
+        }
+    }
+}