Merge pull request #132 from manick02/utils-wf-states

Implement GetStates by StateType utility method #127

Author: tsurdilo

utils/src/main/java/io/serverlessworkflow/utils/WorkflowUtils.java

@@ -18,6 +18,9 @@
 import io.serverlessworkflow.api.Workflow;
 import io.serverlessworkflow.api.interfaces.State;
 import io.serverlessworkflow.api.start.Start;
+import io.serverlessworkflow.api.states.DefaultState;
+import java.util.List;
+import java.util.stream.Collectors;
 
 /** Provides common utility methods to provide most often needed answers from a workflow */
 public final class WorkflowUtils {
@@ -44,4 +47,21 @@ public static State getStartingState(Workflow workflow) {
           .get();
     }
   }
+
+  /**
+   * Gets List of States matching stateType
+   *
+   * @param workflow
+   * @param stateType
+   * @return {@code List<State>}. Returns {@code null} when workflow is null.
+   */
+  public static List<State> getStates(Workflow workflow, DefaultState.Type stateType) {
+    if (workflow == null || workflow.getStates() == null) {
+      return null;
+    }
+
+    return workflow.getStates().stream()
+        .filter(state -> state.getType() == stateType)
+        .collect(Collectors.toList());
+  }
 }

utils/src/test/java/io/serverlessworkflow/util/GetStatesTest.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright 2020-Present The Serverless Workflow Specification Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.serverlessworkflow.util;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+import io.serverlessworkflow.api.Workflow;
+import io.serverlessworkflow.api.interfaces.State;
+import io.serverlessworkflow.api.states.DefaultState;
+import io.serverlessworkflow.util.testutil.TestUtils;
+import io.serverlessworkflow.utils.WorkflowUtils;
+import java.util.List;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
+
+class GetStatesTest {
+
+  @ParameterizedTest
+  @ValueSource(strings = {"/getStates/workflowwithstates.yml"})
+  public void testGetStatesByDefaultState(String workflowWithState) {
+    int matchingEvents = 2;
+    int notMatchingEvents = 0;
+    Workflow workflow = TestUtils.createWorkflowFromTestResource(workflowWithState);
+    List<State> matchingStates = WorkflowUtils.getStates(workflow, DefaultState.Type.EVENT);
+    List<State> notMatchingStates = WorkflowUtils.getStates(workflow, DefaultState.Type.SLEEP);
+    assertEquals(matchingEvents, matchingStates.size());
+    assertEquals(notMatchingEvents, notMatchingStates.size());
+  }
+
+  @Test
+  public void testGetsStatesForNullWorkflow() {
+    assertNull(WorkflowUtils.getStates(null, DefaultState.Type.EVENT));
+  }
+}

utils/src/test/resources/getStates/workflowwithstates.yml

@@ -0,0 +1,55 @@
+id: finalizeCollegeApplication
+name: Finalize College Application
+version: '1.0'
+specVersion: '0.7'
+events:
+  - name: ApplicationSubmitted
+    type: org.application.submitted
+    source: applicationsource
+    correlation:
+      - contextAttributeName: applicantId
+  - name: SATScoresReceived
+    type: org.application.satscores
+    source: applicationsource
+    correlation:
+      - contextAttributeName: applicantId
+  - name: RecommendationLetterReceived
+    type: org.application.recommendationLetter
+    source: applicationsource
+    correlation:
+      - contextAttributeName: applicantId
+functions:
+  - name: finalizeApplicationFunction
+    operation: http://myapis.org/collegeapplicationapi.json#finalize
+states:
+  - name: FinalizeApplication
+    type: event
+    exclusive: false
+    onEvents:
+      - eventRefs:
+          - ApplicationSubmitted
+          - SATScoresReceived
+          - RecommendationLetterReceived
+        actions:
+          - functionRef:
+              refName: finalizeApplicationFunction
+              arguments:
+                student: "${ .applicantId }"
+    end:
+      terminate: true
+
+  - name: CancelApplication
+    type: event
+    exclusive: false
+    onEvents:
+      - eventRefs:
+          - ApplicationSubmitted
+          - SATScoresReceived
+          - RecommendationLetterReceived
+        actions:
+          - functionRef:
+              refName: finalizeApplicationFunction
+              arguments:
+                student: "${ .applicantId }"
+    end:
+      terminate: true