Fix model serialization tests

Author: atextor

core/esmf-aspect-model-serializer/src/main/java/org/eclipse/esmf/aspectmodel/serializer/PrettyPrinter.java

@@ -77,8 +77,7 @@ public class PrettyPrinter {
    private final Set<Resource> processedResources = new HashSet<>();
    private final Queue<Resource> resourceQueue = new ArrayDeque<>();
 
-   private final List<ModelElement> elementsToWrite;
-   private final List<String> headerComment;
+   private final AspectModelFile modelFile;
    private final Model model;
    private final PrintWriter writer;
 
@@ -91,8 +90,7 @@ public class PrettyPrinter {
     * @param writer the writer to write to
     */
    public PrettyPrinter( final AspectModelFile modelFile, final PrintWriter writer ) {
-      elementsToWrite = modelFile.elements();
-      headerComment = modelFile.headerComment();
+      this.modelFile = modelFile;
       this.writer = writer;
       model = ModelFactory.createDefaultModel();
       model.add( modelFile.sourceModel() );
@@ -211,10 +209,10 @@ private void showMilestoneBanner() {
     * Print to the PrintWriter given in the constructor. This method does not close the PrintWriter.
     */
    public void print() {
-      for ( final String line : headerComment ) {
+      for ( final String line : modelFile.headerComment() ) {
          writer.println( "# " + line );
       }
-      if ( headerComment.size() > 1 ) {
+      if ( modelFile.headerComment().size() > 1 ) {
          writer.println();
       }
 
@@ -224,7 +222,7 @@ public void print() {
             .forEach( entry -> writer.format( "@prefix %s: <%s> .%n", entry.getKey(), entry.getValue() ) );
       writer.println();
 
-      elementsToWrite.stream()
+      modelFile.elements().stream()
             .filter( element -> !element.isAnonymous() )
             .sorted( elementDefinitionOrder )
             .map( ModelElement::urn )

core/esmf-aspect-model-serializer/src/test/java/org/eclipse/esmf/aspectmodel/serializer/AspectSerializerTest.java

@@ -15,6 +15,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.eclipse.esmf.aspectmodel.RdfUtil.createModel;
+import static org.eclipse.esmf.aspectmodel.serializer.RdfComparison.modelToString;
 
 import java.io.File;
 import java.io.IOException;
@@ -31,13 +32,18 @@
 import org.eclipse.esmf.aspectmodel.edit.change.MoveRenameAspectModelFile;
 import org.eclipse.esmf.aspectmodel.loader.AspectModelLoader;
 import org.eclipse.esmf.aspectmodel.resolver.modelfile.RawAspectModelFileBuilder;
+import org.eclipse.esmf.aspectmodel.resolver.services.TurtleLoader;
 import org.eclipse.esmf.metamodel.AspectModel;
 import org.eclipse.esmf.test.TestAspect;
 import org.eclipse.esmf.test.TestResources;
 
+import io.vavr.control.Try;
+import org.apache.jena.rdf.model.Model;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.EnumSource;
 
 public class AspectSerializerTest {
    Path outputDirectory = null;
@@ -68,6 +74,28 @@ void afterEach() {
       }
    }
 
+   @ParameterizedTest
+   @EnumSource( value = TestAspect.class,
+         mode = EnumSource.Mode.EXCLUDE,
+         names = { "MODEL_WITH_BLANK_AND_ADDITIONAL_NODES" } )
+   void testSerializeAspectModelFile( final TestAspect testAspect ) {
+      final AspectModel aspectModel = TestResources.load( testAspect );
+      for ( final AspectModelFile file : aspectModel.files() ) {
+         final Model originalModel = file.sourceModel();
+
+         final String modelString = AspectSerializer.INSTANCE.aspectModelFileToString( file );
+         final Try<Model> tryModel = TurtleLoader.loadTurtle( modelString );
+         final Model serializedModel = tryModel.getOrElseThrow( () -> new RuntimeException( tryModel.getCause() ) );
+
+         serializedModel.clearNsPrefixMap();
+         originalModel.getNsPrefixMap().forEach( serializedModel::setNsPrefix );
+
+         final String serializedModelString = modelToString( serializedModel );
+         final String originalModelString = modelToString( originalModel );
+         assertThat( serializedModelString ).isEqualToIgnoringWhitespace( originalModelString );
+      }
+   }
+
    @Test
    void testWriteAspectModelFileToFileSystem() {
       final AspectModel aspectModel = TestResources.load( TestAspect.ASPECT );

core/esmf-aspect-model-serializer/src/test/java/org/eclipse/esmf/aspectmodel/serializer/PrettyPrinterTest.java

@@ -50,7 +50,6 @@ void testPrettyPrinter( final TestModel testModel ) {
 
       final InputStream bufferInput = new ByteArrayInputStream( buffer.toByteArray() );
       final String formattedModel = buffer.toString( StandardCharsets.UTF_8 );
-      System.out.println( formattedModel );
       final Model prettyPrintedModel = TurtleLoader.loadTurtle( formattedModel ).get();
 
       assertThat( RdfComparison.hash( originalFile.sourceModel() ).equals( RdfComparison.hash( prettyPrintedModel ) ) ).isTrue();

core/esmf-aspect-model-serializer/src/test/java/org/eclipse/esmf/aspectmodel/serializer/RdfComparison.java

@@ -13,9 +13,12 @@
 
 package org.eclipse.esmf.aspectmodel.serializer;
 
+import java.util.Arrays;
 import java.util.List;
 import java.util.stream.Collectors;
 
+import org.eclipse.esmf.test.TestModel;
+
 import org.apache.jena.rdf.model.Model;
 import org.apache.jena.rdf.model.RDFList;
 import org.apache.jena.rdf.model.RDFNode;
@@ -58,4 +61,31 @@ private static String hashAnonymousResource( final Resource resource ) {
             .sorted()
             .collect( Collectors.joining() );
    }
+
+   static String modelToString( final Model model ) {
+      return Arrays.stream( TestModel.modelToString( model )
+                  .replaceAll( ";", "" )
+                  .replaceAll( "\\.", "" )
+                  .replaceAll( " +", "" )
+                  .split( "\\n" ) )
+            .filter( line -> !line.contains( "samm-c:values" ) )
+            .filter( line -> !line.contains( "samm:see" ) )
+            .map( RdfComparison::sortLineWithRdfListOrLangString )
+            .sorted()
+            .collect( Collectors.joining() )
+            .replaceAll( " +", " " );
+   }
+
+   /**
+    * In some test models, lines with RDF lists appear, e.g.:
+    * :property ( "foo" "bar" )
+    * However, for some serialized models, the order of elements is non-deterministic since the underlying collection is a Set.
+    * In order to check that the line is present in the two models, we simply tokenize and sort both lines, so we can compare them.
+    */
+   static String sortLineWithRdfListOrLangString( final String line ) {
+      if ( line.contains( " ( " ) || line.contains( "@" ) ) {
+         return Arrays.stream( line.split( "[ ,\"]" ) ).sorted().collect( Collectors.joining() );
+      }
+      return line;
+   }
 }

core/esmf-aspect-model-serializer/src/test/java/org/eclipse/esmf/aspectmodel/serializer/RdfModelCreatorVisitorTest.java

@@ -14,6 +14,7 @@
 package org.eclipse.esmf.aspectmodel.serializer;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.eclipse.esmf.aspectmodel.serializer.RdfComparison.modelToString;
 
 import java.util.Arrays;
 import java.util.HashMap;
@@ -59,7 +60,8 @@ public class RdfModelCreatorVisitorTest {
          "ASPECT_WITH_UMLAUT_DESCRIPTION",
          "MODEL_WITH_BROKEN_CYCLES",
          "MODEL_WITH_BLANK_AND_ADDITIONAL_NODES",
-         "ASPECT_WITH_TIME_SERIES"
+         "ASPECT_WITH_TIME_SERIES",
+         "ASPECT_WITH_NAMESPACE_DESCRIPTION"
    } )
    public void testRdfModelCreatorVisitor( final TestAspect testAspect ) {
       final KnownVersion knownVersion = KnownVersion.getLatest();
@@ -90,30 +92,5 @@ public void testRdfModelCreatorVisitor( final TestAspect testAspect ) {
       assertThat( serializedModelString ).isEqualToIgnoringWhitespace( originalModelString );
    }
 
-   private String modelToString( final Model model ) {
-      return Arrays.stream( TestModel.modelToString( model )
-                  .replaceAll( ";", "" )
-                  .replaceAll( "\\.", "" )
-                  .replaceAll( " +", "" )
-                  .split( "\\n" ) )
-            .filter( line -> !line.contains( "samm-c:values" ) )
-            .filter( line -> !line.contains( "samm:see" ) )
-            .map( this::sortLineWithRdfListOrLangString )
-            .sorted()
-            .collect( Collectors.joining() )
-            .replaceAll( " +", " " );
-   }
 
-   /**
-    * In some test models, lines with RDF lists appear, e.g.:
-    * :property ( "foo" "bar" )
-    * However, for some serialized models, the order of elements is non-deterministic since the underlying collection is a Set.
-    * In order to check that the line is present in the two models, we simply tokenize and sort both lines, so we can compare them.
-    */
-   private String sortLineWithRdfListOrLangString( final String line ) {
-      if ( line.contains( " ( " ) || line.contains( "@" ) ) {
-         return Arrays.stream( line.split( "[ ,\"]" ) ).sorted().collect( Collectors.joining() );
-      }
-      return line;
-   }
 }

core/esmf-test-aspect-models/src/main/resources/valid/org.eclipse.esmf.test/1.0.0/ModelWithBlankAndAdditionalNodes.ttl

@@ -12,7 +12,7 @@
 @prefix : <urn:samm:org.eclipse.esmf.test:1.0.0#> .
 @prefix samm: <urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#> .
 @prefix samm-c: <urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#> .
-@prefix aux: <urn:samm:org.eclipse.esmf.samm:aux#> .
+@prefix aux: <http://example.com/aux#> .
 @prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
 
 [