Merge pull request #25 from API-Flows/components-refactoring

Components refactoring

Author: gcatanese

src/main/java/com/apiflows/model/Components.java

@@ -1,32 +1,43 @@
 package com.apiflows.model;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.v3.oas.models.media.Schema;
 
+import java.util.HashMap;
 import java.util.Map;
 
 public class Components {
 
-    private Map<String, InputComponent> inputs;
-    private Map<String, ParameterComponent> parameters;
+    private Map<String, Schema> inputs = new HashMap<>();
+    private Map<String, Parameter> parameters = new HashMap<>();
 
     // Getters and setters
 
     @JsonProperty("inputs")
-    public Map<String, InputComponent> getInputs() {
+    public Map<String, Schema> getInputs() {
         return inputs;
     }
 
-    public void setInputs(Map<String, InputComponent> inputs) {
+    public void setInputs(Map<String, Schema> inputs) {
         this.inputs = inputs;
     }
 
     @JsonProperty("parameters")
-    public Map<String, ParameterComponent> getParameters() {
+    public Map<String, Parameter> getParameters() {
         return parameters;
     }
 
-    public void setParameters(Map<String, ParameterComponent> parameters) {
+    public void setParameters(Map<String, Parameter> parameters) {
         this.parameters = parameters;
     }
+
+    public void addParameter(String key, Parameter parameter) {
+        this.parameters.put(key, parameter);
+    }
+
+    public void addInput(String key, Schema input) {
+        this.inputs.put(key, input);
+    }
+
 }
 

src/main/java/com/apiflows/model/InputComponent.java

@@ -34,10 +34,11 @@ public OpenAPIWorkflowValidatorResult validate() {
             result.addError("'workflowsSpec' is undefined");
         }
 
+        // Info
         result.addErrors(validateInfo(openAPIWorkflow.getInfo()));
-
+        // SourceDescriptions
         result.addErrors(validateSourceDescriptions(openAPIWorkflow.getSourceDescriptions()));
-
+        // Workflows
         if (openAPIWorkflow.getWorkflows() == null || openAPIWorkflow.getWorkflows().isEmpty()) {
             result.addError("'Workflows' is undefined");
         }
@@ -53,6 +54,8 @@ public OpenAPIWorkflowValidatorResult validate() {
                 }
             }
         }
+        // Components
+        result.addErrors(validateComponents(openAPIWorkflow.getComponents()));
 
         if(!result.getErrors().isEmpty()) {
             result.setValid(false);
@@ -318,6 +321,35 @@ List<String> validateCriterion(Criterion criterion, String stepId) {
         return errors;
     }
 
+    List<String> validateComponents(Components components) {
+        List<String> errors = new ArrayList<>();
+
+        if(components != null) {
+            if (components.getParameters() != null) {
+
+                for(String key : components.getParameters().keySet()) {
+                    if(isValidComponentKey(key)) {
+                        errors.add("'Component parameter " + key + " is invalid (should match regex " + getComponentKeyRegularExpression() + ")");
+                    }
+                }
+
+                for (Parameter parameter : components.getParameters().values()) {
+                    errors.addAll(validateParameter(parameter, "Components"));
+                }
+            }
+            if (components.getInputs() != null) {
+
+                for(String key : components.getInputs().keySet()) {
+                    if(isValidComponentKey(key)) {
+                        errors.add("'Component input " + key + " is invalid (should match regex " + getComponentKeyRegularExpression() + ")");
+                    }
+                }
+
+            }
+        }
+
+        return errors;
+    }
 
     boolean isValidWorkflowId(String workflowId) {
         return Pattern.matches(getWorkflowIdRegularExpression(), workflowId);
@@ -327,13 +359,21 @@ boolean isValidStepId(String stepId) {
         return Pattern.matches(getStepIdRegularExpression(), stepId);
     }
 
+    boolean isValidComponentKey(String key) {
+        return Pattern.matches(getComponentKeyRegularExpression(), key);
+    }
+
     String getStepIdRegularExpression() {
         return "[A-Za-z0-9_\\-]+";
     }
 
     String getWorkflowIdRegularExpression() {
         return "[A-Za-z0-9_\\\\-]++";
     }
+    String getComponentKeyRegularExpression() {
+        return "^[a-zA-Z0-9\\.\\-_]+$";
+    }
+
     boolean isValidOutputsKey(String key) {
         return Pattern.matches(getOutputsKeyRegularExpression(), key);
     }

src/main/java/com/apiflows/model/ParameterComponent.java

@@ -429,6 +429,20 @@ void loadWorkflowIWithDuplicateIds() {
         assertEquals(1, validator.loadWorkflowIds(list).size());
     }
 
+    @Test
+    void validateComponentsParameterInvalidIn() {
+        Parameter parameter = new Parameter()
+                .name("param")
+                .value("1")
+                .in("dummy");
+        String worklowId = "q1";
+
+        Components components = new Components();
+        components.addParameter("param1", parameter);
+
+        assertEquals(1, validator.validateParameter(parameter, worklowId).size());
+    }
+
     @Test
     void loadStepsWithDuplicateIds() {
         List<Workflow> list = List.of(
@@ -460,7 +474,7 @@ void validOutputsKey() {
     }
 
     @Test
-    void inalidOutputsKey() {
+    void invalidOutputsKey() {
         assertFalse(new OpenAPIWorkflowValidator().isValidOutputsKey("$tokenExpires"));
     }
 
@@ -469,4 +483,14 @@ void invalidOutputsKeyWithSpace() {
         assertFalse(new OpenAPIWorkflowValidator().isValidOutputsKey("$token Expires"));
     }
 
+    @Test
+    void validComponentKey() {
+        assertTrue(new OpenAPIWorkflowValidator().isValidComponentKey("pagination"));
+    }
+
+    @Test
+    void invalidComponentKey() {
+        assertFalse(new OpenAPIWorkflowValidator().isValidComponentKey("pagination order"));
+    }
+
 }