feature: Return a wrapper object for flows instead of a plain array/list

of flows
kaoto-archive · May 8, 2023 · efa5105 · efa5105
1 parent deb6798
commit efa5105
Show file tree

Hide file tree

Showing 7 changed files with 45 additions and 19 deletions.
diff --git a/api/src/main/java/io/kaoto/backend/api/resource/model/FlowsWrapper.java b/api/src/main/java/io/kaoto/backend/api/resource/model/FlowsWrapper.java
@@ -0,0 +1,23 @@
+package io.kaoto.backend.api.resource.model;
+
+import io.kaoto.backend.api.resource.v1.model.Integration;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * 🐱class FlowsWrapper
+ *
+ * Used by the API to pass flows back and forth.
+ *
+ */
+public record FlowsWrapper(List<Integration> flows, Map<String, Object> properties) {
+
+    public FlowsWrapper(List<Integration> flows) {
+        this(flows, null);
+    }
+
+    public FlowsWrapper(List<Integration> flows, Map<String, Object> properties) {
+        this.flows = flows;
+        this.properties = properties;
+    }
+}
diff --git a/api/src/main/java/io/kaoto/backend/api/resource/v2/IntegrationsResource.java b/api/src/main/java/io/kaoto/backend/api/resource/v2/IntegrationsResource.java
@@ -1,5 +1,6 @@
 package io.kaoto.backend.api.resource.v2;
 
+import io.kaoto.backend.api.resource.model.FlowsWrapper;
 import io.kaoto.backend.api.resource.v1.model.Integration;
 import io.kaoto.backend.api.service.deployment.DeploymentService;
 import io.kaoto.backend.api.service.step.parser.StepParserService;
@@ -19,6 +20,7 @@
 import javax.ws.rs.core.Response;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 
 /**
  * 🐱class IntegrationsResource
@@ -62,10 +64,10 @@ public void setStepParserServices(final Instance<StepParserService<Step>> stepPa
     @Operation(summary = "Get CRDs",
             description = "Returns the associated custom resource definitions. This is an idempotent operation.")
     public String crds(
-            final @RequestBody List<Integration> request,
+            final @RequestBody FlowsWrapper request,
             final @Parameter(description = "DSL to use. For example: 'Kamelet Binding'.")
             @QueryParam("dsl") String dsl) {
-        return deploymentService.crds(request, dsl);
+        return deploymentService.crds(request.flows(), dsl);
     }
 
     /*
@@ -84,10 +86,9 @@ public String crds(
     @Operation(summary = "Get Integration Object",
             description = "Given the associated custom resource definition, returns the JSON object."
                     + " This is an idempotent operation.")
-    public List<Integration> integration(
+    public FlowsWrapper integration(
             final @RequestBody String crd,
-            final @Parameter(description = "DSL to use. For example: "
-                    + "'Kamelet Binding'.")
+            final @Parameter(description = "DSL to use. For example: 'Kamelet Binding'.")
             @QueryParam("dsl") String dsl) {
         List<Integration> integrations = new ArrayList<>();
 
@@ -123,7 +124,7 @@ public List<Integration> integration(
             }
         }
 
-        return integrations;
+        return new FlowsWrapper(integrations, Map.of());
     }
 
     private void decorateIntegration(String dsl, List<Integration> integrations,

diff --git a/api/src/test/java/io/kaoto/backend/api/resource/v2/IntegrationsResourceTest.java b/api/src/test/java/io/kaoto/backend/api/resource/v2/IntegrationsResourceTest.java
@@ -1,5 +1,6 @@
 package io.kaoto.backend.api.resource.v2;
 
+import io.kaoto.backend.api.resource.model.FlowsWrapper;
 import io.kaoto.backend.api.resource.v1.model.Integration;
 import io.kaoto.backend.api.service.deployment.generator.kamelet.KameletRepresenter;
 import io.kaoto.backend.model.deployment.kamelet.KameletBinding;
@@ -45,7 +46,7 @@ void amqAmq() throws Exception {
                 .then()
                 .statusCode(Response.Status.OK.getStatusCode());
 
-        var flows = Arrays.asList(res.extract().body().as(Integration[].class));
+        var flows = res.extract().body().as(FlowsWrapper.class).flows();
         assertTrue(!flows.isEmpty());
         var flow = flows.get(0);
         assertEquals(2, flow.getSteps().size());
@@ -105,7 +106,7 @@ void amqAmqFromJson() throws Exception {
                 .then()
                 .statusCode(Response.Status.OK.getStatusCode());
 
-        var flows = Arrays.asList(res.extract().body().as(Integration[].class));
+        var flows = res.extract().body().as(FlowsWrapper.class).flows();
         assertTrue(!flows.isEmpty());
         var flow = flows.get(0);
         assertEquals(2, flow.getSteps().size());
@@ -168,7 +169,7 @@ void scriptStep() throws Exception {
                 .then()
                 .statusCode(Response.Status.OK.getStatusCode());
 
-        var flows = Arrays.asList(res.extract().body().as(Integration[].class));
+        var flows = res.extract().body().as(FlowsWrapper.class).flows();
         assertTrue(!flows.isEmpty());
         var flow = flows.get(0);
         assertEquals(2, flow.getSteps().size());
@@ -295,7 +296,7 @@ void uriLogStop() throws Exception {
                 .then()
                 .statusCode(Response.Status.OK.getStatusCode());
 
-        var flows = Arrays.asList(res.extract().body().as(Integration[].class));
+        var flows = res.extract().body().as(FlowsWrapper.class).flows();
         assertTrue(!flows.isEmpty());
         var flow = flows.get(0);
         var filter = flow.getSteps().get(1);
@@ -363,7 +364,7 @@ void roundTrip(String file) throws IOException {
 
         assertEquals(res0.extract().body().asString(), res1.extract().body().asString());
 
-        var flows = Arrays.asList(res1.extract().body().as(Integration[].class));
+        var flows = res1.extract().body().as(FlowsWrapper.class);
 
         //Now let's try to recreate the source code
         var res2 = given()

diff --git a/api/src/test/resources/io/kaoto/backend/api/resource/amq-amq-multi.json b/api/src/test/resources/io/kaoto/backend/api/resource/amq-amq-multi.json
@@ -1,4 +1,4 @@
-[
+{ "flows": [
   {
     "dsl": "Camel Route",
     "metadata": {
@@ -2795,4 +2795,5 @@
     "params": [],
     "parameters": null
   }
-]
+]
+}
diff --git a/api/src/test/resources/io/kaoto/backend/api/resource/new-branch-step-multi.json b/api/src/test/resources/io/kaoto/backend/api/resource/new-branch-step-multi.json
@@ -1,4 +1,4 @@
-[
+{ "flows": [
   {
     "dsl": "Camel Route",
     "metadata": {
@@ -144,4 +144,4 @@
     ],
     "params": []
   }
-]
+]}
diff --git a/api/src/test/resources/io/kaoto/backend/api/resource/no-from-multi.json b/api/src/test/resources/io/kaoto/backend/api/resource/no-from-multi.json
@@ -1,4 +1,4 @@
-[
+{ "flows": [
   {
     "dsl": "Camel Route",
     "metadata": {
@@ -456,4 +456,4 @@
     ],
     "params": []
   }
-]
+]}
diff --git a/api/src/test/resources/io/kaoto/backend/api/resource/script-multi.json b/api/src/test/resources/io/kaoto/backend/api/resource/script-multi.json
@@ -1,4 +1,4 @@
-[
+{ "flows": [
   {
     "dsl": "Camel Route",
     "metadata": {
@@ -287,4 +287,4 @@
     ],
     "params": []
   }
-]
+]}