- F add ConsoleOutput.verifyAll

Co-Authored-By: Llewellyn Falco <[email protected]>
Co-Authored-By: 4dsherwood <[email protected]>

Author: 3 people

approvaltests-tests/src/test/java/org/approvaltests/utils/ConsoleOutputTests.java

@@ -0,0 +1,62 @@
+package org.approvaltests.utils;
+
+import org.approvaltests.core.Options;
+import org.approvaltests.reporters.AutoApproveReporter;
+import org.approvaltests.reporters.UseReporter;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+public class ConsoleOutputTests
+{
+  @Test
+  @UseReporter(AutoApproveReporter.class)
+  void testVerifyOutput()
+  {
+    var expected = """
+        Hello, World!
+        No newline
+        """;
+    try (ConsoleOutput console = new ConsoleOutput())
+    {
+      System.out.println("Hello, World!");
+      System.out.print("No ");
+      System.out.print("newline");
+      console.verifyOutput(new Options().inline(expected));
+    }
+  }
+  @Test
+  @UseReporter(AutoApproveReporter.class)
+  void testVerifyError()
+  {
+    var expected = """
+        Error message
+        No newline
+        """;
+    try (ConsoleOutput console = new ConsoleOutput())
+    {
+      System.err.println("Error message");
+      System.err.print("No ");
+      System.err.print("newline");
+      console.verifyError(new Options().inline(expected));
+    }
+  }
+  @Test
+  @UseReporter(AutoApproveReporter.class)
+  void testVerifyAll()
+  {
+    var expected = """
+        Output:
+        Standard output
+
+        Error:
+        Error output
+        """;
+    try (ConsoleOutput console = new ConsoleOutput())
+    {
+      System.out.println("Standard output");
+      System.err.println("Error output");
+      console.verifyAll(new Options().inline(expected));
+    }
+  }
+}

approvaltests/src/main/java/org/approvaltests/utils/ConsoleOutput.java

@@ -83,6 +83,24 @@ public void verifyError(Options options)
   {
     Approvals.verify(getError(), options);
   }
+  /**
+   * Verifies both captured standard output and error using ApprovalTests.
+   * This is a convenience method that calls Approvals.verify() on both the output and error combined.
+   */
+  public void verifyAll()
+  {
+    verifyAll(new Options());
+  }
+  /**
+   * Verifies both captured standard output and error using ApprovalTests with options.
+   * This is a convenience method that calls Approvals.verify() on both the output and error combined.
+   * @param options The options to use for verification
+   */
+  public void verifyAll(Options options)
+  {
+    String combined = "Output:\n" + getOutput() + "\nError:\n" + getError();
+    Approvals.verify(combined, options);
+  }
   /**
    * Restores the original System.out and System.err streams.
    * This method is automatically called when used in a try-with-resources block.

internal_documentation/micro_features/console_output.md

@@ -18,6 +18,9 @@ Allows users to capture and verify console output (both System.out and System.er
 3. **getError()**: Returns captured standard error as a string
 4. **verifyOutput()**: Convenience method that calls Approvals.verify() on captured output
 5. **verifyError()**: Convenience method that calls Approvals.verify() on captured error
+5. **verifyAll()**: Convenience method that calls Approvals.verify() on both the output and error
+
+
 6. **close()**: Restores original System.out and System.err streams
 
 ## Usage Example
@@ -30,4 +33,9 @@ try (ConsoleOutput console = new ConsoleOutput()) {
 
 ## Integration
 - Works seamlessly with ApprovalTests
-- Automatically handles stream restoration even if exceptions occur
+- Automatically handles stream restoration even if exceptions occur
+
+## Tests
+1. Test verifyOutput
+2. Test verifyError
+3. Test verifyAll