JUnit System.out.println() 测试

Question

我需要为旧应用程序编写 JUnit 测试，该应用程序设计不当并且正在向标准 output 写入大量错误消息。当getResponse(String request)方法运行正确时，它会返回 XML 响应：

@BeforeClass
public static void setUpClass() throws Exception {
    Properties queries = loadPropertiesFile("requests.properties");
    Properties responses = loadPropertiesFile("responses.properties");
    instance = new ResponseGenerator(queries, responses);
}

@Test
public void testGetResponse() {
    String request = "<some>request</some>";
    String expResult = "<some>response</some>";
    String result = instance.getResponse(request);
    assertEquals(expResult, result);
}

但是当它出现格式错误的 XML 或不理解请求时，它会返回null并将一些内容写入标准 output。

有没有办法在 JUnit 中断言控制台 output？ 捕捉这样的情况：

System.out.println("match found: " + strExpr);
System.out.println("xml not well formed: " + e.getMessage());

Answer 1

使用ByteArrayOutputStream和 System.setXXX 很简单：

private final ByteArrayOutputStream outContent = new ByteArrayOutputStream();
private final ByteArrayOutputStream errContent = new ByteArrayOutputStream();
private final PrintStream originalOut = System.out;
private final PrintStream originalErr = System.err;

@Before
public void setUpStreams() {
    System.setOut(new PrintStream(outContent));
    System.setErr(new PrintStream(errContent));
}

@After
public void restoreStreams() {
    System.setOut(originalOut);
    System.setErr(originalErr);
}

示例测试用例：

@Test
public void out() {
    System.out.print("hello");
    assertEquals("hello", outContent.toString());
}

@Test
public void err() {
    System.err.print("hello again");
    assertEquals("hello again", errContent.toString());
}

我使用此代码来测试命令行选项（断言 -version 输出版本字符串等）

编辑：此答案的先前版本在测试后称为System.setOut(null) ； 这是 NullPointerExceptions 评论者引用的原因。

Answer 2

我知道这是一个旧线程，但是有一个很好的库可以做到这一点：系统规则
文档中的示例：

public void MyTest {
    @Rule
    public final SystemOutRule systemOutRule = new SystemOutRule().enableLog();

    @Test
    public void overrideProperty() {
        System.out.print("hello world");
        assertEquals("hello world", systemOutRule.getLog());
    }
}

它还允许您捕获System.exit(-1)和其他命令行工具需要测试的内容。

Answer 3

我不会重定向System.out ，而是通过将PrintStream作为合作者传递，然后在生产中使用System.out并在测试中使用Test Spy来重构使用System.out.println()的类。 即使用依赖注入来消除直接使用标准输出流。

生产中

ConsoleWriter writer = new ConsoleWriter(System.out));

在测试中

ByteArrayOutputStream outSpy = new ByteArrayOutputStream();
ConsoleWriter writer = new ConsoleWriter(new PrintStream(outSpy));
writer.printSomething();
assertThat(outSpy.toString(), is("expected output"));

讨论

这样，被测类就可以通过简单的重构进行测试，而无需对标准输出进行间接重定向或使用系统规则进行模糊拦截。

Answer 4

您可以通过setOut() （以及in和err ）设置 System.out 打印流。 你能把它重定向到一个记录到字符串的打印流，然后检查它吗？ 这似乎是最简单的机制。

（我会提倡在某个阶段将应用程序转换为某种日志记录框架 - 但我怀疑您已经意识到这一点！）

Answer 5

有点偏离主题，但如果有些人（比如我，当我第一次发现这个线程时）可能对通过 SLF4J 捕获日志输出感兴趣， commons-testing的 JUnit @Rule可能会有所帮助：

public class FooTest {
    @Rule
    public final ExpectedLogs logs = new ExpectedLogs() {{
        captureFor(Foo.class, LogLevel.WARN);
    }};

    @Test
    public void barShouldLogWarning() {
        assertThat(logs.isEmpty(), is(true)); // Nothing captured yet.

        // Logic using the class you are capturing logs for:
        Foo foo = new Foo();
        assertThat(foo.bar(), is(not(nullValue())));

        // Assert content of the captured logs:
        assertThat(logs.isEmpty(), is(false));
        assertThat(logs.contains("Your warning message here"), is(true));
    }
}

免责声明：

• 我开发了这个库，因为我找不到任何适合我自己需要的解决方案。
• 目前只有log4j 、 log4j2和logback绑定可用，但我很高兴添加更多。

Answer 6

@dfa 的回答很棒，所以我更进一步，使测试输出块成为可能。

首先，我使用一个方法captureOutput创建了TestHelper ，该方法接受令人讨厌的类CaptureTest 。 captureOutput 方法完成设置和拆除输出流的工作。 当调用CaptureOutput的test方法的实现时，它可以访问测试块的输出生成。

TestHelper 的来源：

public class TestHelper {

    public static void captureOutput( CaptureTest test ) throws Exception {
        ByteArrayOutputStream outContent = new ByteArrayOutputStream();
        ByteArrayOutputStream errContent = new ByteArrayOutputStream();

        System.setOut(new PrintStream(outContent));
        System.setErr(new PrintStream(errContent));

        test.test( outContent, errContent );

        System.setOut(new PrintStream(new FileOutputStream(FileDescriptor.out)));
        System.setErr(new PrintStream(new FileOutputStream(FileDescriptor.out)));

    }
}

abstract class CaptureTest {
    public abstract void test( ByteArrayOutputStream outContent, ByteArrayOutputStream errContent ) throws Exception;
}

请注意，TestHelper 和 CaptureTest 定义在同一文件中。

然后在您的测试中，您可以导入静态 captureOutput。 下面是一个使用 JUnit 的例子：

// imports for junit
import static package.to.TestHelper.*;

public class SimpleTest {

    @Test
    public void testOutput() throws Exception {

        captureOutput( new CaptureTest() {
            @Override
            public void test(ByteArrayOutputStream outContent, ByteArrayOutputStream errContent) throws Exception {

                // code that writes to System.out

                assertEquals( "the expected output\n", outContent.toString() );
            }
        });
}

Answer 7

如果您使用的是 Spring Boot（您提到您正在使用旧应用程序，所以您可能不是，但它可能对其他人有用），那么您可以使用org.springframework.boot.test.rule.OutputCapture以下列方式：

@Rule
public OutputCapture outputCapture = new OutputCapture();

@Test
public void out() {
    System.out.print("hello");
    assertEquals(outputCapture.toString(), "hello");
}

Answer 8

基于@dfa 的答案和另一个显示如何测试 System.in的答案，我想分享我的解决方案，为程序提供输入并测试其输出。

作为参考，我使用 JUnit 4.12。

假设我们有一个简单地将输入复制到输出的程序：

import java.util.Scanner;

public class SimpleProgram {
    public static void main(String[] args) {
        Scanner scanner = new Scanner(System.in);
        System.out.print(scanner.next());
        scanner.close();
    }
}

为了测试它，我们可以使用以下类：

import static org.junit.Assert.*;

import java.io.*;

import org.junit.*;

public class SimpleProgramTest {
    private final InputStream systemIn = System.in;
    private final PrintStream systemOut = System.out;

    private ByteArrayInputStream testIn;
    private ByteArrayOutputStream testOut;

    @Before
    public void setUpOutput() {
        testOut = new ByteArrayOutputStream();
        System.setOut(new PrintStream(testOut));
    }

    private void provideInput(String data) {
        testIn = new ByteArrayInputStream(data.getBytes());
        System.setIn(testIn);
    }

    private String getOutput() {
        return testOut.toString();
    }

    @After
    public void restoreSystemInputOutput() {
        System.setIn(systemIn);
        System.setOut(systemOut);
    }

    @Test
    public void testCase1() {
        final String testString = "Hello!";
        provideInput(testString);

        SimpleProgram.main(new String[0]);

        assertEquals(testString, getOutput());
    }
}

我不会解释太多，因为我相信代码是可读的并且我引用了我的来源。

当 JUnit 运行testCase1() ，它将按照它们出现的顺序调用辅助方法：

1. setUpOutput() ，因为@Before注释
2. provideInput(String data) ，从testCase1()调用
3. getOutput() ，从testCase1()调用
4. restoreSystemInputOutput() ，因为@After注释

我没有测试System.err因为我不需要它，但它应该很容易实现，类似于测试System.out 。

Answer 9

测试System.out完整 JUnit 5 示例（替换 when 部分）：

package learning;

import static org.assertj.core.api.BDDAssertions.then;

import java.io.ByteArrayOutputStream;
import java.io.PrintStream;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

class SystemOutLT {

    private PrintStream originalSystemOut;
    private ByteArrayOutputStream systemOutContent;

    @BeforeEach
    void redirectSystemOutStream() {

        originalSystemOut = System.out;

        // given
        systemOutContent = new ByteArrayOutputStream();
        System.setOut(new PrintStream(systemOutContent));
    }

    @AfterEach
    void restoreSystemOutStream() {
        System.setOut(originalSystemOut);
    }

    @Test
    void shouldPrintToSystemOut() {

        // when
        System.out.println("example");

        then(systemOutContent.toString()).containsIgnoringCase("example");
    }
}

Answer 10

您不想重定向 system.out 流，因为它会重定向整个 JVM。 在 JVM 上运行的任何其他东西都可能被搞砸。 有更好的方法来测试输入/输出。 查看存根/模拟。

Answer 11

在使用JUnit 时，您不能通过使用system.out.println或使用logger api直接打印。 但是，如果您想检查任何值，那么您只需使用

Assert.assertEquals("value", str);

它将抛出以下断言错误：

java.lang.AssertionError: expected [21.92] but found [value]

您的值应该是 21.92，现在如果您将使用此值进行测试，如下所示，您的测试用例将通过。

 Assert.assertEquals(21.92, str);

Answer 12

为了出去

@Test
void it_prints_out() {

    PrintStream save_out=System.out;final ByteArrayOutputStream out = new ByteArrayOutputStream();System.setOut(new PrintStream(out));

    System.out.println("Hello World!");
    assertEquals("Hello World!\r\n", out.toString());

    System.setOut(save_out);
}

对于错误

@Test
void it_prints_err() {

    PrintStream save_err=System.err;final ByteArrayOutputStream err= new ByteArrayOutputStream();System.setErr(new PrintStream(err));

    System.err.println("Hello World!");
    assertEquals("Hello World!\r\n", err.toString());

    System.setErr(save_err);
}

Answer 13

如果该函数正在打印到 System.out，您可以通过使用 System.setOut 方法将 System.out 更改为转到您提供的 PrintStream 来捕获该输出。 如果创建连接到 ByteArrayOutputStream 的 PrintStream，则可以将输出捕获为字符串。

// Create a stream to hold the output
ByteArrayOutputStream baos = new ByteArrayOutputStream();
PrintStream ps = new PrintStream(baos);
// IMPORTANT: Save the old System.out!
PrintStream old = System.out;
// Tell Java to use your special stream
System.setOut(ps);
// Print some output: goes to your special stream
System.out.println("Foofoofoo!");
// Put things back
System.out.flush();
System.setOut(old);
// Show what happened
System.out.println("Here: " + baos.toString());

Answer 14

虽然这个问题已经很老了，并且已经有了很好的答案，但我想提供一个替代方案。 我喜欢dfa的答案，但是我希望在不复制配置的情况下在不同的项目中具有可重用的东西，因此我从中创建了一个库并希望回馈社区。 它被称为Console Captor ，您可以使用以下代码段添加它：

<dependency>
    <groupId>io.github.hakky54</groupId>
    <artifactId>consolecaptor</artifactId>
    <version>1.0.0</version>
    <scope>test</scope>
</dependency>

示例类

public class FooService {

    public void sayHello() {
        System.out.println("Keyboard not responding. Press any key to continue...");
        System.err.println("Congratulations, you are pregnant!");
    }

}

单元测试

import static org.assertj.core.api.Assertions.assertThat;

import nl.altindag.console.ConsoleCaptor;
import org.junit.jupiter.api.Test;

public class FooServiceTest {

    @Test
    public void captureStandardAndErrorOutput() {
        ConsoleCaptor consoleCaptor = new ConsoleCaptor();

        FooService fooService = new FooService();
        fooService.sayHello();

        assertThat(consoleCaptor.getStandardOutput()).contains("Keyboard not responding. Press any key to continue...");
        assertThat(consoleCaptor.getErrorOutput()).contains("Congratulations, you are pregnant!");
        
        consoleCaptor.close();
    }
}