Fix execution of custom resolvers that output many lines

Author: atextor

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

@@ -18,7 +18,7 @@
 /**
  * Represents the result of the operation of writing changes in the {@link AspectChangeManager} to the file system.
  */
-sealed public interface WriteResult {
+public sealed interface WriteResult {
    interface Visitor<T> {
       T visitSuccess( Success success );
 

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

@@ -13,33 +13,42 @@
 
 package org.eclipse.esmf.aspectmodel.resolver;
 
-import java.io.IOException;
+import java.io.File;
 import java.io.InputStream;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Optional;
 import java.util.Scanner;
 import java.util.StringTokenizer;
 
-import org.eclipse.esmf.aspectmodel.resolver.exceptions.ModelResolutionException;
+import org.eclipse.esmf.aspectmodel.resolver.exceptions.ProcessExecutionException;
+import org.eclipse.esmf.aspectmodel.resolver.process.BinaryLauncher;
+import org.eclipse.esmf.aspectmodel.resolver.process.ExecutableJarLauncher;
+import org.eclipse.esmf.aspectmodel.resolver.process.ProcessLauncher;
 
 /**
  * Executes an external resolver via the underlying OS command and returns the stdout from the command as result.
  */
 public class CommandExecutor {
-   public static String executeCommand( String command ) {
-      // convenience: if just the name of the jar is given, expand to the proper java invocation command
-      if ( isJarInvocation( command ) ) {
-         command = String.format( "%s -jar %s", ProcessHandle.current().info().command().orElse( "java" ), command );
-      }
+   public static String executeCommand( final String command ) {
+      final List<String> parts = Arrays.asList( command.split( " " ) );
+      final String executableOrJar = parts.get( 0 );
+      final ProcessLauncher processLauncher = executableOrJar.toLowerCase().endsWith( ".jar" )
+            ? new ExecutableJarLauncher( new File( executableOrJar ) )
+            : new BinaryLauncher( new File( executableOrJar ) );
+      final List<String> arguments = parts.size() == 1
+            ? List.of()
+            : parts.subList( 1, parts.size() );
+      final ProcessLauncher.ExecutionContext context = new ProcessLauncher.ExecutionContext(
+            arguments, Optional.empty(), new File( System.getProperty( "user.dir" ) ) );
+      final ProcessLauncher.ExecutionResult result = processLauncher.apply( context );
 
-      try {
-         final Process p = Runtime.getRuntime().exec( command );
-         final int result = p.waitFor();
-         if ( result != 0 ) {
-            throw new ModelResolutionException( getOutputFrom( p.getErrorStream() ) );
-         }
-         return getOutputFrom( p.getInputStream() );
-      } catch ( final IOException | InterruptedException exception ) {
-         throw new ModelResolutionException( "The attempt to execute external resolver failed with the error:", exception );
+      if ( result.exitStatus() == 0 ) {
+         return result.stdout();
       }
+
+      throw new ProcessExecutionException( "Execution of '" + executableOrJar + "' failed (status " + result.exitStatus() + "). "
+            + "Error output: " + result.stderr() );
    }
 
    private static boolean isJarInvocation( final String command ) {

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/resolver/exceptions/ProcessExecutionException.java

@@ -0,0 +1,24 @@
+/*
+ * 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.aspectmodel.resolver.exceptions;
+
+public class ProcessExecutionException extends RuntimeException {
+   public ProcessExecutionException( final String message ) {
+      super( message );
+   }
+
+   public ProcessExecutionException( final Exception exception ) {
+      super( exception );
+   }
+}

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/resolver/process/BinaryLauncher.java

@@ -0,0 +1,26 @@
+/*
+ * 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.aspectmodel.resolver.process;
+
+import java.io.File;
+import java.util.List;
+
+/**
+ * A {@link ProcessLauncher} that executes a native binary.
+ */
+public class BinaryLauncher extends OsProcessLauncher {
+   public BinaryLauncher( final File binary ) {
+      super( List.of( binary.getAbsolutePath() ) );
+   }
+}

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/resolver/process/ExecutableJarLauncher.java

@@ -0,0 +1,40 @@
+/*
+ * 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.aspectmodel.resolver.process;
+
+import java.io.File;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * A {@link ProcessLauncher} that executes an executable jar.
+ */
+public class ExecutableJarLauncher extends OsProcessLauncher {
+   public ExecutableJarLauncher( final File executableJar ) {
+      this( executableJar, List.of() );
+   }
+
+   public ExecutableJarLauncher( final File executableJar, final List<String> jvmArguments ) {
+      super( buildCommand( executableJar, jvmArguments ) );
+   }
+
+   private static List<String> buildCommand( final File executableJar, final List<String> jvmArguments ) {
+      final List<String> commandWithArguments = new ArrayList<>();
+      commandWithArguments.add( ProcessHandle.current().info().command().orElse( "java" ) );
+      commandWithArguments.addAll( jvmArguments );
+      commandWithArguments.add( "-jar" );
+      commandWithArguments.add( executableJar.getAbsolutePath() );
+      return commandWithArguments;
+   }
+}

tools/samm-cli/src/test/java/org/eclipse/esmf/OsProcessLauncher.java renamed to core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/resolver/process/OsProcessLauncher.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
+ * Copyright (c) 2025 Robert Bosch Manufacturing Solutions GmbH
  *
  * See the AUTHORS file(s) distributed with this work for additional
  * information regarding authorship.
@@ -11,9 +11,7 @@
  * SPDX-License-Identifier: MPL-2.0
  */
 
-package org.eclipse.esmf;
-
-import static org.junit.jupiter.api.Assertions.fail;
+package org.eclipse.esmf.aspectmodel.resolver.process;
 
 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
@@ -30,6 +28,8 @@
 import java.util.concurrent.Future;
 import java.util.stream.Collectors;
 
+import org.eclipse.esmf.aspectmodel.resolver.exceptions.ProcessExecutionException;
+
 import org.apache.commons.io.IOUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -82,16 +82,15 @@ public ExecutionResult apply( final ExecutionContext context ) {
             stdoutRaw = stdoutFuture.get().toByteArray();
             stderrRaw = stderrFuture.get().toByteArray();
          } catch ( final ExecutionException | InterruptedException exception ) {
-            throw new RuntimeException( exception );
+            throw new ProcessExecutionException( exception );
          }
 
          return new ExecutionResult( process.exitValue(), new String( stdoutRaw, StandardCharsets.UTF_8 ),
                new String( stderrRaw, StandardCharsets.UTF_8 ),
                stdoutRaw, stderrRaw );
       } catch ( final IOException | InterruptedException exception ) {
-         fail( exception );
+         throw new ProcessExecutionException( exception );
       }
-      return null;
    }
 
    /**

tools/samm-cli/src/test/java/org/eclipse/esmf/ProcessLauncher.java renamed to core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/resolver/process/ProcessLauncher.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
+ * Copyright (c) 2025 Robert Bosch Manufacturing Solutions GmbH
  *
  * See the AUTHORS file(s) distributed with this work for additional
  * information regarding authorship.
@@ -11,16 +11,16 @@
  * SPDX-License-Identifier: MPL-2.0
  */
 
-package org.eclipse.esmf;
-
-import static org.junit.jupiter.api.Assertions.fail;
+package org.eclipse.esmf.aspectmodel.resolver.process;
 
 import java.io.File;
 import java.util.Arrays;
 import java.util.List;
 import java.util.Optional;
 import java.util.function.Function;
 
+import org.eclipse.esmf.aspectmodel.resolver.exceptions.ProcessExecutionException;
+
 /**
  * This class abstracts running a "process", i.e. running a program by providing its arguments, optional stdin and its working directory,
  * and representing the output using exit status and stdout and stderr streams.
@@ -36,20 +36,21 @@ public ExecutionResult apply( final String... arguments ) {
    public ExecutionResult runAndExpectSuccess( final String... arguments ) {
       final ExecutionResult result = apply( arguments );
       if ( result.exitStatus() != 0 ) {
-         System.out.printf( "Execution failed (status %d):%n", result.exitStatus() );
-         System.out.println( "stdout:" );
-         System.out.println( result.stdout() );
-         System.out.println();
-         System.out.println( "stderr:" );
-         System.out.println( result.stderr() );
-         fail();
+         throw new ProcessExecutionException(
+               "Execution failed (status " + result.exitStatus + "):\n"
+                     + "stdout:"
+                     + result.stdout()
+                     + "\n"
+                     + "stderr:"
+                     + result.stderr()
+         );
       }
       return result;
    }
 
-   public static record ExecutionContext( List<String> arguments, Optional<byte[]> stdin, File workingDirectory ) {
+   public record ExecutionContext( List<String> arguments, Optional<byte[]> stdin, File workingDirectory ) {
    }
 
-   public static record ExecutionResult( int exitStatus, String stdout, String stderr, byte[] stdoutRaw, byte[] stderrRaw ) {
+   public record ExecutionResult( int exitStatus, String stdout, String stderr, byte[] stdoutRaw, byte[] stderrRaw ) {
    }
 }

core/esmf-aspect-model-java-generator/src/test/java/org/eclipse/esmf/aspectmodel/java/AspectModelJavaGeneratorTest.java

@@ -28,7 +28,6 @@
 import java.util.List;
 import java.util.Optional;
 import java.util.Set;
-
 import javax.xml.datatype.Duration;
 import javax.xml.datatype.XMLGregorianCalendar;
 

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

@@ -14,10 +14,11 @@
 package org.eclipse.esmf;
 
 import java.nio.file.Path;
-import java.util.ArrayList;
 import java.util.List;
+import java.util.Optional;
 import java.util.function.Function;
 import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 import org.eclipse.esmf.aspectmodel.loader.AspectModelLoader;
 import org.eclipse.esmf.aspectmodel.resolver.ExternalResolverStrategy;
@@ -68,35 +69,43 @@ public AbstractInputHandler( final String input, final ResolverConfigurationMixi
    protected abstract String expectedAspectName();
 
    protected List<ResolutionStrategy> configuredStrategies() {
-      final List<ResolutionStrategy> strategies = new ArrayList<>();
       if ( resolverConfig == null ) {
-         return strategies;
+         return List.of();
       }
-      final List<String> modelsRoots = resolverConfig.modelsRoots == null
-            ? List.of()
-            : resolverConfig.modelsRoots;
-      for ( final String modelsRoot : modelsRoots ) {
-         strategies.add( new FileSystemStrategy( new StructuredModelsRoot( Path.of( modelsRoot ) ) ) );
-      }
-      if ( resolverConfig.commandLine != null && !resolverConfig.commandLine.isBlank() ) {
-         strategies.add( new ExternalResolverStrategy( resolverConfig.commandLine ) );
-      }
-      if ( resolverConfig.gitHubResolutionOptions != null && resolverConfig.gitHubResolutionOptions.gitHubName != null ) {
-         final String[] parts = resolverConfig.gitHubResolutionOptions.gitHubName.split( "/" );
-         final String owner = parts[0];
-         final String repositoryName = parts[1];
-         final GithubRepository.Ref branchOrTag = resolverConfig.gitHubResolutionOptions.gitHubTag != null
-               ? new GithubRepository.Tag( resolverConfig.gitHubResolutionOptions.gitHubTag )
-               : new GithubRepository.Branch( resolverConfig.gitHubResolutionOptions.gitHubBranch );
-         final GithubRepository repository = new GithubRepository( owner, repositoryName, branchOrTag );
-         final GithubModelSourceConfig modelSourceConfig = GithubModelSourceConfigBuilder.builder()
-               .repository( repository )
-               .directory( resolverConfig.gitHubResolutionOptions.gitHubDirectory )
-               .token( resolverConfig.gitHubResolutionOptions.gitHubToken )
-               .build();
-         strategies.add( new GitHubStrategy( modelSourceConfig ) );
+      return Stream.of(
+                  Optional.ofNullable( resolverConfig.modelsRoots ).orElse( List.of() )
+                        .stream()
+                        .map( modelsRoot -> new FileSystemStrategy( new StructuredModelsRoot( Path.of( modelsRoot ) ) ) ),
+                  Optional.ofNullable( resolverConfig.commandLine )
+                        .orElse( List.of() )
+                        .stream()
+                        .map( ExternalResolverStrategy::new ),
+                  Optional.ofNullable( resolverConfig.gitHubResolverOptions ).orElse( List.of() )
+                        .stream()
+                        .map( options -> buildGithubModelSourceConfig( options, resolverConfig.gitHubToken ) )
+                        .flatMap( Optional::stream )
+                        .map( GitHubStrategy::new ) )
+            .<ResolutionStrategy> flatMap( Function.identity() )
+            .toList();
+   }
+
+   private Optional<GithubModelSourceConfig> buildGithubModelSourceConfig(
+         final ResolverConfigurationMixin.GitHubResolverOptions options, final String gitHubToken ) {
+      if ( options.gitHubName == null ) {
+         return Optional.empty();
       }
-      return strategies;
+      final String[] parts = options.gitHubName.split( "/" );
+      final String owner = parts[0];
+      final String repositoryName = parts[1];
+      final GithubRepository.Ref branchOrTag = options.gitHubTag != null
+            ? new GithubRepository.Tag( options.gitHubTag )
+            : new GithubRepository.Branch( options.gitHubBranch );
+      final GithubRepository repository = new GithubRepository( owner, repositoryName, branchOrTag );
+      return Optional.of( GithubModelSourceConfigBuilder.builder()
+            .repository( repository )
+            .directory( options.gitHubDirectory )
+            .token( gitHubToken )
+            .build() );
    }
 
    @Override

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

@@ -46,11 +46,13 @@ private AspectModelUrn urnFromInput( final String input ) {
    protected List<ResolutionStrategy> resolutionStrategies() {
       final boolean noName = urn.getName().isEmpty();
       final boolean noResolverConfig = resolverConfig == null;
-      final boolean noGitHubResolver =
-            noResolverConfig || resolverConfig.gitHubResolutionOptions == null || resolverConfig.gitHubResolutionOptions.gitHubName == null;
+      final boolean noGitHubResolver = noResolverConfig || resolverConfig.gitHubResolverOptions == null
+            || resolverConfig.gitHubResolverOptions.isEmpty();
       final boolean noLocalModelRoots = noResolverConfig || resolverConfig.modelsRoots == null || resolverConfig.modelsRoots.isEmpty();
-      if ( !noName && noGitHubResolver && noLocalModelRoots ) {
-         throw new CommandException( "When resolving a URN, at least one models root directory or GitHub repository must be set" );
+      final boolean noCustomResolver = noResolverConfig || resolverConfig.commandLine == null || resolverConfig.commandLine.isEmpty();
+      if ( !noName && noGitHubResolver && noLocalModelRoots && noCustomResolver ) {
+         throw new CommandException(
+               "When resolving a URN, at least one models root directory, GitHub repository or custom resolver must be set" );
       }
       return configuredStrategies();
    }