fix(cdevents-webhooks) : Adding support for Artifact Constraints and Parameters

echo-webhooks/src/main/groovy/com/netflix/spinnaker/echo/controllers/WebhooksController.groovy

@@ -17,21 +17,19 @@
 package com.netflix.spinnaker.echo.controllers
 
 import com.fasterxml.jackson.databind.ObjectMapper
+import com.netflix.spinnaker.echo.api.events.Event
+import com.netflix.spinnaker.echo.api.events.Metadata
 import com.netflix.spinnaker.echo.artifacts.ArtifactExtractor
 import com.netflix.spinnaker.echo.events.EventPropagator
-import com.netflix.spinnaker.echo.scm.ScmWebhookHandler
 import com.netflix.spinnaker.echo.scm.GitWebhookHandler
-import com.netflix.spinnaker.echo.api.events.Event
-import com.netflix.spinnaker.echo.api.events.Metadata
+import com.netflix.spinnaker.echo.scm.ScmWebhookHandler
 import groovy.util.logging.Slf4j
+import io.cloudevents.CloudEvent
 import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.http.HttpHeaders
 import org.springframework.http.ResponseEntity
 import org.springframework.util.CollectionUtils
-import org.springframework.util.MultiValueMap
 import org.springframework.web.bind.annotation.*
-import io.cloudevents.CloudEvent
-import java.nio.charset.StandardCharsets
 
 @RestController
 @Slf4j
@@ -140,31 +138,43 @@ class WebhooksController {
                                     @RequestBody CloudEvent cdevent,
                                     @RequestHeader HttpHeaders headers) {
     log.info("CDEvents Webhook received with source ${source} and with event type ${cdevent.getType()}")
-
-    String ceDataJsonString = new String(cdevent.getData().toBytes(), StandardCharsets.UTF_8);
-
-    Event event = new Event()
-    boolean sendEvent = true
-    event.details = new Metadata()
-    event.details.source = source
-    event.details.type = "cdevents"
-    event.details.requestHeaders = headers
-    event.rawContent = ceDataJsonString
+    String ceDataJsonString  = headers.get("Ce-Data").get(0)
+    log.info("CDEvent received with in the CloudEvent data request {}", ceDataJsonString)
     Map postedEvent
     try {
       postedEvent = mapper.readValue(ceDataJsonString, Map) ?: [:]
+      if (postedEvent.get("customData") == null || !postedEvent.get("context") || !postedEvent.get("subject")) {
+        throw new RuntimeException("Invalid CDEvent data posted with the CloudEvent RequestBody - " + postedEvent);
+      }
     } catch (Exception e) {
       log.error("Failed to parse payload ceDataJsonString: {}", ceDataJsonString, e);
       throw e
     }
-    event.content = postedEvent
-    event.payload = new HashMap(postedEvent)
 
+    Event event = new Event()
+    event.details = new Metadata()
+    event.details.source = source
+    event.details.type = "cdevents"
+    event.details.requestHeaders = headers
+    event.rawContent = ceDataJsonString
+    event.payload = new HashMap(postedEvent)
+    event.content = new HashMap<>();
+
+    Map customDataMap = new HashMap(postedEvent.get("customData"))
+    def artifacts = customDataMap.get("artifacts")
+    def parameters = customDataMap.get("parameters")
+    if (artifacts){
+      log.info("Artifacts received from postedEvent - {}", artifacts)
+      event.content.artifacts = artifacts
+    }
+    if (parameters){
+      log.info("Parameters received from postedEvent - {}", parameters)
+      event.content.parameters = parameters
+    }
     propagator.processEvent(event)
 
     WebhookResponse.newInstance(eventProcessed: true, eventId: event.eventId)
     ResponseEntity.ok().build();
-
   }
 
   private static class WebhookResponse {

echo-webhooks/src/test/groovy/com/netflix/spinnaker/echo/controllers/WebhooksControllerSpec.groovy

@@ -29,7 +29,8 @@ import com.netflix.spinnaker.echo.scm.bitbucket.server.BitbucketServerEventHandl
 import org.springframework.http.HttpHeaders
 import spock.lang.Specification
 import io.cloudevents.CloudEvent
-import io.cloudevents.core.builder.CloudEventBuilder;
+import io.cloudevents.core.builder.CloudEventBuilder
+import com.fasterxml.jackson.databind.ObjectMapper
 
 
 import java.nio.charset.StandardCharsets
@@ -828,19 +829,49 @@ class WebhooksControllerSpec extends Specification {
     WebhooksController controller = new WebhooksController(mapper: EchoObjectMapper.getInstance(), scmWebhookHandler: scmWebhookHandler)
     controller.propagator = Mock(EventPropagator)
 
+    String cdEventData = "{\n" +
+      "  \"context\": {\n" +
+      "    \"id\": \"5fb38d7d-28dd-47e4-ade2-cb21153cc8dc\",\n" +
+      "    \"type\": \"dev.cdevents.artifact.published.0.1.0\",\n" +
+      "    \"source\": \"https://ci-build.est.tech/\",\n" +
+      "    \"version\": \"0.1.2\"\n" +
+      "  },\n" +
+      "  \"customData\": {\n" +
+      "    \"artifacts\": [\n" +
+      "      {\n" +
+      "        \"type\": \"custom/object\",\n" +
+      "        \"name\": \"image-cdevents\",\n" +
+      "        \"version\": \"1.0.1\",\n" +
+      "        \"reference\": \"custom/object/artifact\"\n" +
+      "      }\n" +
+      "    ],\n" +
+      "    \"parameters\": {\n" +
+      "      \"stack\": \"prod\"\n" +
+      "    }\n" +
+      "  },\n" +
+      "  \"customDataContentType\": \"application/json\",\n" +
+      "  \"subject\": {\n" +
+      "    \"type\": \"ARTIFACT\",\n" +
+      "    \"content\": {\n" +
+      "      \"pipelineName\": \"test-1\",\n" +
+      "      \"outcome\": \"SUCCESS\"\n" +
+      "    }\n" +
+      "  }\n" +
+      "}"
     HttpHeaders headers = new HttpHeaders();
     headers.add("Ce-Id", "1234")
     headers.add("Ce-Specversion", "1.0")
     headers.add("Ce-Type", "dev.cdevents.artifact.packaged")
+    headers.add("Ce-Data", cdEventData)
 
-    String eventData = "{\"id\": \"1234\", \"subject\": \"event\"}";
-    CloudEvent cdevent = CloudEventBuilder.v1() //
-      .withId("12345") //
-      .withType("dev.cdevents.artifact.packaged") //
-      .withSource(URI.create("https://cdevents.dev")) //
-      .withData(eventData.getBytes(StandardCharsets.UTF_8)) //
+    CloudEvent cdevent = CloudEventBuilder.v1()
+      .withId("12345")
+      .withType("dev.cdevents.artifact.packaged")
+      .withSource(URI.create("https://cdevents.dev"))
       .build();
 
+    Map dataMap = new ObjectMapper().readValue(cdEventData, Map) ?: [:]
+    Map customDataMap = new HashMap(dataMap.get("customData"))
     when:
     def response = controller.forwardEvent("artifactPackaged",cdevent, headers)
 
@@ -851,9 +882,37 @@ class WebhooksControllerSpec extends Specification {
 
     event.details.type == "cdevents"
     event.details.source == "artifactPackaged"
-    event.rawContent == eventData
+    event.rawContent == cdEventData
     event.details.requestHeaders.get("Ce-Type")[0] == "dev.cdevents.artifact.packaged"
     event.details.requestHeaders.get("Ce-Id")[0] == "1234"
+    event.content.artifacts == customDataMap.get("artifacts")
+    event.content.parameters == customDataMap.get("parameters")
+
+  }
+
+  void "handles RuntimeException with invalid CDEvents Webhook Event"() {
+    given:
+    WebhooksController controller = new WebhooksController(mapper: EchoObjectMapper.getInstance(), scmWebhookHandler: scmWebhookHandler)
+    controller.propagator = Mock(EventPropagator)
+    String cdEventData = "{\"id\": \"1234\", \"subject\": \"event\"}"
+    HttpHeaders headers = new HttpHeaders()
+    headers.add("Ce-Id", "1234")
+    headers.add("Ce-Specversion", "1.0")
+    headers.add("Ce-Type", "dev.cdevents.artifact.packaged")
+    headers.add("Ce-Data", cdEventData)
+
+    CloudEvent cdevent = CloudEventBuilder.v1()
+      .withId("12345")
+      .withType("dev.cdevents.artifact.packaged")
+      .withSource(URI.create("https://cdevents.dev"))
+      .build();
+    Map dataMap = new ObjectMapper().readValue(cdEventData, Map) ?: [:]
+
+    when:
+    def response = controller.forwardEvent("artifactPackaged",cdevent, headers)
+    then:
+    def exception = thrown(RuntimeException)
+    exception.message == "Invalid CDEvent data posted with the CloudEvent RequestBody - $dataMap"
 
   }
 }