Implemented Utility Method- GetConsumedEvents and GetProducedEvents

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

Author: manick02

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

@@ -16,6 +16,7 @@
 package io.serverlessworkflow.utils;
 
 import io.serverlessworkflow.api.Workflow;
+import io.serverlessworkflow.api.events.EventDefinition;
 import io.serverlessworkflow.api.interfaces.State;
 import io.serverlessworkflow.api.start.Start;
 import io.serverlessworkflow.api.states.DefaultState;
@@ -64,4 +65,41 @@ public static List<State> getStates(Workflow workflow, DefaultState.Type stateTy
         .filter(state -> state.getType() == stateType)
         .collect(Collectors.toList());
   }
+
+  /**
+   * @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);
+  }
+
+  /**
+   * @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);
+  }
+
+  /**
+   * Gets list of event definition matching eventKind
+   *
+   * @param 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) {
+    if (workflow == null || workflow.getEvents() == null) {
+      return null;
+    }
+    List<EventDefinition> eventDefs = workflow.getEvents().getEventDefs();
+    if (eventDefs == null) {
+      return null;
+    }
+
+    return eventDefs.stream()
+        .filter(eventDef -> eventDef.getKind() == eventKind)
+        .collect(Collectors.toList());
+  }
 }

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

@@ -0,0 +1,54 @@
+/*
+ * 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.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNull;
+
+import io.serverlessworkflow.api.Workflow;
+import io.serverlessworkflow.api.events.EventDefinition;
+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 EventsTest {
+  @ParameterizedTest
+  @ValueSource(strings = {"/events/workflowwithevents.yml"})
+  public void testGetConsumedEvents(String workflowEvents) {
+    int consumedEventsCount = 2;
+    Workflow workflow = TestUtils.createWorkflowFromTestResource(workflowEvents);
+    List<EventDefinition> consumedEvents = WorkflowUtils.getConsumedEvents(workflow);
+    assertEquals(consumedEventsCount, consumedEvents.size());
+  }
+
+  @ParameterizedTest
+  @ValueSource(strings = {"/events/workflowwithevents.yml"})
+  public void testGetProducedEvents(String workflowEvents) {
+    int producedEventsCounts = 1;
+    Workflow workflow = TestUtils.createWorkflowFromTestResource(workflowEvents);
+    List<EventDefinition> producedEvents = WorkflowUtils.getProducedEvents(workflow);
+    assertEquals(producedEventsCounts, producedEvents.size());
+  }
+
+  @Test
+  public void testGetEventsForNullWorkflow() {
+    assertNull(WorkflowUtils.getEvents(null, EventDefinition.Kind.CONSUMED));
+  }
+}

utils/src/test/resources/events/workflowwithevents.yml

@@ -0,0 +1,56 @@
+id: finalizeCollegeApplication
+name: Finalize College Application
+version: '1.0'
+specVersion: '0.7'
+events:
+  - name: ApplicationSubmitted
+    type: org.application.submitted
+    source: applicationsource
+    kind: produced
+    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