Updated Util method to get Defined Events and its count

Signed-off-by: manick02 <[email protected]>

Author: manick02

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

@@ -26,6 +26,7 @@
 /** Provides common utility methods to provide most often needed answers from a workflow */
 public final class WorkflowUtils {
   private static final int DEFAULT_STARTING_STATE_POSITION = 0;
+
   /**
    * Gets State matching Start state.If start is not present returns first state otherwise returns
    * null
@@ -70,16 +71,16 @@ public static List<State> getStates(Workflow workflow, DefaultState.Type stateTy
    * @return {@code List<io.serverlessworkflow.api.events.EventDefinition>}. Returns {@code NULL}
    *     when workflow is null or when workflow does not contain events
    */
-  public static List<EventDefinition> getConsumedEvents(Workflow workflow) {
-    return getEvents(workflow, EventDefinition.Kind.CONSUMED);
+  public static List<EventDefinition> getDefinedConsumedEvents(Workflow workflow) {
+    return getDefinedEvents(workflow, EventDefinition.Kind.CONSUMED);
   }
 
   /**
    * @return {@code List<io.serverlessworkflow.api.events.EventDefinition>}. Returns {@code NULL}
    *     when workflow is null or when workflow does not contain events
    */
-  public static List<EventDefinition> getProducedEvents(Workflow workflow) {
-    return getEvents(workflow, EventDefinition.Kind.PRODUCED);
+  public static List<EventDefinition> getDefinedProducedEvents(Workflow workflow) {
+    return getDefinedEvents(workflow, EventDefinition.Kind.PRODUCED);
   }
 
   /**
@@ -89,7 +90,8 @@ public static List<EventDefinition> getProducedEvents(Workflow workflow) {
    * @return {@code List<io.serverlessworkflow.api.events.EventDefinition>}. Returns {@code NULL}
    *     when workflow is null or when workflow does not contain events
    */
-  public static List<EventDefinition> getEvents(Workflow workflow, EventDefinition.Kind eventKind) {
+  public static List<EventDefinition> getDefinedEvents(
+      Workflow workflow, EventDefinition.Kind eventKind) {
     if (workflow == null || workflow.getEvents() == null) {
       return null;
     }
@@ -102,4 +104,20 @@ public static List<EventDefinition> getEvents(Workflow workflow, EventDefinition
         .filter(eventDef -> eventDef.getKind() == eventKind)
         .collect(Collectors.toList());
   }
+
+  /** @return {@code int} Returns count of defined event count matching eventKind */
+  public static int getDefinedEventsCount(Workflow workflow, EventDefinition.Kind eventKind) {
+    List<EventDefinition> definedEvents = getDefinedEvents(workflow, eventKind);
+    return definedEvents == null ? 0 : definedEvents.size();
+  }
+
+  /** @return {@code int} Returns count of Defined Consumed Event Count */
+  public static int getDefinedConsumedEventsCount(Workflow workflow) {
+    return getDefinedEventsCount(workflow, EventDefinition.Kind.CONSUMED);
+  }
+
+  /** @return {@code int} Returns count of Defined Produced Event Count */
+  public static int getDefinedProducedEventsCount(Workflow workflow) {
+    return getDefinedEventsCount(workflow, EventDefinition.Kind.PRODUCED);
+  }
 }

utils/src/test/java/io/serverlessworkflow/util/EventsTest.java renamed to utils/src/test/java/io/serverlessworkflow/util/DefinedEventsTest.java

@@ -28,27 +28,52 @@
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.ValueSource;
 
-class EventsTest {
+class DefinedEventsTest {
   @ParameterizedTest
   @ValueSource(strings = {"/events/workflowwithevents.yml"})
-  public void testGetConsumedEvents(String workflowEvents) {
+  public void testGetDefinedConsumedEvents(String workflowEvents) {
     int consumedEventsCount = 2;
     Workflow workflow = TestUtils.createWorkflowFromTestResource(workflowEvents);
-    List<EventDefinition> consumedEvents = WorkflowUtils.getConsumedEvents(workflow);
+    List<EventDefinition> consumedEvents = WorkflowUtils.getDefinedConsumedEvents(workflow);
     assertEquals(consumedEventsCount, consumedEvents.size());
   }
 
   @ParameterizedTest
   @ValueSource(strings = {"/events/workflowwithevents.yml"})
-  public void testGetProducedEvents(String workflowEvents) {
+  public void testGetDefinedroducedEvents(String workflowEvents) {
     int producedEventsCounts = 1;
     Workflow workflow = TestUtils.createWorkflowFromTestResource(workflowEvents);
-    List<EventDefinition> producedEvents = WorkflowUtils.getProducedEvents(workflow);
+    List<EventDefinition> producedEvents = WorkflowUtils.getDefinedProducedEvents(workflow);
     assertEquals(producedEventsCounts, producedEvents.size());
   }
 
+  @ParameterizedTest
+  @ValueSource(strings = {"/events/workflowwithevents.yml"})
+  public void testGetDefinedConsumedEventsCount(String workflowEvents) {
+    int consumedEventsCountExpected = 2;
+    Workflow workflow = TestUtils.createWorkflowFromTestResource(workflowEvents);
+    int consumedEventsCount = WorkflowUtils.getDefinedConsumedEventsCount(workflow);
+    assertEquals(consumedEventsCountExpected, consumedEventsCount);
+  }
+
+  @ParameterizedTest
+  @ValueSource(strings = {"/events/workflowwithevents.yml"})
+  public void testGetDefinedroducedEventsCount(String workflowEvents) {
+    int producedEventsCountExpected = 1;
+    Workflow workflow = TestUtils.createWorkflowFromTestResource(workflowEvents);
+    int producedEventsCount = WorkflowUtils.getDefinedProducedEventsCount(workflow);
+    assertEquals(producedEventsCountExpected, producedEventsCount);
+  }
+
+  @Test
+  public void testGetDefinedEventsForNullWorkflow() {
+    assertNull(WorkflowUtils.getDefinedEvents(null, EventDefinition.Kind.CONSUMED));
+  }
+
   @Test
-  public void testGetEventsForNullWorkflow() {
-    assertNull(WorkflowUtils.getEvents(null, EventDefinition.Kind.CONSUMED));
+  public void testGetDefinedEventsCountForNullWorkflow() {
+    int expectedCount = 0;
+    assertEquals(
+        expectedCount, WorkflowUtils.getDefinedEventsCount(null, EventDefinition.Kind.PRODUCED));
   }
 }