Merge pull request #45 from API-Flows/arazzo-refactor-components

gcatanese · web-flow · commit 1beaecf70c97 · 2024-06-03T17:39:05.000+02:00
Arazzo refactor components
diff --git a/src/main/java/com/apiflows/model/Components.java b/src/main/java/com/apiflows/model/Components.java
@@ -10,6 +10,8 @@ public class Components {
 
     private Map<String, Schema> inputs = new HashMap<>();
     private Map<String, Parameter> parameters = new HashMap<>();
+    private Map<String, SuccessAction> successActions = new HashMap<>();
+    private Map<String, FailureAction> failureActions = new HashMap<>();
 
     // Getters and setters
 
@@ -39,5 +41,27 @@ public void addInput(String key, Schema input) {
         this.inputs.put(key, input);
     }
 
+    @JsonProperty("successActions")
+    public Map<String, SuccessAction> getSuccessActions() {
+        return successActions;
+    }
+
+    public void setSuccessActions(Map<String, SuccessAction> successActions) {
+        this.successActions = successActions;
+    }
+
+    @JsonProperty("failureActions")
+    public Map<String, FailureAction> getFailureActions() {
+        return failureActions;
+    }
+
+    public void setFailureActions(Map<String, FailureAction> failureActions) {
+        this.failureActions = failureActions;
+    }
+
+    public Components parameter(String key, Parameter parameter) {
+        this.addParameter(key, parameter);
+        return this;
+    }
 }
 
diff --git a/src/main/java/com/apiflows/model/Parameter.java b/src/main/java/com/apiflows/model/Parameter.java
@@ -7,7 +7,7 @@ public class Parameter {
     private String name;
     private String in;
     private String value;
-    private String style;
+    private String reference;
 
     @JsonProperty("name")
     public String getName() {
@@ -36,12 +36,13 @@ public void setValue(String value) {
         this.value = value;
     }
 
-    public String getStyle() {
-        return style;
+    @JsonProperty("reference")
+    public String getReference() {
+        return reference;
     }
 
-    public void setStyle(String style) {
-        this.style = style;
+    public void setReference(String reference) {
+        this.reference = reference;
     }
 
     public Parameter name(String name) {
@@ -59,8 +60,8 @@ public Parameter value(String value) {
         return this;
     }
 
-    public Parameter style(String style) {
-        this.style = style;
+    public Parameter reference(String reference) {
+        this.reference = reference;
         return this;
     }
 
diff --git a/src/main/java/com/apiflows/model/SourceDescription.java b/src/main/java/com/apiflows/model/SourceDescription.java
@@ -39,8 +39,8 @@ public boolean isOpenApi() {
         return "openapi".equals(this.type);
     }
 
-    public boolean isWorkflowsSpec() {
-        return "workflowsSpec".equals(this.type);
+    public boolean isArazzo() {
+        return "arazzo".equals(this.type);
     }
 
     public SourceDescription name(String name) {
diff --git a/src/main/java/com/apiflows/parser/OpenAPIWorkflowValidator.java b/src/main/java/com/apiflows/parser/OpenAPIWorkflowValidator.java
@@ -13,7 +13,8 @@ public class OpenAPIWorkflowValidator {
     Set<String> workflowIds = new HashSet<>();
     Map<String, Set<String>> stepIds = new HashMap<>();
     Set<String> operationIds = new HashSet<>();
-    Set<Schema> components = new HashSet<>();
+    Set<String> componentIds = new HashSet<>();
+    Components components = null;
 
     OpenAPIWorkflowValidator() {
     }
@@ -31,11 +32,12 @@ public OpenAPIWorkflowValidatorResult validate() {
         loadWorkflowIds(this.openAPIWorkflow);
         loadStepIds(this.openAPIWorkflow.getWorkflows());
         loadOperationIds(this.openAPIWorkflow);
+        loadComponents(this.openAPIWorkflow.getComponents());
 
         OpenAPIWorkflowValidatorResult result = new OpenAPIWorkflowValidatorResult();
         
         if (openAPIWorkflow.getArazzo() == null || openAPIWorkflow.getArazzo().isEmpty()) {
-            result.addError("'workflowsSpec' is undefined");
+            result.addError("'arazzo' is undefined");
         }
 
         // Info
@@ -85,7 +87,7 @@ List<String> validateInfo(Info info) {
     }
 
     List<String> validateSourceDescriptions(List<SourceDescription> sourceDescriptions) {
-        List<String> SUPPORTED_TYPES = Arrays.asList("openapi", "workflowsSpec");
+        List<String> SUPPORTED_TYPES = Arrays.asList("openapi", "arazzo");
 
         List<String> errors = new ArrayList<>();
 
@@ -171,15 +173,18 @@ List<String> validateStep(Step step, String workflowId ) {
 
         if(step.getParameters() != null) {
             for(Parameter parameter : step.getParameters()) {
-                if(isRuntimeExpression(parameter.getName())) {
+                if(isRuntimeExpression(parameter.getReference())) {
+                    // reference a reusable object
                     errors.addAll(validateReusableParameter(parameter, workflowId, null));
                 } else {
+                    // parameter
                     errors.addAll(validateParameter(parameter, workflowId, null));
-                }
-                if(step.getWorkflowId() == null) {
-                    // when the step in context is NOT a workflowId the parameter IN must be defined
-                    if(!isRuntimeExpression(parameter.getName()) && parameter.getIn() == null) {
-                        errors.add("'Workflow[" + workflowId + "]' parameter IN must be defined");
+
+                    if(step.getWorkflowId() == null) {
+                        // when the step in context is NOT a workflowId the parameter IN must be defined
+                        if(!isRuntimeExpression(parameter.getName()) && parameter.getIn() == null) {
+                            errors.add("'Workflow[" + workflowId + "]' parameter IN must be defined");
+                        }
                     }
                 }
             }
@@ -212,7 +217,7 @@ List<String> validateStep(Step step, String workflowId ) {
     }
 
     List<String> validateParameter(Parameter parameter, String workflowId, String componentName) {
-        List<String> SUPPORTED_VALUES = Arrays.asList("path", "query", "header", "cookie", "body", "workflow");
+        List<String> SUPPORTED_VALUES = Arrays.asList("path", "query", "header", "cookie", "body");
 
         String source;
 
@@ -264,19 +269,18 @@ List<String> validateReusableParameter(Parameter parameter, String workflowId, S
             source = "Component[" + componentName + "]";
         }
 
-        List<String> errors = new ArrayList<>();
-
-        if(isRuntimeExpression(parameter.getName())) {
-            // Reusable Parameter object
-            String name = parameter.getName();
-
-            if(parameter.getIn() != null) {
-                errors.add(source +  "parameter " + name + " in (" + parameter.getIn() + ") should not be provided for a Reusable Parameter Object");
-            }
+        // reference to reusable object
+        String reference = parameter.getReference();
+        // normalize reference
+        String key = reference.replace("$components.parameters.", "");
 
-            // TODO: check reusable parameter exists in Components
+        List<String> errors = new ArrayList<>();
 
+        // check reusable parameter exists in Components
+        if(!this.components.getParameters().containsKey(key)) {
+            errors.add(source + " parameter '" + reference + "' not found");
         }
+
         return errors;
     }
 
@@ -447,14 +451,13 @@ String getOutputsKeyRegularExpression() {
     List<String> loadWorkflowIds(OpenAPIWorkflow openAPIWorkflow) {
         List<String> errors = new ArrayList<>();
 
-        boolean multipleWorkflowsSpec = getNumWorkflowsSpecSourceDescriptions(openAPIWorkflow.getSourceDescriptions()) > 1 ? true : false;
-
+        boolean multipleSpecs = getNumArazzoTypeSourceDescriptions(openAPIWorkflow.getSourceDescriptions()) > 1 ? true : false;
 
         if(openAPIWorkflow.getWorkflows() != null) {
             validateWorkflowIdsUniqueness(openAPIWorkflow.getWorkflows());
 
             for (Workflow workflow : openAPIWorkflow.getWorkflows()) {
-                errors.addAll(validateStepsWorkflowIds(workflow.getSteps(), multipleWorkflowsSpec));
+                errors.addAll(validateStepsWorkflowIds(workflow.getSteps(), multipleSpecs));
             }
 
             for (Workflow workflow : openAPIWorkflow.getWorkflows()) {
@@ -508,6 +511,10 @@ List<String> loadOperationIds(OpenAPIWorkflow openAPIWorkflow) {
         return errors;
     }
 
+    void loadComponents(Components components) {
+        this.components = components;
+    }
+
     public List<String> validateStepsOperationIds(List<Step> steps, boolean multipleOpenApiFiles) {
         List<String> errors = new ArrayList<>();
 
@@ -528,9 +535,9 @@ int getNumOpenApiSourceDescriptions(List<SourceDescription> sourceDescriptions)
         return (int) sourceDescriptions.stream().filter(p -> p.isOpenApi()).count();
     }
 
-    // num of SourceDescriptions with type 'workflowsSpec'
-    int getNumWorkflowsSpecSourceDescriptions(List<SourceDescription> sourceDescriptions) {
-        return (int) sourceDescriptions.stream().filter(p -> p.isWorkflowsSpec()).count();
+    // num of SourceDescriptions with type 'arazzo'
+    int getNumArazzoTypeSourceDescriptions(List<SourceDescription> sourceDescriptions) {
+        return (int) sourceDescriptions.stream().filter(p -> p.isArazzo()).count();
     }
 
     boolean stepExists(String workflowId, String stepId) {
@@ -554,11 +561,11 @@ List<String> validateWorkflowIdsUniqueness(List<Workflow> workflows) {
         return errors;
     }
 
-    List<String> validateStepsWorkflowIds(List<Step> steps, boolean multipleWorkflowsSpecFiles) {
+    List<String> validateStepsWorkflowIds(List<Step> steps, boolean multipleArazzoTypeFiles) {
         List<String> errors = new ArrayList<>();
 
         for(Step step : steps) {
-            if(multipleWorkflowsSpecFiles) {
+            if(multipleArazzoTypeFiles) {
                 // must use runtime expression to map applicable SourceDescription
                 if(step.getWorkflowId() != null && !step.getWorkflowId().startsWith("$sourceDescriptions.")) {
                     errors.add("Operation " + step.getWorkflowId() + " must be specified using a runtime expression (e.g., $sourceDescriptions.<name>.<workflowId>)");
diff --git a/src/test/java/com/apiflows/parser/OpenAPIWorkflowParserTest.java b/src/test/java/com/apiflows/parser/OpenAPIWorkflowParserTest.java
@@ -86,7 +86,7 @@ public void isYaml() {
     @Test
     public void getJsonFormat() {
         final String CONTENT = "{" +
-                "\"workflowsSpec\" : \"1.0.0\"" +
+                "\"arazzo\" : \"1.0.0\"" +
                 "}";
 
         OpenAPIWorkflowParserResult.Format format = parser.getFormat(CONTENT);
@@ -96,7 +96,7 @@ public void getJsonFormat() {
     @Test
     public void getYamlFormat() {
         final String CONTENT = "" +
-                "workflowsSpec : 1.0.0" +
+                "arazzo : 1.0.0" +
                 "info:" +
                 "  title: simple\n";
 
diff --git a/src/test/java/com/apiflows/parser/OpenAPIWorkflowValidatorTest.java b/src/test/java/com/apiflows/parser/OpenAPIWorkflowValidatorTest.java
@@ -1,6 +1,7 @@
 package com.apiflows.parser;
 
 import com.apiflows.model.*;
+import org.checkerframework.checker.units.qual.C;
 import org.junit.jupiter.api.Test;
 
 import java.util.*;
@@ -18,7 +19,7 @@ void validate() {
 
         assertFalse(result.isValid());
         assertFalse(result.getErrors().isEmpty());
-        assertEquals("'workflowsSpec' is undefined", result.getErrors().get(0));
+        assertEquals("'arazzo' is undefined", result.getErrors().get(0));
     }
 
     @Test
@@ -201,22 +202,33 @@ void validateStepWithoutInAttribute() {
     @Test
     void validateReusableParameter() {
         Parameter parameter = new Parameter()
-                .name("$components.parameters.page")
+                .reference("$components.parameters.pageSize")
                 .value("1");
         String worklowId = "q1";
 
+        Components components = new Components()
+                .parameter("pageSize", parameter);
+
+        validator.loadComponents(components);
+
         assertEquals(0, validator.validateReusableParameter(parameter, worklowId, null).size());
     }
 
     @Test
-    void validateReusableParameterWithInAttribute() {
+    void validateReusableParameterNotFound() {
         Parameter parameter = new Parameter()
-                .name("$components.parameters.page")
-                .value("1")
-                .in("query");
+                .reference("$components.parameters.pageSize")
+                .value("1");
+        Parameter anotherParameter = new Parameter()
+                .reference("$components.parameters.pageCounter")
+                .value("1");
         String worklowId = "q1";
 
-        // error: must not define IN attribute
+        Components components = new Components()
+                .parameter("anotherParameter", anotherParameter);
+
+        validator.loadComponents(components);
+
         assertEquals(1, validator.validateReusableParameter(parameter, worklowId, null).size());
     }
 
@@ -570,14 +582,14 @@ public void getNumOpenApiSourceDescriptions() {
                         .type("openapi"),
                 new SourceDescription()
                         .name("workflowspec-1")
-                        .type("workflowsSpec")
+                        .type("arazzo")
         );
 
         assertEquals(2, new OpenAPIWorkflowValidator().getNumOpenApiSourceDescriptions(sourceDescriptions));
     }
 
     @Test
-    public void getNumWorkflowsSpecSourceDescriptions() {
+    public void getNumArazzoTypeSourceDescriptions() {
         List<SourceDescription> sourceDescriptions = List.of(
                 new SourceDescription()
                         .name("openapifile-1")
@@ -587,10 +599,10 @@ public void getNumWorkflowsSpecSourceDescriptions() {
                         .type("openapi"),
                 new SourceDescription()
                         .name("workflowspec-1")
-                        .type("workflowsSpec")
+                        .type("arazzo")
         );
 
-        assertEquals(1, new OpenAPIWorkflowValidator().getNumWorkflowsSpecSourceDescriptions(sourceDescriptions));
+        assertEquals(1, new OpenAPIWorkflowValidator().getNumArazzoTypeSourceDescriptions(sourceDescriptions));
     }
 
     @Test
@@ -621,28 +633,28 @@ public void validateStepsOperationIdsWithoutRuntimeExpression() {
 
     @Test
     public void validateStepsWorkflowIds() {
-        boolean multipleWorkflowsSpecFiles = true;
+        boolean multipleArazzoTypeFiles = true;
 
         List<Step> steps = List.of(
                 new Step()
                         .stepId("step-one")
                         .workflowId("w2")
         );
 
-        assertEquals(1, new OpenAPIWorkflowValidator().validateStepsWorkflowIds(steps, multipleWorkflowsSpecFiles).size());
+        assertEquals(1, new OpenAPIWorkflowValidator().validateStepsWorkflowIds(steps, multipleArazzoTypeFiles).size());
     }
 
     @Test
     public void validateStepsWorkflowIdsWithoutRuntimeExpression() {
-        boolean multipleWorkflowsSpecFiles = false;
+        boolean multipleArazzoTypeFiles = false;
 
         List<Step> steps = List.of(
                 new Step()
                         .stepId("step-one")
                         .workflowId("w2")
         );
 
-        assertEquals(0, new OpenAPIWorkflowValidator().validateStepsWorkflowIds(steps, multipleWorkflowsSpecFiles).size());
+        assertEquals(0, new OpenAPIWorkflowValidator().validateStepsWorkflowIds(steps, multipleArazzoTypeFiles).size());
     }
 
     @Test

Original file line number	Diff line number	Diff line change
`@@ -39,8 +39,8 @@ public boolean isOpenApi() {`
`39`	`39`	`return "openapi".equals(this.type);`
`40`	`40`	`}`
`41`	`41`
`42`		`- public boolean isWorkflowsSpec() {`
`43`		`- return "workflowsSpec".equals(this.type);`
	`42`	`+ public boolean isArazzo() {`
	`43`	`+ return "arazzo".equals(this.type);`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`public SourceDescription name(String name) {`