[번역] Unit Testing of System.out.println() with JUnit

💡 원본 글 : https://www.baeldung.com/java-testing-system-out-println

1. 소개

단위 테스트를 할 때 때때로 System.out.println()을 통해 표준 출력된 메시지를 테스트하고 싶을 수 있습니다.

일반적으로 표준 출력보다 로깅 프레임워크를 선호하지만 때때로 이를 사용할 수 없을 수도 있습니다.

이 빠른 튜토리얼에서는 JUnit을 사용하여 System.out.println()을 단위 테스트할 수 있는 몇 가지 방법을 살펴보겠습니다.

2. 간단한 print 메서드

이 튜토리얼을 진행하는 동안 작성하게 될 테스트는 주로 표준 출력 스트림에 결과를 출력하는 간단한 메서드를 대상으로 삼을 것입니다:

private void print(String output) {
    System.out.println(output);
}

System.out 변수는 표준 출력 스트림을 나타내는 public static final PrintStream 객체로 시스템 전반에서 사용된다는 점을 빠르게 상기시켜 드립니다.

추가적인 내용

표준 출력 스트림(standard output stream)이란 일반적으로 콘솔 화면에 데이터를 출력하는 데 사용되는 스트림으로 자바에서 System.out 변수가 표준 출력 스트림을 나타냅니다.

3. 핵심적인 Java 동작

이제부터 println 메서드로 보내는 내용을 확인하기 위해 단위 테스트를 작성하는 방법을 살펴보겠습니다. 그러나, 실제 단위 테스트를 작성하기 전에 테스트에서 일부 초기화 코드를 제공해주어야 합니다.

private final PrintStream standardOut = System.out;
private final ByteArrayOutputStream outputStreamCaptor = new ByteArrayOutputStream();

@BeforeEach
public void setUp() {
    System.setOut(new PrintStream(outputStreamCaptor));
}

setUp 메서드에서는 ByteArrayOutputStream을 사용하여 표준 출력 스트림을 새로운 PrintStream에 재할당합니다. 우리가 보게 될 출력 스트림은 이제부터 여기에 출력될 것입니다.

@Test
void givenSystemOutRedirection_whenInvokePrintln_thenOutputCaptorSuccess() {
    print("Hello Baeldung Readers!!");

    Assert.assertEquals("Hello Baeldung Readers!!", outputStreamCaptor.toString()
      .trim());
}

우리가 작성한 텍스트를 print 메서드로 호출한 후, 우리가 기대한 콘텐츠가 outputStreamCaptor에 포함되어 있는지 확인해볼 수 있습니다. System.out.println()이 추가한 새 줄을 제거하기 위해 trim()를 호출합니다.

표준 출력 스트림은 다른 부분에서 사용되는 공유 정적 리소스이므로 테스트가 종료되면 원래 상태로 복원해야 합니다.

@AfterEach
public void tearDown() {
    System.setOut(standardOut);
}

이렇게 하면 나중에 다른 테스트에서 원치 않는 부작용이 발생하지 않습니다.

System.setOut이란?

해당 메서드는 표준 출력 스트림을 제정의 하는데 사용됩니다.

public static void setOut(PrintStream out)

다른 부분에서 사용되는 공유 정적 리소스로써 테스트가 종료되면 원래 상태로 복원해야 합니다.

해당 메서드를 사용해 재정의를 하면 System.out로 출력한 데이터가 변경될수 있습니다.

4. 시스템 규칙 사용

System 클래스를 사용하는 코드를 테스트 하기 위한 Junit 규칙을 제공해주는 System Rules라는 외부 라이브러리를 살펴보겠습니다.

pom.xml에 아래와 같이 의존성을 추가해주면 됩니다.

<dependency>
    <groupId>com.github.stefanbirkner</groupId>
    <artifactId>system-rules</artifactId>
    <version>1.19.0</version>
    <scope>test</scope>
</dependency>

gradle에서는 아래와 같이 추가하면 됩니다.

 

implementation("com.github.stefanbirkner:system-rules:1.19.0")

이제 라이브러리가 제공하는 SystemOutRule 을 사용하여 테스트를 작성할 수 있습니다.

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

@Test
public void givenSystemOutRule_whenInvokePrintln_thenLogSuccess() {
    print("Hello Baeldung Readers!!");

    Assert.assertEquals("Hello Baeldung Readers!!", systemOutRule.getLog()
      .trim());
}

정말 멋집니다! SystemOutRule 을 사용하면 System.out 에 대한 쓰기를 차단할 수 있습니다.

먼저 규칙에서 enableLog() 를 호출하여 System.out에 기록된 모든 내용을 기록하기 시작합니다.

그런 다음 enableLog()를 호출했기 떄문에 간단히 getLog()를 호출하여 System.out에 기록된 텍스트를 가져옵니다.

이 규칙에는 항상 줄 구분 기호가 \\\\n 인 로그를 반환하는 메서드도 포함되어 있습니다.

Assert.assertEquals("Hello Baeldung Readers!!\\n", systemOutRule.getLogWithNormalizedLineSeparator());

5. Junit5 및 Lambda와 함께 시스템 규칙 사용

Junit5에서는 규칙 모델이 extensions로 변경되었습니다. 다행히, 4번 세션에서 제시된 시스템 규칙 라이브러리에서는 Junit5와 함께 동작하도록 준비된 다른 라이브러리가 있습니다.

System Lambda는 Maven Central에서 사용할 수 있습니다. 따라서 이를 pom.xml에 추가할 수 있습니다:

<dependency>
    <groupId>com.github.stefanbirkner</groupId>
    <artifactId>system-lambda</artifactId>
    <version>1.2.1</version>
</dependency>

gradle에서는 아래와 같이 추가하면 됩니다.

implementation("com.github.stefanbirkner:system-lambda:1.2.1")

 

이제 이 라이브러리를 사용하여 테스트를 구현해보겠습니다:

@Test
void givenTapSystemOut_whenInvokePrintln_thenOutputIsReturnedSuccessfully() throws Exception {

    String text = tapSystemOut(() -> {
        print("Hello Baeldung Readers!!");
    });

    Assert.assertEquals("Hello Baeldung Readers!!", text.trim());
}

이 버전에서는 명령문을 실행하고 System.out에 전달된 콘텐츠를 캡처할 수 있는 tapSystemOut 메서드를 사용합니다.

6. 결론

이 튜토리얼에서는 System.out.println를 테스트하기 위한 몇 가지 접근 방식에 대해 배웠습니다. 첫 번째 접근 방식에서는 기본적인 Java를 사용하여 표준 출력 스트림을 작성하는 위치를 리디렉션하는 방법을 살펴보았습니다.

그런 다음에 Junit4 스타일 규칙을 사용하고 나중에 람다로 작업하는 외부 라이브러리 사용 방법을 배웠습니다.

 

언제나 그렇듯이 기사의 전체 소스 코드는 Github에서 확인할 수 있습니다.