Merge pull request #20 from API-Flows/workflowid-validation

WorkflowId validation

Author: gcatanese

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

@@ -64,6 +64,11 @@ public OpenAPIWorkflowValidatorResult validate(OpenAPIWorkflow openAPIWorkflow)
                 if (workflow.getWorkflowId() == null || workflow.getWorkflowId().isEmpty()) {
                     result.addError("'Workflow[" + i + "] workflowId' is undefined");
                 }
+
+                if (!isValidWorkflowId(workflow.getWorkflowId())) {
+                    result.addError("'Workflow[" + i + "] workflowId' format is invalid (should match regex " +  getWorkflowIdRegularExpression() + ")");
+                }
+
                 if (workflow.getSteps() == null) {
                     result.addError("'Workflow " + workflow.getWorkflowId() + "' no Steps are undefined");
                 }
@@ -162,6 +167,10 @@ public OpenAPIWorkflowValidatorResult validate(OpenAPIWorkflow openAPIWorkflow)
         return result;
     }
 
+    boolean isValidWorkflowId(String workflowId) {
+        return Pattern.matches(getWorkflowIdRegularExpression(), workflowId);
+    }
+
     boolean isValidStepId(String stepId) {
         return Pattern.matches(getStepIdRegularExpression(), stepId);
     }
@@ -170,6 +179,9 @@ String getStepIdRegularExpression() {
         return "[A-Za-z0-9_\\-]+";
     }
 
+    String getWorkflowIdRegularExpression() {
+        return "[A-Za-z0-9_\\\\-]++";
+    }
     boolean isValidOutputsKey(String key) {
         return Pattern.matches(getOutputsKeyRegularExpression(), key);
     }

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

@@ -30,7 +30,7 @@ void parseFromFile() {
 
     @Test
     void parseFromUrl() {
-        final String WORKFLOWS_SPEC_FILE = "https://raw.githubusercontent.com/OAI/sig-workflows/main/examples/1.0.0/pet-coupons.workflow.yaml";
+        final String WORKFLOWS_SPEC_FILE = "https://raw.githubusercontent.com/API-Flows/openapi-workflow-parser/main/src/test/resources/1.0.0/pet-coupons.workflow.yaml";
 
         OpenAPIWorkflowParserResult result = parser.parse(WORKFLOWS_SPEC_FILE);
         assertNotNull(result.getOpenAPIWorkflow());

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

@@ -16,4 +16,14 @@ void validate() {
         assertFalse(result.getErrors().isEmpty());
         assertEquals("'workflowsSpec' is undefined", result.getErrors().get(0));
     }
+
+    @Test
+    void validWorkflowId() {
+        assertTrue(new OpenAPIWorkflowValidator().isValidWorkflowId("idOfTheWorkflow_1"));
+    }
+
+    @Test
+    void invalidWorkflowId() {
+        assertFalse(new OpenAPIWorkflowValidator().isValidWorkflowId("workflow id"));
+    }
 }