Merge pull request #174 from bci-oss/feature/OMP-SDK-168-milestone-disclaimer

Show milestone banner when prettyprinting.

Author: atextor

core/sds-aspect-model-serializer/pom.xml

@@ -84,6 +84,22 @@
                </annotationProcessorPaths>
             </configuration>
          </plugin>
+         <plugin>
+            <groupId>org.codehaus.mojo</groupId>
+            <artifactId>properties-maven-plugin</artifactId>
+            <version>1.0.0</version>
+            <executions>
+               <execution>
+                  <phase>generate-resources</phase>
+                  <goals>
+                     <goal>write-project-properties</goal>
+                  </goals>
+                  <configuration>
+                     <outputFile>${project.build.outputDirectory}/pom.properties</outputFile>
+                  </configuration>
+               </execution>
+            </executions>
+         </plugin>
       </plugins>
    </build>
 </project>

core/sds-aspect-model-serializer/src/main/java/io/openmanufacturing/sds/aspectmodel/serializer/PrettyPrinter.java

@@ -13,6 +13,8 @@
 
 package io.openmanufacturing.sds.aspectmodel.serializer;
 
+import java.io.IOException;
+import java.io.InputStream;
 import java.io.PrintWriter;
 import java.util.ArrayDeque;
 import java.util.ArrayList;
@@ -22,6 +24,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
+import java.util.Properties;
 import java.util.Queue;
 import java.util.Set;
 import java.util.stream.Collectors;
@@ -159,10 +162,33 @@ private Comparator<Map.Entry<String, String>> createPredefinedPrefixOrder() {
             .thenComparing( Map.Entry::getKey );
    }
 
+   private Properties loadProperties( final String filename ) {
+      final Properties properties = new Properties();
+      final InputStream propertiesResource = PrettyPrinter.class.getClassLoader().getResourceAsStream( filename );
+      try {
+         properties.load( propertiesResource );
+      } catch ( final IOException exception ) {
+         throw new RuntimeException( "Failed to load Properties: " + filename );
+      }
+      return properties;
+   }
+
+   private void showMilestoneBanner() {
+      // property file generated by properties-maven-plugin at build time
+      final Properties applicationProperties = loadProperties( "pom.properties" );
+      final String version = applicationProperties.get( "aspect-meta-model-version" ).toString();
+      if ( version.contains( "-M" ) ) {
+         writer.println( "# This model was created using BAMM version " + version + " and is not intended for productive usage." );
+         writer.println();
+      }
+   }
+
    /**
     * Print to the PrintWriter given in the constructor. This method does not close the PrintWriter.
     */
    public void print() {
+      showMilestoneBanner();
+
       prefixMap.entrySet().stream().sorted( prefixOrder ).forEach( entry -> writer.format( "@prefix %s: <%s> .%n", entry.getKey(), entry.getValue() ) );
       writer.println();
 

tools/bamm-cli/src/test/java/io/openmanufacturing/sds/ApplicationIntegrationTest.java

@@ -288,7 +288,7 @@ public void testPrettyPrintingToFile( final KnownVersion metaModelVersion ) {
    @MethodSource( value = "allVersions" )
    public void testPrettyPrintingToStdout( final KnownVersion metaModelVersion ) {
       createValidArgsExecution( metaModelVersion, "prettyprint" );
-      assertThat( stdoutBuffer.toString( StandardCharsets.UTF_8 ) ).startsWith( "@prefix" );
+      assertThat( stdoutBuffer.toString( StandardCharsets.UTF_8 ) ).contains( "@prefix" );
    }
 
    @ParameterizedTest
@@ -303,7 +303,7 @@ public void testVersionMigrationToFile( final KnownVersion metaModelVersion ) {
    @MethodSource( value = "allVersions" )
    public void testVersionMigrationToStdout( final KnownVersion metaModelVersion ) {
       createValidArgsExecution( metaModelVersion, "migrate" );
-      assertThat( stdoutBuffer.toString( StandardCharsets.UTF_8 ) ).startsWith( "@prefix" );
+      assertThat( stdoutBuffer.toString( StandardCharsets.UTF_8 ) ).contains( "@prefix" );
    }
 
    @ParameterizedTest