Merge branch 'main' into 2.10.x

atextor · atextor · commit dc2afc42f875 · 2025-04-02T14:35:25.000+02:00
diff --git a/.github/workflows/dependency-update.yml b/.github/workflows/dependency-update.yml
@@ -14,6 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+
       - name: Submit Dependency Snapshot
         uses: advanced-security/maven-dependency-submission-action@v3
diff --git a/.github/workflows/pull-request-check.yml b/.github/workflows/pull-request-check.yml
@@ -69,21 +69,24 @@ jobs:
           java --version
           export MAVEN_OPTS="-Xmx4096m"
           export JAVA_TOOL_OPTIONS="-Dfile.encoding=UTF8"
+          # Actual build of core SDK
           mvn -B -pl '!org.eclipse.esmf:samm-cli' clean install -Pnative -Dmaven.wagon.httpconnectionManager.ttlSeconds=60
+          # Build samm-cli executable jar and run integration tests
+          unset JAVA_TOOL_OPTIONS
+          mvn -B -pl tools/samm-cli clean verify -Dmaven.wagon.httpconnectionManager.ttlSeconds=60
         shell: bash
 
       - name: Build native image
         if: matrix.os != 'macos-13'
         run: |
           export MAVEN_OPTS="-Xmx4096m"
-          mvn -B -pl tools/samm-cli clean verify -Pnative -Dmaven.wagon.httpconnectionManager.ttlSeconds=60
+          # Build native binary and run integration tests
+          mvn -B -pl tools/samm-cli verify -Pnative -Dmaven.wagon.httpconnectionManager.ttlSeconds=60
         shell: bash
 
       - name: Build native image (Mac)
         if: matrix.os == 'macos-13'
         run: |
-          export MAVEN_OPTS="-Xmx4096m"
-          mvn -B -pl tools/samm-cli clean verify -Dmaven.wagon.httpconnectionManager.ttlSeconds=60
           bundle="samm-bundle-DEV-SNAPSHOT-$(date +%s)"
           mkdir ${bundle}
           curl -Lo jre.tar.gz https://github.com/adoptium/temurin21-binaries/releases/download/jdk-21.0.6%2B7/OpenJDK21U-jre_x64_mac_hotspot_21.0.6_7.tar.gz
diff --git a/.github/workflows/release-workflow.yml b/.github/workflows/release-workflow.yml
@@ -104,9 +104,11 @@ jobs:
 
           # Actual build of core SDK
           mvn -B -pl '!org.eclipse.esmf:samm-cli' clean deploy -Pnative -Dmaven.wagon.httpconnectionManager.ttlSeconds=60 -DaltDeploymentRepository=local::default::file://nexus-staging -Psign
-          # Build of CLI
+          # Build samm-cli executable jar and run integration tests
           unset JAVA_TOOL_OPTIONS
-          mvn -B -pl tools/samm-cli clean verify -Pnative -Dmaven.wagon.httpconnectionManager.ttlSeconds=60
+          mvn -B -pl tools/samm-cli clean verify -Dmaven.wagon.httpconnectionManager.ttlSeconds=60
+          # Build native binary and run integration tests
+          mvn -B -pl tools/samm-cli verify -Pnative -Dmaven.wagon.httpconnectionManager.ttlSeconds=60
 
           # Create .tar.gz of samm-cli
           pushd tools/samm-cli/target
@@ -178,7 +180,7 @@ jobs:
           mvn versions:commit
           # Actual build of core SDK
           mvn -B -pl '!org.eclipse.esmf:samm-cli' clean install -Pnative -Dmaven.wagon.httpconnectionManager.ttlSeconds=60
-          # Build of CLI
+          # Build samm-cli executable jar and run integration tests
           unset JAVA_TOOL_OPTIONS
           mvn -B -pl tools/samm-cli clean verify -Dmaven.wagon.httpconnectionManager.ttlSeconds=60
         shell: bash
@@ -266,9 +268,11 @@ jobs:
 
           # Actual build of core SDK
           mvn -B -pl '!org.eclipse.esmf:samm-cli' clean install -Pnative -Dmaven.wagon.httpconnectionManager.ttlSeconds=60
-          # Build of CLI
+          # Build samm-cli executable jar and run integration tests
           unset JAVA_TOOL_OPTIONS
-          mvn -B -pl tools/samm-cli clean verify -Pnative -Dmaven.wagon.httpconnectionManager.ttlSeconds=60
+          mvn -B -pl tools/samm-cli clean verify -Dmaven.wagon.httpconnectionManager.ttlSeconds=60
+          # Build native binary and run integration tests
+          mvn -B -pl tools/samm-cli verify -Pnative -Dmaven.wagon.httpconnectionManager.ttlSeconds=60
         shell: bash
 
       - name: Upload Windows binary
diff --git a/README.md b/README.md
@@ -58,14 +58,13 @@ Building the SDK requires a Java 21-compatible [GraalVM JDK](https://www.graalvm
 
 To build the SDK core components, run the following command:
 ```bash
-mvn -pl '!org.eclipse.esmf:samm-cli' clean install
+mvn -pl '!org.eclipse.esmf:samm-cli' clean install -Pnative
 ```
 
 To also build SDK core components and the CLI tool, run the above command, followed by:
 ```bash
-cd tools/samm-cli
-mvn -B clean verify
-mvn -B verify -Pnative
+mvn -pl org.eclipse.esmf:samm-cli clean verify
+mvn -pl org.eclipse.esmf:samm-cli verify -Pnative
 ```
 
 We are always looking forward to your contributions. For more details on how to contribute just take
diff --git a/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/loader/AspectModelLoader.java b/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/loader/AspectModelLoader.java
@@ -525,7 +525,7 @@ private void setNamespaces( final Collection<AspectModelFile> files, final Colle
                   final ModelElementFactory modelElementFactory = new ModelElementFactory( model, Map.of(), r -> null );
                   final Resource namespaceResource = model.listStatements( null, RDF.type, SammNs.SAMM.Namespace() )
                         .mapWith( Statement::getSubject )
-                        .toList().iterator().next();
+                        .toList().getFirst();
                   namespaceDefinition = modelElementFactory.createBaseAttributes( namespaceResource );
                   fileContainingNamespaceDefinition = elementFile;
                   break;
diff --git a/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/versionupdate/BammUriRewriter.java b/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/versionupdate/BammUriRewriter.java
@@ -125,11 +125,17 @@ public Model migrate( final Model sourceModel ) {
    }
 
    public enum BammVersion {
-      BAMM_1_0_0,
-      BAMM_2_0_0;
+      BAMM_1_0_0( "1.0.0" ),
+      BAMM_2_0_0( "2.0.0" );
+
+      private final String versionString;
+
+      BammVersion( final String versionString ) {
+         this.versionString = versionString;
+      }
 
       public String versionString() {
-         return toString().replaceFirst( "BAMM_(\\d+)_(\\d+)_(\\d+)", "$1.$2.$3" );
+         return versionString;
       }
    }
 }
diff --git a/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/versionupdate/SammMetaModelVersionUriRewriter.java b/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/versionupdate/SammMetaModelVersionUriRewriter.java
@@ -19,7 +19,6 @@
 import org.eclipse.esmf.samm.KnownVersion;
 
 public class SammMetaModelVersionUriRewriter extends AbstractUriRewriter {
-
    public SammMetaModelVersionUriRewriter( final KnownVersion sourceVersion, final KnownVersion targetVersion ) {
       super( sourceVersion, targetVersion );
    }
@@ -31,15 +30,15 @@ public int order() {
 
    @Override
    protected Optional<String> rewriteUri( final String oldUri, final Map<String, String> oldToNewNamespaces ) {
-      final String[] uriParts = oldUri.split( "#" );
-      if ( uriParts.length == 1 ) {
+      final int indexOfHash = oldUri.indexOf( '#' );
+      if ( indexOfHash == -1 ) {
+         return Optional.empty();
+      }
+      final String newNamespace = oldToNewNamespaces.get( oldUri.substring( 0, indexOfHash + 1 ) );
+      if ( newNamespace == null ) {
          return Optional.empty();
       }
-      return oldToNewNamespaces.keySet()
-            .stream()
-            .filter( key -> key.equals( uriParts[0] + "#" ) )
-            .findAny()
-            .map( key -> oldToNewNamespaces.get( key ) + uriParts[1] );
+      return Optional.of( newNamespace + oldUri.substring( indexOfHash + 1 ) );
    }
 
    @Override
diff --git a/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/metamodel/impl/DefaultScalarValue.java b/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/metamodel/impl/DefaultScalarValue.java
@@ -31,6 +31,23 @@ public class DefaultScalarValue implements ScalarValue {
 
    private final MetaModelBaseAttributes metaModelBaseAttributes;
 
+   /**
+    * Constructor for non-described/anonymous scalar values
+    *
+    * @param value the value
+    * @param type the type
+    */
+   public DefaultScalarValue( final Object value, final Scalar type ) {
+      this( null, value, type );
+   }
+
+   /**
+    * Standard constructor for scalar values that provides context information such as the value's descriptions
+    *
+    * @param metaModelBaseAttributes the base attributes
+    * @param value the value
+    * @param type the type
+    */
    public DefaultScalarValue( final MetaModelBaseAttributes metaModelBaseAttributes, final Object value, final Scalar type ) {
       this.metaModelBaseAttributes = metaModelBaseAttributes;
       this.value = value;
@@ -49,22 +66,22 @@ public Scalar getType() {
 
    @Override
    public List<String> getSee() {
-      return metaModelBaseAttributes.getSee();
+      return metaModelBaseAttributes == null ? List.of() : metaModelBaseAttributes.getSee();
    }
 
    @Override
    public Set<LangString> getPreferredNames() {
-      return metaModelBaseAttributes.getPreferredNames();
+      return metaModelBaseAttributes == null ? Set.of() : metaModelBaseAttributes.getPreferredNames();
    }
 
    @Override
    public Set<LangString> getDescriptions() {
-      return metaModelBaseAttributes.getDescriptions();
+      return metaModelBaseAttributes == null ? Set.of() : metaModelBaseAttributes.getDescriptions();
    }
 
    @Override
    public AspectModelFile getSourceFile() {
-      return metaModelBaseAttributes.getSourceFile();
+      return metaModelBaseAttributes == null ? null : metaModelBaseAttributes.getSourceFile();
    }
 
    @Override
diff --git a/core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/openapi/AspectModelOpenApiGenerator.java b/core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/openapi/AspectModelOpenApiGenerator.java
@@ -248,13 +248,13 @@ private void setResponseBodies( final Aspect aspect, final ObjectNode jsonNode,
       final ObjectNode componentsResponseNode = (ObjectNode) jsonNode.get( FIELD_COMPONENTS ).get( FIELD_RESPONSES );
       final ObjectNode referenceNode = FACTORY.objectNode()
             .put( REF, COMPONENTS_SCHEMAS + ( includePaging ? FIELD_PAGING_SCHEMA : aspect.getName() ) );
-      final ObjectNode contentNode = getApplicationNode( referenceNode );
+      final ObjectNode contentNode = getApplicationNode( referenceNode, false );
       componentsResponseNode.set( aspect.getName(), contentNode );
       contentNode.put( FIELD_DESCRIPTION, "The request was successful." );
       if ( !aspect.getOperations().isEmpty() ) {
          final ObjectNode operationResponseNode = FACTORY.objectNode()
                .put( REF, COMPONENTS_SCHEMAS + FIELD_OPERATION_RESPONSE );
-         final ObjectNode wrappedOperationNode = getApplicationNode( operationResponseNode );
+         final ObjectNode wrappedOperationNode = getApplicationNode( operationResponseNode, false );
          componentsResponseNode.set( FIELD_OPERATION_RESPONSE, wrappedOperationNode );
          wrappedOperationNode.put( FIELD_DESCRIPTION, "The request was successful." );
       }
@@ -265,21 +265,24 @@ private void setRequestBodies( final Aspect aspect, final OpenApiSchemaGeneratio
       final ObjectNode requestBodies = FACTORY.objectNode();
       componentNode.set( FIELD_REQUEST_BODIES, requestBodies );
       requestBodies.set( aspect.getName(),
-            getApplicationNode( FACTORY.objectNode().put( REF, COMPONENTS_SCHEMAS + aspect.getName() ) ) );
+            getApplicationNode( FACTORY.objectNode().put( REF, COMPONENTS_SCHEMAS + aspect.getName() ), true ) );
       if ( config.includeQueryApi() ) {
          requestBodies.set( FIELD_FILTER,
-               getApplicationNode( FACTORY.objectNode().put( REF, COMPONENTS_SCHEMAS + FIELD_FILTER ) ) );
+               getApplicationNode( FACTORY.objectNode().put( REF, COMPONENTS_SCHEMAS + FIELD_FILTER ), true ) );
       }
       if ( !aspect.getOperations().isEmpty() ) {
          requestBodies.set( FIELD_OPERATION,
-               getApplicationNode( FACTORY.objectNode().put( REF, COMPONENTS_SCHEMAS + FIELD_OPERATION ) ) );
+               getApplicationNode( FACTORY.objectNode().put( REF, COMPONENTS_SCHEMAS + FIELD_OPERATION ), true ) );
       }
    }
 
-   private ObjectNode getApplicationNode( final ObjectNode contentNode ) {
-      return FACTORY.objectNode().set( FIELD_CONTENT,
-            FACTORY.objectNode().set( APPLICATION_JSON,
-                  FACTORY.objectNode().set( FIELD_SCHEMA, contentNode ) ) );
+   private ObjectNode getApplicationNode( final ObjectNode contentNode, final boolean addRequired ) {
+      final ObjectNode result = FACTORY.objectNode();
+      result.set( FIELD_CONTENT, FACTORY.objectNode().set( APPLICATION_JSON, FACTORY.objectNode().set( FIELD_SCHEMA, contentNode ) ) );
+      if ( addRequired ) {
+         result.put( FIELD_REQUIRED, true );
+      }
+      return result;
    }
 
    private void setAspectSchemas( final Aspect aspect, final OpenApiSchemaGenerationConfig config, final ObjectNode jsonNode ) {
@@ -503,7 +506,10 @@ private ObjectNode getRequestEndpointsUpdate( final Aspect aspect, final ObjectN
       objectNode.set( "tags", FACTORY.arrayNode().add( aspect.getName() ) );
       objectNode.put( FIELD_OPERATION_ID, ( isPut ? FIELD_PUT : FIELD_PATCH ) + aspect.getName() );
       objectNode.set( FIELD_PARAMETERS, getRequiredParameters( parameterNode, isEmpty( resourcePath ) ) );
-      objectNode.set( FIELD_REQUEST_BODY, FACTORY.objectNode().put( REF, COMPONENTS_REQUESTS + aspect.getName() ) );
+      final ObjectNode requestBody = FACTORY.objectNode();
+      requestBody.put( FIELD_REQUIRED, true );
+      requestBody.put( REF, COMPONENTS_REQUESTS + aspect.getName() );
+      objectNode.set( FIELD_REQUEST_BODY, requestBody );
       objectNode.set( FIELD_RESPONSES, getResponsesForGet( aspect ) );
       return objectNode;
    }
diff --git a/core/esmf-aspect-model-document-generators/src/test/java/org/eclipse/esmf/aspectmodel/generator/openapi/AspectModelOpenApiGeneratorTest.java b/core/esmf-aspect-model-document-generators/src/test/java/org/eclipse/esmf/aspectmodel/generator/openapi/AspectModelOpenApiGeneratorTest.java
@@ -586,6 +586,8 @@ void testAspectWithPutOperation() {
       final SwaggerParseResult result = new OpenAPIParser().readContents( json.toString(), null, null );
       final OpenAPI openApi = result.getOpenAPI();
 
+      assertThat( openApi.getComponents().getRequestBodies().get( "AspectWithoutSeeAttribute" ).getRequired() ).isTrue();
+
       final String apiEndpoint = "/{tenant-id}/aspect-without-see-attribute";
 
       assertThat( openApi.getPaths().get( apiEndpoint ).getGet() ).isNotNull();
diff --git a/core/esmf-aspect-model-urn/src/main/java/org/eclipse/esmf/aspectmodel/urn/AspectModelUrn.java b/core/esmf-aspect-model-urn/src/main/java/org/eclipse/esmf/aspectmodel/urn/AspectModelUrn.java
@@ -73,6 +73,7 @@ public class AspectModelUrn implements Comparable<AspectModelUrn> {
    private final String namespaceMainPart;
    private final ElementType elementType;
    private final boolean isSammUrn;
+   private final String namespaceIdentifier;
 
    @JsonValue
    private final URI urn;
@@ -85,6 +86,10 @@ private AspectModelUrn( final URI urn, final String name, final String namespace
       this.elementType = elementType;
       this.version = version;
       this.isSammUrn = isSammUrn;
+      final String urnString = urn.toString();
+      namespaceIdentifier = urnString.contains( "#" )
+            ? urnString.substring( 0, urnString.indexOf( '#' ) )
+            : urnString;
    }
 
    /**
@@ -357,7 +362,7 @@ public String getNamespaceMainPart() {
     * @return the prefix part of the URN
     */
    public String getNamespaceIdentifier() {
-      return urn.toString().split( "#" )[0];
+      return namespaceIdentifier;
    }
 
    /**
diff --git a/core/esmf-test-aspect-models/src/main/resources/valid/org.eclipse.esmf.test/1.0.0/propertyWithValue.ttl b/core/esmf-test-aspect-models/src/main/resources/valid/org.eclipse.esmf.test/1.0.0/propertyWithValue.ttl
@@ -10,7 +10,7 @@
 #
 # SPDX-License-Identifier: MPL-2.0
 #
-@prefix : <urn:samm:org.eclipse.esmf.samm.test:1.0.0#> .
+@prefix : <urn:samm:org.eclipse.esmf.test:1.0.0#> .
 @prefix samm: <urn:samm:org.eclipse.esmf.samm:meta-model:2.2.0#> .
 @prefix samm-c: <urn:samm:org.eclipse.esmf.samm:characteristic:2.2.0#> .
 @prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
diff --git a/tools/samm-cli/pom.xml b/tools/samm-cli/pom.xml

Original file line number	Diff line number	Diff line change
`@@ -125,11 +125,17 @@ public Model migrate( final Model sourceModel ) {`
`125`	`125`	`}`
`126`	`126`
`127`	`127`	`public enum BammVersion {`
`128`		`- BAMM_1_0_0,`
`129`		`- BAMM_2_0_0;`
	`128`	`+ BAMM_1_0_0( "1.0.0" ),`
	`129`	`+ BAMM_2_0_0( "2.0.0" );`
	`130`	`+`
	`131`	`+ private final String versionString;`
	`132`	`+`
	`133`	`+ BammVersion( final String versionString ) {`
	`134`	`+ this.versionString = versionString;`
	`135`	`+ }`
`130`	`136`
`131`	`137`	`public String versionString() {`
`132`		`- return toString().replaceFirst( "BAMM_(\\d+)_(\\d+)_(\\d+)", "$1.$2.$3" );`
	`138`	`+ return versionString;`
`133`	`139`	`}`
`134`	`140`	`}`
`135`	`141`	`}`