Merge pull request #293 from bci-oss/add_json_support_to_aas_generator

Add json support to aas generator

Author: atextor

core/esmf-aspect-model-aas-generator/pom.xml

@@ -39,6 +39,10 @@
          <groupId>org.eclipse.digitaltwin.aas4j</groupId>
          <artifactId>dataformat-aasx</artifactId>
       </dependency>
+      <dependency>
+         <groupId>org.eclipse.digitaltwin.aas4j</groupId>
+         <artifactId>dataformat-json</artifactId>
+      </dependency>
       <dependency>
          <groupId>org.eclipse.esmf</groupId>
          <artifactId>esmf-test-resources</artifactId>

core/esmf-aspect-model-aas-generator/src/main/java/org/eclipse/esmf/aspectmodel/aas/AspectModelAASGenerator.java

@@ -18,7 +18,9 @@
 import java.util.function.Function;
 
 import org.eclipse.digitaltwin.aas4j.v3.dataformat.SerializationException;
+import org.eclipse.digitaltwin.aas4j.v3.dataformat.Serializer;
 import org.eclipse.digitaltwin.aas4j.v3.dataformat.aasx.AASXSerializer;
+import org.eclipse.digitaltwin.aas4j.v3.dataformat.json.JsonSerializer;
 import org.eclipse.digitaltwin.aas4j.v3.dataformat.xml.XmlSerializer;
 import org.eclipse.digitaltwin.aas4j.v3.model.Environment;
 
@@ -44,7 +46,7 @@ public void generateAASXFile( final Aspect aspect, final Function<String, Output
    /**
     * Generates an AAS XML archive file for a given Aspect and writes it to a given OutputStream provided by <code>nameMapper<code/>
     *
-    * @param aspect the Aspect for which an AASX archive shall be generated
+    * @param aspect the Aspect for which an xml file shall be generated
     * @param nameMapper a Name Mapper implementation, which provides an OutputStream for a given filename
     * @throws IOException in case the generation can not properly be executed
     */
@@ -55,6 +57,20 @@ public void generateAasXmlFile(
       }
    }
 
+   /**
+    * Generates an AAS JSON file for a given Aspect and writes it to a given OutputStream provided by <code>nameMapper<code/>
+    *
+    * @param aspect the Aspect for which an JSON shall be generated
+    * @param nameMapper a Name Mapper implementation, which provides an OutputStream for a given filename
+    * @throws IOException in case the generation can not properly be executed
+    */
+   public void generateAasJsonFile(
+         final Aspect aspect, final Function<String, OutputStream> nameMapper ) throws IOException {
+      try ( final OutputStream output = nameMapper.apply( aspect.getName() ) ) {
+         output.write( generateJsonOutput( aspect ).toByteArray() );
+      }
+   }
+
    protected ByteArrayOutputStream generateAasxOutput( Aspect aspect ) throws IOException {
       final AspectModelAASVisitor visitor = new AspectModelAASVisitor();
       Environment environment = visitor.visitAspect( aspect, null );
@@ -69,11 +85,18 @@ protected ByteArrayOutputStream generateAasxOutput( Aspect aspect ) throws IOExc
    }
 
    protected ByteArrayOutputStream generateXmlOutput( Aspect aspect ) throws IOException {
+      return generate( new XmlSerializer(), aspect );
+   }
+
+   protected ByteArrayOutputStream generateJsonOutput( Aspect aspect ) throws IOException {
+      return generate( new JsonSerializer(), aspect );
+   }
+
+   protected ByteArrayOutputStream generate( Serializer serializer, Aspect aspect ) throws IOException {
       final AspectModelAASVisitor visitor = new AspectModelAASVisitor();
       Environment environment = visitor.visitAspect( aspect, null );
 
       try ( ByteArrayOutputStream out = new ByteArrayOutputStream() ) {
-         XmlSerializer serializer = new XmlSerializer();
          serializer.write( out, environment );
          return out;
       } catch ( SerializationException e ) {

documentation/developer-guide/modules/tooling-guide/pages/samm-cli.adoc

@@ -95,7 +95,7 @@ The available options and their meaning can also be seen in the help text of the
 | _--custom-resolver_ : use an external resolver for the resolution of the model elements |
 .4+| aspect <model> to aas              | Generate Asset Administration Shell (AAS) submodel template for an Aspect Model  | `samm aspect AspectModel.ttl to aas`
                                         |  _--output, -o_ : output file path (default: stdout)           |
-                                        |  _--format, -f_ : output file format (xml or aasx, default: xml)|
+                                        |  _--format, -f_ : output file format (xml, json, or aasx, default: xml)|
 | _--custom-resolver_ : use an external resolver for the resolution of the model elements |
 |===
 

pom.xml

@@ -18,7 +18,7 @@
    <parent>
       <groupId>org.eclipse.esmf</groupId>
       <artifactId>esmf-parent</artifactId>
-      <version>3</version>
+      <version>4</version>
    </parent>
 
    <artifactId>esmf-sdk-parent</artifactId>

tools/samm-cli/src/main/java/org/eclipse/esmf/aspect/to/AspectToAasCommand.java

@@ -35,6 +35,8 @@ public class AspectToAasCommand extends AbstractCommand {
    public static final String COMMAND_NAME = "aas";
    public static final String AASX = "aasx";
    public static final String XML = "xml";
+   public static final String JSON = "json";
+
 
    @CommandLine.Option(
          names = { "--output", "-o" },
@@ -43,7 +45,7 @@ public class AspectToAasCommand extends AbstractCommand {
 
    @CommandLine.Option(
          names = { "--format", "-f" },
-         description = "The file format the AAS is to be generated. Valid options are \"" + AASX + "\" and \"" + XML + "\". Default is \"" + XML + "\"." )
+         description = "The file format the AAS is to be generated. Valid options are \"" + AASX + "\", \"" + JSON + "\", and \"" + XML + "\". Default is \"" + XML + "\"." )
    private String format = XML;
 
    @CommandLine.ParentCommand
@@ -63,9 +65,14 @@ public void run() {
          // we intentionally override the name of the generated artifact here to the name explicitly
          // desired by the user (outputFilePath), as opposed to what the model thinks it should be
          // called (name)
-         if ( format.equals( AASX ) ) {
+         switch ( format ) {
+         case AASX:
             generator.generateAASXFile( aspect, name -> getStreamForFile( outputFilePath ) );
-         } else {
+            break;
+         case JSON:
+            generator.generateAasJsonFile( aspect, name -> getStreamForFile( outputFilePath ) );
+            break;
+         default:
             generator.generateAasXmlFile( aspect, name -> getStreamForFile( outputFilePath ) );
          }
       } catch ( final IOException e ) {

tools/samm-cli/src/test/java/org/eclipse/esmf/SammCliTest.java

@@ -219,7 +219,7 @@ public void testAspectToAasXmlToStdout() {
    }
 
    @Test
-   public void testAspectToAasAasxToFile() throws TikaException, IOException {
+   public void testAspectToAasAasxToFile() {
       final File targetFile = outputFile( "output.aasx" );
       final ExecutionResult result = sammCli.runAndExpectSuccess( "--disable-color", "aspect", defaultInputFile, "to", "aas", "--format", "aasx", "-o",
             targetFile.getAbsolutePath() );
@@ -230,12 +230,30 @@ public void testAspectToAasAasxToFile() throws TikaException, IOException {
    }
 
    @Test
-   public void testAspectToAasAasxToStdout() throws TikaException, IOException {
+   public void testAspectToAasAasxToStdout() {
       final ExecutionResult result = sammCli.runAndExpectSuccess( "--disable-color", "aspect", defaultInputFile, "to", "aas", "--format", "aasx" );
       assertThat( result.stderr() ).isEmpty();
       assertThat( contentType( result.stdoutRaw() ) ).isEqualTo( MediaType.application( "x-tika-ooxml" ) );
    }
 
+   @Test
+   public void testAspectToAasJsonToFile() {
+      final File targetFile = outputFile( "output.json" );
+      final ExecutionResult result = sammCli.runAndExpectSuccess( "--disable-color", "aspect", defaultInputFile, "to", "aas", "--format", "json", "-o",
+            targetFile.getAbsolutePath() );
+      assertThat( result.stdout() ).isEmpty();
+      assertThat( result.stderr() ).isEmpty();
+      assertThat( targetFile ).exists();
+      assertThat( contentType( targetFile ) ).isEqualTo( MediaType.text( "plain" ) );
+   }
+
+   @Test
+   public void testAspectToAasJsonToStdout() {
+      final ExecutionResult result = sammCli.runAndExpectSuccess( "--disable-color", "aspect", defaultInputFile, "to", "aas", "--format", "json" );
+      assertThat( result.stderr() ).isEmpty();
+      assertThat( contentType( result.stdoutRaw() ) ).isEqualTo( MediaType.text( "plain" ) );
+   }
+
    @Test
    public void testAspectToDotWithDefaultLanguage() {
       final File targetFile = outputFile( "output.dot" );
@@ -585,7 +603,7 @@ public void testAspectToOpenApiWithResourcePathAndCustomResolver() {
    }
 
    @Test
-   public void testAspectToPngWithDefaultLanguage() throws TikaException, IOException {
+   public void testAspectToPngWithDefaultLanguage() {
       final File targetFile = outputFile( "output.png" );
       final ExecutionResult result = sammCli.runAndExpectSuccess( "--disable-color", "aspect", defaultInputFile, "to", "png", "-o",
             targetFile.getAbsolutePath() );
@@ -596,7 +614,7 @@ public void testAspectToPngWithDefaultLanguage() throws TikaException, IOExcepti
    }
 
    @Test
-   public void testAspectToPngWithGivenLanguage() throws TikaException, IOException {
+   public void testAspectToPngWithGivenLanguage() {
       final File targetFile = outputFile( "output.png" );
       final ExecutionResult result = sammCli.runAndExpectSuccess( "--disable-color", "aspect", defaultInputFile, "to", "png", "-o",
             targetFile.getAbsolutePath(),
@@ -619,7 +637,7 @@ public void testAspectToPngWithNonExistentLanguage() {
    }
 
    @Test
-   public void testAspectToPngToStdout() throws TikaException, IOException {
+   public void testAspectToPngToStdout() {
       final ExecutionResult result = sammCli.runAndExpectSuccess( "--disable-color", "aspect", defaultInputFile, "to", "png" );
       assertThat( result.stderr() ).isEmpty();
       assertThat( contentType( result.stdoutRaw() ) ).isEqualTo( MediaType.image( "png" ) );