Merge branch 'main' into 2.10.x

Author: atextor

.github/workflows/release-workflow.yml

@@ -471,7 +471,7 @@ jobs:
       # Milestone release: Maven deploy to Github
       - name: Publish to Github
         if: contains( github.event.inputs.release_version, '-M' )
-        run: mvn -s ./settings.xml -B clean -pl '!esmf-sdk-test-report,!documentation,!tools/samm-cli' deploy -DskipTests -Pmilestone-build,sign
+        run: mvn -s ./settings.xml -B clean -pl '!documentation,!tools/samm-cli' deploy -DskipTests -Pmilestone-build,sign
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN  }}
           PGP_KEY_PASSWORD: ${{ secrets.PGP_KEY_PASSWORD }}

CONVENTIONS.md

@@ -55,10 +55,8 @@ if (someOptional != null && someOptional.isPresent()) ...
 * You should be using Objects.requireNonNull() for those sort of checks (or Guava's Preconditions if you're having more types of assertions than non-null and aim for a maximum of consistency).
 
 ### Lombok
-We use Lombok in the ESMF SDK. Project Lombok is a Java library that automatically plugs into your
-editor and build tools. It removes the burden to write getter or equals methods, adds fully featured
-builders to a class with one annotation, automates logging variables, and much more. Consider using
-its features if you are in the need to do something like that.
+Lombok was used in the past, but is not used anymore in the ESMF SDK. Instead of the `@Value` or
+`@Data` annotations, consider using Java records.
 
 ## Documentation
 

core/esmf-aspect-meta-model-interface/pom.xml

@@ -48,10 +48,6 @@
          <groupId>jakarta.xml.bind</groupId>
          <artifactId>jakarta.xml.bind-api</artifactId>
       </dependency>
-      <dependency>
-         <groupId>org.projectlombok</groupId>
-         <artifactId>lombok</artifactId>
-      </dependency>
 
       <dependency>
          <groupId>org.junit.jupiter</groupId>

core/esmf-aspect-meta-model-interface/src/main/java/org/eclipse/esmf/metamodel/vocabulary/RdfNamespace.java

@@ -56,7 +56,8 @@ static Map<String, String> createPrefixMap( final KnownVersion metaModelVersion
       result.put( samm.getShortForm(), samm.getNamespace() );
       final SAMMC sammc = new SAMMC( metaModelVersion );
       result.put( sammc.getShortForm(), sammc.getNamespace() );
-      result.put( "samm-e", new SAMME( metaModelVersion, samm ).getNamespace() );
+      final SAMME samme = new SAMME( metaModelVersion, samm );
+      result.put( samme.getShortForm(), samme.getNamespace() );
       final UNIT unit = new UNIT( metaModelVersion, samm );
       result.put( unit.getShortForm(), unit.getNamespace() );
       result.put( "rdf", RDF.getURI() );

core/esmf-aspect-meta-model-interface/src/main/java/org/eclipse/esmf/metamodel/vocabulary/SammNs.java

@@ -13,6 +13,8 @@
 
 package org.eclipse.esmf.metamodel.vocabulary;
 
+import java.util.stream.Stream;
+
 import org.eclipse.esmf.samm.KnownVersion;
 
 /**
@@ -23,4 +25,13 @@ public class SammNs {
    public static final SAMMC SAMMC = new SAMMC( KnownVersion.getLatest() );
    public static final SAMME SAMME = new SAMME( KnownVersion.getLatest(), SAMM );
    public static final UNIT UNIT = new UNIT( KnownVersion.getLatest(), SAMM );
+
+   /**
+    * All SAMM-specific metamodel RDF namespaces
+    *
+    * @return the namespaces
+    */
+   public static Stream<RdfNamespace> sammNamespaces() {
+      return Stream.of( SAMM, SAMMC, SAMME, UNIT );
+   }
 }

core/esmf-aspect-meta-model-java/pom.xml

@@ -28,6 +28,11 @@
    <name>ESMF Aspect Meta Model Java</name>
    <packaging>jar</packaging>
 
+   <properties>
+      <!-- Necessary so that properties-maven-plugin writes it into app.properties -->
+      <project-version>${project.version}</project-version>
+   </properties>
+
    <dependencies>
       <dependency>
          <groupId>org.eclipse.esmf</groupId>
@@ -79,12 +84,30 @@
 
    <build>
       <plugins>
+         <plugin>
+            <groupId>org.codehaus.mojo</groupId>
+            <artifactId>properties-maven-plugin</artifactId>
+            <executions>
+               <execution>
+                  <phase>initialize</phase>
+                  <goals>
+                     <goal>write-project-properties</goal>
+                  </goals>
+                  <configuration>
+                     <outputFile>
+                        ${project.build.outputDirectory}/app.properties
+                     </outputFile>
+                  </configuration>
+               </execution>
+            </executions>
+         </plugin>
+
          <plugin>
             <groupId>org.codehaus.mojo</groupId>
             <artifactId>build-helper-maven-plugin</artifactId>
             <executions>
                <execution>
-                  <id>add-shared-test-source</id>
+                  <id>add-shared-test-sources</id>
                   <phase>initialize</phase>
                   <goals>
                      <goal>add-test-source</goal>
@@ -96,7 +119,7 @@
                   </configuration>
                </execution>
                <execution>
-                  <id>add-source</id>
+                  <id>add-generated-sources</id>
                   <phase>initialize</phase>
                   <goals>
                      <goal>add-source</goal>
@@ -108,7 +131,7 @@
                   </configuration>
                </execution>
                <execution>
-                  <id>add-src-buildtime-source</id>
+                  <id>add-buildtime-sources</id>
                   <phase>initialize</phase>
                   <goals>
                      <goal>add-source</goal>
@@ -141,28 +164,6 @@
             </executions>
          </plugin>
 
-         <!-- Disable surefire report plugin. The report is created in the esmf-sdk-test-report module -->
-         <plugin>
-            <groupId>org.apache.maven.plugins</groupId>
-            <artifactId>maven-surefire-report-plugin</artifactId>
-            <version>${maven-surefire-report-plugin-version}</version>
-            <configuration>
-               <skipFailsafeReport>true</skipFailsafeReport>
-               <skipSurefireReport>true</skipSurefireReport>
-            </configuration>
-         </plugin>
-
-         <!-- Disable maven site plugin. It is not required since the report is created in the
-         esmf-sdk-test-report module -->
-         <plugin>
-            <groupId>org.apache.maven.plugins</groupId>
-            <artifactId>maven-site-plugin</artifactId>
-            <version>${maven-site-plugin-version}</version>
-            <configuration>
-               <skip>true</skip>
-            </configuration>
-         </plugin>
-
          <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-clean-plugin</artifactId>
@@ -180,11 +181,6 @@
             <artifactId>maven-compiler-plugin</artifactId>
             <configuration>
                <annotationProcessorPaths>
-                  <path>
-                     <groupId>org.projectlombok</groupId>
-                     <artifactId>lombok</artifactId>
-                     <version>${lombok-version}</version>
-                  </path>
                   <path>
                      <groupId>io.soabase.record-builder</groupId>
                      <artifactId>record-builder-processor</artifactId>

core/esmf-aspect-meta-model-java/src-buildtime/main/java/org/eclipse/esmf/buildtime/GenerateBuildtimeCode.java

@@ -31,7 +31,8 @@ public static void main( final String[] args ) {
 
       Stream.of(
             new GenerateUnits( srcBuildtimePath, srcGenPath ),
-            new GenerateQuantityKinds( srcBuildtimePath, srcGenPath )
+            new GenerateQuantityKinds( srcBuildtimePath, srcGenPath ),
+            new GenerateVersionInfo( srcBuildtimePath, srcGenPath )
       ).forEach( BuildtimeCodeGenerator::writeGeneratedFile );
    }
 }

core/esmf-aspect-meta-model-java/src-buildtime/main/java/org/eclipse/esmf/buildtime/GenerateVersionInfo.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2025 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
+ */
+
+package org.eclipse.esmf.buildtime;
+
+import java.io.InputStream;
+import java.nio.file.Path;
+import java.util.Properties;
+
+/**
+ * Generates the static version info class
+ */
+public class GenerateVersionInfo extends BuildtimeCodeGenerator {
+   private final Properties properties;
+
+   protected GenerateVersionInfo( final Path srcBuildTimePath, final Path srcGenPath ) {
+      super( srcBuildTimePath, srcGenPath, "VersionInfo", "org.eclipse.esmf.aspectmodel" );
+
+      try ( final InputStream stream = GenerateVersionInfo.class.getClassLoader().getResourceAsStream( "app.properties" ) ) {
+         if ( stream == null ) {
+            throw new RuntimeException();
+         }
+         properties = new Properties();
+         properties.load( stream );
+      } catch ( final Exception exception ) {
+         throw new RuntimeException( "Could not load app.properties" );
+      }
+   }
+
+   @Override
+   protected String interpolateVariable( final String variableName ) {
+      return switch ( variableName ) {
+         case "esmfSdkVersion" -> properties.getProperty( "project-version" );
+         case "aspectMetaModelVersion" -> properties.getProperty( "aspect-meta-model-version" );
+         case "generator" -> getClass().getCanonicalName();
+         default -> throw new RuntimeException( "Unexpected variable in template: " + variableName );
+      };
+   }
+}

core/esmf-aspect-meta-model-java/src-buildtime/main/java/org/eclipse/esmf/buildtime/template/VersionInfo.java

@@ -0,0 +1,22 @@
+/*
+ * Copyright (c) 2025 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
+ */
+
+package org.eclipse.esmf.buildtime.template;
+
+import javax.annotation.processing.Generated;
+
+@Generated( "${generator}" )
+public class VersionInfo {
+   public static final String ESMF_SDK_VERSION = "${esmfSdkVersion}";
+   public static final String ASPECT_META_MODEL_VERSION = "${aspectMetaModelVersion}";
+}

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

@@ -23,6 +23,7 @@
 import java.util.stream.Stream;
 
 import org.eclipse.esmf.aspectmodel.resolver.services.TurtleLoader;
+import org.eclipse.esmf.aspectmodel.serializer.AspectSerializer;
 import org.eclipse.esmf.aspectmodel.urn.AspectModelUrn;
 import org.eclipse.esmf.aspectmodel.urn.ElementType;
 import org.eclipse.esmf.metamodel.vocabulary.SammNs;
@@ -39,6 +40,9 @@
 import org.apache.jena.rdf.model.ResIterator;
 import org.apache.jena.rdf.model.Resource;
 import org.apache.jena.rdf.model.Statement;
+import org.apache.jena.riot.RDFFormat;
+import org.apache.jena.riot.RDFLanguages;
+import org.apache.jena.riot.RDFWriter;
 import org.apache.jena.vocabulary.RDF;
 import org.apache.jena.vocabulary.XSD;
 
@@ -147,6 +151,17 @@ public static Model createModel( final String ttlRepresentation ) {
       return TurtleLoader.loadTurtle( ttlRepresentation ).get();
    }
 
+   /**
+    * Turn a an RDF model to its String representation. Note that this method should only be used where {@link AspectSerializer} can
+    * not be used since it does not honor Aspect Model formatting rules.
+    *
+    * @param model the input model
+    * @return the rendered model
+    */
+   public static String modelToString( final Model model ) {
+      return RDFWriter.create().format( RDFFormat.TURTLE ).lang( RDFLanguages.TURTLE ).source( model ).asString();
+   }
+
    /**
     * Returns the List of named resources that transitively point to a given node. Transtively here means that the given node
     * is reachable from the named resource via any number of anonymous nodes inbetween.