ทดสอบ JUnit สำหรับ System.out.println ()

ฉันต้องเขียนการทดสอบ JUnit สำหรับแอปพลิเคชันเก่าที่ออกแบบมาไม่ดีและกำลังเขียนข้อความแสดงข้อผิดพลาดจำนวนมากไปยังเอาต์พุตมาตรฐาน เมื่อ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และเขียนบางสิ่งลงในเอาต์พุตมาตรฐาน

มีวิธีการยืนยันเอาต์พุตคอนโซลใน JUnit หรือไม่? หากต้องการดูกรณีเช่น:

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

การใช้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());
}

ฉันใช้รหัสนี้เพื่อทดสอบตัวเลือกบรรทัดคำสั่ง (ยืนยันว่า - รุ่นส่งออกสตริงรุ่น ฯลฯ ฯลฯ )

แก้ไข: รุ่นก่อนหน้าของคำตอบนี้เรียกว่าSystem.setOut(null)หลังจากการทดสอบ; นี่คือสาเหตุของการแสดงความคิดเห็น NullPointerExceptions อ้างถึง

ฉันรู้ว่านี่เป็นหัวข้อเก่า แต่มีห้องสมุดที่ดีในการทำเช่นนี้:

กฎของระบบ

ตัวอย่างจากเอกสาร:

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)และสิ่งอื่น ๆ ที่เครื่องมือบรรทัดคำสั่งจะต้องมีการทดสอบ

แทนที่จะเปลี่ยนเส้นทางSystem.outฉันจะ refactor คลาสที่ใช้System.out.println()โดยผ่านการPrintStreamเป็นผู้ทำงานร่วมกันจากนั้นใช้System.outในการผลิตและTest Spyในการทดสอบ นั่นคือใช้ Dependency Injection เพื่อกำจัดการใช้สตรีมเอาต์พุตมาตรฐานโดยตรง

ในการผลิต

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"));

อภิปรายผล

วิธีนี้คลาสที่อยู่ภายใต้การทดสอบจะสามารถทดสอบได้โดยการปรับโครงสร้างอย่างง่ายโดยไม่จำเป็นต้องเปลี่ยนเส้นทางทางอ้อมของเอาต์พุตมาตรฐานหรือการสกัดกั้นแบบคลุมเครือด้วยกฎของระบบ

คุณสามารถตั้งค่าสตรีมการพิมพ์ System.out ผ่านsetOut () (และสำหรับinและerr) คุณสามารถเปลี่ยนเส้นทางสิ่งนี้ไปยังกระแสการพิมพ์ที่บันทึกไปยังสตริงแล้วตรวจสอบได้หรือไม่ นั่นจะเป็นกลไกที่ง่ายที่สุด

(ฉันจะสนับสนุนในบางขั้นตอนให้เปลี่ยนแอปเป็นกรอบการบันทึกบางอย่าง - แต่ฉันสงสัยว่าคุณรู้เรื่องนี้อยู่แล้ว!)

ปิดหัวข้อเล็กน้อย แต่ในกรณีที่บางคน (เช่นฉันเมื่อฉันพบเธรดนี้ครั้งแรก) อาจสนใจบันทึกเอาต์พุตผ่าน SLF4J, 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ที่มีอยู่ในขณะนี้ แต่ผมมีความสุขที่จะเพิ่มมากขึ้น

@dfa คำตอบดีมากดังนั้นฉันจึงก้าวไปอีกขั้นเพื่อให้สามารถทดสอบกลุ่มของ ouput ได้

ครั้งแรกที่ฉันสร้างขึ้นTestHelperด้วยวิธีการที่ยอมรับระดับcaptureOutput annoymous 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 ถูกกำหนดไว้ในไฟล์เดียวกัน

จากนั้นในการทดสอบของคุณคุณสามารถนำเข้าจับภาพคงที่ออก นี่คือตัวอย่างการใช้ 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() );
            }
        });
}

หากคุณใช้ 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");
}

จากคำตอบของ @ 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แต่มันควรจะเป็นเรื่องง่ายที่จะดำเนินการคล้ายกับการทดสอบ

คุณไม่ต้องการเปลี่ยนเส้นทางสตรีม system.out เนื่องจากการเปลี่ยนเส้นทางสำหรับ ENTIRE JVM อะไรก็ตามที่ทำงานบน JVM สามารถทำให้เกิดความสับสนได้ มีวิธีที่ดีกว่าในการทดสอบอินพุต / เอาต์พุต มองเข้าไปในต้นขั้ว / mocks

ตัวอย่าง JUnit 5 แบบเต็มเพื่อทดสอบSystem.out(แทนที่ส่วน 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");
    }
}

คุณไม่สามารถพิมพ์โดยตรงโดยใช้System.out.printlnหรือใช้API ตัดไม้ในขณะที่ใช้JUnit แต่ถ้าคุณต้องการตรวจสอบค่าใด ๆ คุณก็สามารถใช้งานได้

Assert.assertEquals("value", str);

มันจะโยนด้านล่างข้อผิดพลาดการยืนยัน:

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

ค่าของคุณควรเป็น 21.92 ตอนนี้ถ้าคุณจะทดสอบโดยใช้ค่านี้เช่นด้านล่างกรณีทดสอบของคุณจะผ่าน

 Assert.assertEquals(21.92, str);

สำหรับออก

@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);
}