Fix open api generation to add also here an single aspect method (#41)

* Fix open api generation to add also here an single aspect method

* Update ModelUtils.java

Author: michelu89

src/main/java/org/eclipse/esmf/ame/services/GenerateService.java

@@ -15,27 +15,21 @@
 
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
-import java.util.List;
 import java.util.Locale;
 import java.util.Optional;
 
 import org.apache.commons.lang3.LocaleUtils;
-import org.eclipse.esmf.ame.exceptions.FileReadException;
 import org.eclipse.esmf.ame.exceptions.InvalidAspectModelException;
 import org.eclipse.esmf.ame.resolver.strategy.FileSystemStrategy;
 import org.eclipse.esmf.ame.services.utils.ModelUtils;
-import org.eclipse.esmf.ame.validation.ViolationFormatter;
 import org.eclipse.esmf.aspectmodel.generator.docu.AspectModelDocumentationGenerator;
 import org.eclipse.esmf.aspectmodel.generator.json.AspectModelJsonPayloadGenerator;
 import org.eclipse.esmf.aspectmodel.generator.jsonschema.AspectModelJsonSchemaGenerator;
 import org.eclipse.esmf.aspectmodel.generator.openapi.AspectModelOpenApiGenerator;
 import org.eclipse.esmf.aspectmodel.generator.openapi.PagingOption;
 import org.eclipse.esmf.aspectmodel.resolver.services.DataType;
 import org.eclipse.esmf.aspectmodel.resolver.services.VersionedModel;
-import org.eclipse.esmf.aspectmodel.shacl.violation.Violation;
-import org.eclipse.esmf.aspectmodel.validation.services.AspectModelValidator;
 import org.eclipse.esmf.metamodel.AspectContext;
-import org.eclipse.esmf.metamodel.loader.AspectModelLoader;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.stereotype.Service;
@@ -103,23 +97,9 @@ private AspectContext generateAspectContext( final String aspectModel ) {
       final Try<VersionedModel> versionedModels = ModelUtils.fetchVersionModel( fileSystemStrategy );
 
       final Try<AspectContext> context = versionedModels.flatMap(
-            model -> getSingleAspect( fileSystemStrategy, model ) );
+            model -> ModelUtils.getSingleAspect( fileSystemStrategy, model ) );
 
-      return context.recover( throwable -> {
-         // Another exception, e.g. syntax error. Let the validator handle this
-         final List<Violation> violations = new AspectModelValidator().validateModel(
-               context.map( AspectContext::rdfModel ) );
-
-         throw new FileReadException(
-               String.format( "The generation process encountered failures due to the following violations: %s",
-                     new ViolationFormatter().apply( violations ) ) );
-      } ).get();
-   }
-
-   private static Try<AspectContext> getSingleAspect( FileSystemStrategy fileSystemStrategy, VersionedModel model ) {
-      return AspectModelLoader.getSingleAspect( model,
-                                    aspect -> aspect.getName().equals( fileSystemStrategy.getAspectModelUrn().getName() ) )
-                              .map( aspect -> new AspectContext( model, aspect ) );
+      return ModelUtils.getAspectContext( context );
    }
 
    public String generateYamlOpenApiSpec( final String language, final String aspectModel, final String baseUrl,

src/main/java/org/eclipse/esmf/ame/services/utils/ModelUtils.java

@@ -23,23 +23,18 @@
 import java.net.URI;
 import java.net.URL;
 import java.nio.file.Path;
-import java.nio.file.Paths;
 import java.util.Arrays;
 import java.util.List;
 import java.util.Optional;
 import java.util.function.Predicate;
 
-import org.apache.commons.io.FileUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.jena.rdf.model.Model;
 import org.apache.jena.riot.RiotException;
 import org.eclipse.esmf.ame.config.ApplicationSettings;
-import org.eclipse.esmf.ame.exceptions.FileNotFoundException;
+import org.eclipse.esmf.ame.exceptions.FileReadException;
 import org.eclipse.esmf.ame.exceptions.InvalidAspectModelException;
-import org.eclipse.esmf.ame.model.packaging.AspectModelFiles;
-import org.eclipse.esmf.ame.model.resolver.FolderStructure;
 import org.eclipse.esmf.ame.model.validation.ViolationReport;
-import org.eclipse.esmf.ame.repository.strategy.utils.LocalFolderResolverUtils;
 import org.eclipse.esmf.ame.resolver.strategy.FileSystemStrategy;
 import org.eclipse.esmf.ame.resolver.strategy.InMemoryStrategy;
 import org.eclipse.esmf.ame.validation.ViolationFormatter;
@@ -55,6 +50,7 @@
 import org.eclipse.esmf.aspectmodel.validation.services.AspectModelValidator;
 import org.eclipse.esmf.aspectmodel.versionupdate.MigratorService;
 import org.eclipse.esmf.metamodel.Aspect;
+import org.eclipse.esmf.metamodel.AspectContext;
 import org.eclipse.esmf.metamodel.loader.AspectModelLoader;
 
 import io.vavr.control.Try;
@@ -127,11 +123,48 @@ public static String migrateModel( final String aspectModel ) throws InvalidAspe
     * @param aspectModel as a string.
     * @return the Aspect as an object.
     */
-   public static Aspect resolveAspectFromModel( final String aspectModel )
-         throws InvalidAspectModelException {
+   public static Aspect resolveAspectFromModel( final String aspectModel ) throws InvalidAspectModelException {
       final FileSystemStrategy fileSystemStrategy = new FileSystemStrategy( aspectModel );
-      final VersionedModel versionedModel = ModelUtils.loadModelFromStoragePath( fileSystemStrategy );
-      return AspectModelLoader.getSingleAspectUnchecked( versionedModel );
+      final Try<VersionedModel> versionedModels = ModelUtils.fetchVersionModel( fileSystemStrategy );
+
+      final Try<AspectContext> context = versionedModels.flatMap(
+            model -> getSingleAspect( fileSystemStrategy, model ) );
+
+      return getAspectContext( context ).aspect();
+   }
+
+   /**
+    * Retrieves a single AspectContext based on the given FileSystemStrategy and VersionedModel.
+    *
+    * @param fileSystemStrategy The file system strategy to retrieve the AspectModel URN.
+    * @param model The versioned model to search for the aspect.
+    * @return A Try containing the AspectContext if found, otherwise a failure.
+    */
+   public static Try<AspectContext> getSingleAspect( final FileSystemStrategy fileSystemStrategy,
+         final VersionedModel model ) {
+      return AspectModelLoader.getSingleAspect( model,
+                                    aspect -> aspect.getName().equals( fileSystemStrategy.getAspectModelUrn().getName() ) )
+                              .map( aspect -> new AspectContext( model, aspect ) );
+   }
+
+   /**
+    * Retrieves the AspectContext from the provided Try<AspectContext>, handling exceptions if necessary.
+    *
+    * @param context The Try<AspectContext> representing the context to retrieve the AspectContext from.
+    * @return The retrieved AspectContext.
+    *
+    * @throws FileReadException If there are failures in the generation process due to violations in the model.
+    */
+   public static AspectContext getAspectContext( Try<AspectContext> context ) {
+      return context.recover( throwable -> {
+         // Another exception, e.g. syntax error. Let the validator handle this
+         final List<Violation> violations = new AspectModelValidator().validateModel(
+               context.map( AspectContext::rdfModel ) );
+
+         throw new FileReadException(
+               String.format( "The generation process encountered failures due to the following violations: %s",
+                     new ViolationFormatter().apply( violations ) ) );
+      } ).get();
    }
 
    /**
@@ -227,25 +260,6 @@ public static Predicate<Violation> isProcessingViolation() {
                                                                     .equals( ProcessingViolation.ERROR_CODE );
    }
 
-   public static List<String> copyAspectModelToDirectory( final List<AspectModelFiles> aspectModelFiles,
-         final String destStorage ) {
-
-      return aspectModelFiles.stream().flatMap( data -> data.getFiles().stream().map( fileName -> {
-         final FolderStructure folderStructure = LocalFolderResolverUtils.extractFilePath( data.getNamespace() );
-         folderStructure.setFileName( fileName );
-         final String absoluteAspectModelPath = File.separator + folderStructure;
-         final File aspectModelStoragePath = Paths.get( destStorage, folderStructure.getFileRootPath(),
-               folderStructure.getVersion() ).toFile();
-         try {
-            FileUtils.copyFileToDirectory( new File( absoluteAspectModelPath ), aspectModelStoragePath );
-            return folderStructure.toString();
-         } catch ( final IOException e ) {
-            throw new FileNotFoundException(
-                  String.format( "Cannot copy file %s to %s", folderStructure.getFileName(), aspectModelStoragePath ) );
-         }
-      } ) ).toList();
-   }
-
    /**
     * Returns the {@link Model} that corresponds to the given model URN
     *