Merge pull request #235 from bci-oss/bugfix/OMP-SDK-234-fix-model-resolution

Fix model resolution to only load referenced models once.

Author: atextor

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

@@ -175,23 +175,28 @@ private Try<Model> resolve( final String urn, final ResolutionStrategy resolutio
 
          // Merge the resolved model into the target if it was not already merged before.
          // It could have been merged before when the model contains another model definition that was already resolved
-         if ( !mergedModels.contains( model ) ) {
+         if ( !modelAlreadyResolved( model, mergedModels ) ) {
             mergeModels( result, model );
             mergedModels.add( model );
-         }
-         for ( final String element : getAllUrnsInModel( model ) ) {
-            if ( !result.contains( model.createResource( element ), RDF.type, (RDFNode) null )
-                  // Backwards compatibility with BAMM 1.0.0
-                  && !result.contains( model.createResource( element ), refines, (RDFNode) null )
-                  && !unresolvedUrns.contains( element ) ) {
-               unresolvedUrns.push( element );
+
+            for ( final String element : getAllUrnsInModel( model ) ) {
+               if ( !result.contains( model.createResource( element ), RDF.type, (RDFNode) null )
+                     // Backwards compatibility with BAMM 1.0.0
+                     && !result.contains( model.createResource( element ), refines, (RDFNode) null )
+                     && !unresolvedUrns.contains( element ) ) {
+                  unresolvedUrns.push( element );
+               }
             }
          }
       }
 
       return Try.success( result );
    }
 
+   private boolean modelAlreadyResolved( final Model model, final Set<Model> resolvedModels ) {
+      return resolvedModels.stream().anyMatch( model::isIsomorphicWith );
+   }
+
    private final Model EMPTY_MODEL = ModelFactory.createDefaultModel();
 
    /**

core/sds-aspect-model-resolver/src/test/java/io/openmanufacturing/sds/aspectmodel/resolver/AspectModelResolverTest.java

@@ -16,7 +16,6 @@
 import static org.assertj.vavr.api.VavrAssertions.assertThat;
 
 import java.io.File;
-import java.io.FileNotFoundException;
 import java.net.URISyntaxException;
 import java.util.List;
 
@@ -372,4 +371,27 @@ public void testMergingModelsWithBlankNodeValues( final KnownVersion metaModelVe
       final List<Statement> propertiesAssertions = model.listStatements( primaryAspect, bamm.properties(), (RDFNode) null ).toList();
       Assertions.assertThat( propertiesAssertions.size() ).isEqualTo( 1 );
    }
+
+   @ParameterizedTest
+   @MethodSource( value = "allVersions" )
+   public void testMultiReferenceSameSource( final KnownVersion metaModelVersion ) throws URISyntaxException {
+      final File aspectModelsRootDirectory = new File(
+            AspectModelResolverTest.class.getClassLoader()
+                  .getResource( metaModelVersion.toString().toLowerCase() )
+                  .toURI()
+                  .getPath() );
+
+      final AspectModelUrn testUrn = AspectModelUrn.fromUrn( "urn:bamm:io.openmanufacturing.test:1.0.0#VehicleInstance" );
+
+      final ResolutionStrategy urnStrategy = new FileSystemStrategy( aspectModelsRootDirectory.toPath() );
+      final Try<VersionedModel> result = resolver.resolveAspectModel( urnStrategy, testUrn );
+      assertThat( result ).isSuccess();
+
+      // make sure the source file for the definitions of ModelYear and ModelCode (ModelDef.ttl) is only loaded once
+      final Model model = result.get().getModel();
+      final Resource entity = model.createResource( "urn:bamm:io.openmanufacturing.test:1.0.0#SomeOtherNonRelatedEntity" );
+      final BAMM bamm = new BAMM( metaModelVersion );
+      final List<Statement> properties = model.listStatements( entity, bamm.properties(), (RDFNode) null ).toList();
+      Assertions.assertThat( properties.size() ).isEqualTo( 1 );
+   }
 }

core/sds-aspect-model-resolver/src/test/resources/bamm_1_0_0/io.openmanufacturing.test/1.0.0/ModelDef.ttl

@@ -0,0 +1,31 @@
+# Copyright (c) 2022 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
+
+@prefix bamm: <urn:bamm:io.openmanufacturing:meta-model:1.0.0#> .
+@prefix bamm-c: <urn:bamm:io.openmanufacturing:characteristic:1.0.0#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+@prefix : <urn:bamm:io.openmanufacturing.test:1.0.0#> .
+
+:ModelCode a bamm-c:Code ;
+   bamm:name "ModelCode" ;
+   bamm:dataType xsd:string .
+
+:ModelYear a bamm-c:Code ;
+   bamm:name "ModelYear" ;
+   bamm:dataType xsd:nonNegativeInteger .
+
+:SomeOtherNonRelatedEntity a bamm:Entity ;
+   bamm:name "SomeOtherNonRelatedEntity";
+   bamm:properties ( :name ) .
+
+:name a bamm:Property ;
+   bamm:name "name";
+   bamm:characteristic bamm-c:Text .

core/sds-aspect-model-resolver/src/test/resources/bamm_1_0_0/io.openmanufacturing.test/1.0.0/VehicleInstance.ttl

@@ -0,0 +1,25 @@
+# Copyright (c) 2022 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
+
+@prefix bamm: <urn:bamm:io.openmanufacturing:meta-model:1.0.0#> .
+@prefix : <urn:bamm:io.openmanufacturing.test:1.0.0#> .
+
+:VehicleInstance a bamm:Entity ;
+   bamm:name "VehicleInstance" ;
+   bamm:properties ( :modelYear :model ) .
+
+:modelYear a bamm:Property ;
+   bamm:name "modelYear" ;
+   bamm:characteristic :ModelYear .
+
+:model a bamm:Property ;
+   bamm:name "model" ;
+   bamm:characteristic :ModelCode .

core/sds-aspect-model-resolver/src/test/resources/bamm_2_0_0/io.openmanufacturing.test/1.0.0/ModelDef.ttl

@@ -0,0 +1,27 @@
+# Copyright (c) 2022 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
+
+@prefix bamm: <urn:bamm:io.openmanufacturing:meta-model:2.0.0#> .
+@prefix bamm-c: <urn:bamm:io.openmanufacturing:characteristic:2.0.0#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+@prefix : <urn:bamm:io.openmanufacturing.test:1.0.0#> .
+
+:ModelCode a bamm-c:Code ;
+   bamm:dataType xsd:string .
+
+:ModelYear a bamm-c:Code ;
+   bamm:dataType xsd:nonNegativeInteger .
+
+:SomeOtherNonRelatedEntity a bamm:Entity ;
+   bamm:properties ( :name ) .
+
+:name a bamm:Property ;
+   bamm:characteristic bamm-c:Text .

core/sds-aspect-model-resolver/src/test/resources/bamm_2_0_0/io.openmanufacturing.test/1.0.0/VehicleInstance.ttl

@@ -0,0 +1,22 @@
+# Copyright (c) 2022 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
+
+@prefix bamm: <urn:bamm:io.openmanufacturing:meta-model:2.0.0#> .
+@prefix : <urn:bamm:io.openmanufacturing.test:1.0.0#> .
+
+:VehicleInstance a bamm:Entity ;
+   bamm:properties ( :modelYear :model ) .
+
+:modelYear a bamm:Property ;
+   bamm:characteristic :ModelYear .
+
+:model a bamm:Property ;
+   bamm:characteristic :ModelCode .