Continuous Deployment CDEvents to render as CloudEvent and schema validation

src/main/java/dev/cdevents/constants/CDEventConstants.java

@@ -27,6 +27,11 @@ public enum SubjectType {
          */
         PIPELINERUN("pipelineRun"),
 
+        /**
+         * Subject Type Environment.
+         */
+        ENVIRONMENT("environment"),
+
         /**
          * Subject type branch.
          */

src/main/java/dev/cdevents/events/EnvironmentCreatedCDEvent.java

@@ -0,0 +1,190 @@
+package dev.cdevents.events;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import dev.cdevents.constants.CDEventConstants;
+import dev.cdevents.models.CDEvent;
+import dev.cdevents.models.EnvironmentCreatedSubject;
+
+import java.net.URI;
+
+public class EnvironmentCreatedCDEvent extends CDEvent {
+
+    private static final String CDEVENT_VERSION = "0.1.0";
+    @JsonProperty(required = true)
+    private EnvironmentCreatedSubject subject;
+
+    /**
+     * Constructor to init CDEvent and set the Subject for {@link EnvironmentCreatedCDEvent}.
+     */
+    public EnvironmentCreatedCDEvent() {
+        initCDEvent(currentCDEventType());
+        setSubject(new EnvironmentCreatedSubject(CDEventConstants.SubjectType.ENVIRONMENT));
+    }
+
+    /**
+     * @return subject
+     */
+    public EnvironmentCreatedSubject getSubject() {
+        return subject;
+    }
+
+    /**
+     * @param subject
+     */
+    public void setSubject(EnvironmentCreatedSubject subject) {
+        this.subject = subject;
+    }
+
+    /**
+     * @return the current CDEvent type
+     */
+    @Override
+    public String currentCDEventType() {
+        return CDEventConstants.CDEventTypes.EnvironmentCreatedEvent.getEventType().concat(CDEVENT_VERSION);
+    }
+
+    /**
+     * @return the environment-created-event schema URL
+     */
+    @Override
+    public String schemaURL() {
+        return String.format("https://cdevents.dev/%s/schema/environment-created-event", CDEventConstants.CDEVENTS_SPEC_VERSION);
+    }
+
+    /**
+     * @return the environment-created-event schema Json
+     */
+    @Override
+    public String eventSchema() {
+        return "{\n" +
+                "  \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n" +
+                "  \"$id\": \"https://cdevents.dev/0.1.2/schema/environment-created-event\",\n" +
+                "  \"properties\": {\n" +
+                "    \"context\": {\n" +
+                "      \"properties\": {\n" +
+                "        \"version\": {\n" +
+                "          \"type\": \"string\",\n" +
+                "          \"minLength\": 1\n" +
+                "        },\n" +
+                "        \"id\": {\n" +
+                "          \"type\": \"string\",\n" +
+                "          \"minLength\": 1\n" +
+                "        },\n" +
+                "        \"source\": {\n" +
+                "          \"type\": \"string\",\n" +
+                "          \"minLength\": 1\n" +
+                "        },\n" +
+                "        \"type\": {\n" +
+                "          \"type\": \"string\",\n" +
+                "          \"enum\": [\n" +
+                "            \"dev.cdevents.environment.created.0.1.0\"\n" +
+                "          ],\n" +
+                "          \"default\": \"dev.cdevents.environment.created.0.1.0\"\n" +
+                "        },\n" +
+                "        \"timestamp\": {\n" +
+                "          \"type\": \"string\",\n" +
+                "          \"format\": \"date-time\"\n" +
+                "        }\n" +
+                "      },\n" +
+                "      \"additionalProperties\": false,\n" +
+                "      \"type\": \"object\",\n" +
+                "      \"required\": [\n" +
+                "        \"version\",\n" +
+                "        \"id\",\n" +
+                "        \"source\",\n" +
+                "        \"type\",\n" +
+                "        \"timestamp\"\n" +
+                "      ]\n" +
+                "    },\n" +
+                "    \"subject\": {\n" +
+                "      \"properties\": {\n" +
+                "        \"id\": {\n" +
+                "          \"type\": \"string\",\n" +
+                "          \"minLength\": 1\n" +
+                "        },\n" +
+                "        \"source\": {\n" +
+                "          \"type\": \"string\"\n" +
+                "        },\n" +
+                "        \"type\": {\n" +
+                "          \"type\": \"string\",\n" +
+                "          \"minLength\": 1\n" +
+                "        },\n" +
+                "        \"content\": {\n" +
+                "          \"properties\": {\n" +
+                "            \"name\": {\n" +
+                "              \"type\": \"string\"\n" +
+                "            },\n" +
+                "            \"url\": {\n" +
+                "              \"type\": \"string\"\n" +
+                "            }\n" +
+                "          },\n" +
+                "          \"additionalProperties\": false,\n" +
+                "          \"type\": \"object\"\n" +
+                "        }\n" +
+                "      },\n" +
+                "      \"additionalProperties\": false,\n" +
+                "      \"type\": \"object\",\n" +
+                "      \"required\": [\n" +
+                "        \"id\",\n" +
+                "        \"type\",\n" +
+                "        \"content\"\n" +
+                "      ]\n" +
+                "    },\n" +
+                "    \"customData\": {\n" +
+                "      \"oneOf\": [\n" +
+                "        {\n" +
+                "          \"type\": \"object\"\n" +
+                "        },\n" +
+                "        {\n" +
+                "          \"type\": \"string\",\n" +
+                "          \"contentEncoding\": \"base64\"\n" +
+                "        }\n" +
+                "      ]\n" +
+                "    },\n" +
+                "    \"customDataContentType\": {\n" +
+                "      \"type\": \"string\"\n" +
+                "    }\n" +
+                "  },\n" +
+                "  \"additionalProperties\": false,\n" +
+                "  \"type\": \"object\",\n" +
+                "  \"required\": [\n" +
+                "    \"context\",\n" +
+                "    \"subject\"\n" +
+                "  ]\n" +
+                "}";
+    }
+
+    /**
+     * @param subjectId
+     * sets the subject Id
+     */
+    public void setSubjectId(String subjectId) {
+        getSubject().setId(subjectId);
+    }
+
+    /**
+     * @param subjectSource
+     * sets the subject source
+     */
+    public void setSubjectSource(URI subjectSource) {
+        getSubject().setSource(subjectSource);
+    }
+
+    /**
+     * @param subjectName
+     * sets the subject name
+     */
+    public void setSubjectName(String subjectName) {
+        getSubject().getContent().setName(subjectName);
+    }
+
+    /**
+     * @param subjectUrl
+     * sets the subject URL
+     */
+    public void setSubjectUrl(String subjectUrl) {
+        getSubject().getContent().setUrl(subjectUrl);
+    }
+
+
+}

src/main/java/dev/cdevents/models/EnvironmentCreatedSubject.java

@@ -0,0 +1,73 @@
+package dev.cdevents.models;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import dev.cdevents.constants.CDEventConstants;
+
+public class EnvironmentCreatedSubject extends Subject {
+
+    @JsonProperty(required = true)
+    private  EnvironmentCreatedSubjectContent content;
+
+
+
+    /**
+     * @return the EnvironmentCreated subject's content
+     */
+    public EnvironmentCreatedSubjectContent getContent() {
+        return content;
+    }
+
+    /**
+     * @param content
+     */
+    public void setContent(EnvironmentCreatedSubjectContent content) {
+        this.content = content;
+    }
+
+    /**
+     * Constructor to set the Subject Type.
+     *
+     * @param subjectType
+     */
+    public EnvironmentCreatedSubject(CDEventConstants.SubjectType subjectType) {
+        super(subjectType);
+        setContent(new EnvironmentCreatedSubjectContent());
+    }
+
+
+    public class EnvironmentCreatedSubjectContent {
+        @JsonProperty
+        private String name;
+
+        @JsonProperty
+        private String url;
+
+        /**
+         * @return name
+         */
+        public String getName() {
+            return name;
+        }
+
+        /**
+         * @param name
+         */
+        public void setName(String name) {
+            this.name = name;
+        }
+
+        /**
+         * @return url
+         */
+        public String getUrl() {
+            return url;
+        }
+
+        /**
+         * @param url
+         */
+        public void setUrl(String url) {
+            this.url = url;
+        }
+    }
+}

src/test/java/dev/cdevents/CDEventsTest.java

@@ -580,4 +580,38 @@ void testInvalidChangeUpdatedEventWithNoSubject() {
 
         assertThat(exception.getMessage()).isEqualTo(expectedError);
     }
+
+    @Test
+    void createEnvironmentCreatedEventAsCloudEvent(){
+        EnvironmentCreatedCDEvent cdEvent = new EnvironmentCreatedCDEvent();
+        cdEvent.setSource(URI.create("http://dev.cdevents"));
+
+        cdEvent.setSubjectId("/dev/pipeline/run/subject");
+        cdEvent.setSubjectSource(URI.create("/dev/pipeline/run/subject"));
+        cdEvent.setSubjectName("Name");
+        cdEvent.setSubjectUrl("http://dev/pipeline/url");
+
+        String cdEventJson = CDEvents.cdEventAsJson(cdEvent);
+
+        CloudEvent ceEvent = CDEvents.cdEventAsCloudEvent(cdEvent);
+
+        String ceDataJson = new String(ceEvent.getData().toBytes(), StandardCharsets.UTF_8);
+
+        assertThat(ceEvent.getType()).isEqualTo(cdEvent.getContext().getType());
+        assertThat(ceEvent.getSource()).isEqualTo(cdEvent.getContext().getSource());
+        assertThat(ceDataJson).isEqualTo(cdEventJson);
+    }
+
+    @Test
+    void testInvalidEnvironmentCreatedEventWithNoSubject(){
+        EnvironmentCreatedCDEvent cdEvent = new EnvironmentCreatedCDEvent();
+        cdEvent.setSource(URI.create("http://dev.cdevents"));
+
+        Exception exception = assertThrows(CDEventsException.class, () -> {
+            CDEvents.cdEventAsCloudEvent(cdEvent);
+        });
+        String expectedError = "CDEvent validation failed against schema URL - " + cdEvent.schemaURL();
+
+        assertThat(exception.getMessage()).isEqualTo(expectedError);
+    }
 }