set additional info for report urls

rhdhorchestrator · Jun 19, 2023 · 7fbe738 · 7fbe738
1 parent b0ad1f3
commit 7fbe738
Show file tree

Hide file tree

Showing 19 changed files with 414 additions and 9 deletions.
diff --git a/parodos-model-api/src/main/java/com/redhat/parodos/workflow/context/WorkContextDelegate.java b/parodos-model-api/src/main/java/com/redhat/parodos/workflow/context/WorkContextDelegate.java
@@ -56,7 +56,9 @@ public enum Resource {
 
 		WORKFLOW_OPTIONS(Visibility.PUBLIC),
 
-		PARENT_WORKFLOW;
+		PARENT_WORKFLOW,
+
+		ADDITIONAL_INFO;
 		// @formatter:on
 
 		private final Visibility visibility;

diff --git a/parodos-model-api/src/main/java/com/redhat/parodos/workflow/task/BaseWorkFlowTask.java b/parodos-model-api/src/main/java/com/redhat/parodos/workflow/task/BaseWorkFlowTask.java
@@ -97,6 +97,10 @@ public Map<String, String> getAllParameters(WorkContext workContext) {
 		return WorkContextUtils.getAllParameters(workContext, name);
 	}
 
+	public void addAdditionInfo(String key, String value) {
+		WorkContextUtils.addAdditionalInfo(workContext, key, value);
+	}
+
 	/**
 	 * Get Parameters specific to this WorkFlowTask, this is a required parameter
 	 * @param parameterName

diff --git a/parodos-model-api/src/main/java/com/redhat/parodos/workflow/utils/WorkContextUtils.java b/parodos-model-api/src/main/java/com/redhat/parodos/workflow/utils/WorkContextUtils.java
@@ -120,6 +120,32 @@ public static void addParameter(WorkContext workContext, String key, String valu
 				WorkContextDelegate.Resource.ARGUMENTS, parameterMap);
 	}
 
+	/**
+	 * add additional info for the workflow, e.g. result links
+	 * @param workContext
+	 * @param key
+	 * @param value
+	 */
+	public static void addAdditionalInfo(WorkContext workContext, String key, String value) {
+		Map<String, String> additionalInfoMap = Optional
+				.ofNullable(new ObjectMapper().convertValue(
+						WorkContextDelegate.read(workContext, WorkContextDelegate.ProcessType.WORKFLOW_EXECUTION,
+								WorkContextDelegate.Resource.ADDITIONAL_INFO),
+						new TypeReference<HashMap<String, String>>() {
+						}))
+				.orElse(new HashMap<>());
+		additionalInfoMap.put(key, value);
+		WorkContextDelegate.write(workContext, WorkContextDelegate.ProcessType.WORKFLOW_EXECUTION,
+				WorkContextDelegate.Resource.ADDITIONAL_INFO, additionalInfoMap);
+	}
+
+	public static Map<String, String> getAdditionalInfo(WorkContext workContext) {
+		return new ObjectMapper().convertValue(WorkContextDelegate.read(workContext,
+				WorkContextDelegate.ProcessType.WORKFLOW_EXECUTION, WorkContextDelegate.Resource.ADDITIONAL_INFO),
+				new TypeReference<>() {
+				});
+	}
+
 	/**
 	 * get all available parameters for a task
 	 * @param workContext work context

diff --git a/...-tasks/src/main/java/com/redhat/parodos/tasks/migrationtoolkit/CreateApplicationTask.java b/...-tasks/src/main/java/com/redhat/parodos/tasks/migrationtoolkit/CreateApplicationTask.java
@@ -71,6 +71,7 @@ else if (result instanceof Result.Success<App> success) {
 			workContext.put("application", success.value());
 			taskLogger.logInfoWithSlf4j("MTA client returned success result for application creation: {}",
 					success.value().name());
+			addAdditionInfo("VCS branch", repo);
 			return new DefaultWorkReport(WorkStatus.COMPLETED, workContext);
 		}
 		throw new IllegalArgumentException();

diff --git a/prebuilt-tasks/src/main/java/com/redhat/parodos/tasks/migrationtoolkit/GetAnalysisTask.java b/prebuilt-tasks/src/main/java/com/redhat/parodos/tasks/migrationtoolkit/GetAnalysisTask.java
@@ -101,6 +101,7 @@ else if (result instanceof Result.Success<TaskGroup> success) {
 						success.value().tasks()[0].application().id(), success.value().data().output());
 				taskLogger.logInfoWithSlf4j("MTA client returned success result with report url: {}", reportURL);
 				addParameter("reportURL", reportURL);
+				addAdditionInfo("MTA assessment report", reportURL);
 				notificationSender.send("Migration Analysis Report Completed",
 						"[Migration analysis report](%s) completed.".formatted(reportURL));
 				return new DefaultWorkReport(WorkStatus.COMPLETED, workContext);

diff --git a/...src/main/java/com/redhat/parodos/examples/negative/simple/task/DoNothingWorkFlowTask.java b/...src/main/java/com/redhat/parodos/examples/negative/simple/task/DoNothingWorkFlowTask.java
@@ -16,6 +16,7 @@ public class DoNothingWorkFlowTask extends BaseInfrastructureWorkFlowTask {
 	@Override
 	public WorkReport execute(WorkContext workContext) {
 		log.info("DoNothingWorkFlowTask execution should return COMPLETE");
+		addAdditionInfo("DoNothing", null);
 		return new DefaultWorkReport(WorkStatus.COMPLETED, workContext);
 	}
 

diff --git a/...com/redhat/parodos/examples/negative/simple/task/PendingWithAlertMessageWorkFlowTask.java b/...com/redhat/parodos/examples/negative/simple/task/PendingWithAlertMessageWorkFlowTask.java
@@ -16,6 +16,7 @@ public class PendingWithAlertMessageWorkFlowTask extends BaseInfrastructureWorkF
 	@Override
 	public WorkReport execute(WorkContext workContext) {
 		log.info("FailedWithAlertMessageWorkFlowTask execution should return PENDING");
+		addAdditionInfo("Alert message", "http://localhost:8080");
 		return new DefaultWorkReport(WorkStatus.PENDING, workContext, "[link](http://localhost:8080)");
 	}
 

diff --git a/workflow-service-sdk/README.md b/workflow-service-sdk/README.md
@@ -137,6 +137,7 @@ Class | Method | HTTP request | Description
  - [AccessResponseDTO](docs/AccessResponseDTO.md)
  - [AccessStatusRequestDTO](docs/AccessStatusRequestDTO.md)
  - [AccessStatusResponseDTO](docs/AccessStatusResponseDTO.md)
+ - [AdditionalInfo](docs/AdditionalInfo.md)
  - [ArgumentRequestDTO](docs/ArgumentRequestDTO.md)
  - [ErrorMessageDTO](docs/ErrorMessageDTO.md)
  - [ProjectDTO](docs/ProjectDTO.md)

diff --git a/workflow-service-sdk/api/openapi.yaml b/workflow-service-sdk/api/openapi.yaml
@@ -723,6 +723,7 @@ paths:
             - STATUS
             - WORKFLOW_OPTIONS
             - PARENT_WORKFLOW
+            - ADDITIONAL_INFO
             type: string
           type: array
         style: form
@@ -930,6 +931,16 @@ components:
           - REJECTED
           type: string
       type: object
+    AdditionalInfo:
+      example:
+        value: value
+        key: key
+      properties:
+        key:
+          type: string
+        value:
+          type: string
+      type: object
     ArgumentRequestDTO:
       example:
         value: value
@@ -1523,13 +1534,22 @@ components:
     WorkFlowResponseDTO:
       example:
         workStatus: FAILED
+        additionalInfos:
+        - value: value
+          key: key
+        - value: value
+          key: key
         workFlowName: workFlowName
         executeBy: executeBy
         endDate: endDate
         workFlowExecutionId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
         projectId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
         startDate: startDate
       properties:
+        additionalInfos:
+          items:
+            $ref: '#/components/schemas/AdditionalInfo'
+          type: array
         endDate:
           type: string
         executeBy:

diff --git a/workflow-service-sdk/docs/AdditionalInfo.md b/workflow-service-sdk/docs/AdditionalInfo.md
@@ -0,0 +1,14 @@
+
+
+# AdditionalInfo
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**key** | **String** |  |  [optional] |
+|**value** | **String** |  |  [optional] |
+
+
+
diff --git a/workflow-service-sdk/docs/WorkFlowResponseDTO.md b/workflow-service-sdk/docs/WorkFlowResponseDTO.md
@@ -7,6 +7,7 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
+|**additionalInfos** | [**List&lt;AdditionalInfo&gt;**](AdditionalInfo.md) |  |  [optional] |
 |**endDate** | **String** |  |  [optional] |
 |**executeBy** | **String** |  |  [optional] |
 |**projectId** | **UUID** |  |  [optional] |

diff --git a/workflow-service-sdk/docs/WorkflowApi.md b/workflow-service-sdk/docs/WorkflowApi.md
@@ -318,7 +318,7 @@ public class Example {
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **workFlowExecutionId** | **UUID**|  | |
-| **param** | [**List&lt;String&gt;**](String.md)|  | [enum: ID, NAME, PARAMETERS, ARGUMENTS, STATUS, WORKFLOW_OPTIONS, PARENT_WORKFLOW] |
+| **param** | [**List&lt;String&gt;**](String.md)|  | [enum: ID, NAME, PARAMETERS, ARGUMENTS, STATUS, WORKFLOW_OPTIONS, PARENT_WORKFLOW, ADDITIONAL_INFO] |
 
 ### Return type
 

diff --git a/workflow-service-sdk/src/main/java/com/redhat/parodos/sdk/invoker/JSON.java b/workflow-service-sdk/src/main/java/com/redhat/parodos/sdk/invoker/JSON.java
@@ -93,6 +93,8 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
 				new com.redhat.parodos.sdk.model.AccessStatusRequestDTO.CustomTypeAdapterFactory());
 		gsonBuilder.registerTypeAdapterFactory(
 				new com.redhat.parodos.sdk.model.AccessStatusResponseDTO.CustomTypeAdapterFactory());
+		gsonBuilder
+				.registerTypeAdapterFactory(new com.redhat.parodos.sdk.model.AdditionalInfo.CustomTypeAdapterFactory());
 		gsonBuilder.registerTypeAdapterFactory(
 				new com.redhat.parodos.sdk.model.ArgumentRequestDTO.CustomTypeAdapterFactory());
 		gsonBuilder.registerTypeAdapterFactory(