Create Aspect Models from AAS submodel template

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

@@ -30,6 +30,7 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import org.eclipse.digitaltwin.aas4j.v3.model.Referable;
 import org.eclipse.esmf.aspectmodel.VersionNumber;
 import org.eclipse.esmf.aspectmodel.urn.AspectModelUrn;
 import org.eclipse.esmf.aspectmodel.vocabulary.SAMMC;
@@ -165,6 +166,14 @@ public List<Aspect> generateAspects() {
             .toList();
    }
 
+   public List<String> getSubmodelNames() {
+      return aasEnvironment.getSubmodels()
+            .stream()
+            .filter( submodel -> submodel.getKind().equals( ModellingKind.TEMPLATE ) )
+            .map( Referable::getIdShort )
+            .collect( Collectors.toList());
+   }
+
    protected String escapeUrnNamespacePart( final String namespacePart ) {
       if ( namespacePart.matches( AspectModelUrn.NAMESPACE_REGEX ) ) {
          return namespacePart;

documentation/developer-guide/modules/tooling-guide/pages/samm-cli.adoc

@@ -136,9 +136,14 @@ The available options and their meaning can also be seen in the help text of the
                                    | _--format, -f_ : output file format (xml, json, or aasx, default: xml)                  |
                                    | _--custom-resolver_ : use an external resolver for the resolution of the model elements |
                                    | _--aspect-data, -a_ : path to a JSON file containing aspect data corresponding to the Aspect Model |
-.2+| aas <aas file> to aspect      | Translate Asset Administration Shell (AAS) Submodel Templates to Aspect Models          | `samm aas AssetAdminShell.aasx to aspect`
+.3+| aas <aas file> to aspect      | Translate Asset Administration Shell (AAS) Submodel Templates to Aspect Models          | `samm aas AssetAdminShell.aasx to aspect`
                                    | _--output-directory, -d_ : output directory to write files to (default:
                                        current directory)                                                                    |
+                                   | _--submodel-template, -s_ : selected submodel template for generating;
+                                       run `samm aas <aas file> list` to list them.                                          | `samm aas AssetAdminShell.aasx to aspect -s 1 -s 2`
+.1+| aas <aas file> list           | Retrieve a list of submodel templates contained within the provided
+                                       Asset Administration Shell (AAS) file.                                                | `samm aas AssetAdminShell.aasx list`
+
 |===
 
 === Custom model resolver

tools/samm-cli/src/main/java/org/eclipse/esmf/aas/AasCommand.java

@@ -11,6 +11,7 @@
       subcommands = {
             CommandLine.HelpCommand.class,
             AasToCommand.class,
+            AasListSubmodelsCommand.class
       },
       headerHeading = "@|bold Usage|@:%n%n",
       descriptionHeading = "%n@|bold Description|@:%n%n",

tools/samm-cli/src/main/java/org/eclipse/esmf/aas/AasListSubmodelsCommand.java

@@ -0,0 +1,47 @@
+package org.eclipse.esmf.aas;
+
+import java.io.File;
+import java.util.Arrays;
+import java.util.List;
+
+import org.apache.commons.io.FilenameUtils;
+import org.eclipse.esmf.AbstractCommand;
+import org.eclipse.esmf.LoggingMixin;
+import org.eclipse.esmf.aspectmodel.aas.AasFileFormat;
+import org.eclipse.esmf.aspectmodel.aas.AasToAspectModelGenerator;
+import org.eclipse.esmf.exception.CommandException;
+
+import picocli.CommandLine;
+
+@CommandLine.Command( name = AasListSubmodelsCommand.COMMAND_NAME, description = "Get list of submodel templates of AAS input",
+      descriptionHeading = "%n@|bold Description|@:%n%n",
+      parameterListHeading = "%n@|bold Parameters|@:%n",
+      optionListHeading = "%n@|bold Options|@:%n",
+      mixinStandardHelpOptions = true
+)
+public class AasListSubmodelsCommand extends AbstractCommand {
+   public static final String COMMAND_NAME = "list";
+
+   @CommandLine.Mixin
+   private LoggingMixin loggingMixin;
+
+   @CommandLine.ParentCommand
+   private AasCommand parentCommand;
+
+   @Override
+   public void run() {
+      final String path = parentCommand.getInput();
+      final String extension = FilenameUtils.getExtension( path );
+
+      if ( Arrays.stream( AasFileFormat.values() ).noneMatch( format -> format.toString().equals( extension ) ) ) {
+         throw new CommandException( "Input file name must be one of " + AasFileFormat.allValues() );
+      }
+
+      final List<String> submodelNames = AasToAspectModelGenerator.fromFile( new File( path ) ).getSubmodelNames();
+
+      for ( final String submodelName : submodelNames ) {
+         final int index = submodelNames.indexOf( submodelName );
+         System.out.printf( "%2s: %s%n", index + 1, submodelName );
+      }
+   }
+}

tools/samm-cli/src/main/java/org/eclipse/esmf/aas/to/AasToAspectCommand.java

@@ -6,19 +6,22 @@
 import java.io.IOException;
 import java.io.Writer;
 import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.stream.IntStream;
 
+import org.apache.commons.io.FilenameUtils;
 import org.eclipse.esmf.AbstractCommand;
 import org.eclipse.esmf.LoggingMixin;
 import org.eclipse.esmf.aas.AasToCommand;
 import org.eclipse.esmf.aspectmodel.aas.AasToAspectModelGenerator;
+import org.eclipse.esmf.aspectmodel.resolver.fs.StructuredModelsRoot;
 import org.eclipse.esmf.aspectmodel.serializer.AspectSerializer;
 import org.eclipse.esmf.exception.CommandException;
 import org.eclipse.esmf.metamodel.Aspect;
-
-import org.eclipse.esmf.aspectmodel.resolver.fs.StructuredModelsRoot;
-import org.apache.commons.io.FilenameUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+
 import picocli.CommandLine;
 
 @CommandLine.Command(
@@ -38,6 +41,10 @@ public class AasToAspectCommand extends AbstractCommand {
    @CommandLine.Option( names = { "--output-directory", "-d" }, description = "Output directory to write files to" )
    private String outputPath = ".";
 
+   @CommandLine.Option( names = { "--submodel-template",
+         "-s" }, description = "Select the submodel template(s) to include, as returned by the aas list command" )
+   private List<Integer> selectedOptions = new ArrayList<>();
+
    @CommandLine.Mixin
    private LoggingMixin loggingMixin;
 
@@ -53,7 +60,15 @@ public void run() {
 
    private void generateAspects( final AasToAspectModelGenerator generator ) {
       final StructuredModelsRoot modelsRoot = new StructuredModelsRoot( Path.of( outputPath ) );
-      for ( final Aspect aspect : generator.generateAspects() ) {
+      final List<Aspect> generatedAspects = generator.generateAspects();
+
+      final List<Aspect> filteredAspects = this.selectedOptions.isEmpty() ? generatedAspects :
+            IntStream.range( 0, generatedAspects.size() )
+                  .filter( index -> selectedOptions.contains( index + 1 ) )
+                  .mapToObj( generatedAspects::get )
+                  .toList();
+
+      for ( final Aspect aspect : filteredAspects ) {
          final String aspectString = AspectSerializer.INSTANCE.apply( aspect );
          final File targetFile = modelsRoot.determineAspectModelFile( aspect.getAspectModelUrn().get() );
          LOG.info( "Writing {}", targetFile.getAbsolutePath() );

tools/samm-cli/src/test/java/org/eclipse/esmf/ProcessLauncher.java

@@ -34,8 +34,7 @@ public ExecutionResult apply( final String... arguments ) {
    }
 
    public ExecutionResult runAndExpectSuccess( final String... arguments ) {
-      final ExecutionResult result = apply(
-            new ExecutionContext( Arrays.asList( arguments ), Optional.empty(), new File( System.getProperty( "user.dir" ) ) ) );
+      final ExecutionResult result = apply( arguments );
       if ( result.exitStatus() != 0 ) {
          System.out.printf( "Execution failed (status %d):%n", result.exitStatus() );
          System.out.println( "stdout:" );

tools/samm-cli/src/test/java/org/eclipse/esmf/SammCliTest.java

@@ -31,6 +31,10 @@
 import java.util.Optional;
 import java.util.stream.Stream;
 
+import org.apache.tika.config.TikaConfig;
+import org.apache.tika.exception.TikaException;
+import org.apache.tika.metadata.Metadata;
+import org.apache.tika.mime.MediaType;
 import org.eclipse.esmf.ProcessLauncher.ExecutionResult;
 import org.eclipse.esmf.aspect.AspectValidateCommand;
 import org.eclipse.esmf.aspectmodel.shacl.violation.InvalidSyntaxViolation;
@@ -39,11 +43,6 @@
 import org.eclipse.esmf.test.MetaModelVersions;
 import org.eclipse.esmf.test.TestAspect;
 import org.eclipse.esmf.test.TestModel;
-
-import org.apache.tika.config.TikaConfig;
-import org.apache.tika.exception.TikaException;
-import org.apache.tika.metadata.Metadata;
-import org.apache.tika.mime.MediaType;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -381,6 +380,46 @@ public void testAasToAspectModel() {
       assertThat( sourceFile ).content().contains( ":" + testModel.getName() + " a samm:Aspect" );
    }
 
+   @Test
+   public void testAasListSubmodels() {
+      final File aasXmlFile = outputFile( "output.xml" );
+      final ExecutionResult generateAasXmlResult = sammCli.runAndExpectSuccess( "--disable-color", "aspect", defaultInputFile, "to", "aas",
+            "--format", "xml", "-o", aasXmlFile.getAbsolutePath() );
+      assertThat( generateAasXmlResult.stdout() ).isEmpty();
+      assertThat( generateAasXmlResult.stderr() ).isEmpty();
+
+      final ExecutionResult result = sammCli.runAndExpectSuccess( "--disable-color", "aas", aasXmlFile.getAbsolutePath(), "list" );
+      assertThat( result.stdout() ).isNotEmpty();
+      assertThat( result.stderr() ).isEmpty();
+   }
+
+   @Test
+   public void testAasToAspectModelWithSelectedSubmodels() {
+      // First create the AAS XML file we want to read
+      final File aasXmlFile = outputFile( "output.xml" );
+      final ExecutionResult generateAasXmlResult = sammCli.runAndExpectSuccess( "--disable-color", "aspect", defaultInputFile, "to", "aas",
+            "--format", "xml", "-o", aasXmlFile.getAbsolutePath() );
+      assertThat( generateAasXmlResult.stdout() ).isEmpty();
+      assertThat( generateAasXmlResult.stderr() ).isEmpty();
+
+      // Now the actual test, convert it to an Aspect Model
+      final File outputDir = outputDirectory.toFile();
+      final ExecutionResult result = sammCli.runAndExpectSuccess( "--disable-color", "aas", aasXmlFile.getAbsolutePath(), "to", "aspect",
+            "--output-directory", outputDir.getAbsolutePath(), "-s", "1" );
+      assertThat( result.stdout() ).isEmpty();
+      assertThat( result.stderr() ).isEmpty();
+
+      final File directory = outputDirectory.resolve( testModel.getUrn().getNamespace() )
+            .resolve( testModel.getUrn().getVersion() )
+            .toFile();
+      assertThat( directory ).exists();
+      final String expectedAspectModelFileName = testModel.getName() + ".ttl";
+      assertThat( directory ).isDirectoryContaining( file -> file.getName().equals( expectedAspectModelFileName ) );
+
+      final File sourceFile = directory.toPath().resolve( expectedAspectModelFileName ).toFile();
+      assertThat( sourceFile ).content().contains( ":" + testModel.getName() + " a samm:Aspect" );
+   }
+
    @Test
    public void testAspectToHtmlWithDefaultLanguageToFile() {
       final File targetFile = outputFile( "output.html" );