Merge branch 'main' into 379-specify-model-namespace-packages

Author: Yauhenikapl

documentation/developer-guide/modules/tooling-guide/pages/java-aspect-tooling.adoc

@@ -152,23 +152,24 @@ include::esmf-developer-guide:ROOT:partial$esmf-aspect-meta-model-java-artifact.
 [[understanding-model-resolution]]
 === Understanding Model Resolution
 
-The example in the last section showed how a self-contained Aspect Model file can be loaded (i.e., a file that
-does not refer to model element definitions in other files or namespaces). Whenever models are loaded that
-could contain such references, or you want to load a model element by URN, the AspectModelLoader relies on
-so-called _resolution strategies_. A resolution strategy is a function that takes a model element identifier
-(a model element URN) as an input and returns the content of the file that contains the corresponding model
-element definition. Note that this is not necessarily a file in the local filesystem, but it could also be a
-remote file or even exist only virtually as a collection of statements in an RDF triple store. Several
-`ResolutionStrategy`s are provided that can be instantiated and passed to the `AspectModelLoader` constructor
-to enable it to find model element definitions:
+The example in the last section showed how a self-contained Aspect Model file can be loaded (i.e., a
+file that does not refer to model element definitions in other files or namespaces). Whenever models
+are loaded that could contain such references, or you want to load a model element by URN, the
+AspectModelLoader relies on so-called _resolution strategies_. A resolution strategy is a function
+that takes a model element identifier (a model element URN) as an input and returns the content of
+the file that contains the corresponding model element definition. Note that this is not necessarily
+a file in the local filesystem, but it could also be a remote file or even exist only virtually as a
+collection of statements in an RDF triple store. Several `ResolutionStrategy`​s are provided
+that can be instantiated and passed to the `AspectModelLoader` constructor to enable it to find
+model element definitions:
 
 * The `FileSystemStrategy` resolves elements from files in the file system which are either structured in the
   xref:tooling-guide:samm-cli.adoc#models-directory-structure[models directory structure] or exist as flat
   list of files in one directory (by using `FileSystemStrategy` with a `FlatModelsRoot`).
 * The `ClassPathStrategy` resolves model elements from resources in the Java class path.
 * The `FromLoadedFileStrategy` resolves model elements from an `AspectModelFile` that already resides in
   memory.
-* The `EitherStrategy` can be used to chain two or more different `ResolutionStrategy`s.
+* The `EitherStrategy` can be used to chain two or more different `ResolutionStrategy`​s.
 * The `ExternalResolverStrategy` delegates resolution to an external command such as a script; it is used in
   the implementation of the `--custom-resolver` option of the xref:tooling-guide:samm-cli.adoc[samm-cli].
 

documentation/developer-guide/modules/tooling-guide/pages/maven-plugin.adoc

@@ -118,6 +118,7 @@ are replaced using `packageName` | `String` | none | {nok}
 | `templateFile` | The path and name of the velocity template file containing the macro library. See xref:java-aspect-tooling.adoc#providing-custom-macros-for-code-generation[Providing Custom Macros for Code Generation]. | `String` | none | {nok}
 | `executeLibraryMacros` | Execute the macros provided in the velocity macro library. | `Boolean` | `false` | {nok}
 | `disableJacksonAnnotations` | Leads to generated Java code that does not contain https://github.com/FasterXML/jackson[Jackson] annotations. | `Boolean` | `false` | {nok}
+| `skip` | Skip execution of plugin and generation | `Boolean` | `false` | {nok}
 |===
 
 === Generate Static Meta Classes
@@ -265,7 +266,7 @@ Configuration Properties:
 | `aspectApiBaseUrl` | The base URL for the Aspect API OpenAPI specification. | `String` | none | {ok}
 | `aspectParameterFile` | The path to a file including the schema description for the resource. For JSON the description has to be in json, for YAML it has to be in YAML. | `String` | none | {nok}
 | `useSemanticApiVersion` | Use the complete semantic version of the Aspect Model as the version of the Aspect API. | `Boolean` | `false` | {nok}
-| `aspectResourcePath` | The resource-path` for the Aspect API endpoints. | `String` | none | {nok}
+| `aspectResourcePath` | The `resource-path` for the Aspect API endpoints. | `String` | none | {nok}
 | `includeQueryApi` | Include the path for the Query Aspect API Endpoint in the OpenAPI specification. | `Boolean` | `false` | {nok}
 | `includeFullCrud` | Include the POST/PUT/PATCH methods in the OpenAPI specification. | `Boolean` | `false` | {nok}
 | `includePost` | Include the POST method in the OpenAPI specification. | `Boolean` | `false` | {nok}

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

@@ -37,6 +37,7 @@
 import io.vavr.control.Either;
 import org.apache.maven.plugin.AbstractMojo;
 import org.apache.maven.plugin.MojoExecutionException;
+import org.apache.maven.plugin.MojoFailureException;
 import org.apache.maven.plugins.annotations.Parameter;
 
 public abstract class AspectModelMojo extends AbstractMojo {
@@ -52,6 +53,12 @@ public abstract class AspectModelMojo extends AbstractMojo {
    @Parameter( defaultValue = "false" )
    protected boolean detailedValidationMessages;
 
+   /**
+    * Skip the execution.
+    */
+   @Parameter( name = "skip", property = "gen.skip", defaultValue = "false" )
+   private Boolean skip;
+
    protected void validateParameters() throws MojoExecutionException {
       if ( includes == null || includes.isEmpty() ) {
          throw new MojoExecutionException( "Missing configuration. Please provide Aspect Models to be included." );
@@ -101,4 +108,15 @@ protected FileOutputStream getOutputStreamForFile( final String artifactName, fi
          throw new RuntimeException( "Could not write to output " + outputDirectory );
       }
    }
+
+   @Override
+   public void execute() throws MojoExecutionException, MojoFailureException {
+      if ( Boolean.TRUE.equals( skip ) ) {
+         getLog().info( "Generation is skipped." );
+         return;
+      }
+      executeGeneration();
+   }
+
+   abstract void executeGeneration() throws MojoExecutionException, MojoFailureException;
 }

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

@@ -32,7 +32,7 @@ public class GenerateAas extends AspectModelMojo {
    private String targetFormat;
 
    @Override
-   public void execute() throws MojoExecutionException, MojoFailureException {
+   public void executeGeneration() throws MojoExecutionException, MojoFailureException {
       validateParameters();
       final Set<Aspect> aspects = loadAspects();
       final AspectModelAasGenerator generator = new AspectModelAasGenerator();

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

@@ -32,7 +32,7 @@
 @Mojo( name = "generateAspectFromAas", defaultPhase = LifecyclePhase.GENERATE_RESOURCES )
 public class GenerateAspectFromAas extends AspectModelMojo {
    @Override
-   public void execute() throws MojoExecutionException, MojoFailureException {
+   public void executeGeneration() throws MojoExecutionException, MojoFailureException {
       validateParameters();
       for ( final String include : includes ) {
          final AasToAspectModelGenerator generator = AasToAspectModelGenerator.fromFile( new File( include ) );

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

@@ -57,7 +57,7 @@ public class GenerateAsyncApiSpec extends AspectModelMojo {
    private String language;
 
    @Override
-   public void execute() throws MojoExecutionException, MojoFailureException {
+   public void executeGeneration() throws MojoExecutionException, MojoFailureException {
       final Set<Aspect> aspects = loadAspects();
       final Locale locale = Optional.ofNullable( language ).map( Locale::forLanguageTag ).orElse( Locale.ENGLISH );
       final ApiFormat format = Try.of( () -> ApiFormat.valueOf( outputFormat.toUpperCase() ) )

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

@@ -36,7 +36,7 @@ public class GenerateDiagram extends AspectModelMojo {
    private Set<String> targetFormats;
 
    @Override
-   public void execute() throws MojoExecutionException {
+   public void executeGeneration() throws MojoExecutionException {
       validateParameters();
 
       final Set<Aspect> aspects = loadAspects();

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

@@ -38,7 +38,7 @@ public class GenerateDocumentation extends AspectModelMojo {
    private final String htmlCustomCssFilePath = "";
 
    @Override
-   public void execute() throws MojoExecutionException {
+   public void executeGeneration() throws MojoExecutionException {
       validateParameters();
 
       try {

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

@@ -37,7 +37,7 @@ public class GenerateJavaClasses extends CodeGenerationMojo {
    private boolean disableJacksonAnnotations;
 
    @Override
-   public void execute() throws MojoExecutionException {
+   public void executeGeneration() throws MojoExecutionException {
       final Set<Aspect> aspects = loadAspects();
       for ( final Aspect aspect : aspects ) {
          final File templateLibFile = Path.of( templateFile ).toFile();

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

@@ -31,7 +31,7 @@ public class GenerateJsonPayload extends AspectModelMojo {
    private static final Logger LOG = LoggerFactory.getLogger( GenerateJsonPayload.class );
 
    @Override
-   public void execute() throws MojoExecutionException, MojoFailureException {
+   public void executeGeneration() throws MojoExecutionException, MojoFailureException {
       validateParameters();
 
       final Set<Aspect> aspects = loadAspects();