Implement generateAspectImplementationStub Maven goal

Author: atextor

core/esmf-aspect-model-generator/src/main/java/org/eclipse/esmf/aspectmodel/generator/Generator.java

@@ -19,6 +19,7 @@
 import java.util.function.Function;
 import java.util.stream.Stream;
 
+import org.eclipse.esmf.functions.ThrowingFunction;
 import org.eclipse.esmf.metamodel.ModelElement;
 
 import lombok.Getter;
@@ -62,6 +63,16 @@ public void generate( final Function<I, OutputStream> nameMapper ) {
       generate().toList().forEach( generationResult -> write( generationResult, nameMapper ) );
    }
 
+   /**
+    * Similar to {@link #generate(Function)}, except the name mapper function can also write an exception
+    *
+    * @param nameMapper the callback function that maps artifact identifiers to OutputStreams
+    * @param <E> the type of exception that can be thrown by the name mapper
+    */
+   public <E extends Throwable> void generateThrowing( final ThrowingFunction<I, OutputStream, E> nameMapper ) {
+      generate().toList().forEach( generationResult -> writeThrowing( generationResult, nameMapper ) );
+   }
+
    /**
     * Generates artifacts for the given Aspect model
     *
@@ -103,4 +114,20 @@ protected void write( final Artifact<I, T> artifact, final Function<I, OutputStr
          LOG.error( "Failure during writing of generated artifact", exception );
       }
    }
+
+   /**
+    * Writes an artifact to the corresponding output stream
+    *
+    * @param artifact the artifact
+    * @param nameMapper the function that provides the output stream for the artifact
+    */
+   protected <E extends Throwable> void writeThrowing( final Artifact<I, T> artifact,
+         final ThrowingFunction<I, OutputStream, E> nameMapper ) {
+      try ( final OutputStream output = nameMapper.apply( artifact.getId() ) ) {
+         output.write( artifact.serialize() );
+         output.flush();
+      } catch ( final Throwable exception ) {
+         LOG.error( "Failure during writing of generated artifact", exception );
+      }
+   }
 }

pom.xml

@@ -83,6 +83,7 @@
       <!-- Dependency version overrides -->
       <log4j-version>2.22.1</log4j-version>
       <wagon-maven-plugin-version>1.0</wagon-maven-plugin-version>
+      <mojo-executor-version>2.4.0</mojo-executor-version>
    </properties>
 
    <dependencyManagement>
@@ -208,6 +209,11 @@
             <artifactId>log4j-core</artifactId>
             <version>${log4j-version}</version>
          </dependency>
+         <dependency>
+            <groupId>org.twdata.maven</groupId>
+            <artifactId>mojo-executor</artifactId>
+            <version>${mojo-executor-version}</version>
+         </dependency>
       </dependencies>
    </dependencyManagement>
 

tools/esmf-aspect-model-maven-plugin/pom.xml

@@ -51,6 +51,15 @@
          <version>${maven-plugin-dependencies-version}</version>
          <scope>provided</scope>
       </dependency>
+      <dependency>
+         <groupId>org.twdata.maven</groupId>
+         <artifactId>mojo-executor</artifactId>
+      </dependency>
+      <dependency>
+         <groupId>io.soabase.record-builder</groupId>
+         <artifactId>record-builder-processor</artifactId>
+         <scope>provided</scope>
+      </dependency>
 
       <dependency>
          <groupId>org.eclipse.esmf</groupId>
@@ -88,6 +97,20 @@
 
    <build>
       <plugins>
+         <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-compiler-plugin</artifactId>
+            <configuration>
+               <annotationProcessorPaths>
+                  <path>
+                     <groupId>io.soabase.record-builder</groupId>
+                     <artifactId>record-builder-processor</artifactId>
+                     <version>${record-builder-version}</version>
+                  </path>
+               </annotationProcessorPaths>
+            </configuration>
+         </plugin>
+
          <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-plugin-plugin</artifactId>

tools/esmf-aspect-model-maven-plugin/src/main/java/org/eclipse/esmf/aspectmodel/AspectModelMojo.java

@@ -13,8 +13,14 @@
 
 package org.eclipse.esmf.aspectmodel;
 
+import static java.lang.String.format;
+
+import java.io.File;
+import java.io.FileInputStream;
 import java.io.FileOutputStream;
 import java.io.IOException;
+import java.io.InputStream;
+import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.ArrayList;
@@ -42,7 +48,15 @@
 import org.eclipse.esmf.metamodel.Aspect;
 import org.eclipse.esmf.metamodel.AspectModel;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator;
+import com.fasterxml.jackson.dataformat.yaml.YAMLMapper;
 import io.vavr.control.Either;
+import io.vavr.control.Try;
+import org.apache.commons.io.FilenameUtils;
+import org.apache.commons.io.IOUtils;
+import org.apache.commons.lang3.StringUtils;
 import org.apache.maven.execution.MavenSession;
 import org.apache.maven.plugin.AbstractMojo;
 import org.apache.maven.plugin.MojoExecutionException;
@@ -53,29 +67,41 @@
 import org.codehaus.plexus.util.xml.Xpp3Dom;
 
 public abstract class AspectModelMojo extends AbstractMojo {
-   @Parameter( defaultValue = "${basedir}" )
-   private String basedir;
+   protected static final ObjectMapper YAML_MAPPER = new YAMLMapper().enable( YAMLGenerator.Feature.MINIMIZE_QUOTES );
+   protected static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
 
    @Parameter
-   private String modelsRootDirectory;
+   protected String modelsRootDirectory;
 
    @Parameter( required = true, property = "include" )
    protected Set<String> includes;
 
    @Parameter
    protected String outputDirectory = "";
 
+   @Parameter
+   protected String generatedSourcesDirectory = "";
+
    @Parameter( defaultValue = "false" )
    protected boolean detailedValidationMessages;
 
    @Parameter
    protected String githubServerId;
 
    @Parameter( defaultValue = "${session}", readonly = true )
-   private MavenSession session;
+   protected MavenSession mavenSession;
 
    protected GithubModelSourceConfig gitHubConfig;
 
+   private Map<AspectModel, Aspect> aspects;
+
+   public AspectModelMojo() {
+   }
+
+   protected AspectModelMojo( final Map<AspectModel, Aspect> aspects ) {
+      this.aspects = aspects;
+   }
+
    /**
     * Skip the execution.
     */
@@ -97,6 +123,9 @@ protected Set<AspectModel> loadModels() throws MojoExecutionException {
    }
 
    private Map<AspectModel, Aspect> loadAspectModels() throws MojoExecutionException {
+      if ( aspects != null ) {
+         return aspects;
+      }
       final List<ResolutionStrategy> strategies = new ArrayList<>();
       if ( modelsRootDirectory != null ) {
          final Path modelsRoot = Path.of( modelsRootDirectory );
@@ -110,7 +139,7 @@ private Map<AspectModel, Aspect> loadAspectModels() throws MojoExecutionExceptio
                "Neither modelsRootDirectory nor gitHubServerId were configured, don't know how to resolve Aspect Models" );
       }
 
-      final Map<AspectModel, Aspect> result = new HashMap<>();
+      aspects = new HashMap<>();
 
       final AspectModelLoader aspectModelLoader = new AspectModelLoader( strategies );
       for ( final String inputUrn : includes ) {
@@ -129,18 +158,27 @@ private Map<AspectModel, Aspect> loadAspectModels() throws MojoExecutionExceptio
                .filter( theAspect -> theAspect.urn().equals( urn ) )
                .findFirst()
                .orElseThrow( () -> new MojoExecutionException( "Loaded Aspect Model does not contain Aspect " + urn ) );
-         result.put( aspectModel, aspect );
+         aspects.put( aspectModel, aspect );
       }
-      return result;
+      return aspects;
    }
 
-   protected FileOutputStream getOutputStreamForFile( final String artifactName, final String outputDirectory ) {
+   protected File getOutFile( final String artifactName, final String outputDirectory ) throws MojoExecutionException {
       try {
          final Path outputPath = Path.of( outputDirectory );
          Files.createDirectories( outputPath );
-         return new FileOutputStream( outputPath.resolve( artifactName ).toFile() );
+         return outputPath.resolve( artifactName ).toFile();
+      } catch ( final IOException exception ) {
+         throw new MojoExecutionException( "Could not create missing directories for path " + outputDirectory );
+      }
+   }
+
+   protected FileOutputStream getOutputStreamForFile( final String artifactName, final String outputDirectory )
+         throws MojoExecutionException {
+      try {
+         return new FileOutputStream( getOutFile( artifactName, outputDirectory ) );
       } catch ( final IOException exception ) {
-         throw new RuntimeException( "Could not write to output " + outputDirectory );
+         throw new MojoExecutionException( "Could not write to output " + outputDirectory );
       }
    }
 
@@ -152,10 +190,10 @@ public void execute() throws MojoExecutionException, MojoFailureException {
       }
 
       if ( githubServerId != null ) {
-         if ( session == null ) {
+         if ( mavenSession == null ) {
             getLog().warn( "Could not read Maven session, ignoring GitHub server configuration." );
          } else {
-            final Server server = session.getSettings().getServer( githubServerId );
+            final Server server = mavenSession.getSettings().getServer( githubServerId );
             if ( server != null ) {
                final Xpp3Dom dom = (Xpp3Dom) server.getConfiguration();
                final String[] repositoryParts = Optional.ofNullable( dom.getChild( "repository" ) )
@@ -177,7 +215,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
                            .map( GithubRepository.Tag::new ) )
                      .orElse( new GithubRepository.Branch( "main" ) );
 
-               final List<Proxy> proxies = session.getSettings().getProxies();
+               final List<Proxy> proxies = mavenSession.getSettings().getProxies();
                final ProxyConfig proxyConfig = Optional.ofNullable( proxies ).stream().flatMap( Collection::stream )
                      .filter( proxy -> proxy.getProtocol().equals( "https" ) )
                      .findFirst()
@@ -203,4 +241,38 @@ public void execute() throws MojoExecutionException, MojoFailureException {
    }
 
    abstract void executeGeneration() throws MojoExecutionException, MojoFailureException;
+
+   protected ObjectNode readFile( final String file ) throws MojoExecutionException {
+      if ( StringUtils.isBlank( file ) ) {
+         return null;
+      }
+      final String extension = FilenameUtils.getExtension( file ).toUpperCase();
+      final Try<String> fileData = Try.of( () -> getFileAsString( file ) ).mapTry( Optional::get );
+      return switch ( extension ) {
+         case "YAML", "YML" -> (ObjectNode) fileData
+               .mapTry( data -> YAML_MAPPER.readValue( data, Object.class ) )
+               .mapTry( OBJECT_MAPPER::writeValueAsString )
+               .mapTry( OBJECT_MAPPER::readTree )
+               .get();
+         case "JSON" -> (ObjectNode) fileData
+               .mapTry( OBJECT_MAPPER::readTree )
+               .get();
+         default -> throw new MojoExecutionException( format( "File extension [%s] not supported.", extension ) );
+      };
+   }
+
+   private static Optional<String> getFileAsString( final String filePath ) throws MojoExecutionException {
+      if ( filePath == null || filePath.isEmpty() ) {
+         return Optional.empty();
+      }
+      final File f = new File( filePath );
+      if ( f.exists() && !f.isDirectory() ) {
+         try ( final InputStream inputStream = new FileInputStream( filePath ) ) {
+            return Optional.of( IOUtils.toString( inputStream, StandardCharsets.UTF_8 ) );
+         } catch ( final IOException e ) {
+            throw new MojoExecutionException( format( "Could not load file %s.", filePath ), e );
+         }
+      }
+      throw new MojoExecutionException( format( "File does not exist %s.", filePath ) );
+   }
 }

tools/esmf-aspect-model-maven-plugin/src/main/java/org/eclipse/esmf/aspectmodel/CodeGenerationMojo.java

@@ -15,17 +15,16 @@
 
 import java.io.File;
 import java.io.OutputStream;
-import java.util.function.Function;
 
 import org.eclipse.esmf.aspectmodel.java.QualifiedName;
 import org.eclipse.esmf.aspectmodel.urn.AspectModelUrn;
+import org.eclipse.esmf.functions.ThrowingFunction;
 import org.eclipse.esmf.metamodel.Aspect;
 
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugins.annotations.Parameter;
 
 public abstract class CodeGenerationMojo extends AspectModelMojo {
-
    @Parameter
    protected String packageName = "";
 
@@ -51,13 +50,15 @@ protected void validateParameters( final File templateLibFile ) throws MojoExecu
       super.validateParameters();
    }
 
-   protected final Function<QualifiedName, OutputStream> nameMapper = artifact -> {
-      final String path = artifact.getPackageName();
-      final String fileName = artifact.getClassName();
-      final String outputDirectoryForArtifact = outputDirectory + File.separator + path.replace( '.', File.separatorChar );
-      final String artifactName = fileName + ".java";
-      return getOutputStreamForFile( artifactName, outputDirectoryForArtifact );
-   };
+   protected ThrowingFunction<QualifiedName, OutputStream, MojoExecutionException> javaFileNameMapper( final String outputPath ) {
+      return artifact -> {
+         final String path = artifact.getPackageName();
+         final String fileName = artifact.getClassName();
+         final String outputDirectoryForArtifact = outputPath + File.separator + path.replace( '.', File.separatorChar );
+         final String artifactName = fileName + ".java";
+         return getOutputStreamForFile( artifactName, outputDirectoryForArtifact );
+      };
+   }
 
    protected String determinePackageName( final Aspect aspect ) {
       if ( packageName == null || packageName.isEmpty() ) {

tools/esmf-aspect-model-maven-plugin/src/main/java/org/eclipse/esmf/aspectmodel/GenerateAspectFromAas.java

@@ -29,8 +29,10 @@
 import org.apache.maven.plugins.annotations.LifecyclePhase;
 import org.apache.maven.plugins.annotations.Mojo;
 
-@Mojo( name = "generateAspectFromAas", defaultPhase = LifecyclePhase.GENERATE_RESOURCES )
+@Mojo( name = GenerateAspectFromAas.MAVEN_GOAL, defaultPhase = LifecyclePhase.GENERATE_RESOURCES )
 public class GenerateAspectFromAas extends AspectModelMojo {
+   public static final String MAVEN_GOAL = "generateAspectFromAas";
+
    @Override
    public void executeGeneration() throws MojoExecutionException, MojoFailureException {
       validateParameters();