Merge branch 'main' into 2.9.x

Author: atextor

.github/workflows/pull-request-check.yml

@@ -16,6 +16,8 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
+        with:
+          submodules: recursive
 
       - name: Check code style
         if: matrix.os == 'ubuntu-20.04'

.github/workflows/release-workflow.yml

@@ -12,6 +12,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+        with:
+          submodules: recursive
 
       # Required for Maven
       - name: Set up JDK 17
@@ -51,6 +53,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+        with:
+          submodules: recursive
 
       # Even though the build itself is done using the GraalVM JDK
       # (see below), we use the setup-java action to have GPG configured
@@ -146,6 +150,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+        with:
+          submodules: recursive
 
       - name: Setup JDK
         uses: graalvm/setup-graalvm@2f25c0caae5b220866f732832d5e3e29ff493338 # v1.2.1
@@ -219,6 +225,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+        with:
+          submodules: recursive
 
       - name: Setup JDK
         uses: graalvm/setup-graalvm@2f25c0caae5b220866f732832d5e3e29ff493338 # v1.2.1
@@ -363,7 +371,7 @@ jobs:
           comment-template: |
             Release {release_link} addresses this.
 
-      # Sign SAML-CLI Windows executable
+      # Sign SAMM-CLI Windows executable
       - name: Get Artifact ID (Windows)
         shell: bash
         run: |

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "core/esmf-aspect-model-aas-generator/src/test/resources/submodel-templates"]
+	path = core/esmf-aspect-model-aas-generator/src/test/resources/submodel-templates
+	url = https://github.com/admin-shell-io/submodel-templates.git
+	branch = main

core/esmf-aspect-meta-model-interface/src/main/java/org/eclipse/esmf/aspectmodel/AspectModelFile.java

@@ -46,6 +46,18 @@ default List<String> headerComment() {
       return List.of();
    }
 
+   /**
+    * Returns the SPDX license identifier for this file, if one exists
+    *
+    * @return the SPDX identifier
+    */
+   default Optional<String> spdxLicenseIdentifier() {
+      return headerComment().stream()
+            .filter( line -> line.startsWith( "SPDX-License-Identifier:" ) )
+            .map( line -> line.split( ":" )[1].trim() )
+            .findFirst();
+   }
+
    /**
     * The URI that denominates the source location, if present. It can be a file:// or https:// URL, but it
     * could for example also be an Aspect Model URN, if it refers to a file that is part of the SAMM specification.

core/esmf-aspect-meta-model-interface/src/main/java/org/eclipse/esmf/aspectmodel/MissingMetaModelVersionException.java

@@ -13,6 +13,7 @@
 
 package org.eclipse.esmf.aspectmodel;
 
+@Deprecated( forRemoval = true )
 public class MissingMetaModelVersionException extends RuntimeException {
    private static final long serialVersionUID = -6978063564517733205L;
 }

core/esmf-aspect-meta-model-interface/src/main/java/org/eclipse/esmf/aspectmodel/MultipleMetaModelVersionsException.java

@@ -13,6 +13,7 @@
 
 package org.eclipse.esmf.aspectmodel;
 
+@Deprecated( forRemoval = true )
 public class MultipleMetaModelVersionsException extends RuntimeException {
    private static final long serialVersionUID = -592452975353816247L;
 }

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/loader/AspectModelLoader.java

@@ -25,7 +25,6 @@
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Deque;
-import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
@@ -37,6 +36,7 @@
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipInputStream;
 
+import org.eclipse.esmf.aspectmodel.AspectLoadingException;
 import org.eclipse.esmf.aspectmodel.AspectModelFile;
 import org.eclipse.esmf.aspectmodel.RdfUtil;
 import org.eclipse.esmf.aspectmodel.resolver.AspectModelFileLoader;
@@ -208,14 +208,14 @@ public AspectModel load( final InputStream inputStream ) {
     */
    public AspectModel loadNamespacePackage( final File namespacePackage ) {
       if ( !namespacePackage.exists() || !namespacePackage.isFile() ) {
-         throw new ModelResolutionException( "The specified file does not exist or is not a file." );
+         throw new AspectLoadingException( "The specified file does not exist or is not a file." );
       }
 
       try ( final InputStream inputStream = new FileInputStream( namespacePackage ) ) {
          return loadNamespacePackage( inputStream );
       } catch ( final IOException exception ) {
          LOG.error( "Error reading the file: {}", namespacePackage.getAbsolutePath(), exception );
-         throw new ModelResolutionException( "Error reading the file: " + namespacePackage.getAbsolutePath(), exception );
+         throw new AspectLoadingException( "Error reading the file: " + namespacePackage.getAbsolutePath(), exception );
       }
    }
 
@@ -232,7 +232,7 @@ public AspectModel loadNamespacePackage( final InputStream inputStream ) {
          inputStream.transferTo( baos );
          hasAspectModelsFolder = containsFolderInNamespacePackage( new ByteArrayInputStream( baos.toByteArray() ) );
       } catch ( final IOException exception ) {
-         throw new ModelResolutionException( "Could not read from input", exception );
+         throw new AspectLoadingException( "Could not read from input", exception );
       }
       return loadNamespacePackageFromStream( new ByteArrayInputStream( baos.toByteArray() ), hasAspectModelsFolder );
    }
@@ -258,7 +258,7 @@ private AspectModel loadNamespacePackageFromStream( final InputStream inputStrea
          zis.closeEntry();
       } catch ( final IOException exception ) {
          LOG.error( "Error reading the Archive input stream", exception );
-         throw new ModelResolutionException( "Error reading the Archive input stream", exception );
+         throw new AspectLoadingException( "Error reading the Archive input stream", exception );
       }
 
       final LoaderContext loaderContext = new LoaderContext();
@@ -336,13 +336,14 @@ private Optional<AspectModelFile> applyResolutionStrategy( final String urn ) {
          }
          final AspectModelFile resolutionResult = resolutionStrategy.apply( aspectModelUrn, this );
          if ( !containsType( resolutionResult.sourceModel(), urn ) ) {
-            throw new ModelResolutionException(
+            throw new AspectLoadingException(
                   "Resolution strategy returned a model which does not contain element definition for " + urn );
          }
          return Optional.of( resolutionResult );
-      } catch ( final UrnSyntaxException e ) {
+      } catch ( final UrnSyntaxException exception ) {
+         // This happens if the URN to load is no actual URN.
          // If it's no valid Aspect Model URN but some other URI (e.g., a samm:see value), there is nothing
-         // to resolve, so we return just an empty model
+         // to resolve, so we return just an empty model.
          return Optional.empty();
       }
    }
@@ -379,6 +380,7 @@ private void resolve( final List<AspectModelFile> inputFiles, final LoaderContex
          context.unresolvedFiles().push( aspectModelFile );
       }
 
+      final List<ModelResolutionException.LoadingFailure> loadingFailures = new ArrayList<>();
       while ( !context.unresolvedFiles().isEmpty() || !context.unresolvedUrns().isEmpty() ) {
          if ( !context.unresolvedFiles().isEmpty() ) {
             final AspectModelFile modelFile = context.unresolvedFiles().pop();
@@ -389,11 +391,25 @@ private void resolve( final List<AspectModelFile> inputFiles, final LoaderContex
          }
 
          while ( !context.unresolvedUrns().isEmpty() ) {
-            applyResolutionStrategy( context.unresolvedUrns().pop() )
-                  .map( this::migrate )
-                  .ifPresent( resolvedFile -> markModelFileAsLoaded( resolvedFile, context ) );
+            try {
+               applyResolutionStrategy( context.unresolvedUrns().pop() )
+                     .map( this::migrate )
+                     .ifPresent( resolvedFile -> markModelFileAsLoaded( resolvedFile, context ) );
+            } catch ( final ModelResolutionException exception ) {
+               // If one element can not be resolved, collect its cause and continue, so that
+               // we can create an comprehensive overview of all elements that can not be resolved
+               if ( exception.getCheckedLocations().isEmpty() ) {
+                  throw exception;
+               } else {
+                  loadingFailures.addAll( exception.getCheckedLocations() );
+               }
+            }
          }
       }
+
+      if ( !loadingFailures.isEmpty() ) {
+         throw new ModelResolutionException( loadingFailures );
+      }
    }
 
    /**
@@ -442,7 +458,6 @@ public AspectModel loadAspectModelFiles( final Collection<AspectModelFile> input
 
       final List<ModelElement> elements = new ArrayList<>();
       final List<AspectModelFile> files = new ArrayList<>();
-      final Map<AspectModelFile, MetaModelBaseAttributes> namespaceDefinitions = new HashMap<>();
       for ( final AspectModelFile file : inputFiles ) {
          final DefaultAspectModelFile aspectModelFile = new DefaultAspectModelFile( file.sourceModel(), file.headerComment(),
                file.sourceLocation() );
@@ -465,6 +480,13 @@ public AspectModel loadAspectModelFiles( final Collection<AspectModelFile> input
             .filter( modelElement -> modelElement.is( Aspect.class ) )
             .findFirst()
             .ifPresent( aspect -> mergedModel.setNsPrefix( "", aspect.urn().getUrnPrefix() ) );
+      for ( AspectModelFile file : files ) {
+         if ( file.aspects().size() > 1 ) {
+            throw new AspectLoadingException(
+                  "Aspect model file " + file.sourceLocation().map( location -> location + " " ).orElse( "" ) + "contains " + file.aspects()
+                        .size() + " aspects, but may only contain one." );
+         }
+      }
       return new DefaultAspectModel( files, mergedModel, elements );
    }
 

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/loader/AttributeValueRetriever.java

@@ -71,7 +71,7 @@ private boolean isRdfList( final Resource resource ) {
 
    /**
     * Returns the values of n-ary attributes on a model element (or its super elements), or if a given attribute is an rdf:List, the list
-    * elements. The list will be ordered by precedence, e.g., if a Property is present on both the current element and it's superelement,
+    * elements. The list will be ordered by precedence, e.g., if a Property is present on both the current element and its superelement,
     * the assertion on the current element will be on a lower list index. Duplicate attribute assertions are removed and only the assertion
     * with the highest precedence will be returned (bottom-most in the inheritance tree), this includes multiple assertions for the same
     * attribute with rdf:langString values with the same language tag. For example:

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/loader/instantiator/PropertyInstantiator.java

@@ -17,11 +17,11 @@
 import java.util.Map;
 import java.util.Optional;
 
+import org.eclipse.esmf.aspectmodel.AspectLoadingException;
 import org.eclipse.esmf.aspectmodel.loader.DefaultPropertyWrapper;
 import org.eclipse.esmf.aspectmodel.loader.Instantiator;
 import org.eclipse.esmf.aspectmodel.loader.MetaModelBaseAttributes;
 import org.eclipse.esmf.aspectmodel.loader.ModelElementFactory;
-import org.eclipse.esmf.aspectmodel.resolver.exceptions.InvalidModelException;
 import org.eclipse.esmf.metamodel.Characteristic;
 import org.eclipse.esmf.metamodel.Property;
 import org.eclipse.esmf.metamodel.Scalar;
@@ -81,7 +81,7 @@ public Property apply( final Resource property ) {
                .flatMap( statement -> characteristic.getDataType()
                      .map( type -> {
                         if ( !type.is( Scalar.class ) ) {
-                           throw new InvalidModelException( "Type of example value on Property " + property + " has incorrect type" );
+                           throw new AspectLoadingException( "Type of example value on Property " + property + " has incorrect type" );
                         }
                         return type.as( Scalar.class );
                      } )

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/resolver/AspectModelFileLoader.java

@@ -15,23 +15,25 @@
 
 import static org.apache.commons.lang3.StringUtils.isBlank;
 
-import java.io.BufferedReader;
 import java.io.ByteArrayInputStream;
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.InputStream;
-import java.io.InputStreamReader;
 import java.net.MalformedURLException;
 import java.net.URI;
 import java.net.URISyntaxException;
 import java.net.URL;
+import java.nio.ByteBuffer;
+import java.nio.CharBuffer;
+import java.nio.charset.CharsetDecoder;
+import java.nio.charset.MalformedInputException;
 import java.nio.charset.StandardCharsets;
+import java.nio.charset.UnmappableCharacterException;
 import java.nio.file.Paths;
 import java.util.List;
 import java.util.Optional;
-import java.util.stream.Collectors;
 
 import org.eclipse.esmf.aspectmodel.AspectModelFile;
 import org.eclipse.esmf.aspectmodel.loader.AspectModelLoader;
@@ -53,6 +55,11 @@ public static RawAspectModelFile load( final File file ) {
       try {
          final RawAspectModelFile fromString = load( content( new FileInputStream( file ) ) );
          return new RawAspectModelFile( fromString.sourceModel(), fromString.headerComment(), Optional.of( file.toURI() ) );
+      } catch ( final ModelResolutionException exception ) {
+         if ( exception.getMessage().startsWith( "Encountered invalid encoding" ) ) {
+            throw new ModelResolutionException( "Encountered invalid encoding in input file " + file, exception.getCause() );
+         }
+         throw exception;
       } catch ( final FileNotFoundException exception ) {
          throw new ModelResolutionException( "File not found: " + file, exception );
       }
@@ -70,8 +77,16 @@ public static RawAspectModelFile load( final String rdfTurtle ) {
    }
 
    private static String content( final InputStream inputStream ) {
-      return new BufferedReader( new InputStreamReader( inputStream, StandardCharsets.UTF_8 ) ).lines()
-            .collect( Collectors.joining( "\n" ) );
+      try {
+         final byte[] bytes = inputStream.readAllBytes();
+         final CharsetDecoder charsetDecoder = StandardCharsets.UTF_8.newDecoder();
+         final CharBuffer decodedCharBuffer = charsetDecoder.decode( ByteBuffer.wrap( bytes ) );
+         return new String( bytes, StandardCharsets.UTF_8 );
+      } catch ( final MalformedInputException | UnmappableCharacterException exception ) {
+         throw new ModelResolutionException( "Encountered invalid encoding in input" );
+      } catch ( final IOException exception ) {
+         throw new RuntimeException( exception );
+      }
    }
 
    private static List<String> headerComment( final String content ) {