PART 2: Generate events using jsonschema2pojo and mustache template (#60)

Changes to generate event class file using template
---------

Signed-off-by: Jalander Ramagiri <jalander.ramagiri@est.tech>
Co-authored-by: Lapenta Francesco Davide <37077655+lapentad@users.noreply.github.com>

Author: rjalander

.github/workflows/test.yml

@@ -17,6 +17,7 @@ jobs:
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
+          submodules: 'true'
 
       - name: Setup Java
         uses: actions/setup-java@v3

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "spec"]
+	path = spec
+	url = git@github.com:cdevents/spec.git

generator/pom.xml

@@ -52,9 +52,9 @@ public static void main(String[] args) {
         }
         String generatorBaseDir = args[0];
         String sdkBaseDir = args[1];
+        String parentBaseDir = args[2];
         String targetPackageDir = sdkBaseDir + File.separator + "src/main/java/dev/cdevents/events";
-        File folder = new File(sdkBaseDir + File.separator + RESOURCES_DIR + "schema");
-        System.out.println(folder.toPath().toAbsolutePath());
+        File folder = new File(parentBaseDir + File.separator + "spec" + File.separator + "schemas");
         if (folder.isDirectory()) {
             File[] files = folder.listFiles((dir, name) -> name.toLowerCase().endsWith(".json"));
             if (files != null) {
@@ -68,7 +68,11 @@ public static void main(String[] args) {
                     SchemaData schemaData = buildCDEventDataFromJsonSchema(file);
                     generateClassFileFromSchemaData(mustache, schemaData, targetPackageDir);
                 }
+            } else {
+                log.error("No schema files found in the specified directory {}", folder.getAbsolutePath());
             }
+        } else {
+            log.error("No schema directory found in the specified directory {}", folder.getAbsolutePath());
         }
     }
 
@@ -94,21 +98,19 @@ private static SchemaData buildCDEventDataFromJsonSchema(File file) {
         try {
             JsonNode rootNode = objectMapper.readTree(file);
             JsonNode contextNode = rootNode.get("properties").get("context").get("properties");
+            String schemaURL = rootNode.get("$id").asText();
 
             String eventType = contextNode.get("type").get("enum").get(0).asText();
             log.info("eventType: {}", eventType);
             String[] type = eventType.split("\\.");
             String subject = type[SUBJECT_INDEX];
             String predicate = type[PREDICATE_INDEX];
             String capitalizedSubject = StringUtils.capitalize(subject);
-            if (subject.equals("pipelinerun")) {
-                capitalizedSubject = capitalizedSubject.substring(0, SUBSTRING_PIPELINE_INDEX)
-                        + StringUtils.capitalize(subject.substring(SUBSTRING_PIPELINE_INDEX));
-            }
             String capitalizedPredicate = StringUtils.capitalize(predicate);
             String version = type[VERSION_INDEX];
 
             //set the Schema JsonNode required values to schemaData
+            schemaData.setSchemaURL(schemaURL);
             schemaData.setSubject(subject);
             schemaData.setPredicate(predicate);
             schemaData.setCapitalizedSubject(capitalizedSubject);

generator/src/main/java/dev/cdevents/generator/CDEventsGenerator.java

@@ -17,6 +17,8 @@ public class SchemaData {
     private String upperCaseSubject;
     private String schemaFileName;
 
+    private String schemaURL;
+
     private List<ContentField> contentFields;
 
     private List<ContentObjectField> contentObjectFields;
@@ -153,6 +155,20 @@ public void setSchemaFileName(String schemaFileName) {
         this.schemaFileName = schemaFileName;
     }
 
+    /**
+     * @return schemaURL
+     */
+    public String getSchemaURL() {
+        return schemaURL;
+    }
+
+    /**
+     * @param schemaURL
+     */
+    public void setSchemaURL(String schemaURL) {
+        this.schemaURL = schemaURL;
+    }
+
     /**
      * @return the Content fields of an event
      */

generator/src/main/java/dev/cdevents/generator/SchemaData.java

@@ -34,7 +34,7 @@ import java.nio.file.Files;
 import java.nio.file.Paths;
 
 
-public class {{capitalizedSubject}}{{capitalizedPredicate}}CDEvent extends {{capitalizedSubject}}{{capitalizedPredicate}}Event implements CDEvent {
+public class {{capitalizedSubject}}{{capitalizedPredicate}}CDEvent extends {{capitalizedSubject}}{{predicate}} implements CDEvent {
 
 
     /**
@@ -93,8 +93,7 @@ public class {{capitalizedSubject}}{{capitalizedPredicate}}CDEvent extends {{cap
 
     @Override
     public String schemaURL() {
-        String eventSchemaName = "{{schemaFileName}}".substring(0, "{{schemaFileName}}".lastIndexOf(".json"));
-        return String.format("https://cdevents.dev/%s/schema/%s", CDEventConstants.CDEVENTS_SPEC_VERSION, eventSchemaName);
+        return "{{schemaURL}}";
     }
 
 

generator/src/main/resources/template/event-template.mustache

@@ -196,7 +196,6 @@
 			</plugin>
 		</plugins>
 	</build>
-
 	<profiles>
 		<profile>
 			<id>publication</id>

pom.xml

@@ -8,7 +8,8 @@ private CDEventConstants() {
     /**
      * Event JsonSchema files location.
      */
-    public static final String SCHEMA_FOLDER = "src/main/resources/schema";
+    public static final String SCHEMA_FOLDER = "../spec/schemas";
+
     /**
      * Mustache generic event template file.
      */

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

@@ -34,7 +34,7 @@
 import java.nio.file.Paths;
 
 
-public class ArtifactPackagedCDEvent extends ArtifactPackagedEvent implements CDEvent {
+public class ArtifactPackagedCDEvent extends Artifactpackaged implements CDEvent {
 
 
     /**
@@ -86,24 +86,23 @@ public String currentCDEventType() {
 
 
     /**
-    * @return the artifact-packaged-event.json schema URL
+    * @return the artifactpackaged.json schema URL
     */
 
     @Override
     public String schemaURL() {
-        String eventSchemaName = "artifact-packaged-event.json".substring(0, "artifact-packaged-event.json".lastIndexOf(".json"));
-        return String.format("https://cdevents.dev/%s/schema/%s", CDEventConstants.CDEVENTS_SPEC_VERSION, eventSchemaName);
+        return "https://cdevents.dev/0.1.2/schema/artifact-packaged-event";
     }
 
 
     /**
-    * @return the artifact-packaged-event.json schema Json
+    * @return the artifactpackaged.json schema Json
     */
 
     @Override
     public String eventSchema() {
         try {
-            return Files.readString(Paths.get(CDEventConstants.SCHEMA_FOLDER + "/artifact-packaged-event.json"));
+            return Files.readString(Paths.get(CDEventConstants.SCHEMA_FOLDER + "/artifactpackaged.json"));
         } catch (IOException e) {
             throw new CDEventsException("Exception while reading Event JsonSchema file ", e);
         }

sdk/src/main/java/dev/cdevents/events/ArtifactPackagedCDEvent.java

@@ -34,7 +34,7 @@
 import java.nio.file.Paths;
 
 
-public class ArtifactPublishedCDEvent extends ArtifactPublishedEvent implements CDEvent {
+public class ArtifactPublishedCDEvent extends Artifactpublished implements CDEvent {
 
 
     /**
@@ -85,24 +85,23 @@ public String currentCDEventType() {
 
 
     /**
-    * @return the artifact-published-event.json schema URL
+    * @return the artifactpublished.json schema URL
     */
 
     @Override
     public String schemaURL() {
-        String eventSchemaName = "artifact-published-event.json".substring(0, "artifact-published-event.json".lastIndexOf(".json"));
-        return String.format("https://cdevents.dev/%s/schema/%s", CDEventConstants.CDEVENTS_SPEC_VERSION, eventSchemaName);
+        return "https://cdevents.dev/0.1.2/schema/artifact-published-event";
     }
 
 
     /**
-    * @return the artifact-published-event.json schema Json
+    * @return the artifactpublished.json schema Json
     */
 
     @Override
     public String eventSchema() {
         try {
-            return Files.readString(Paths.get(CDEventConstants.SCHEMA_FOLDER + "/artifact-published-event.json"));
+            return Files.readString(Paths.get(CDEventConstants.SCHEMA_FOLDER + "/artifactpublished.json"));
         } catch (IOException e) {
             throw new CDEventsException("Exception while reading Event JsonSchema file ", e);
         }

sdk/src/main/java/dev/cdevents/events/ArtifactPublishedCDEvent.java

@@ -0,0 +1,156 @@
+// Code generated by dev.cdevents.generator.CDEventsGenerator. DO NOT EDIT.
+
+/*
+Copyright 2023 The CDEvents Authors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package dev.cdevents.events;
+
+
+import dev.cdevents.constants.CDEventConstants;
+import dev.cdevents.exception.CDEventsException;
+import dev.cdevents.models.CDEvent;
+import dev.cdevents.models.branch.created.*;
+
+import java.net.URI;
+import java.util.Date;
+import java.util.UUID;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+
+
+public class BranchCreatedCDEvent extends Branchcreated implements CDEvent {
+
+
+    /**
+    * Constructor to init CDEvent and set the Subject for {@link BranchCreatedCDEvent}.
+    */
+
+    public BranchCreatedCDEvent() {
+        initCDEvent();
+    }
+
+
+    /**
+    * Initialize the CDEvent with the context values.
+    */
+
+    @Override
+    public void initCDEvent() {
+        setContext(new Context());
+        setSubject(new Subject());
+        setCustomData(new Object());
+        setCustomDataContentType("application/json");
+        Context context = getContext();
+        context.setId(UUID.randomUUID().toString());
+        context.setTimestamp(new Date());
+        context.setVersion(CDEventConstants.CDEVENTS_SPEC_VERSION);
+        getSubject().setContent(new Content());
+        getSubject().getContent().setRepository(new Repository());
+        getSubject().setType(CDEventConstants.SubjectType.BRANCH.getSubjectType());
+    }
+
+    /**
+    * @return the event source
+    */
+
+    @Override
+    public String eventSource() {
+        return getContext().getSource();
+    }
+
+
+    /**
+    * @return the current CDEvent type
+    */
+
+    @Override
+    public String currentCDEventType() {
+        return getContext().getType().value();
+    }
+
+
+    /**
+    * @return the branchcreated.json schema URL
+    */
+
+    @Override
+    public String schemaURL() {
+        return "https://cdevents.dev/0.1.2/schema/branch-created-event";
+    }
+
+
+    /**
+    * @return the branchcreated.json schema Json
+    */
+
+    @Override
+    public String eventSchema() {
+        try {
+            return Files.readString(Paths.get(CDEventConstants.SCHEMA_FOLDER + "/branchcreated.json"));
+        } catch (IOException e) {
+            throw new CDEventsException("Exception while reading Event JsonSchema file ", e);
+        }
+    }
+
+
+    /**
+    * @param source
+    * Sets the {@link Context} source value
+    */
+
+    public void setSource(URI source) {
+        getContext().setSource(source.toString());
+    }
+
+
+    /**
+    * @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.toString());
+    }
+
+
+
+    /**
+    * @param id
+    */
+    public void setSubjectRepositoryId(String id) {
+        getSubject().getContent().getRepository().setId(id);
+    }
+    /**
+    * @param source
+    */
+    public void setSubjectRepositorySource(String source) {
+        getSubject().getContent().getRepository().setSource(source);
+    }
+
+}