refactor: Add constants to CreateConnectorStep and update enum usage #535 (#1299)

* refactor: Add constants to CreateConnectorStep and update enum usage

- Add REQUIRED_INPUTS, OPTIONAL_INPUTS, and PROVIDED_OUTPUTS constants to CreateConnectorStep
- Update WorkflowSteps.CREATE_CONNECTOR enum to use constants from CreateConnectorStep class
- Refactor WorkflowStepValidatorTests to use constants instead of magic strings
- Remove code duplication between CreateConnectorStep and WorkflowSteps enum

This follows the same pattern as DeleteIndexStep and addresses issue #535.

Signed-off-by: Nurym <nurym0807@gmail.com>

* Fix formatting, add Javadoc, and remove star imports

Signed-off-by: kokibas <nurym0807@gmail.com>

---------

Signed-off-by: Nurym <nurym0807@gmail.com>
Signed-off-by: kokibas <nurym0807@gmail.com>

Author: kokibas

src/main/java/org/opensearch/flowframework/workflow/CreateConnectorStep.java

@@ -41,6 +41,7 @@
 import static org.opensearch.flowframework.common.CommonValue.PARAMETERS_FIELD;
 import static org.opensearch.flowframework.common.CommonValue.PROTOCOL_FIELD;
 import static org.opensearch.flowframework.common.CommonValue.VERSION_FIELD;
+import static org.opensearch.flowframework.common.WorkflowResources.CONNECTOR_ID;
 import static org.opensearch.flowframework.exception.WorkflowStepException.getSafeException;
 import static org.opensearch.flowframework.util.ParseUtils.getStringToStringMap;
 
@@ -56,6 +57,20 @@ public class CreateConnectorStep implements WorkflowStep {
 
     /** The name of this step, used as a key in the template and the {@link WorkflowStepFactory} */
     public static final String NAME = "create_connector";
+    /** Required input keys */
+    public static final Set<String> REQUIRED_INPUTS = Set.of(
+        NAME_FIELD,
+        DESCRIPTION_FIELD,
+        VERSION_FIELD,
+        PROTOCOL_FIELD,
+        PARAMETERS_FIELD,
+        CREDENTIAL_FIELD,
+        ACTIONS_FIELD
+    );
+    /** Optional input keys */
+    public static final Set<String> OPTIONAL_INPUTS = Collections.emptySet();
+    /** Provided output keys */
+    public static final Set<String> PROVIDED_OUTPUTS = Set.of(CONNECTOR_ID);
 
     /**
      * Instantiate this class
@@ -103,21 +118,10 @@ public void onFailure(Exception ex) {
             }
         };
 
-        Set<String> requiredKeys = Set.of(
-            NAME_FIELD,
-            DESCRIPTION_FIELD,
-            VERSION_FIELD,
-            PROTOCOL_FIELD,
-            PARAMETERS_FIELD,
-            CREDENTIAL_FIELD,
-            ACTIONS_FIELD
-        );
-        Set<String> optionalKeys = Collections.emptySet();
-
         try {
             Map<String, Object> inputs = ParseUtils.getInputsFromPreviousSteps(
-                requiredKeys,
-                optionalKeys,
+                REQUIRED_INPUTS,
+                OPTIONAL_INPUTS,
                 currentNodeInputs,
                 outputs,
                 previousNodeInputs,

src/main/java/org/opensearch/flowframework/workflow/WorkflowStepFactory.java

@@ -23,6 +23,7 @@
 import org.opensearch.threadpool.ThreadPool;
 import org.opensearch.transport.client.Client;
 
+import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.HashMap;
@@ -33,10 +34,7 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
-import static org.opensearch.flowframework.common.CommonValue.ACTIONS_FIELD;
 import static org.opensearch.flowframework.common.CommonValue.CONFIGURATIONS;
-import static org.opensearch.flowframework.common.CommonValue.CREDENTIAL_FIELD;
-import static org.opensearch.flowframework.common.CommonValue.DESCRIPTION_FIELD;
 import static org.opensearch.flowframework.common.CommonValue.DESTINATION_INDEX;
 import static org.opensearch.flowframework.common.CommonValue.EMBEDDING_DIMENSION;
 import static org.opensearch.flowframework.common.CommonValue.FRAMEWORK_TYPE;
@@ -47,9 +45,7 @@
 import static org.opensearch.flowframework.common.CommonValue.MODEL_TYPE;
 import static org.opensearch.flowframework.common.CommonValue.NAME_FIELD;
 import static org.opensearch.flowframework.common.CommonValue.OPENSEARCH_ML;
-import static org.opensearch.flowframework.common.CommonValue.PARAMETERS_FIELD;
 import static org.opensearch.flowframework.common.CommonValue.PIPELINE_ID;
-import static org.opensearch.flowframework.common.CommonValue.PROTOCOL_FIELD;
 import static org.opensearch.flowframework.common.CommonValue.REGISTER_MODEL_STATUS;
 import static org.opensearch.flowframework.common.CommonValue.SOURCE_INDEX;
 import static org.opensearch.flowframework.common.CommonValue.SUCCESS;
@@ -151,8 +147,8 @@ public enum WorkflowSteps {
         /** Create Connector Step */
         CREATE_CONNECTOR(
             CreateConnectorStep.NAME,
-            List.of(NAME_FIELD, DESCRIPTION_FIELD, VERSION_FIELD, PROTOCOL_FIELD, PARAMETERS_FIELD, CREDENTIAL_FIELD, ACTIONS_FIELD),
-            List.of(CONNECTOR_ID),
+            new ArrayList<>(CreateConnectorStep.REQUIRED_INPUTS),
+            new ArrayList<>(CreateConnectorStep.PROVIDED_OUTPUTS),
             List.of(OPENSEARCH_ML),
             TimeValue.timeValueSeconds(60)
         ),

src/test/java/org/opensearch/flowframework/model/WorkflowStepValidatorTests.java

@@ -8,12 +8,11 @@
  */
 package org.opensearch.flowframework.model;
 
+import org.opensearch.flowframework.workflow.CreateConnectorStep;
 import org.opensearch.flowframework.workflow.WorkflowStepFactory;
 import org.opensearch.test.OpenSearchTestCase;
 
 import java.io.IOException;
-import java.util.HashMap;
-import java.util.Map;
 
 public class WorkflowStepValidatorTests extends OpenSearchTestCase {
 
@@ -24,17 +23,14 @@ public void setUp() throws Exception {
 
     public void testParseWorkflowStepValidator() throws IOException {
 
-        Map<String, WorkflowStepValidator> workflowStepValidators = new HashMap<>();
-        workflowStepValidators.put(
-            WorkflowStepFactory.WorkflowSteps.CREATE_CONNECTOR.getWorkflowStepName(),
-            WorkflowStepFactory.WorkflowSteps.CREATE_CONNECTOR.getWorkflowStepValidator()
-        );
+        var step = WorkflowStepFactory.WorkflowSteps.CREATE_CONNECTOR;
 
-        assertEquals(7, WorkflowStepFactory.WorkflowSteps.CREATE_CONNECTOR.inputs().size());
-        assertEquals(1, WorkflowStepFactory.WorkflowSteps.CREATE_CONNECTOR.outputs().size());
+        assertEquals(CreateConnectorStep.NAME, step.getWorkflowStepName());
 
-        assertEquals("name", WorkflowStepFactory.WorkflowSteps.CREATE_CONNECTOR.inputs().get(0));
-        assertEquals("connector_id", WorkflowStepFactory.WorkflowSteps.CREATE_CONNECTOR.outputs().get(0));
+        assertEquals(CreateConnectorStep.REQUIRED_INPUTS.size(), step.inputs().size());
+        assertTrue(step.inputs().containsAll(CreateConnectorStep.REQUIRED_INPUTS));
+        assertEquals(CreateConnectorStep.PROVIDED_OUTPUTS.size(), step.outputs().size());
+        assertTrue(step.outputs().containsAll(CreateConnectorStep.PROVIDED_OUTPUTS));
     }
 
 }