Fix problems with referenced models (#19)

Author: michelu89

src/main/java/io/openmanufacturing/ame/repository/strategy/LocalFolderResolverStrategy.java

@@ -13,7 +13,7 @@
 
 package io.openmanufacturing.ame.repository.strategy;
 
-import static io.openmanufacturing.ame.services.utils.ModelUtils.fetchVersionModel;
+import static io.openmanufacturing.ame.services.utils.ModelUtils.inMemoryStrategy;
 import static java.util.stream.Collectors.toList;
 
 import java.io.File;
@@ -32,8 +32,6 @@
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.io.FilenameUtils;
 import org.apache.commons.lang3.StringUtils;
-import org.apache.jena.rdf.model.StmtIterator;
-import org.apache.jena.vocabulary.RDF;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.stereotype.Service;
@@ -47,14 +45,9 @@
 import io.openmanufacturing.ame.repository.model.ValidFile;
 import io.openmanufacturing.ame.repository.strategy.utils.LocalFolderResolverUtils;
 import io.openmanufacturing.ame.services.utils.ModelUtils;
-import io.openmanufacturing.sds.aspectmetamodel.KnownVersion;
 import io.openmanufacturing.sds.aspectmodel.resolver.services.ExtendedXsdDataType;
 import io.openmanufacturing.sds.aspectmodel.resolver.services.SdsAspectMetaModelResourceResolver;
-import io.openmanufacturing.sds.aspectmodel.resolver.services.VersionedModel;
 import io.openmanufacturing.sds.aspectmodel.urn.AspectModelUrn;
-import io.openmanufacturing.sds.aspectmodel.vocabulary.BAMM;
-import io.vavr.NotImplementedError;
-import io.vavr.control.Try;
 
 @Service
 public class LocalFolderResolverStrategy implements ModelResolverStrategy {
@@ -117,7 +110,7 @@ private String getFilePath( final String urn, final String turtleData, final Str
          return getFilePathBasedOnTurtleData( turtleData, storagePath ) + applicationSettings.getFileType();
       }
 
-      if ( ":latest.ttl".equalsIgnoreCase( urn ) ) {
+      if ( ":latest.ttl".equalsIgnoreCase( urn ) || urn.contains( applicationSettings.getFileType() ) ) {
          return LocalFolderResolverUtils.extractFilePath( urn ).toString();
       }
 
@@ -365,15 +358,16 @@ protected File getFileInstance( @Nonnull final String filePath ) {
       return storeFile;
    }
 
-   private Try<AspectModelUrn> getRootElementUrn( final VersionedModel versionedModel ) {
-      final BAMM bamm = new BAMM( KnownVersion.getLatest() );
-      final StmtIterator stmtIterator = versionedModel.getModel().listStatements( null, RDF.type, bamm.Aspect() );
-
-      if ( stmtIterator.hasNext() ) {
-         return Try.success( AspectModelUrn.fromUrn( stmtIterator.next().getSubject().getURI() ) );
-      }
-
-      return Try.failure( new NotImplementedError( "AspectModelUrn cannot be found." ) );
+   /**
+    * Extract Aspect Model urn from turtle data.
+    *
+    * @param turtleData - file used to extract filePath.
+    * @param storagePath - path to storage files.
+    * @return Aspect Model urn
+    */
+   protected AspectModelUrn getAspectModelUrn( @Nonnull final String turtleData,
+         final @Nonnull String storagePath ) {
+      return inMemoryStrategy( turtleData, storagePath ).getAspectModelUrn();
    }
 
    /**
@@ -385,9 +379,7 @@ private Try<AspectModelUrn> getRootElementUrn( final VersionedModel versionedMod
     */
    protected String getFilePathBasedOnTurtleData( @Nonnull final String turtleData,
          final @Nonnull String storagePath ) {
-      final Try<AspectModelUrn> urnTemp = fetchVersionModel( turtleData, storagePath ).flatMap(
-            this::getRootElementUrn );
-      final AspectModelUrn aspectModelUrn = urnTemp.get();
+      final AspectModelUrn aspectModelUrn = getAspectModelUrn( turtleData, storagePath );
 
       return aspectModelUrn.getNamespace() + File.separator + aspectModelUrn.getVersion() + File.separator +
             aspectModelUrn.getName();

src/main/java/io/openmanufacturing/ame/services/GenerateService.java

@@ -13,6 +13,8 @@
 
 package io.openmanufacturing.ame.services;
 
+import static io.openmanufacturing.ame.services.utils.ModelUtils.inMemoryStrategy;
+
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.util.Optional;
@@ -27,6 +29,7 @@
 
 import io.openmanufacturing.ame.config.ApplicationSettings;
 import io.openmanufacturing.ame.exceptions.InvalidAspectModelException;
+import io.openmanufacturing.ame.resolver.inmemory.InMemoryStrategy;
 import io.openmanufacturing.ame.services.utils.ModelUtils;
 import io.openmanufacturing.sds.aspectmodel.generator.docu.AspectModelDocumentationGenerator;
 import io.openmanufacturing.sds.aspectmodel.generator.json.AspectModelJsonPayloadGenerator;
@@ -104,8 +107,9 @@ public String sampleJSONPayload( final String aspectModel ) {
    }
 
    private Try<VersionedModel> getVersionModel( final String aspectModel, final Optional<String> storagePath ) {
-      return ModelUtils.fetchVersionModel( aspectModel,
+      final InMemoryStrategy inMemoryStrategy = inMemoryStrategy( aspectModel,
             storagePath.orElse( ApplicationSettings.getMetaModelStoragePath() ) );
+      return ModelUtils.fetchVersionModel( inMemoryStrategy );
    }
 
    public String generateYamlOpenApiSpec( final String aspectModel, final String baseUrl, final boolean includeQueryApi,

src/main/java/io/openmanufacturing/ame/services/utils/ModelUtils.java

@@ -85,12 +85,10 @@ public static String getPrettyPrintedVersionedModel( final VersionedModel versio
    /**
     * Method to resolve a given AspectModelUrn using a suitable ResolutionStrategy.
     *
-    * @param aspectModel as a string.
-    * @param storagePath stored path to the Aspect Models.
+    * @param inMemoryStrategy strategy of the backend.
     * @return The resolved model on success.
     */
-   public static Try<VersionedModel> fetchVersionModel( final String aspectModel, final String storagePath ) {
-      final InMemoryStrategy inMemoryStrategy = inMemoryStrategy( aspectModel, storagePath );
+   public static Try<VersionedModel> fetchVersionModel( final InMemoryStrategy inMemoryStrategy ) {
       return new AspectModelResolver().resolveAspectModel( inMemoryStrategy, inMemoryStrategy.getAspectModelUrn() );
    }
 
@@ -175,7 +173,7 @@ public static ValidationReport validateModel( final String aspectModel, final St
          final AspectModelValidator aspectModelValidator ) {
       try {
          final InMemoryStrategy inMemoryStrategy = inMemoryStrategy( aspectModel, storagePath );
-         final Try<VersionedModel> versionedModel = ModelUtils.fetchVersionModel( aspectModel, storagePath );
+         final Try<VersionedModel> versionedModel = ModelUtils.fetchVersionModel( inMemoryStrategy );
 
          if ( versionedModel.isFailure() ) {
             final String message = versionedModel.getCause().toString();

src/test/java/io/openmanufacturing/ame/repository/strategy/LocalFolderResolverStrategyTest.java

@@ -19,6 +19,7 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.Collections;
@@ -66,6 +67,9 @@ public class LocalFolderResolverStrategyTest {
    private static final String NAMESPACE = "com.test.example:1.0.0:AspectDefault.ttl";
    private static final String TTL_FILE_CONTENT = "new result ttl file";
    private static final String TTL_FILE_EXTENSION = ".ttl";
+   private static final String TTL_FILE_WITH_EXT_REF =
+         "io.openmanufacturing" + File.separator + "1.0.0" + File.separator
+               + "AspectModelWithExternalRef" + TTL_FILE_EXTENSION;
    private static final String COM_TEST_EXAMPLE_1_2_0 =
          "com" + File.separator + "test" + File.separator + "example" + File.separator + "1.2.0";
    private static final String COM_TEST_EXAMPLE_1_0_0_ASPECT_DEFAULT =
@@ -184,6 +188,16 @@ public void testSaveModel() throws Exception {
       assertEquals( COM_TEST_EXAMPLE_1_0_0_ASPECT_DEFAULT + TTL_FILE_EXTENSION, result );
    }
 
+   @Test
+   public void testGetFilePathBasedOnTurtleData() throws Exception {
+      final Path extRefAspectModel = Path.of( resourcesPath.toAbsolutePath().toString(), TTL_FILE_WITH_EXT_REF );
+      final AspectModelUrn aspectModelUrn = localFolderResolverStrategy.getAspectModelUrn(
+            Files.readString( extRefAspectModel ),
+            resourcesPath.toString() );
+
+      assertEquals( "urn:bamm:io.openmanufacturing:1.0.0#AspectModelWithExternalRef", aspectModelUrn.toString() );
+   }
+
    @Test( expected = FileWriteException.class )
    public void testSaveModelCanNotWriteToFile() throws Exception {
       doReturn( COM_TEST_EXAMPLE_1_0_0_ASPECT_DEFAULT ).when( localFolderResolverStrategy )

src/test/resources/io.openmanufacturing/1.0.0/AspectModelWithExternalRef.ttl

@@ -0,0 +1,29 @@
+# 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 bamm-e: <urn:bamm:io.openmanufacturing:entity:2.0.0#> .
+@prefix unit: <urn:bamm:io.openmanufacturing:unit:2.0.0#> .
+@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+@prefix : <urn:bamm:io.openmanufacturing:1.0.0#> .
+@prefix ext-one: <urn:bamm:io.openmanufacturing.one:1.0.0#> .
+@prefix ext-two: <urn:bamm:io.openmanufacturing.two:1.0.0#> .
+@prefix ext-three: <urn:bamm:io.openmanufacturing.three:1.0.0#> .
+
+:AspectModelWithExternalRef a bamm:Aspect ;
+    bamm:properties (:property ext-one:property2 ext-two:property3) ;
+    bamm:operations () .
+
+:property a bamm:Property;
+    bamm:characteristic ext-three:Characteristic .