Merge branch 'main' into 2.0.x

Author: atextor

core/sds-aspect-meta-model-java/src/main/java/io/openmanufacturing/sds/metamodel/ComplexType.java

@@ -20,7 +20,7 @@ default boolean isAbstractEntity() {
     */
    default List<Property> getAllProperties() {
       if ( getExtends().isPresent() ) {
-         return Stream.of( getProperties(), getExtends().get().getProperties() ).flatMap( Collection::stream ).collect( Collectors.toList() );
+         return Stream.of( getProperties(), getExtends().get().getAllProperties() ).flatMap( Collection::stream ).collect( Collectors.toList() );
       }
       return List.copyOf( getProperties() );
    }

core/sds-aspect-meta-model-java/src/main/java/io/openmanufacturing/sds/metamodel/EntityInstance.java

@@ -15,7 +15,7 @@
 
 import java.util.Map;
 
-public interface EntityInstance extends Base, IsDescribed, Value, Comparable<EntityInstance> {
+public interface EntityInstance extends Base, IsDescribed, Value {
    Map<Property, Value> getAssertions();
 
    default Entity getEntityType() {

core/sds-aspect-meta-model-java/src/main/java/io/openmanufacturing/sds/metamodel/impl/BaseImpl.java

@@ -12,6 +12,7 @@
  */
 package io.openmanufacturing.sds.metamodel.impl;
 
+import java.util.Comparator;
 import java.util.List;
 import java.util.Objects;
 import java.util.Optional;
@@ -27,7 +28,7 @@
 /**
  * The base implemenation of all model elements.
  */
-public abstract class BaseImpl implements Base, IsDescribed {
+public abstract class BaseImpl implements Base, IsDescribed, Comparable<BaseImpl> {
    private final KnownVersion metaModelVersion;
    private final Optional<AspectModelUrn> urn;
    private final String name;
@@ -121,4 +122,15 @@ public boolean equals( final Object o ) {
    public int hashCode() {
       return Objects.hash( urn, name );
    }
+
+   @Override
+   public int compareTo( BaseImpl o ) {
+      if ( this.urn.isPresent() && o.urn.isPresent() )
+         return this.urn.get().compareTo( o.urn.get() );
+      return Comparator
+            .comparing( BaseImpl::getMetaModelVersion )
+            .thenComparing( BaseImpl::getName )
+            .thenComparing( BaseImpl::hasSyntheticName )
+            .compare( this, o );
+   }
 }

core/sds-aspect-meta-model-java/src/main/java/io/openmanufacturing/sds/metamodel/impl/DefaultAbstractEntity.java

@@ -14,6 +14,7 @@
 package io.openmanufacturing.sds.metamodel.impl;
 
 import java.util.List;
+import java.util.Objects;
 import java.util.Optional;
 import java.util.stream.Collectors;
 
@@ -52,7 +53,7 @@ private DefaultAbstractEntity( final MetaModelBaseAttributes metaModelBaseAttrib
     */
    @Override
    public List<ComplexType> getExtendingElements() {
-      return extendingElements.stream().map( instances::get ).collect( Collectors.toList() );
+      return extendingElements.stream().map( instances::get ).filter( Objects::nonNull ).collect( Collectors.toList() );
    }
 
    /**

core/sds-aspect-meta-model-java/src/main/java/io/openmanufacturing/sds/metamodel/impl/DefaultEntityInstance.java

@@ -44,11 +44,6 @@ public Map<Property, Value> getAssertions() {
       return assertions;
    }
 
-   @Override
-   public int compareTo( final EntityInstance other ) {
-      return getName().compareTo( other.getName() );
-   }
-
    @Override
    public <T, C> T accept( final AspectVisitor<T, C> visitor, final C context ) {
       return visitor.visitEntityInstance( this, context );

core/sds-aspect-model-java-generator/src/main/java/io/openmanufacturing/sds/aspectmodel/java/AspectModelJavaUtil.java

@@ -535,11 +535,15 @@ public static String objectEqualsExpression( final StructureElement element ) {
             .collect( Collectors.joining( " && " ) );
    }
 
-   public static String objectsHashCodeExpression( final StructureElement element ) {
-      return element.getProperties().stream()
+   public static String objectsHashCodeExpression( final StructureElement element, final boolean needsLeadingComma ) {
+      final String elementString = element.getProperties().stream()
             .filter( property -> !property.isAbstract() )
             .map( Property::getPayloadName )
             .collect( Collectors.joining( ", " ) );
+      if ( StringUtils.isNotBlank( elementString ) && needsLeadingComma ) {
+         return ", " + elementString;
+      }
+      return elementString;
    }
 
    /**

core/sds-aspect-model-java-generator/src/main/resources/java-pojo-hashcode-method-lib.vm

@@ -1,14 +1,18 @@
 #macro( javaPojoHashCodeMethod )
 @Override
 public int hashCode() {
-    return Objects.hash(
+return Objects.hash(
     #if ( $element.is( $ComplexType ) )
         #set( $complexElement = $ComplexType.cast( $element ) )
         #if ( $complexElement.getExtends().isPresent() )
-            super.hashCode(),
+        super.hashCode()
+            ${util.objectsHashCodeExpression( $element, true )}
+        #else
+            ${util.objectsHashCodeExpression( $element, false )}
         #end
+    #else
+        ${util.objectsHashCodeExpression( $element, false )}
     #end
-    ${util.objectsHashCodeExpression( $element )}
-    );
+);
 }
 #end

core/sds-aspect-model-java-generator/src/test/java/io/openmanufacturing/sds/aspectmodel/java/StaticMetaModelGeneratorTest.java

@@ -24,6 +24,8 @@
 import io.openmanufacturing.sds.test.MetaModelVersions;
 import io.openmanufacturing.sds.test.TestAspect;
 import io.openmanufacturing.sds.test.TestResources;
+import io.openmanufacturing.sds.test.TestSharedAspect;
+import io.openmanufacturing.sds.test.TestSharedModel;
 
 abstract class StaticMetaModelGeneratorTest extends MetaModelVersions {
 
@@ -41,4 +43,10 @@ Collection<JavaGenerator> getGenerators( final TestAspect aspect, final KnownVer
       final JavaGenerator staticGenerator = new StaticMetaModelJavaGenerator( model, false, null );
       return List.of( pojoGenerator, staticGenerator );
    }
+   Collection<JavaGenerator> getGenerators( final TestSharedAspect aspect, final KnownVersion version ) {
+      final VersionedModel model = TestResources.getModel( aspect, version ).get();
+      final JavaGenerator pojoGenerator = new AspectModelJavaGenerator( model, false, false, null );
+      final JavaGenerator staticGenerator = new StaticMetaModelJavaGenerator( model, false, null );
+      return List.of( pojoGenerator, staticGenerator );
+   }
 }

core/sds-aspect-model-java-generator/src/test/java/io/openmanufacturing/sds/aspectmodel/java/StaticMetaModelJavaGeneratorTest.java

@@ -52,6 +52,7 @@
 import io.openmanufacturing.sds.staticmetamodel.constraint.StaticConstraintContainerProperty;
 import io.openmanufacturing.sds.staticmetamodel.constraint.StaticConstraintProperty;
 import io.openmanufacturing.sds.test.TestAspect;
+import io.openmanufacturing.sds.test.TestSharedAspect;
 
 public class StaticMetaModelJavaGeneratorTest extends StaticMetaModelGeneratorTest {
 
@@ -65,6 +66,17 @@ public void testCodeGeneration( final TestAspect testAspect ) {
       assertThatCode( () -> TestContext.generateStaticAspectCode().apply( getGenerators( testAspect, KnownVersion.getLatest() ) ) ).doesNotThrowAnyException();
    }
 
+   /**
+    * Tests that code generation succeeds for all test models, that have properties shared over two files, for the latest meta model version
+    * @param testAspect the injected shared Aspect models
+    */
+   @ParameterizedTest
+   @EnumSource( value = TestSharedAspect.class )
+   public void testCodeGenerationSharedAspect( final TestSharedAspect testAspect ) {
+      assertThatCode( () -> TestContext.generateStaticAspectCode().apply( getGenerators( testAspect, KnownVersion.getLatest() ) ) ).doesNotThrowAnyException();
+   }
+
+
    @ParameterizedTest
    @MethodSource( value = "allVersions" )
    public void testGenerateStaticMetaModelWithOptionalProperties( final KnownVersion metaModelVersion ) throws IOException {
@@ -142,6 +154,18 @@ ImmutableMap.<String, Object> builder().put( "NAMESPACE", String.class ).put( "M
                   } ).build(), new HashMap<>() );
    }
 
+   @ParameterizedTest
+   @MethodSource( value = "versionsStartingWith2_0_0" )
+   public void testGenerateStaticMetaModelWithMeasurementTwo( final KnownVersion metaModelVersion ) throws IOException {
+      final TestAspect aspect = TestAspect.ASPECT_WITH_EXTENDED_ENTITY;
+      final StaticClassGenerationResult result = TestContext.generateStaticAspectCode().apply( getGenerators( aspect, metaModelVersion ) );
+      result.assertNumberOfFiles( 8 );
+      result.assertFields( "MetaAspectWithExtendedEntity",
+            ImmutableMap.<String, Object> builder().put( "NAMESPACE", String.class ).put( "MODEL_ELEMENT_URN", String.class )
+                  .put( "CHARACTERISTIC_NAMESPACE", String.class ).put( "INSTANCE", "MetaAspectWithExtendedEntity" )
+                  .put( "TEST_PROPERTY", "StaticContainerProperty<TestEntity,java.util.LinkedHashSet<TestEntity>>").build(), new HashMap<>() );
+   }
+
    @ParameterizedTest
    @MethodSource( value = "allVersions" )
    public void testGenerateStaticMetaModelWithRecursiveAspectWithOptional( final KnownVersion metaModelVersion ) throws IOException {
@@ -211,7 +235,6 @@ ImmutableMap.<String, Object> builder().put( "NAMESPACE", String.class ).put( "M
    }
 
    @ParameterizedTest
-//   @MethodSource( value = "allVersions" )
    @MethodSource( value = "latestVersion" )
    public void testGenerateStaticMetaModelWithConstraints( final KnownVersion metaModelVersion ) throws IOException {
       final TestAspect aspect = TestAspect.ASPECT_WITH_CONSTRAINTS;

core/sds-aspect-model-resolver/src/main/java/io/openmanufacturing/sds/aspectmodel/resolver/ClasspathStrategy.java

@@ -2,7 +2,7 @@
  * Copyright (c) 2021 Robert Bosch Manufacturing Solutions GmbH
  *
  * See the AUTHORS file(s) distributed with this work for additional
- * information regarding authorship. 
+ * 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
@@ -13,15 +13,24 @@
 
 package io.openmanufacturing.sds.aspectmodel.resolver;
 
+import java.io.File;
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.URL;
 import java.nio.charset.StandardCharsets;
+import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Comparator;
+import java.util.Enumeration;
+import java.util.List;
+import java.util.Optional;
+import java.util.jar.JarEntry;
+import java.util.jar.JarFile;
 import java.util.stream.Stream;
 
 import org.apache.commons.io.IOUtils;
+import org.apache.commons.lang3.StringUtils;
 import org.apache.jena.rdf.model.Model;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -88,18 +97,58 @@ protected URL resourceUrl( final String directory, final String filename ) {
 
    protected Stream<String> filesInDirectory( final String directory ) {
       try {
-         final InputStream directoryUrl = getClass().getResourceAsStream( directory );
-         if ( directoryUrl == null ) {
-            LOG.warn( "No such classpath directory {}", directory );
-            return Stream.empty();
+         final Optional<File> file = getDirectoryFile( directory );
+         if ( file.isPresent() && file.get().isFile() ) {
+            return getFilesFromJar( directory, file.get() );
+         } else {
+            return getFilesFromResources( directory );
          }
-         return Arrays.stream( IOUtils.toString( directoryUrl, StandardCharsets.UTF_8 ).split( "\\n" ) );
       } catch ( final IOException exception ) {
          LOG.warn( "Could not list files in classpath directory {}", directory, exception );
          return Stream.empty();
       }
    }
 
+   private Optional<File> getDirectoryFile( String directory ) {
+      // The incoming URL will look like this:  jar:file:/pathToJar/o.jar/packageName/className
+      // In case we run the code from a jar. Because of that we need to deconstruct the path to get the path to the jar only and remove the unwanted part of the URL.
+      final URL url = getClass().getClassLoader().getResource( directory );
+      if ( url == null ) {
+         return Optional.empty();
+      }
+      final String urlString = url.toString();
+      final int jarIndex = urlString.indexOf( ".jar" );
+      final String path = jarIndex > 0 ? urlString.substring( 0, jarIndex + 4 ).replace( "jar:file:", "" ) : urlString;
+      return Optional.of( new File( path ) );
+   }
+
+   private Stream<String> getFilesFromResources( String directory ) throws IOException {
+      final InputStream directoryUrl = getClass().getClassLoader().getResourceAsStream( directory );
+      if ( directoryUrl == null ) {
+         LOG.warn( "No such classpath directory {}", directory );
+         return Stream.empty();
+      }
+      return Arrays.stream( IOUtils.toString( directoryUrl, StandardCharsets.UTF_8 ).split( "\\n" ) );
+   }
+
+   private Stream<String> getFilesFromJar( String directory, File jarFile ) throws IOException {
+      final List<String> fileList = new ArrayList<>();
+      final JarFile jar = new JarFile( jarFile );
+      final Enumeration<JarEntry> entries = jar.entries();
+      final String dir = directory.endsWith( "/" ) ? directory : directory + "/";
+      while ( entries.hasMoreElements() ) {
+         final String name = entries.nextElement().getName();
+         if ( name.startsWith( dir ) ) {
+            final String fileName = name.replace( dir, "" );
+            if ( StringUtils.isNotEmpty( fileName ) ) {
+               fileList.add( fileName );
+            }
+         }
+      }
+      jar.close();
+      return fileList.stream();
+   }
+
    @Override
    public Try<Model> apply( final AspectModelUrn aspectModelUrn ) {
       final String modelsRootTrailingSlash = modelsRoot.isEmpty() ? "" : "/";
@@ -117,13 +166,13 @@ public Try<Model> apply( final AspectModelUrn aspectModelUrn ) {
       return filesInDirectory( directory )
             .filter( name -> name.endsWith( ".ttl" ) )
             .map( name -> resourceUrl( directory, name ) )
-            .sorted()
+            .sorted( Comparator.comparing( URL::getPath ) )
             .map( this::loadFromUrl )
             .filter( tryModel -> tryModel
                   .map( model -> AspectModelResolver.containsDefinition( model, aspectModelUrn ) )
                   .getOrElse( false ) )
             .findFirst()
             .orElse( Try.failure( new FileNotFoundException(
-                  "The AspectModel: " + aspectModelUrn.toString() + " could not be found in directory: " + directory ) ) );
+                  "The AspectModel: " + aspectModelUrn + " could not be found in directory: " + directory ) ) );
    }
 }