Return Checkers in WorkFlowDefinitions

parodos-dev · Jun 30, 2023 · 79c68e3 · 79c68e3
1 parent 10e4fa0
commit 79c68e3
Show file tree

Hide file tree

Showing 24 changed files with 263 additions and 131 deletions.
diff --git a/integration-tests/src/test/java/com/redhat/parodos/flows/PrebuiltWorkFlowTest.java b/integration-tests/src/test/java/com/redhat/parodos/flows/PrebuiltWorkFlowTest.java
@@ -2,6 +2,7 @@
 
 import java.util.Arrays;
 import java.util.List;
+import java.util.Optional;
 import java.util.function.Consumer;
 
 import com.redhat.parodos.flows.common.WorkFlowTestBuilder;
@@ -79,12 +80,13 @@ private Consumer<WorkFlowDefinitionResponseDTO> getWorkFlowDefinitionResponseCon
 
 			assertNotNull(workFlowDefinition.getWorks());
 			assertEquals(1, workFlowDefinition.getWorks().size());
-			assertEquals("notificationTask", workFlowDefinition.getWorks().get(0).getName());
-			assertEquals(WorkDefinitionResponseDTO.WorkTypeEnum.TASK,
-					workFlowDefinition.getWorks().get(0).getWorkType());
-			assertTrue(CollectionUtils.isEmpty(workFlowDefinition.getWorks().get(0).getWorks()));
-			assertNull(workFlowDefinition.getWorks().get(0).getProcessingType());
-			assertNotNull(workFlowDefinition.getWorks().get(0).getParameters());
+			Optional<WorkDefinitionResponseDTO> firstWork = workFlowDefinition.getWorks().stream().findFirst();
+			assertTrue(firstWork.isPresent());
+			assertEquals("notificationTask", firstWork.get().getName());
+			assertEquals(WorkDefinitionResponseDTO.WorkTypeEnum.TASK, firstWork.get().getWorkType());
+			assertTrue(CollectionUtils.isEmpty(firstWork.get().getWorks()));
+			assertNull(firstWork.get().getProcessingType());
+			assertNotNull(firstWork.get().getParameters());
 		};
 	}
 

diff --git a/integration-tests/src/test/java/com/redhat/parodos/flows/SimpleWorkFlowTest.java b/integration-tests/src/test/java/com/redhat/parodos/flows/SimpleWorkFlowTest.java
@@ -90,19 +90,18 @@ private static Consumer<WorkFlowDefinitionResponseDTO> getWorkFlowDefinitionResp
 
 			assertNotNull(workFlowDefinition.getWorks());
 			assertEquals(2, workFlowDefinition.getWorks().size());
-			assertEquals("restCallTask", workFlowDefinition.getWorks().get(0).getName());
-			assertEquals(WorkDefinitionResponseDTO.WorkTypeEnum.TASK,
-					workFlowDefinition.getWorks().get(0).getWorkType());
-			assertTrue(CollectionUtils.isEmpty(workFlowDefinition.getWorks().get(0).getWorks()));
-			assertNull(workFlowDefinition.getWorks().get(0).getProcessingType());
-			assertNotNull(workFlowDefinition.getWorks().get(0).getParameters());
-
-			assertEquals("loggingTask", workFlowDefinition.getWorks().get(1).getName());
-			assertEquals(WorkDefinitionResponseDTO.WorkTypeEnum.TASK,
-					workFlowDefinition.getWorks().get(1).getWorkType());
-			assertTrue(CollectionUtils.isEmpty(workFlowDefinition.getWorks().get(1).getWorks()));
-			assertNull(workFlowDefinition.getWorks().get(1).getProcessingType());
-			assertNotNull(workFlowDefinition.getWorks().get(1).getParameters());
+			List<WorkDefinitionResponseDTO> works = workFlowDefinition.getWorks().stream().toList();
+			assertEquals("restCallTask", works.get(0).getName());
+			assertEquals(WorkDefinitionResponseDTO.WorkTypeEnum.TASK, works.get(0).getWorkType());
+			assertTrue(CollectionUtils.isEmpty(works.get(0).getWorks()));
+			assertNull(works.get(0).getProcessingType());
+			assertNotNull(works.get(0).getParameters());
+
+			assertEquals("loggingTask", works.get(1).getName());
+			assertEquals(WorkDefinitionResponseDTO.WorkTypeEnum.TASK, works.get(1).getWorkType());
+			assertTrue(CollectionUtils.isEmpty(works.get(1).getWorks()));
+			assertNull(works.get(1).getProcessingType());
+			assertNotNull(works.get(1).getParameters());
 		};
 	}
 

diff --git a/...s/src/test/java/com/redhat/parodos/flows/negative/FailedWithAlertMessageWorkFlowTest.java b/...s/src/test/java/com/redhat/parodos/flows/negative/FailedWithAlertMessageWorkFlowTest.java
@@ -1,5 +1,6 @@
 package com.redhat.parodos.flows.negative;
 
+import java.util.List;
 import java.util.function.Consumer;
 
 import com.redhat.parodos.flows.common.WorkFlowTestBuilder;
@@ -86,13 +87,13 @@ private static Consumer<WorkFlowDefinitionResponseDTO> getWorkFlowDefinitionResp
 
 			assertThat(workFlowDefinition.getWorks()).isNotNull();
 			assertThat(workFlowDefinition.getWorks()).hasSize(2);
-			assertThat(workFlowDefinition.getWorks().get(1).getName()).isEqualTo("doNothingAgainWorkFlowTask");
-			assertThat(workFlowDefinition.getWorks().get(1).getWorkType())
-					.isEqualTo(WorkDefinitionResponseDTO.WorkTypeEnum.TASK);
-			assertThat(workFlowDefinition.getWorks().get(1).getWorks()).isNullOrEmpty();
-			assertThat(workFlowDefinition.getWorks().get(1).getProcessingType()).isNull();
-			assertThat(workFlowDefinition.getWorks().get(1).getParameters()).isNotNull();
-			assertThat(workFlowDefinition.getWorks().get(0).getName()).isEqualTo("failedWithAlertMessageWorkFlowTask");
+			List<WorkDefinitionResponseDTO> works = workFlowDefinition.getWorks().stream().toList();
+			assertThat(works.get(1).getName()).isEqualTo("doNothingAgainWorkFlowTask");
+			assertThat(works.get(1).getWorkType()).isEqualTo(WorkDefinitionResponseDTO.WorkTypeEnum.TASK);
+			assertThat(works.get(1).getWorks()).isNullOrEmpty();
+			assertThat(works.get(1).getProcessingType()).isNull();
+			assertThat(works.get(1).getParameters()).isNotNull();
+			assertThat(works.get(0).getName()).isEqualTo("failedWithAlertMessageWorkFlowTask");
 		};
 	}
 

diff --git a/.../src/test/java/com/redhat/parodos/flows/negative/PendingWithAlertMessageWorkFlowTest.java b/.../src/test/java/com/redhat/parodos/flows/negative/PendingWithAlertMessageWorkFlowTest.java
@@ -1,5 +1,6 @@
 package com.redhat.parodos.flows.negative;
 
+import java.util.List;
 import java.util.function.Consumer;
 
 import com.redhat.parodos.flows.common.WorkFlowTestBuilder;
@@ -86,13 +87,13 @@ private static Consumer<WorkFlowDefinitionResponseDTO> getWorkFlowDefinitionResp
 
 			assertThat(workFlowDefinition.getWorks()).isNotNull();
 			assertThat(workFlowDefinition.getWorks()).hasSize(2);
-			assertThat(workFlowDefinition.getWorks().get(1).getName()).isEqualTo("doNothingWorkFlowTask");
-			assertThat(workFlowDefinition.getWorks().get(1).getWorkType())
-					.isEqualTo(WorkDefinitionResponseDTO.WorkTypeEnum.TASK);
-			assertThat(workFlowDefinition.getWorks().get(1).getWorks()).isNullOrEmpty();
-			assertThat(workFlowDefinition.getWorks().get(1).getProcessingType()).isNull();
-			assertThat(workFlowDefinition.getWorks().get(1).getParameters()).isNotNull();
-			assertThat(workFlowDefinition.getWorks().get(0).getName()).isEqualTo("pendingWithAlertMessageWorkFlowTask");
+			List<WorkDefinitionResponseDTO> works = workFlowDefinition.getWorks().stream().toList();
+			assertThat(works.get(1).getName()).isEqualTo("doNothingWorkFlowTask");
+			assertThat(works.get(1).getWorkType()).isEqualTo(WorkDefinitionResponseDTO.WorkTypeEnum.TASK);
+			assertThat(works.get(1).getWorks()).isNullOrEmpty();
+			assertThat(works.get(1).getProcessingType()).isNull();
+			assertThat(works.get(1).getParameters()).isNotNull();
+			assertThat(works.get(0).getName()).isEqualTo("pendingWithAlertMessageWorkFlowTask");
 		};
 	}
 

diff --git a/...est/java/com/redhat/parodos/flows/negative/SequentialFailedWithExceptionWorkFlowTest.java b/...est/java/com/redhat/parodos/flows/negative/SequentialFailedWithExceptionWorkFlowTest.java
@@ -1,5 +1,6 @@
 package com.redhat.parodos.flows.negative;
 
+import java.util.Optional;
 import java.util.function.Consumer;
 
 import com.redhat.parodos.flows.common.WorkFlowTestBuilder;
@@ -21,6 +22,7 @@
 import org.junit.Test;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 @Slf4j
 public class SequentialFailedWithExceptionWorkFlowTest {
@@ -77,12 +79,13 @@ private static Consumer<WorkFlowDefinitionResponseDTO> getWorkFlowDefinitionResp
 
 			assertThat(workFlowDefinition.getWorks()).isNotNull();
 			assertThat(workFlowDefinition.getWorks()).hasSize(1);
-			assertThat(workFlowDefinition.getWorks().get(0).getName()).isEqualTo("failedWithExceptionWorkFlowTask");
-			assertThat(workFlowDefinition.getWorks().get(0).getWorkType())
-					.isEqualTo(WorkDefinitionResponseDTO.WorkTypeEnum.TASK);
-			assertThat(workFlowDefinition.getWorks().get(0).getWorks()).isNullOrEmpty();
-			assertThat(workFlowDefinition.getWorks().get(0).getProcessingType()).isNull();
-			assertThat(workFlowDefinition.getWorks().get(0).getParameters()).isNotNull();
+			Optional<WorkDefinitionResponseDTO> firstWork = workFlowDefinition.getWorks().stream().findFirst();
+			assertTrue(firstWork.isPresent());
+			assertThat(firstWork.get().getName()).isEqualTo("failedWithExceptionWorkFlowTask");
+			assertThat(firstWork.get().getWorkType()).isEqualTo(WorkDefinitionResponseDTO.WorkTypeEnum.TASK);
+			assertThat(firstWork.get().getWorks()).isNullOrEmpty();
+			assertThat(firstWork.get().getProcessingType()).isNull();
+			assertThat(firstWork.get().getParameters()).isNotNull();
 		};
 	}
 

diff --git a/...n-tests/src/test/java/com/redhat/parodos/flows/negative/SequentialFailedWorkFlowTest.java b/...n-tests/src/test/java/com/redhat/parodos/flows/negative/SequentialFailedWorkFlowTest.java
@@ -1,5 +1,6 @@
 package com.redhat.parodos.flows.negative;
 
+import java.util.Optional;
 import java.util.function.Consumer;
 
 import com.redhat.parodos.flows.common.WorkFlowTestBuilder;
@@ -21,6 +22,7 @@
 import org.junit.Test;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 @Slf4j
 public class SequentialFailedWorkFlowTest {
@@ -74,12 +76,13 @@ private static Consumer<WorkFlowDefinitionResponseDTO> getWorkFlowDefinitionResp
 
 			assertThat(workFlowDefinition.getWorks()).isNotNull();
 			assertThat(workFlowDefinition.getWorks()).hasSize(1);
-			assertThat(workFlowDefinition.getWorks().get(0).getName()).isEqualTo("failedWorkFlowTask");
-			assertThat(workFlowDefinition.getWorks().get(0).getWorkType())
-					.isEqualTo(WorkDefinitionResponseDTO.WorkTypeEnum.TASK);
-			assertThat(workFlowDefinition.getWorks().get(0).getWorks()).isNullOrEmpty();
-			assertThat(workFlowDefinition.getWorks().get(0).getProcessingType()).isNull();
-			assertThat(workFlowDefinition.getWorks().get(0).getParameters()).isNotNull();
+			Optional<WorkDefinitionResponseDTO> firstWork = workFlowDefinition.getWorks().stream().findFirst();
+			assertTrue(firstWork.isPresent());
+			assertThat(firstWork.get().getName()).isEqualTo("failedWorkFlowTask");
+			assertThat(firstWork.get().getWorkType()).isEqualTo(WorkDefinitionResponseDTO.WorkTypeEnum.TASK);
+			assertThat(firstWork.get().getWorks()).isNullOrEmpty();
+			assertThat(firstWork.get().getProcessingType()).isNull();
+			assertThat(firstWork.get().getParameters()).isNotNull();
 		};
 	}
 

diff --git a/parodos-model-api/src/main/java/com/redhat/parodos/workflow/enums/WorkType.java b/parodos-model-api/src/main/java/com/redhat/parodos/workflow/enums/WorkType.java
@@ -24,6 +24,6 @@
  */
 public enum WorkType {
 
-	TASK, WORKFLOW
+	TASK, WORKFLOW, CHECKER
 
 }
diff --git a/workflow-service-sdk/api/openapi.yaml b/workflow-service-sdk/api/openapi.yaml
@@ -1133,11 +1133,13 @@ components:
           enum:
           - TASK
           - WORKFLOW
+          - CHECKER
           type: string
         works:
           items:
             $ref: '#/components/schemas/WorkDefinitionResponseDTO'
           type: array
+          uniqueItems: true
       type: object
     WorkFlowCheckerTaskRequestDTO:
       example:
@@ -1259,6 +1261,7 @@ components:
       type: object
     WorkFlowDefinitionResponseDTO:
       example:
+        cronExpression: cronExpression
         processingType: SEQUENTIAL
         rollbackWorkflow: rollbackWorkflow
         works:
@@ -1307,6 +1310,8 @@ components:
         createDate:
           format: date-time
           type: string
+        cronExpression:
+          type: string
         id:
           format: uuid
           type: string
@@ -1342,6 +1347,7 @@ components:
           items:
             $ref: '#/components/schemas/WorkDefinitionResponseDTO'
           type: array
+          uniqueItems: true
       type: object
     WorkFlowExecutionResponseDTO:
       example:
@@ -1703,6 +1709,7 @@ components:
           enum:
           - TASK
           - WORKFLOW
+          - CHECKER
           type: string
         workName:
           type: string
@@ -1736,6 +1743,7 @@ components:
           enum:
           - TASK
           - WORKFLOW
+          - CHECKER
           type: string
         works:
           items:

diff --git a/workflow-service-sdk/docs/WorkDefinitionResponseDTO.md b/workflow-service-sdk/docs/WorkDefinitionResponseDTO.md
@@ -14,7 +14,7 @@
 |**parameters** | **Map&lt;String, Map&lt;String, Object&gt;&gt;** |  |  [optional] |
 |**processingType** | [**ProcessingTypeEnum**](#ProcessingTypeEnum) |  |  [optional] |
 |**workType** | [**WorkTypeEnum**](#WorkTypeEnum) |  |  [optional] |
-|**works** | [**List&lt;WorkDefinitionResponseDTO&gt;**](WorkDefinitionResponseDTO.md) |  |  [optional] |
+|**works** | [**Set&lt;WorkDefinitionResponseDTO&gt;**](WorkDefinitionResponseDTO.md) |  |  [optional] |
 
 
 
@@ -45,6 +45,7 @@
 |---- | -----|
 | TASK | &quot;TASK&quot; |
 | WORKFLOW | &quot;WORKFLOW&quot; |
+| CHECKER | &quot;CHECKER&quot; |
 
 
 
diff --git a/workflow-service-sdk/docs/WorkFlowDefinitionResponseDTO.md b/workflow-service-sdk/docs/WorkFlowDefinitionResponseDTO.md
@@ -9,6 +9,7 @@
 |------------ | ------------- | ------------- | -------------|
 |**author** | **String** |  |  [optional] |
 |**createDate** | **Date** |  |  [optional] |
+|**cronExpression** | **String** |  |  [optional] |
 |**id** | **UUID** |  |  [optional] |
 |**modifyDate** | **Date** |  |  [optional] |
 |**name** | **String** |  |  [optional] |
@@ -17,7 +18,7 @@
 |**properties** | [**WorkFlowPropertiesDefinitionDTO**](WorkFlowPropertiesDefinitionDTO.md) |  |  [optional] |
 |**rollbackWorkflow** | **String** |  |  [optional] |
 |**type** | [**TypeEnum**](#TypeEnum) |  |  [optional] |
-|**works** | [**List&lt;WorkDefinitionResponseDTO&gt;**](WorkDefinitionResponseDTO.md) |  |  [optional] |
+|**works** | [**Set&lt;WorkDefinitionResponseDTO&gt;**](WorkDefinitionResponseDTO.md) |  |  [optional] |
 
 
 

diff --git a/workflow-service-sdk/docs/WorkRequestDTO.md b/workflow-service-sdk/docs/WorkRequestDTO.md
@@ -19,6 +19,7 @@
 |---- | -----|
 | TASK | &quot;TASK&quot; |
 | WORKFLOW | &quot;WORKFLOW&quot; |
+| CHECKER | &quot;CHECKER&quot; |
 
 
 
diff --git a/workflow-service-sdk/docs/WorkStatusResponseDTO.md b/workflow-service-sdk/docs/WorkStatusResponseDTO.md
@@ -34,6 +34,7 @@
 |---- | -----|
 | TASK | &quot;TASK&quot; |
 | WORKFLOW | &quot;WORKFLOW&quot; |
+| CHECKER | &quot;CHECKER&quot; |
 
 
 
diff --git a/...low-service-sdk/src/main/java/com/redhat/parodos/sdk/model/WorkDefinitionResponseDTO.java b/...low-service-sdk/src/main/java/com/redhat/parodos/sdk/model/WorkDefinitionResponseDTO.java
@@ -16,6 +16,7 @@
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.HashSet;
+import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
@@ -188,7 +189,9 @@ public enum WorkTypeEnum {
 
 		TASK("TASK"),
 
-		WORKFLOW("WORKFLOW");
+		WORKFLOW("WORKFLOW"),
+
+		CHECKER("CHECKER");
 
 		private String value;
 
@@ -239,7 +242,7 @@ public WorkTypeEnum read(final JsonReader jsonReader) throws IOException {
 	public static final String SERIALIZED_NAME_WORKS = "works";
 
 	@SerializedName(SERIALIZED_NAME_WORKS)
-	private List<WorkDefinitionResponseDTO> works;
+	private Set<WorkDefinitionResponseDTO> works;
 
 	public WorkDefinitionResponseDTO() {
 	}
@@ -393,15 +396,15 @@ public void setWorkType(WorkTypeEnum workType) {
 		this.workType = workType;
 	}
 
-	public WorkDefinitionResponseDTO works(List<WorkDefinitionResponseDTO> works) {
+	public WorkDefinitionResponseDTO works(Set<WorkDefinitionResponseDTO> works) {
 
 		this.works = works;
 		return this;
 	}
 
 	public WorkDefinitionResponseDTO addWorksItem(WorkDefinitionResponseDTO worksItem) {
 		if (this.works == null) {
-			this.works = new ArrayList<>();
+			this.works = new LinkedHashSet<>();
 		}
 		this.works.add(worksItem);
 		return this;
@@ -412,11 +415,11 @@ public WorkDefinitionResponseDTO addWorksItem(WorkDefinitionResponseDTO worksIte
 	 * @return works
 	 **/
 	@javax.annotation.Nullable
-	public List<WorkDefinitionResponseDTO> getWorks() {
+	public Set<WorkDefinitionResponseDTO> getWorks() {
 		return works;
 	}
 
-	public void setWorks(List<WorkDefinitionResponseDTO> works) {
+	public void setWorks(Set<WorkDefinitionResponseDTO> works) {
 		this.works = works;
 	}