Merge pull request #674 from bci-oss/669-invalid-attribute-in-sample-json-payload

Fix generation of JSON sample payload

Author: atextor

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/AbstractGenerator.java

@@ -13,25 +13,23 @@
 
 package org.eclipse.esmf.aspectmodel.generator;
 
+import java.io.Serial;
 import java.nio.file.Path;
 import java.util.Iterator;
 import java.util.Map;
 import java.util.Optional;
 import java.util.function.Function;
 import java.util.stream.Collectors;
 
+import org.eclipse.esmf.aspectmodel.generator.jsonschema.AspectModelJsonSchemaGenerator;
 import org.eclipse.esmf.aspectmodel.urn.AspectModelUrn;
 
-import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.node.ArrayNode;
 import com.fasterxml.jackson.databind.node.JsonNodeFactory;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.fasterxml.jackson.databind.node.TextNode;
-import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
-import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator;
-import com.fasterxml.jackson.dataformat.yaml.YAMLMapper;
 import com.fasterxml.jackson.dataformat.yaml.util.StringQuotingChecker;
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.Streams;
@@ -40,11 +38,17 @@
 import org.slf4j.LoggerFactory;
 
 /**
- * The result of a schema generation where the schema is represented as a JSON document
+ * The result of a schema generation where the schema is represented as a JSON document.
+ *
+ * @param <T> the concrete type of node of this artifact
  */
-public abstract class AbstractSchemaArtifact<T extends JsonNode> implements Artifact<String, T> {
+public abstract class AbstractSchemaArtifact<T extends JsonNode> extends JsonArtifact<T> {
    private static final Logger LOG = LoggerFactory.getLogger( AbstractSchemaArtifact.class );
 
+   public AbstractSchemaArtifact( final String id, final T content ) {
+      super( id, content );
+   }
+
    /**
     * Returns the OpenAPI schema with separate files for schemas. In the resulting map, the key is the path
     * that names a schema and the value is the corresponding JSON structure. The root schema will be called
@@ -126,38 +130,25 @@ private JsonNode updateRefValues( final JsonNode node, final Map<String, String>
    protected Map<Path, JsonNode> getContentWithSeparateSchemasAsJson( final Optional<String> mainSpec ) {
       final JsonNode jsonContent = getContent();
       final String aspectName = AspectModelUrn.fromUrn(
-            jsonContent.get( "info" ).get( AbstractGenerator.SAMM_EXTENSION ).asText() ).getName();
+            jsonContent.get( "info" ).get( AspectModelJsonSchemaGenerator.SAMM_EXTENSION ).asText() ).getName();
       return getSeparateSchemas( aspectName, "json", mainSpec );
    }
 
    protected Map<Path, String> getContentWithSeparateSchemasAsYaml( final Optional<String> mainSpec ) {
       final JsonNode jsonContent = getContent();
       final String aspectName = AspectModelUrn.fromUrn(
-            jsonContent.get( "info" ).get( AbstractGenerator.SAMM_EXTENSION ).asText() ).getName();
+            jsonContent.get( "info" ).get( AspectModelJsonSchemaGenerator.SAMM_EXTENSION ).asText() ).getName();
       return getSeparateSchemas( aspectName, "yaml", mainSpec ).entrySet().stream().collect( Collectors.toMap(
             Map.Entry::getKey, entry -> jsonToYaml( entry.getValue() ) ) );
    }
 
-   protected String jsonToYaml( final JsonNode json ) {
-      try {
-         final YAMLFactory yamlFactory = YAMLFactory.builder()
-               .stringQuotingChecker( new OpenApiStringQuotingChecker() ).build();
-         return new YAMLMapper( yamlFactory ).enable( YAMLGenerator.Feature.MINIMIZE_QUOTES )
-               .writeValueAsString( json );
-      } catch ( final JsonProcessingException exception ) {
-         LOG.error( "JSON could not be converted to YAML", exception );
-         return json.toString();
-      }
-   }
-
    public static class OpenApiStringQuotingChecker extends StringQuotingChecker.Default {
+      @Serial
+      private static final long serialVersionUID = 6044974890325771572L;
 
       @Override
       protected boolean valueHasQuotableChar( final String inputStr ) {
-         if ( inputStr.contains( "#" ) ) {
-            return true;
-         }
-         return super.valueHasQuotableChar( inputStr );
+         return inputStr.contains( "#" ) || super.valueHasQuotableChar( inputStr );
       }
    }
 }

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/AbstractSchemaArtifact.java

@@ -13,7 +13,7 @@
 
 package org.eclipse.esmf.aspectmodel.generator;
 
-public class DocumentGenerationException extends RuntimeException {
+public class DocumentGenerationException extends GenerationException {
    private static final long serialVersionUID = -3592685602580476530L;
 
    public DocumentGenerationException( final String message ) {

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/DocumentGenerationException.java

@@ -0,0 +1,67 @@
+/*
+ * Copyright (c) 2024 Robert Bosch Manufacturing Solutions GmbH
+ *
+ * See the AUTHORS file(s) distributed with this work for additional
+ * information regarding authorship.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+package org.eclipse.esmf.aspectmodel.generator;
+
+import java.nio.charset.StandardCharsets;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
+import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator;
+import com.fasterxml.jackson.dataformat.yaml.YAMLMapper;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class JsonArtifact<T extends JsonNode> implements Artifact<String, T> {
+   private static final Logger LOG = LoggerFactory.getLogger( JsonArtifact.class );
+
+   private final String id;
+   private final T content;
+
+   public JsonArtifact( final String id, final T content ) {
+      this.id = id;
+      this.content = content;
+   }
+
+   @Override
+   public String getId() {
+      return id;
+   }
+
+   @Override
+   public T getContent() {
+      return content;
+   }
+
+   public String getContentAsYaml() {
+      return jsonToYaml( getContent() );
+   }
+
+   @Override
+   public byte[] serialize() {
+      return getContent().toPrettyString().getBytes( StandardCharsets.UTF_8 );
+   }
+
+   protected String jsonToYaml( final JsonNode json ) {
+      try {
+         final YAMLFactory yamlFactory = YAMLFactory.builder()
+               .stringQuotingChecker( new AbstractSchemaArtifact.OpenApiStringQuotingChecker() ).build();
+         return new YAMLMapper( yamlFactory ).enable( YAMLGenerator.Feature.MINIMIZE_QUOTES )
+               .writeValueAsString( json );
+      } catch ( final JsonProcessingException exception ) {
+         LOG.error( "JSON could not be converted to YAML", exception );
+         return json.toString();
+      }
+   }
+}

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/JsonArtifact.java

@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2024 Robert Bosch Manufacturing Solutions GmbH
+ *
+ * See the AUTHORS file(s) distributed with this work for additional
+ * information regarding authorship.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+package org.eclipse.esmf.aspectmodel.generator;
+
+public interface JsonGenerationConfig extends GenerationConfig {
+}

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/JsonGenerationConfig.java

@@ -0,0 +1,109 @@
+/*
+ * Copyright (c) 2024 Robert Bosch Manufacturing Solutions GmbH
+ *
+ * See the AUTHORS file(s) distributed with this work for additional
+ * information regarding authorship.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+package org.eclipse.esmf.aspectmodel.generator;
+
+import java.io.IOException;
+import java.io.OutputStream;
+import java.util.function.Function;
+
+import org.eclipse.esmf.aspectmodel.jackson.AspectModelJacksonModule;
+import org.eclipse.esmf.metamodel.Aspect;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
+
+/**
+ * Base class for generators that create JSON
+ *
+ * @param <C> the configuration type
+ * @param <R> the result type, e.g., JsonNode or ObjectNode
+ * @param <A> the corresponding artifact type
+ */
+public abstract class JsonGenerator<C extends JsonGenerationConfig, R extends JsonNode, A extends JsonArtifact<R>>
+      extends AspectGenerator<String, R, C, A> {
+   protected final ObjectMapper objectMapper;
+
+   public JsonGenerator( final Aspect aspect, final C config ) {
+      super( aspect, config );
+
+      objectMapper = new ObjectMapper();
+      objectMapper.registerModule( new JavaTimeModule() );
+      objectMapper.registerModule( new AspectModelJacksonModule() );
+      objectMapper.configure( SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false );
+      objectMapper.configure( SerializationFeature.FAIL_ON_EMPTY_BEANS, false );
+   }
+
+   /**
+    * Generate a pretty-printed JSON output
+    *
+    * @return the formatted JSON string
+    */
+   public String generateJson() {
+      return getContent().toPrettyString();
+   }
+
+   /**
+    * Generate a pretty-printed YAML output
+    *
+    * @return the formatted JSON string
+    */
+   public String generateYaml() {
+      return singleResult().getContentAsYaml();
+   }
+
+   /**
+    * Kept for backwards compatibility
+    *
+    * @return the JSON representation of the generated artifact
+    * @deprecated Use {@link #generateJson()} instead
+    */
+   @Deprecated( forRemoval = true )
+   public String generateJsonPretty() throws IOException {
+      return generateJson();
+   }
+
+   /**
+    * Kept for backwards compatibility
+    *
+    * @param nameMapper the callback function that maps artifact identifiers to OutputStreams
+    * @deprecated Use {@link #generate(Function)} instead
+    */
+   @Deprecated( forRemoval = true )
+   public void generateJsonPretty( final Function<String, OutputStream> nameMapper ) throws IOException {
+      generate( nameMapper );
+   }
+
+   /**
+    * Kept for backwards compatibility
+    *
+    * @param nameMapper the callback function that maps artifact identifiers to OutputStreams
+    * @deprecated Use {@link #generate(Function)} instead
+    */
+   @Deprecated( forRemoval = true )
+   public void generateJson( final Function<String, OutputStream> nameMapper ) throws IOException {
+      generate( nameMapper );
+   }
+
+   @Override
+   protected void write( final Artifact<String, R> artifact, final Function<String, OutputStream> nameMapper ) {
+      try ( final OutputStream output = nameMapper.apply( aspect().getName() ) ) {
+         output.write( artifact.serialize() );
+         output.flush();
+      } catch ( final IOException exception ) {
+         throw new DocumentGenerationException( exception );
+      }
+   }
+}

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/JsonGenerator.java

@@ -35,7 +35,6 @@
  * plus some useful operations.
  */
 public class NumericTypeTraits {
-
    private static final Logger LOG = LoggerFactory.getLogger( NumericTypeTraits.class );
 
    private static final List<Class<?>> FLOATING_POINT_TYPES = List.of( Float.class, Double.class, BigDecimal.class );