updates naming & adds UTs to doesMultiTenantIndexExist

Signed-off-by: Brian Flores <[email protected]>

Author: brianf-aws

ml-algorithms/src/main/java/org/opensearch/ml/engine/algorithms/agent/MLAgentExecutor.java

@@ -174,7 +174,7 @@ public void execute(Input input, ActionListener<Output> listener) {
             .fetchSourceContext(fetchSourceContext)
             .build();
 
-        if (MLIndicesHandler.doesMultiTenantIndexExists(clusterService, mlFeatureEnabledSetting.isMultiTenancyEnabled(), ML_AGENT_INDEX)) {
+        if (MLIndicesHandler.doesMultiTenantIndexExist(clusterService, mlFeatureEnabledSetting.isMultiTenancyEnabled(), ML_AGENT_INDEX)) {
             try (ThreadContext.StoredContext context = client.threadPool().getThreadContext().stashContext()) {
                 sdkClient
                     .getDataObjectAsync(getDataObjectRequest, client.threadPool().executor("opensearch_ml_general"))

ml-algorithms/src/main/java/org/opensearch/ml/engine/indices/MLIndicesHandler.java

@@ -33,6 +33,8 @@
 import org.opensearch.ml.common.settings.MLFeatureEnabledSetting;
 import org.opensearch.transport.client.Client;
 
+import com.google.common.annotations.VisibleForTesting;
+
 import lombok.AccessLevel;
 import lombok.RequiredArgsConstructor;
 import lombok.experimental.FieldDefaults;
@@ -65,7 +67,7 @@ public class MLIndicesHandler {
      * @implNote It is recommended that if your environment enables multi tenancy, your plugin indices are
      * pre-populated otherwise this method will result in unwanted early returns without checking the clusterService
      */
-    public static boolean doesMultiTenantIndexExists(ClusterService clusterService, boolean isMultiTenancyEnabled, String indexName) {
+    public static boolean doesMultiTenantIndexExist(ClusterService clusterService, boolean isMultiTenancyEnabled, String indexName) {
         return isMultiTenancyEnabled || clusterService.state().metadata().hasIndex(indexName);
     }
 
@@ -122,7 +124,7 @@ public void initMLIndexIfAbsent(MLIndex index, ActionListener<Boolean> listener)
         String mapping = index.getMapping();
         try (ThreadContext.StoredContext threadContext = client.threadPool().getThreadContext().stashContext()) {
             ActionListener<Boolean> internalListener = ActionListener.runBefore(listener, () -> threadContext.restore());
-            if (!MLIndicesHandler.doesMultiTenantIndexExists(clusterService, mlFeatureEnabledSetting.isMultiTenancyEnabled(), indexName)) {
+            if (!MLIndicesHandler.doesMultiTenantIndexExist(clusterService, mlFeatureEnabledSetting.isMultiTenancyEnabled(), indexName)) {
                 ActionListener<CreateIndexResponse> actionListener = ActionListener.wrap(r -> {
                     if (r.isAcknowledged()) {
                         log.info("create index:{}", indexName);
@@ -237,4 +239,9 @@ public void shouldUpdateIndex(String indexName, Integer newVersion, ActionListen
         listener.onResponse(newVersion > oldVersion);
     }
 
+    @VisibleForTesting
+    public boolean doesIndexExists(String indexName) {
+        return MLIndicesHandler.doesMultiTenantIndexExist(clusterService, mlFeatureEnabledSetting.isMultiTenancyEnabled(), indexName);
+    }
+
 }

ml-algorithms/src/test/java/org/opensearch/ml/engine/indices/MLIndicesHandlerTest.java

@@ -1,6 +1,8 @@
 package org.opensearch.ml.engine.indices;
 
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.ArgumentMatchers.isA;
@@ -11,6 +13,7 @@
 import static org.mockito.Mockito.when;
 import static org.opensearch.ml.common.CommonValue.META;
 import static org.opensearch.ml.common.CommonValue.ML_AGENT_INDEX;
+import static org.opensearch.ml.common.CommonValue.ML_CONFIG_INDEX;
 import static org.opensearch.ml.common.CommonValue.ML_JOBS_INDEX;
 import static org.opensearch.ml.common.CommonValue.ML_MEMORY_MESSAGE_INDEX;
 import static org.opensearch.ml.common.CommonValue.ML_MEMORY_META_INDEX;
@@ -109,6 +112,28 @@ public void setUp() {
         indicesHandler = new MLIndicesHandler(clusterService, client, mlFeatureEnabledSetting);
     }
 
+    @Test
+    public void doesMultiTenantIndexExist_multiTenancyEnabled_returnsTrue() {
+        assertTrue(MLIndicesHandler.doesMultiTenantIndexExist(null, true, null));
+        MLIndicesHandler mlIndicesHandler = new MLIndicesHandler(clusterService, client, mlFeatureEnabledSetting);
+        assertTrue(mlIndicesHandler.doesIndexExists(ML_CONFIG_INDEX));
+    }
+
+    @Test
+    public void doesMultiTenantIndexExist_multiTenancyDisabledSearchesClusterService_returnsValidSearchResult() {
+        assertFalse(MLIndicesHandler.doesMultiTenantIndexExist(clusterService, false, null));
+
+        String sampleIndexName = "test-index";
+        when(mlFeatureEnabledSetting.isMultiTenancyEnabled()).thenReturn(false);
+        MLIndicesHandler mlIndicesHandler = new MLIndicesHandler(clusterService, client, mlFeatureEnabledSetting);
+
+        when(clusterService.state().metadata().hasIndex(sampleIndexName)).thenReturn(true);
+        assertTrue(mlIndicesHandler.doesIndexExists(sampleIndexName));
+
+        when(clusterService.state().metadata().hasIndex(sampleIndexName)).thenReturn(false);
+        assertFalse(mlIndicesHandler.doesIndexExists(sampleIndexName));
+    }
+
     @Test
     public void initMemoryMetaIndex() {
         ActionListener<Boolean> listener = mock(ActionListener.class);

plugin/src/main/java/org/opensearch/ml/action/connector/ExecuteConnectorTransportAction.java

@@ -76,7 +76,7 @@ protected void doExecute(Task task, ActionRequest request, ActionListener<MLTask
         String connectorAction = ConnectorAction.ActionType.EXECUTE.name();
 
         if (MLIndicesHandler
-            .doesMultiTenantIndexExists(clusterService, mlFeatureEnabledSetting.isMultiTenancyEnabled(), ML_CONNECTOR_INDEX)) {
+            .doesMultiTenantIndexExist(clusterService, mlFeatureEnabledSetting.isMultiTenancyEnabled(), ML_CONNECTOR_INDEX)) {
             ActionListener<Connector> listener = ActionListener.wrap(connector -> {
                 if (connectorAccessControlHelper.validateConnectorAccess(client, connector)) {
                     // adding tenantID as null, because we are not implement multi-tenancy for this feature yet.

plugin/src/main/java/org/opensearch/ml/action/handler/MLSearchHandler.java

@@ -138,7 +138,7 @@ public void search(SdkClient sdkClient, SearchRequest request, String tenantId,
                 .wrap(wrappedListener::onResponse, e -> wrapListenerToHandleSearchIndexNotFound(e, wrappedListener));
             if (modelAccessControlHelper.skipModelAccessControl(user)
                 || !MLIndicesHandler
-                    .doesMultiTenantIndexExists(
+                    .doesMultiTenantIndexExist(
                         clusterService,
                         mlFeatureEnabledSetting.isMultiTenancyEnabled(),
                         CommonValue.ML_MODEL_GROUP_INDEX

plugin/src/main/java/org/opensearch/ml/action/tasks/CancelBatchJobTransportAction.java

@@ -201,7 +201,7 @@ private void processRemoteBatchPrediction(MLTask mlTask, ActionListener<MLCancel
                             Connector connector = model.getConnector();
                             executeConnector(connector, mlInput, actionListener);
                         } else if (MLIndicesHandler
-                            .doesMultiTenantIndexExists(
+                            .doesMultiTenantIndexExist(
                                 clusterService,
                                 mlFeatureEnabledSetting.isMultiTenancyEnabled(),
                                 ML_CONNECTOR_INDEX

plugin/src/main/java/org/opensearch/ml/action/tasks/GetTaskTransportAction.java

@@ -392,7 +392,7 @@ private void processRemoteBatchPrediction(
                                             actionListener
                                         );
                                     } else if (MLIndicesHandler
-                                        .doesMultiTenantIndexExists(
+                                        .doesMultiTenantIndexExist(
                                             clusterService,
                                             mlFeatureEnabledSetting.isMultiTenancyEnabled(),
                                             ML_CONNECTOR_INDEX