[AUTO] Model Tracker

.github/workflows/generate-model.yaml

@@ -6,9 +6,6 @@ on:
       - '**'
   workflow_dispatch:
 
-env:
-  SCHEMAS: "RC-EDA RS-EDA EMSI GEO-POS GEO-REQ GEO-RES RC-REF RS-ERROR RS-RI RS-DR RS-RR RS-RPIS RS-EDA-MAJ RS-SR RS-URL RS-ER RS-BPV TECHNICAL TECHNICAL_NOREQ"
-
 jobs:
   generate:
     runs-on: ubuntu-latest
@@ -51,6 +48,15 @@ jobs:
         if: steps.filter.outputs.parsing_required == 'true' || steps.filter.outputs.test_case_parsing_required == 'true'
         run: pip install -r ./requirements.txt
 
+      - name: Clean up old generated schemas
+        working-directory: ./src/main/resources
+        run: find ./json-schema -type f -name '*.json' ! -name 'customContent.schema.json' ! -name 'EDXL-DE-*.schema.json' -exec rm {} +
+
+      - name: Clean up old generated java classes
+        working-directory: ./src/main/java/com/hubsante/model
+        # We specifically only remove FOLDERS with the exception of a couple manually created ones
+        run: find . -mindepth 1 -maxdepth 1 -type d ! -name 'builders' ! -name 'config' ! -name 'custom' ! -name 'edxl' ! -name 'exception' ! -name 'report' -exec rm -r {} +
+
       - name: Run csv_parser and collect OpenAPI & JSON Schemas
         working-directory: ./csv_parser
         if: steps.filter.outputs.parsing_required == 'true'
@@ -63,6 +69,38 @@ jobs:
           rm -r ./out/test-cases || true
           python workflow.py --stage test_case_parser
 
+      - name: Run csv_parser to generate schemas.yaml
+        working-directory: ./csv_parser
+        if: steps.filter.outputs.parsing_required == 'true'
+        run: python workflow.py --stage output_schemas_yaml
+
+      - name: Collect schemas.yaml and copy it to json_schema2xsd
+        working-directory: ./csv_parser
+        if: steps.filter.outputs.parsing_required == 'true'
+        run: |
+          cp ./out/schemas.yaml ./json_schema2xsd/src/main/resources/schemas.yaml
+
+      - name: Setup gomplate
+        if: steps.filter.outputs.parsing_required == 'true'
+        uses: jason-dour/[email protected]
+        with:
+          gomplate-version: v4.2.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Run automatic-schema-generator and move generated files to corresponding locations
+        if: steps.filter.outputs.parsing_required == 'true'
+        working-directory: ./automatic-schema-generator
+        run: |
+          rm -r output || true
+          chmod +x ./automatic-generator.sh
+          ./automatic-generator.sh
+          rm -r ../generator/config/generated || true
+          rsync -a --remove-source-files output/generator ..
+          rsync -a --remove-source-files output/edxl ../src/main/java/com/hubsante/model
+          rsync -a --remove-source-files output/json-schema ../src/main/resources
+          rsync -a --remove-source-files output/xsd ../src/main/resources
+
       - name: Install JDK 11
         uses: actions/setup-java@v4
         if: steps.filter.outputs.parsing_required == 'true'
@@ -79,9 +117,8 @@ jobs:
         working-directory: ./csv_parser/json_schema2xsd
         if: steps.filter.outputs.parsing_required == 'true'
         run: |
-          rm out/RS-ERROR.xsd
           # Clean XSD repo but keep manual XSDs
-          find ../../src/main/resources/xsd -type f -name '*.xsd' ! -name 'EDXL-DE-*.xsd' ! -name 'CustomContent.xsd' ! -name 'RC-XML-ContentType.xsd' ! -name 'RS-ERROR.xsd' ! -path '**/other-supporting-schema/*' -exec rm {} +
+          find ../../src/main/resources/xsd -type f -name '*.xsd' ! -name 'EDXL-DE-*.xsd' ! -name 'customContent.xsd' ! -name 'RC-DE.xsd' ! -name 'RC-XML-ContentType.xsd' ! -name 'RS-ERROR.xsd' ! -path '**/other-supporting-schema/*' -exec rm {} +
           mv out/*.xsd ../../src/main/resources/xsd/
 
       - name: Remove input JSON Schemas
@@ -104,18 +141,15 @@ jobs:
       - name: Generate Java classes
         working-directory: ./generator
         run: |
-          npx @openapitools/openapi-generator-cli generate -c ./config/RC-DE/RC-DE.generator-config.json --skip-validate-spec
-          npx @openapitools/openapi-generator-cli generate -c ./config/RC-DE/RC-DE.distribution-element.generator-config.json --skip-validate-spec
-
-          IFS=' ' read -ra SCHEMAS_ARRAY <<< "$SCHEMAS"
-          for SCHEMA in "${SCHEMAS_ARRAY[@]}"; do
-            if [ "$SCHEMA" != "RS-EDA-MAJ" ] && [ "$SCHEMA" != "RS-ER" ]; then
-            npx @openapitools/openapi-generator-cli generate -c ./config/$SCHEMA/$SCHEMA.generator-config.json --skip-validate-spec
-            fi
-            npx @openapitools/openapi-generator-cli generate -c ./config/$SCHEMA/$SCHEMA.usecase.generator-config.json --skip-validate-spec
-            npx @openapitools/openapi-generator-cli generate -c ./config/$SCHEMA/$SCHEMA.wrapper.generator-config.json --skip-validate-spec
-          done
-
+          # Iterate over each file in the ./config directory, including the entire subfolder structure
+          # and then run @openapitools/openapi-generator-cli generate for each file found
+          # Important notice:          
+          # Results of the find command are sorted in an alphabetic order before being passed to xargs
+          # This means that since the order of class generation is important, it's necessary to maintain an adequately 
+          # named file structure in the ./config/** directories
+          # generator-config.json (if exists) -> usecase.generator-config.json -> wrapper.generator-config.json
+          find ./config/ -type f | sort -n | xargs -i npx @openapitools/openapi-generator-cli generate -c {} --skip-validate-spec
+
       - name: Replace src/ with generated classes
         run: |
           rm -r ./src/main/java/com/hubsante/model/rcde || true

automatic-schema-generator/automatic-generator.sh

@@ -0,0 +1,20 @@
+# We will be using the file schemas.yaml as data source to use with gomplate in order to generate all the files
+# required for each schema
+
+# generate base generator config files
+gomplate -f ./templates/schema.generator-config.json.tmpl -d config=./schemas.yaml -o ./output/generator/config
+
+# generate usecase config files
+gomplate -f ./templates/schema.usecase.generator-config.json.tmpl -d config=./schemas.yaml -o ./output/generator/config
+
+# generate wrapper config files
+gomplate -f ./templates/schema.wrapper.generator-config.json.tmpl -d config=./schemas.yaml -o ./output/generator/config
+
+# generate ContentMessage class
+gomplate -f ./templates/ContentMessage.java.tmpl -d config=./schemas.yaml -o ./output/edxl/ContentMessage.java
+
+# generate EDXL-DE json schema
+gomplate -f ./templates/EDXL-DE-full.schema.json.tmpl -d config=./schemas.yaml -o ./output/json-schema/EDXL-DE-full.schema.json
+
+# generate RC-XML-ContentType xsd schema
+gomplate -f ./templates/RC-XML-ContentType.xsd.tmpl -d config=./schemas.yaml -o ./output/xsd/RC-XML-ContentType.xsd

automatic-schema-generator/schemas.yaml

@@ -0,0 +1 @@
+../csv_parser/json_schema2xsd/src/main/resources/schemas.yaml

automatic-schema-generator/templates/ContentMessage.java.tmpl

@@ -0,0 +1,53 @@
+/**************************************************************************
+ * This file has been generated by the automatic schema generator script.
+ **************************************************************************/
+
+package com.hubsante.model.edxl;
+
+import com.fasterxml.jackson.annotation.JsonSubTypes;
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+
+{{ range (datasource "config").schemas }}
+{{- if eq .automaticGeneration "Y" -}}
+import com.hubsante.model.{{ .package }}.{{ .rootElement | title }};
+import com.hubsante.model.{{ .package }}.{{ .rootElement | title }}Wrapper;
+{{ end }}{{ end -}}
+import com.hubsante.model.report.ErrorWrapper;
+import com.hubsante.model.custom.CustomMessage;
+import java.util.Map;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+@JsonTypeInfo(use = JsonTypeInfo.Id.DEDUCTION)
+@JsonSubTypes({ {{ range $i, $e := (datasource "config").schemas }}{{if eq .automaticGeneration "Y"}}
+        @JsonSubTypes.Type({{ .rootElement | title }}Wrapper.class),{{end}}{{end}}
+        @JsonSubTypes.Type(ErrorWrapper.class),
+        @JsonSubTypes.Type(CustomMessage.class)
+})
+public class ContentMessage {
+
+    /** This equals override is used to avoid breaking the equals override in the messages without RC-DE headers
+     * (in particular ErrorWrapper), as without the override the equality check would only pass when comparing
+     * an object to itself, and we care about the actual values.
+     **/
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        return o != null && getClass() == o.getClass();
+    }
+
+    // As this class has no fields, the hashcode is always 0
+    @Override
+    public int hashCode() {
+        return 0;
+    }
+
+    public static class UseCaseHelper {
+        public static final Map<String,String> useCases = Stream.of(new String[][] {
+                  {{ range $i, $e := (datasource "config").schemas }}{{if eq .automaticGeneration "Y"}}
+                  {"{{ .rootElement }}", {{ .rootElement | title }}.class.getCanonicalName()},{{end}}{{end}}
+                  {"error", ErrorWrapper.class.getCanonicalName()},
+                  {"customContent", CustomMessage.class.getCanonicalName()}
+        }).collect(Collectors.toMap(useCaseData -> useCaseData[0], useCaseData -> useCaseData[1]));
+    }
+}

automatic-schema-generator/templates/ContentMessageDeserializer.java.tmpl

@@ -0,0 +1,54 @@
+/**************************************************************************
+ * This file has been generated by the automatic schema generator script.
+ **************************************************************************/
+
+package com.hubsante.model;
+
+import com.fasterxml.jackson.core.JsonParseException;
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.core.ObjectCodec;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.JsonDeserializer;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.hubsante.model.edxl.ContentMessage;
+import com.hubsante.model.edxl.Descriptor;
+import com.hubsante.model.edxl.EdxlMessage;
+import com.hubsante.model.edxl.Keyword;
+{{ range (datasource "config").schemas }}{{if eq .automaticGeneration "Y" -}}
+import com.hubsante.model.{{ .package }}.{{ .rootElement | title }}Wrapper;
+{{ end }}{{ end -}}
+import com.hubsante.model.report.ErrorWrapper;
+import com.hubsante.model.custom.CustomMessage;
+
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
+
+public class ContentMessageDeserializer extends JsonDeserializer<ContentMessage> {
+
+    private static final Map<String, Class> useCases = new HashMap<String, Class>() { {
+        {{ range (datasource "config").schemas }}{{if eq .automaticGeneration "Y"}}put("{{ .rootElement }}", {{ .rootElement | title }}Wrapper.class);
+        {{ end }}{{ end -}}
+        put("error", ErrorWrapper.class);
+        put("customContent", CustomMessage.class);
+    } };
+
+    @Override
+    public ContentMessage deserialize(JsonParser jp, DeserializationContext ctxt) throws IOException {
+        ObjectCodec codec = jp.getCodec();
+        JsonNode node = codec.readTree(jp);
+        String model = null;
+        try {
+            model = ((EdxlMessage) jp.getParsingContext().getParent().getParent().getParent().getParent().getCurrentValue()).getDescriptor().getKeyword().stream().filter(keyword -> keyword.getValueListURI().equals("urn:hubsante:model")).findFirst().get().getValue();
+        } catch (NullPointerException e) {
+            throw new JsonParseException(jp, "Model name not found in $.descriptor.keyword[0].value");
+        }
+        // Find model in useCases map, throw JsonParseException if not found
+        Class clazz = useCases.get(model);
+        if (clazz == null) {
+            throw new JsonParseException(jp, "Unknown model: " + model);
+        }
+
+        return (ContentMessage) codec.treeToValue(node, clazz);
+    }
+}