Test system out println java

Тест 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 = "request"; String expResult = "response"; 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());

14 ответов

Используя 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()

@Test public void out() < System.out.print("hello"); assertEquals("hello", outContent.toString()); >@Test public void err()

Я использовал этот код для проверки параметра командной строки (утверждая, что -version выводит строку версии и т. Д.)

Изменить: Предыдущие версии этого ответа после тестов назывались System.setOut(null) ; Это причина того, что комментаторы ссылаются на NullPointerExceptions.

Я предпочитаю использовать System.setOut (null), чтобы восстановить поток до того состояния, которое было при запуске виртуальной машины.

В javadocs ничего не говорится о возможности передать null в System.setOut или System.setErr. Вы уверены, что это будет работать на всех JRE?

Я столкнулся с NullPointerException в других тестах после установки нулевого потока ошибок, как было предложено выше (в java.io.writer(Object) , вызываемом внутри валидатором XML). Я бы предложил вместо этого сохранить оригинал в поле: oldStdErr = System.err и восстановить его в методе @After .

Отличное решение. Просто примечание для всех, кто его использует, вам может потребоваться обрезать () пробел / новую строку из outContent.

Если функция выполняет печать в System.out, вы можете захватить этот вывод, используя метод System.setOut, чтобы изменить System.out для перехода к предоставленному вами PrintStream. Если вы создаете PrintStream, подключенный к ByteArrayOutputStream, вы можете записать вывод как String.

// 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());

Для такого рода логики установки и разрыва я бы использовал @Rule , а не делал бы это встроенным в ваш тест. В частности, если ваше утверждение терпит неудачу, второй вызов System.setOut/Err не будет достигнут.

Хотя этот вопрос очень старый и на него уже есть очень хорошие ответы, я хочу предложить альтернативу. Мне понравился ответ dfa , однако я хотел иметь что-то многократно используемое в разных проектах без копирования конфигурации, поэтому я создал на его основе библиотеку и хотел внести свой вклад в сообщество. Он называется Console Captor, и вы можете добавить его с помощью следующего фрагмента:

 io.github.hakky54 consolecaptor 1.0.0 test

Пример класса

Модульный тест

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

Вы не можете напрямую печатать с помощью system.out.println или logger api при использовании JUnit . Но если вы хотите проверить какие-либо значения, вы просто можете использовать

Assert.assertEquals("value", str);

Это вызовет ошибку утверждения ниже:

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

Ваше значение должно быть 21,92. Теперь, если вы будете тестировать, используя это значение, как показано ниже, ваш тестовый пример пройдет.

 Assert.assertEquals(21.92, str);

Я знаю, что это старый поток, но для этого есть хорошая библиотека: Системные правила
Пример из документов:

Это также позволит вам перехватывать System.exit(-1) и другие вещи, на которые нужно будет протестировать инструмент командной строки.

Такой подход чреват проблемами, поскольку стандартный выходной поток является общим ресурсом, используемым всеми частями вашей программы. Лучше использовать внедрение зависимостей, чтобы исключить прямое использование стандартного потока вывода: stackoverflow.com/a/21216342/545127

Немного не по теме, но в случае, если некоторые люди (например, я, когда я впервые нашел эту ветку) могут быть заинтересованы в захвате вывода журнала через SLF4J, JUnit @Rule commons-testing может помочь:

public class FooTest < @Rule public final ExpectedLogs logs = new ExpectedLogs() >; @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 , но я рад добавить больше.

Большое спасибо за создание этой библиотеки! Я так давно искал что-то подобное! Это очень, очень полезно, поскольку иногда вы просто не можете упростить свой код настолько, чтобы его можно было легко протестировать, но с сообщением журнала вы можете творить чудеса!

Это выглядит многообещающе . но даже когда я просто копирую вашу программу ATMTest и запускаю ее как тест в Gradle, я получаю исключение . Я поднял проблему на вашей странице Github .

Ответ @dfa отличный, поэтому я сделал еще один шаг, чтобы можно было тестировать блоки вывода.

Сначала я создал TestHelper с помощью метода captureOutput , который принимает раздражающий класс CaptureTest . Метод captureOutput выполняет работу по настройке и удалению выходных потоков. Когда вызывается реализация метода CaptureOutput test , у нее есть доступ к генерации вывода для тестового блока.

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

Обратите внимание, что 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() ); >>); >

Если вы использовали Spring Boot (вы упомянули, что работаете со старым приложением, поэтому вы, вероятно, не используете его, но оно может быть полезно другим), вы можете использовать org.springframework.boot.test. rule.OutputCapture следующим образом:

@Rule public OutputCapture outputCapture = new OutputCapture(); @Test public void out()

Я поддержал ваш ответ, потому что я использую Spring boot, и это наставило меня на правильный путь. Спасибо! Однако outputCapture необходимо инициализировать. (public OutputCapture outputCapture = new OutputCapture ();) См. docs.spring.io/spring-boot/docs/current/reference/html/…

На основе ответа @ 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() , он будет вызывать вспомогательные методы в том порядке, в котором они появляются:

setUpOutput() из-за аннотации @Before
provideInput(String data) , вызывается из testCase1()
getOutput() , вызывается из testCase1()
restoreSystemInputOutput() из-за аннотации @After

Я не тестировал System.err , потому что он мне не нужен, но это должно быть легко реализовать, подобно тестированию System.out .

Полный пример 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, потому что он перенаправляет ВСЮ JVM. Все остальное, что работает на JVM, может испортиться. Есть способы лучше проверить ввод / вывод. Загляните в заглушки / моки.

Вы можете установить поток печати System.out через setOut () (и для in и err ). Можете ли вы перенаправить это в поток печати, который записывает строку, а затем проверить это? Казалось бы, это простейший механизм.

(Я бы посоветовал на каком-то этапе преобразовать приложение в какую-нибудь структуру ведения журнала, но я подозреваю, что вы уже знаете об этом!)

Это было то, что пришло мне в голову, но я не мог поверить, что нет стандартного способа JUnit для этого. Спасибо, Мозг. Но за реальную работу DFA получила должное.

Да. Я бы поддержал это и, возможно, даже поставил бы под сомнение утверждение регистрации (лучше утверждать вызов на компонент регистрации или аналогичный)

Вместо перенаправления System.out я бы реорганизовал класс, который использует System.out.println() , передав PrintStream в качестве соавтора, а затем используя System.out в производственной среде и Test Spy в тесте. То есть используйте внедрение зависимостей, чтобы исключить прямое использование стандартного потока вывода.

В разработке

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

Таким образом, тестируемый класс становится тестируемым с помощью простого рефакторинга без необходимости косвенного перенаправления стандартного вывода или скрытого перехвата с помощью системного правила.

Источник