Add validation of Reusable Parameter Object

Author: gcatanese

src/main/java/com/apiflows/parser/OpenAPIWorkflowValidator.java

@@ -171,11 +171,14 @@ List<String> validateStep(Step step, String workflowId ) {
 
         if(step.getParameters() != null) {
             for(Parameter parameter : step.getParameters()) {
-                errors.addAll(validateParameter(parameter, workflowId, null));
-
-                if(step.getWorkflowId() != null) {
-                    // when the step in context specifies a workflowId the parameter IN must be defined
-                    if(parameter.getIn() == null) {
+                if(isRuntimeExpression(parameter.getName())) {
+                    errors.addAll(validateReusableParameter(parameter, workflowId, null));
+                } else {
+                    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");
                     }
                 }
@@ -208,12 +211,12 @@ List<String> validateStep(Step step, String workflowId ) {
         return errors;
     }
 
-    List<String> validateParameter(Parameter parameter, String workflowId, String componentName ) {
+    List<String> validateParameter(Parameter parameter, String workflowId, String componentName) {
         List<String> SUPPORTED_VALUES = Arrays.asList("path", "query", "header", "cookie", "body", "workflow");
 
         String source;
 
-        if(workflowId != null) {
+        if (workflowId != null) {
             source = "Workflow[" + workflowId + "]";
         } else {
             source = "Component[" + componentName + "]";
@@ -222,37 +225,57 @@ List<String> validateParameter(Parameter parameter, String workflowId, String co
 
         List<String> errors = new ArrayList<>();
 
-        if(parameter.get$ref() != null) {
-            // Reference object
-            // check is URI
-        } else {
-            // Parameter object
-            String name = parameter.getName();
+        // Parameter object
+        String name = parameter.getName();
 
-            if(name == null) {
-                errors.add(source + " parameter has no name");
-            }
-            if(parameter.getIn() != null) {
-                if(!SUPPORTED_VALUES.contains(parameter.getIn())) {
-                    if(name != null) {
-                        errors.add(source +  "parameter " + name + " type (" + parameter.getIn() + ") is invalid");
-                    } else {
-                        errors.add(source + " parameter type (" + parameter.getIn() + ") is invalid");
-                    }
-                }
-            }
-            if(parameter.getValue() == null) {
-                if(name != null) {
-                    errors.add(source + " parameter " + name + " has no value");
+        if (name == null) {
+            errors.add(source + " parameter has no name");
+        }
+        if (parameter.getIn() != null) {
+            if (!SUPPORTED_VALUES.contains(parameter.getIn())) {
+                if (name != null) {
+                    errors.add(source + "parameter " + name + " in (" + parameter.getIn() + ") is invalid");
                 } else {
-                    errors.add(source + " parameter has no value");
+                    errors.add(source + " parameter in (" + parameter.getIn() + ") is invalid");
                 }
             }
-            if(parameter.getTarget() != null) {
-                if(!isValidJsonPointer(parameter.getTarget())) {
-                    errors.add(source + " parameter " + name + " target is not a valid Json Pointer");
-                }
+        }
+        if (parameter.getValue() == null) {
+            if (name != null) {
+                errors.add(source + " parameter " + name + " has no value");
+            } else {
+                errors.add(source + " parameter has no value");
+            }
+        }
+        if(isRuntimeExpression(parameter.getName())) {
+            errors.add(source + " parameter " + name + " is a Reusable Parameter object");
+        }
+
+        return errors;
+    }
+
+    List<String> validateReusableParameter(Parameter parameter, String workflowId, String componentName ) {
+
+        String source;
+
+        if(workflowId != null) {
+            source = "Workflow[" + workflowId + "]";
+        } else {
+            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");
             }
+
+            // TODO: check reusable parameter exists in Components
+
         }
         return errors;
     }
@@ -561,4 +584,8 @@ public boolean isValidJsonPointer(String jsonPointerString) {
         return ret;
     }
 
+    boolean isRuntimeExpression(String name) {
+        return name.startsWith("$");
+    }
+
 }

src/test/java/com/apiflows/parser/OpenAPIWorkflowValidatorTest.java

@@ -188,7 +188,7 @@ void validateStepWithoutInAttribute() {
         Step step = new Step()
                 .stepId("step-one")
                 .description("First step in the workflow")
-                .workflowId("workflow-id-2");
+                .operationId("op-id-2");
         step.addParameter(new Parameter()
                 .name("param")
                 .value("value"));
@@ -198,6 +198,27 @@ void validateStepWithoutInAttribute() {
         assertEquals(1, validator.validateStep(step, worklowId).size());
     }
 
+    @Test
+    void validateReusableParameter() {
+        Parameter parameter = new Parameter()
+                .name("$components.parameters.page")
+                .value("1");
+        String worklowId = "q1";
+
+        assertEquals(0, validator.validateReusableParameter(parameter, worklowId, null).size());
+    }
+
+    @Test
+    void validateReusableParameterWithInAttribute() {
+        Parameter parameter = new Parameter()
+                .name("$components.parameters.page")
+                .value("1")
+                .in("query");
+        String worklowId = "q1";
+
+        // error: must not define IN attribute
+        assertEquals(1, validator.validateReusableParameter(parameter, worklowId, null).size());
+    }
 
     @Test
     void validateParameter() {