#734: Improve Process Result Model

CHANGELOG.adoc

@@ -10,6 +10,7 @@ Then run the `setup` and all should work fine.
 
 Release with new features and bugfixes:
 
+* https://github.com/devonfw/IDEasy/issues/734[#734]: Improve ProcessResult: get out and err in order
 * https://github.com/devonfw/IDEasy/issues/774[#774]: HTTP proxy support not working properly
 * https://github.com/devonfw/IDEasy/issues/792[#792]: Honor new variable IDE_OPTIONS in ide command wrapper
 * https://github.com/devonfw/IDEasy/issues/589[#589]: Fix NLS Bundles for Linux and MacOS

cli/src/main/java/com/devonfw/tools/ide/process/OutputMessage.java

@@ -0,0 +1,11 @@
+package com.devonfw.tools.ide.process;
+
+/**
+ * Represent an output message that can be either from stdout or stderr.
+ *
+ * @param error A boolean flag that indicates whether the output message is from stdout or stderr
+ * @param message A string containing the outout message
+ */
+public record OutputMessage(boolean error, String message) {
+
+}

cli/src/main/java/com/devonfw/tools/ide/process/ProcessContextImpl.java

@@ -168,17 +168,16 @@ public ProcessResult run(ProcessMode processMode) {
 
       this.processBuilder.command(args);
 
-      List<String> out = null;
-      List<String> err = null;
+      List<OutputMessage> output = new ArrayList<>();
 
       Process process = this.processBuilder.start();
 
       try {
         if (processMode == ProcessMode.DEFAULT_CAPTURE) {
-          CompletableFuture<List<String>> outFut = readInputStream(process.getInputStream());
-          CompletableFuture<List<String>> errFut = readInputStream(process.getErrorStream());
-          out = outFut.get();
-          err = errFut.get();
+          CompletableFuture<List<String>> outFut = readInputStream(process.getInputStream(), false, output);
+          CompletableFuture<List<String>> errFut = readInputStream(process.getErrorStream(), true, output);
+          outFut.get();
+          errFut.get();
         }
 
         int exitCode;
@@ -189,7 +188,7 @@ public ProcessResult run(ProcessMode processMode) {
           exitCode = process.waitFor();
         }
 
-        ProcessResult result = new ProcessResultImpl(this.executable.getFileName().toString(), command, exitCode, out, err);
+        ProcessResult result = new ProcessResultImpl(this.executable.getFileName().toString(), command, exitCode, output);
 
         performLogging(result, exitCode, interpreter);
 
@@ -220,11 +219,19 @@ public ProcessResult run(ProcessMode processMode) {
    * @param is {@link InputStream}.
    * @return {@link CompletableFuture}.
    */
-  private static CompletableFuture<List<String>> readInputStream(InputStream is) {
+  private static CompletableFuture<List<String>> readInputStream(InputStream is, boolean errorStream, List<OutputMessage> outputMessages) {
 
     return CompletableFuture.supplyAsync(() -> {
 
       try (InputStreamReader isr = new InputStreamReader(is); BufferedReader br = new BufferedReader(isr)) {
+
+        String line;
+        while ((line = br.readLine()) != null) {
+          synchronized (outputMessages) {
+            OutputMessage outputMessage = new OutputMessage(errorStream, line);
+            outputMessages.add(outputMessage);
+          }
+        }
         return br.lines().toList();
       } catch (Throwable e) {
         throw new RuntimeException("There was a problem while executing the program", e);

cli/src/main/java/com/devonfw/tools/ide/process/ProcessResult.java

@@ -76,6 +76,12 @@ default boolean isSuccessful() {
    */
   List<String> getErr();
 
+  /**
+   * @return the {@link List} with {@link OutputMessage} that captured on standard out and standard error lines. Will be {@code null} if not captured but
+   *     redirected.
+   */
+  List<OutputMessage> getOutputMessages();
+
   /**
    * Logs output and error messages on the provided log level.
    *

cli/src/main/java/com/devonfw/tools/ide/process/ProcessResultImpl.java

@@ -3,6 +3,7 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Objects;
+import java.util.stream.Collectors;
 
 import com.devonfw.tools.ide.cli.CliProcessException;
 import com.devonfw.tools.ide.context.IdeContext;
@@ -23,23 +24,25 @@ public class ProcessResultImpl implements ProcessResult {
 
   private final List<String> err;
 
+  private final List<OutputMessage> outputMessages;
+
   /**
    * The constructor.
    *
    * @param executable the {@link #getExecutable() executable}.
    * @param command the {@link #getCommand() command}.
    * @param exitCode the {@link #getExitCode() exit code}.
-   * @param out the {@link #getOut() out}.
-   * @param err the {@link #getErr() err}.
+   * @param outputMessages {@link #getOutputMessages() output Messages}.
    */
-  public ProcessResultImpl(String executable, String command, int exitCode, List<String> out, List<String> err) {
+  public ProcessResultImpl(String executable, String command, int exitCode, List<OutputMessage> outputMessages) {
 
     super();
     this.executable = executable;
     this.command = command;
     this.exitCode = exitCode;
-    this.out = Objects.requireNonNullElse(out, Collections.emptyList());
-    this.err = Objects.requireNonNullElse(err, Collections.emptyList());
+    this.outputMessages = Objects.requireNonNullElse(outputMessages, Collections.emptyList());
+    this.out = this.outputMessages.stream().filter(outputMessage -> !outputMessage.error()).map(OutputMessage::message).collect(Collectors.toList());
+    this.err = this.outputMessages.stream().filter(OutputMessage::error).map(OutputMessage::message).collect(Collectors.toList());
   }
 
   @Override
@@ -72,6 +75,13 @@ public List<String> getErr() {
     return this.err;
   }
 
+  @Override
+  public List<OutputMessage> getOutputMessages() {
+
+    return outputMessages;
+
+  }
+
   @Override
   public void log(IdeLogLevel level, IdeContext context) {
     log(level, context, level);
@@ -80,11 +90,8 @@ public void log(IdeLogLevel level, IdeContext context) {
   @Override
   public void log(IdeLogLevel outLevel, IdeContext context, IdeLogLevel errorLevel) {
 
-    if (!this.out.isEmpty()) {
-      doLog(outLevel, this.out, context);
-    }
-    if (!this.err.isEmpty()) {
-      doLog(errorLevel, this.err, context);
+    if (!this.outputMessages.isEmpty()) {
+      doLog(outLevel, getOutputMessages().stream().map(OutputMessage::message).collect(Collectors.toList()), context);
     }
   }
 

cli/src/test/java/com/devonfw/tools/ide/context/ProcessContextGitMock.java

@@ -7,7 +7,9 @@
 import java.time.LocalDateTime;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.stream.Collectors;
 
+import com.devonfw.tools.ide.process.OutputMessage;
 import com.devonfw.tools.ide.process.ProcessContext;
 import com.devonfw.tools.ide.process.ProcessErrorHandling;
 import com.devonfw.tools.ide.process.ProcessMode;
@@ -21,9 +23,7 @@ public class ProcessContextGitMock implements ProcessContext {
 
   private final List<String> arguments;
 
-  private final List<String> errors;
-
-  private final List<String> outs;
+  private final List<OutputMessage> outputMessages;
 
   private final LocalDateTime now;
 
@@ -37,8 +37,7 @@ public class ProcessContextGitMock implements ProcessContext {
   public ProcessContextGitMock(Path directory) {
 
     this.arguments = new ArrayList<>();
-    this.errors = new ArrayList<>();
-    this.outs = new ArrayList<>();
+    this.outputMessages = new ArrayList<>();
     this.exitCode = ProcessResult.SUCCESS;
     this.directory = directory;
     this.now = LocalDateTime.now();
@@ -61,19 +60,30 @@ public void setExitCode(int exitCode) {
   }
 
   /**
-   * @return the {@link List} of mocked error messages.
+   * @return the {@link List} of mocked stderr messages.
    */
   public List<String> getErrors() {
 
-    return errors;
+    return this.outputMessages.stream().filter(OutputMessage::error).map(OutputMessage::message).collect(Collectors.toList());
+
   }
 
   /**
-   * @return the {@link List} of mocked out messages.
+   * @return the {@link List} of mocked stdout messages.
    */
   public List<String> getOuts() {
 
-    return outs;
+    return this.outputMessages.stream().filter(output -> !output.error()).map(OutputMessage::message).collect(Collectors.toList());
+
+  }
+
+  /**
+   * @return the {@link List} of mocked {@link OutputMessage}.
+   */
+  public List<OutputMessage> getOutputMessages() {
+
+    return this.outputMessages;
+
   }
 
   @Override
@@ -139,7 +149,8 @@ public ProcessResult run(ProcessMode processMode) {
     // part of git cleanup checks if a new directory 'new-folder' exists
     if (this.arguments.contains("ls-files")) {
       if (Files.exists(this.directory.resolve("new-folder"))) {
-        this.outs.add("new-folder");
+        OutputMessage outputMessage = new OutputMessage(false, "new-folder");
+        this.outputMessages.add(outputMessage);
         this.exitCode = 0;
       }
     }
@@ -181,7 +192,7 @@ public ProcessResult run(ProcessMode processMode) {
       }
     }
     this.arguments.clear();
-    return new ProcessResultImpl("git", command.toString(), this.exitCode, this.outs, this.errors);
+    return new ProcessResultImpl("git", command.toString(), this.exitCode, this.outputMessages);
   }
 
 }

cli/src/test/java/com/devonfw/tools/ide/git/GitContextTest.java

@@ -19,6 +19,7 @@
 import com.devonfw.tools.ide.context.ProcessContextGitMock;
 import com.devonfw.tools.ide.io.FileAccess;
 import com.devonfw.tools.ide.io.FileAccessImpl;
+import com.devonfw.tools.ide.process.OutputMessage;
 
 /**
  * Test of {@link GitContext}.
@@ -89,7 +90,8 @@ public void testRunGitPullWithoutForce(@TempDir Path tempDir) {
     // arrange
     String gitRepoUrl = "https://github.com/test";
     IdeTestContext context = newGitContext(tempDir);
-    this.processContext.getOuts().add("test-remote");
+    OutputMessage outputMessage = new OutputMessage(false, "test-remote");
+    this.processContext.getOutputMessages().add(outputMessage);
     FileAccess fileAccess = new FileAccessImpl(context);
     Path gitFolderPath = tempDir.resolve(".git");
     fileAccess.mkdirs(gitFolderPath);

cli/src/test/java/com/devonfw/tools/ide/process/ProcessContextImplTest.java

@@ -221,6 +221,18 @@ public void enablingCaptureShouldRedirectAndCaptureStreamsWithErrorsCorrectly()
     assertThat(context).log(IdeLogLevel.ERROR).hasMessageContaining("another error message to stderr");
   }
 
+  @Test
+  public void defaultCaptureShouldCaptureStreamsWithCorrectOrder() {
+    // arrange
+    IdeTestContext context = newContext(PROJECT_BASIC, null, false);
+
+    // act
+    context.newProcess().executable(TEST_RESOURCES.resolve("process-context").resolve("log-order.sh")).run();
+
+    // assert
+    assertThat(context).log(IdeLogLevel.INFO).hasEntries("out1", "err1", "out2", "err2");
+  }
+
   private IdeLogLevel convertToIdeLogLevel(ProcessErrorHandling processErrorHandling) {
 
     return switch (processErrorHandling) {

cli/src/test/java/com/devonfw/tools/ide/tool/ide/IdeToolDummyCommandletTest.java

@@ -75,7 +75,7 @@ public ProcessResult runTool(ProcessMode processMode, GenericVersionRange toolVe
 
       // skip installation but trigger postInstall to test mocked plugin installation
       postInstall(true);
-      return new ProcessResultImpl(this.tool, this.tool, 0, List.of(), List.of());
+      return new ProcessResultImpl(this.tool, this.tool, 0, List.of());
     }
 
     @Override

cli/src/test/resources/process-context/log-order.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+echo "out1"
+echo "err1" >&2
+sleep 5
+echo "out2"
+echo "err2" >&2