@Slf4j это статический лог или нет?
- User
@Slf4j это статический лог или нет?
- Assistant
Аннотация
@Slf4jиз библиотеки Lombok предоставляет статический логгер для класса, в котором она используется. При добавлении этой аннотации в класс, Lombok автоматически создает полеlog, которое является экземпляром логгера, и инициализирует его с помощьюLoggerFactory.getLogger(ClassName.class).Это поле
logявляется нестатическим, то есть оно зависит от инстанса класса, но само логирование, которое осуществляется через этот логгер, может быть использовано как в статических, так и в нестатических методах класса. Чтобы использовать логгер в статическом контексте, вам нужно будет явно создать логгер в статическом методе.Таким образом, можно сказать, что логгер, предоставляемый
@Slf4j, не является статическим, но его использование возможно в статических методах с некоторыми ограничениями. - User
при тестировании метода, со сценарием исключения, логируется стэк ошибки и отображается в консоль, как при тестировании этого избежать? @Slf4j public class KafkaConsumer { public static final String X_TARGET_SYSTEM_HEADER = "X-TARGET-SYSTEM"; public static final String CURRENT_SYSTEM = "CARD_ACC_INIT"; public static final String ALL_SYSTEMS = "ALL";
private final AccountHelpService accountHelpService; private final ClientHelpService clientHelpService; private final CardService cardService; public KafkaConsumer(AccountHelpService accountHelpService, ClientHelpService clientHelpService, CardService cardService) { this.accountHelpService = accountHelpService; this.clientHelpService = clientHelpService; this.cardService = cardService; } @KafkaListener( topics = "account", containerFactory = "clientAccountKafkaListenerContainerFactory") public void onAccountMessage(@Header(value = X_TARGET_SYSTEM_HEADER, required = false) String targetSystem, @Payload String account) { try { if (needToSyncEntity(targetSystem)) { AccountDto accountDto = new Gson().fromJson(account, AccountDto.class); log.debug("Account onMessage received: {}", account); accountHelpService.saveAccount(accountDto); } } catch (Exception e) { Sentry.addBreadcrumb("kafkaAddAccount"); Sentry.captureException(e); log.info("{}", account); log.error("Ошибка сохранения аккаунта из кафка", e); } } - Assistant
Чтобы избежать логирования стека ошибок в консоль при тестировании метода и обработке исключений, можно использовать несколько подходов. Вот некоторые из них:
1. Настройка уровня логирования во время тестов
Если вы используете фреймворк тестирования (например, JUnit) и хотите, чтобы логирование отключалось или изменялось только в тестах, вы можете настроить уровень логирования в конфигурации вашего теста. Например, с помощью
logback.xmlили аналогичной конфигурации логирования вы можете установить уровень логирования вWARNили выше во время выполнения тестов.<logger name="your.package.name" level="WARN"/>2. Использование Mock-объектов
Вы можете использовать библиотеки для мокирования, такие как Mockito, для замены логгера на его мок-версию и проверки вызовов логирования без фактического вывода при тестировании. Например:
import static org.mockito.Mockito.*; public class KafkaConsumerTest { @Mock private AccountHelpService accountHelpService; @Mock private ClientHelpService clientHelpService; @Mock private CardService cardService; private KafkaConsumer kafkaConsumer; @Before public void setUp() { MockitoAnnotations.openMocks(this); kafkaConsumer = new KafkaConsumer(accountHelpService, clientHelpService, cardService); } @Test public void testOnAccountMessage_throwsException() { // arrange String invalidAccount = "invalidJson"; doThrow(new RuntimeException("Test exception")).when(accountHelpService).saveAccount(any(AccountDto.class)); // act kafkaConsumer.onAccountMessage("someTargetSystem", invalidAccount); // assert // Verify no stack trace is printed. } }3. Переопределение логирования в тестах
Если у вас есть необходимость в полной блокировке логов во время выполнения тестов (например, чтобы полностью игнорировать вывод в консоль), вы можете временно подменить
System.outиSystem.errв ваших тестах.@Test public void testOnAccountMessage_loggingSuppressed() { PrintStream originalOut = System.out; PrintStream originalErr = System.err; ByteArrayOutputStream outContent = new ByteArrayOutputStream(); ByteArrayOutputStream errContent = new ByteArrayOutputStream(); System.setOut(new PrintStream(outContent)); System.setErr(new PrintStream(errContent)); try { // act kafkaConsumer.onAccountMessage("someTargetSystem", "invalidJson"); // Add assertions as needed. } finally { System.setOut(originalOut); System.setErr(originalErr); } }4. Конфигурация Sentry
Если вы используете Sentry и не хотите, чтобы ошибки логировались во время тестов, вы можете временно отключить или настроить его в конфигурации тестов.
Заключение
Каждый из этих подходов позволяет вам контролировать вывод логов во время тестирования методов, что исключает нежелательное отображение стека ошибок в консоли. Выберите подход, который лучше всего соответствует вашим требованиям и проекту.
- User
ошибка все равно в консоли 12:18:50.202 [main] INFO acq.micro.cardaccinit.impl.KafkaConsumer -- invalid_json 12:18:51.552 [main] ERROR acq.micro.cardaccinit.impl.KafkaConsumer -- Ошибка сохранения аккаунта из кафка com.google.gson.JsonSyntaxException: java.lang.IllegalStateException: Expected BEGIN_OBJECT but was STRING at line 1 column 1 path Adapter.read(ReflectiveTypeAdapterFactory.java:397) at com.google.gson.Gson.fromJson(Gson.java:1227) at com.google.gson.Gson.fromJson(Gson.java:1137) at com.google.gson.Gson.fromJson(Gson.java:1047) at com.google.gson.Gson.fromJson(Gson.java:982) at acq.micro.cardaccinit.impl.KafkaConsumer.onAccountMessage(KafkaConsumer.java:44) at acq.micro.cardaccinit.impl.KafkaConsumerTest.testOnAccountMessage_shouldHandleException(KafkaConsumerTest.java:59) at java.base/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:103) at java.base/java.lang.reflect.Method.invoke(Method.java:580) at org.junit.platform.commons.util.ReflectionUtils.invokeMethod(ReflectionUtils.java:728) at org.junit.jupiter.engine.execution.MethodInvocation.proceed(MethodInvocation.java:60) at org.junit.jupiter.engine.execution.InvocationInterceptorChainReflectiveInterceptorCall.lambda0(InterceptingExecutableInvoker.java:103) at org.junit.jupiter.engine.execution.InterceptingExecutableInvoker.lambda0(InterceptingExecutableInvoker.java:93) at org.junit.jupiter.engine.execution.InvocationInterceptorChaininvokeTestMethodexecuteRecursivelyexecuteRecursivelyexecuteRecursivelyexecuteRecursivelyexecuteRecursivelyexecuteRecursivelyexecuteRecursivelyexecuteRecursivelyexecuteRecursivelyexecuteRepeaterRepeater.startRunnerWithArgs(IdeaTestRunner.java:35) at com.intellij.rt.junit.JUnitStarter.prepareStreamsAndStart(JUnitStarter.java:232) at com.intellij.rt.junit.JUnitStarter.main(JUnitStarter.java:55) Caused by: java.lang.IllegalStateException: Expected BEGIN_OBJECT but was STRING at line 1 column 1 path Adapter.read(ReflectiveTypeAdapterFactory.java:386) ... 74 common frames omitted
- Assistant
Если вы видите ошибки в консоли при тестировании, это, скорее всего, связано с тем, что уровень логирования не был изменён для тестовой среды, и ваши привычные настройки логирования применяются и во время тестов. Вот несколько способов, как это можно исправить:
1. Отключение логирования во время тестов
Один из простых способов — временно отключить логирование, перенаправив вывод. Например:
import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import java.io.ByteArrayOutputStream; import java.io.PrintStream; public class KafkaConsumerTest { private PrintStream originalOut; private PrintStream originalErr; private ByteArrayOutputStream outContent; private ByteArrayOutputStream errContent; @BeforeEach public void setUp() { originalOut = System.out; originalErr = System.err; outContent = new ByteArrayOutputStream(); errContent = new ByteArrayOutputStream(); System.setOut(new PrintStream(outContent)); System.setErr(new PrintStream(errContent)); } @AfterEach public void tearDown() { System.setOut(originalOut); System.setErr(originalErr); } @Test public void testOnAccountMessage_shouldHandleException() { // Ваш тест } }2. Настройка уровня логирования с использованием Test Configuration
Если вы используете
logback, можно создать отдельный файл конфигурации логирования для тестов, напримерlogback-test.xml, и установить в нем уровень логирования. Этот файл будет загружаться только в тестах.Пример
logback-test.xml:<configuration> <root level="ERROR"> <appender-ref ref="STDOUT"/> </root> </configuration>Это позволит игнорировать логи уровня
INFOиDEBUGво время тестирования.3. Использование фреймворка, поддерживающего Mocks
Если вы используете фреймворки для тестирования, такие как Mockito, можно замокировать поведение логгера или самого объекта, который генерирует запрос к логированию. Например, вместо фактического вызова
log.errorилиlog.info, можно создать мок, который не производит вывода.@Slf4j public class KafkaConsumer { // ... } // В тесте @ExtendWith(MockitoExtension.class) public class KafkaConsumerTest { @Mock private AccountHelpService accountHelpService; private KafkaConsumer kafkaConsumer; @BeforeEach void setUp() { kafkaConsumer = new KafkaConsumer(accountHelpService, /* другие зависимости */); } @Test public void testOnAccountMessage_shouldHandleException() { // Ожидаем, что будет брошено исключение doThrow(new RuntimeException("Test exception")).when(accountHelpService).saveAccount(any()); // Пытаемся вызвать метод kafkaConsumer.onAccountMessage("someTargetSystem", "invalidJson"); // Проверка, что никаких логов не было вызвано // вы можете добавлять дополнительные проверки на ошибки. } }4. Логирование через различные профили (если применимо)
Если ваш проект поддерживает разные профили конфигураций (например, Spring), вы можете создать специфические конфигурации для тестов и изменений поведения логирования в зависимости от профиля.
Заключение
С помощью описанных методов вы можете контролировать вывод логов во время выполнения тестов и избегать их отображения в консоли. Подберите метод, который наилучшим образом подходит для вашего проекта и его настроек.
- User
- Отключение логирования во время тестов Один из простых способов — временно отключить логирование, перенаправив вывод. Что это значит?
- Assistant
Отключение логирования во время тестов с помощью перенаправления вывода означает, что вы временно изменяете стандартные потоки вывода на
System.outиSystem.err, чтобы игнорировать или подавить сообщения логов, которые обычно появляются в консоли во время выполнения программы.Как это работает
В Java
System.outиSystem.errявляются стандартными потоками вывода, которые обычно выводят текст в консоль. Когда вы выполняете логирование (например, черезlog.error,log.infoи т.д.), сообщения логирования попадают в этот стандартный поток, что делает их видимыми в консоли.Чтобы временно отключить или изменить вывод, вы можете перенаправить эти потоки на экземпляры
PrintStream, которые игнорируют данные. Например, вы можете создатьByteArrayOutputStream, который будет захватывать вывод, или просто перенаправить его в "мусор".Пример реализации
Вот конкретный пример того, как временно отключить вывод логирования во время теста:
import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import java.io.ByteArrayOutputStream; import java.io.PrintStream; public class MyTest { private PrintStream originalOut; private PrintStream originalErr; private ByteArrayOutputStream outContent; private ByteArrayOutputStream errContent; @BeforeEach void setUp() { // Сохраняем оригинальные потоки вывода originalOut = System.out; originalErr = System.err; // Создаем потоки для захвата вывода outContent = new ByteArrayOutputStream(); errContent = new ByteArrayOutputStream(); // Перенаправляем потоки вывода System.setOut(new PrintStream(outContent)); System.setErr(new PrintStream(errContent)); } @AfterEach void tearDown() { // Восстанавливаем оригинальные потоки вывода System.setOut(originalOut); System.setErr(originalErr); } @Test void testSomething() { // Ваш тестовый код // Если код вызывает логирование, эти сообщения не будут отображаться в консоли } }Что происходит в этом коде:
- Сохранение оригинальных потоков: Вы сохраняете оригинальные потоки
System.outиSystem.err, чтобы затем восстановить их после теста. - Создание потоков для захвата вывода: Вы создаете экземпляры
ByteArrayOutputStreamдля захвата любого текста, который выводится. - Перенаправление потоков:
System.setOut()иSystem.setErr()перенаправляют вывод на ваши потоки, которые игнорируют данные. - Восстановление потоков: В методе
tearDown, который вызывается после каждого теста, вы восстанавливаете оригинальные потоки вывода, что позволяет вашему окружению вернуться в нормальное состояние.
Таким образом, во время выполнения тестов вы можете избежать вывода логов в консоль, а по окончании тестов все возвращается к нормальному состоянию.
- Сохранение оригинальных потоков: Вы сохраняете оригинальные потоки
- User
логеер @Slf4j мокается вообще?
- Assistant
Да, логгер, созданный с использованием аннотации
@Slf4jиз библиотеки Lombok, можно замокировать с помощью библиотек для мокирования, таких как Mockito. Однако есть некоторые нюансы, о которых стоит помнить.Мокирование статических логгеров
Логгер, создаваемый с помощью аннотации
@Slf4j, является полем класса, и так как он не является статическим, его можно замокировать. Но, поскольку это поле инициализируется автоматически во время создания экземпляра класса, вам нужно будет использовать возможности Mockito для обработки этого.Пример мокирования
- Подключите необходимые библиотеки. Убедитесь, что у вас есть зависимости для Lombok и Mockito в вашем проекте. Если используете Maven, добавьте следующие зависимости в ваш
pom.xml:
<dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>здесь_ваша_версия</version> <scope>provided</scope> </dependency> <dependency> <groupId>org.mockito</groupId> <artifactId>mockito-junit-jupiter</artifactId> <version>здесь_ваша_версия</version> <scope>test</scope> </dependency>- Создайте класс с логгером и замокируйте его в тесте:
import lombok.extern.slf4j.Slf4j; import org.junit.jupiter.api.Test; import org.mockito.Mockito; @Slf4j public class KafkaConsumer { public void processAccount(String account) { log.info("Processing account: {}", account); // другая логика } } public class KafkaConsumerTest { @Test public void testProcessAccount() { // Создайте мок объекта KafkaConsumer KafkaConsumer consumer = Mockito.mock(KafkaConsumer.class); // Вызовите метод consumer.processAccount("testAccount"); // Проверьте, что логирование произошло (через любой другой способ проверки) Mockito.verify(consumer).processAccount("testAccount"); } }Примечания
-
Проверка логирования: Прямое мокирование логгера не даст вам возможности проверить, что произошло логирование, так как мок-объект заменяет реальный объект. Чтобы проверить, было ли выведено сообщение в лог, в этом случае нужно использовать другие методы, такие как
Appenderв таких библиотеках, как Logback или Log4j, чтобы захватывать логи. -
Мокирование
staticметодов: Если вы хотите замокировать статические методы, вам потребуются специальные инструменты, такие какPowerMockito, так как стандартный Mockito не поддерживает мокирование статических методов. -
Поддержка статических полей: Если вы хотите замокировать статические поля, вы можете изменить подход к написанию вашего класса, чтобы сделать его более поддающимся тестированию. Например, вы можете использовать Dependency Injection для передачи логгера вместо статического поля.
-
Использование
@Mockаннотаций: В тестах вы также можете использовать аннотацию@Mockдля автоматического создания мока, но это обычно применяется к полям и методам, а не статическим или внутренним логгерам.
Таким образом, основное направление для мокирования логгеров заключается в необходимости точно понимать, как вы хотите протестировать ваше поведение логирования, а также как это коррелирует с механизмом, который вы используете для их инициализации.
- Подключите необходимые библиотеки. Убедитесь, что у вас есть зависимости для Lombok и Mockito в вашем проекте. Если используете Maven, добавьте следующие зависимости в ваш
- User
а последний лог в консоль попадет? @KafkaListener( topics = "account", containerFactory = "clientAccountKafkaListenerContainerFactory") public void onAccountMessage(@Header(value = X_TARGET_SYSTEM_HEADER, required = false) String targetSystem, @Payload String account) { try { if (needToSyncEntity(targetSystem)) { AccountDto accountDto = new Gson().fromJson(account, AccountDto.class); log.debug("Account onMessage received: {}", account); accountHelpService.saveAccount(accountDto); } } catch (Exception e) { Sentry.addBreadcrumb("kafkaAddAccount"); Sentry.captureException(e); log.info("{}", account); log.error("Ошибка сохранения аккаунта из кафка", e); } }
- Assistant
В вашем коде метода
onAccountMessageиз классаKafkaConsumerпоследний лог в консоль действительно попадёт, если будет выброшено исключение в процессе обработки сообщения. Давайте разберем подробнее, как это работает.Когда логи попадают в консоль:
-
Успешное выполнение кода: Если метод успешно обрабатывает сообщение и исключений не возникает, в логах появится сообщение, записанное с уровнем
DEBUG(если у вас настроен вывод логов соответствующего уровня), например:log.debug("Account onMessage received: {}", account);Это сообщение будет видно в консоли, если уровень логирования установлен на
DEBUGилиINFO. -
Обработка исключения: Если возникает исключение где-то в блоке
try, оно будет поймано в блокеcatch, и вы увидите следующие логи:log.info("{}", account); log.error("Ошибка сохранения аккаунта из кафка", e);Эти сообщения будут записаны в лог при возникновении ошибки. Соответственно, конкретное сообщение об ошибке и стек вызовов (который выводится в случае логирования
log.error) будут видны в консоли.
Пример ситуации, когда лог попадает в консоль
Если бы метод
accountHelpService.saveAccount(accountDto);вызывал исключение (например, еслиaccountDtoне соответствует ожидаемому формату или что-то другое), тогда код в блокеcatchвыполнится:} catch (Exception e) { Sentry.addBreadcrumb("kafkaAddAccount"); Sentry.captureException(e); log.info("{}", account); log.error("Ошибка сохранения аккаунта из кафка", e); }В этом случае будет выведено:
- Информация о полученном аккаунте на уровне
INFO. - Сообщение об ошибке на уровне
ERRORвместе со стеком вызовов.
Как избежать пополнения лога
Чтобы избежать попадания логов в консоль во время тестирования, можно использовать подходы, описанные ранее, такие как:
-
Отключение логирования на уровне
INFOиDEBUGво время тестов, используя конфигурацию логирования (например, с помощьюlogback-test.xml). -
Перенаправление потоков вывода во время выполнения тестов, чтобы сообщения не отображались на консоли.
-
Использование Mock объектов для проверки того, что логи вызываются, но не отправляются в консоль.
Таким образом, если исключение происходит в методе, вы увидите соответствующие сообщения в консоли. Если вы хотите их избежать, используйте настройки логирования или методы перенаправления вывода, как указано выше.
-
- User
а если так, тесты корректно отработают? private PrintStream originalOut; private PrintStream originalErr;
@BeforeEach public void setUp() { MockitoAnnotations.openMocks(this); originalOut = System.out; originalErr = System.err; ByteArrayOutputStream outContent = new ByteArrayOutputStream(); ByteArrayOutputStream errContent = new ByteArrayOutputStream(); System.setOut(new PrintStream(outContent)); System.setErr(new PrintStream(errContent)); } @AfterEach public void tearDown() { System.setOut(originalOut); System.setErr(originalErr); } - Assistant
Ваш код, который вы предоставили для перенаправления стандартных потоков вывода (System.out и System.err), в целом выглядит корректно и должен помочь избежать вывода логов в консоль во время выполнения тестов. Давайте разберем его более подробно.
Код
private PrintStream originalOut; private PrintStream originalErr; private ByteArrayOutputStream outContent; private ByteArrayOutputStream errContent; @BeforeEach public void setUp() { MockitoAnnotations.openMocks(this); originalOut = System.out; originalErr = System.err; outContent = new ByteArrayOutputStream(); errContent = new ByteArrayOutputStream(); System.setOut(new PrintStream(outContent)); System.setErr(new PrintStream(errContent)); } @AfterEach public void tearDown() { System.setOut(originalOut); System.setErr(originalErr); }Объяснение кода
-
Сохранение оригинальных потоков вывода:
- В начале метода
setUp()вы сохраняете оригинальные потокиSystem.outиSystem.err, чтобы потом их можно было восстанавливать в методеtearDown(). Это хороший подход, потому что он позволяет вам не изменять глобальное состояние приложения, а просто временно перенаправить вывод текущего теста.
- В начале метода
-
Создание потоков для перенаправления:
- Вы создаете два
ByteArrayOutputStreamдля перехвата стандартных выходных данных. Это позволит вам захватывать все, что выводится вSystem.outиSystem.err, в переменныеoutContentиerrContent.
- Вы создаете два
-
Перенаправление потоков:
- Вы перенаправляете
System.outиSystem.errна вашиByteArrayOutputStream, что фактически «отключает» вывод в консоль во время выполнения теста. Таким образом, все сообщения логирования, которые должны записываться в консоль, будут перенаправлены в эти стримы и не будут отображаться.
- Вы перенаправляете
-
Восстановление оригинальных потоков:
- В методе
tearDown()вы восстанавливаете оригинальные потоки, что позволяет всем последующим операциям использовать стандартное поведение. Это крайне важно для того, чтобы другие тесты и части вашего приложения могли вести себя нормально.
- В методе
Корректность тестов
-
Тесты действительно смогут работать корректно: Использование этих переливов потоков не влияет на логику тестируемого кода. Вы сможете выполнять тесты на уровне кода, которые включают вложенные вызовы к методам логирования, без лишнего вывода в консоль.
-
Проверка вывода: Если вам нужно будет проверить, какие сообщения логирования были созданы, вы можете это сделать, используя
outContentиerrContent. Например, после выполнения теста вы можете проверить содержимоеoutContentиerrContentдля анализа того, что было выведено.
Пример простого теста с проверкой вывода:
@Test public void testLogOutput() { // Perform the action that triggers logging kafkaConsumer.onAccountMessage("someSystem", "invalidJson"); // Assert that the output was captured correctly String output = outContent.toString(); assertTrue(output.contains("некоторое ожидаемое сообщение")); }Таким образом, код для перенаправления вывода в вашем тесте корректен и будет работать так, как предполагается, эффективно угнетая вывод в консоль.
-
- User
а можно так заглушить только вывод стэка ошибок? @KafkaListener( topics = "account", containerFactory = "clientAccountKafkaListenerContainerFactory") public void onAccountMessage(@Header(value = X_TARGET_SYSTEM_HEADER, required = false) String targetSystem, @Payload String account) { try { if (needToSyncEntity(targetSystem)) { AccountDto accountDto = new Gson().fromJson(account, AccountDto.class); log.debug("Account onMessage received: {}", account); accountHelpService.saveAccount(accountDto); } } catch (Exception e) { Sentry.addBreadcrumb("kafkaAddAccount"); Sentry.captureException(e); log.info("{}", account); log.error("Ошибка сохранения аккаунта из кафка", e); } }
- Assistant
Да, вы можете заглушить вывод стека ошибок, направляя только вывод
System.err(стандартный поток ошибок), при этом оставляяSystem.outбез изменений. Таким образом, вы можете перехватывать и игнорировать только ошибки, в том числе те, что выводятся в логах с уровнемERROR, вместе со стеком исключений.Вот пример, как это можно сделать:
Пример реализации
import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import java.io.ByteArrayOutputStream; import java.io.PrintStream; public class KafkaConsumerTest { private PrintStream originalErr; private ByteArrayOutputStream errContent; @BeforeEach public void setUp() { // Сохраняем оригинальный поток ошибок originalErr = System.err; errContent = new ByteArrayOutputStream(); System.setErr(new PrintStream(errContent)); // Перенаправляем поток ошибок } @AfterEach public void tearDown() { System.setErr(originalErr); // Восстанавливаем оригинальный поток ошибок } @Test public void testOnAccountMessage_shouldHandleException() { // Здесь вызываем метод, который должен вызывать исключение kafkaConsumer.onAccountMessage("someTargetSystem", "invalidJson"); // Здесь вы можете проверить errContent, чтобы убедиться, что ошибки не попали в консоль String errorOutput = errContent.toString(); // Проверяйте на наличие ожидаемых сообщений или стека // assertFalse(errorOutput.contains("Expected Error Message")); } }Объяснение:
-
Сохранение оригинального потока ошибок:
- В
setUp()вы сохраняете оригинальныйSystem.err, что позволяет восстановить его вtearDown().
- В
-
Перенаправление потока ошибок:
- В
setUp()вы перенаправляетеSystem.errна новыйPrintStream, связанный сByteArrayOutputStream. Теперь все сообщения об ошибках будут записываться вerrContent, а не выводиться на консоль.
- В
-
Восстановление потока ошибок:
- В
tearDown()вы восстанавливаете оригинальный потокSystem.err, что позволяет избежать влияния на другие тесты.
- В
-
Проверка ошибок:
- В тесте
testOnAccountMessage_shouldHandleException()вы вызываете метод, который генерирует исключение, и проверяете содержимоеerrContentдля анализа, что было выведено.
- В тесте
Заключение
Таким образом, вы можете заглушить только вывод стека ошибок, оставляя
System.outнетронутым, что позволяет вам контролировать, что выводится, и при этом продолжать использовать ваш обычный логгинг для остальных уровней сообщений. -
- User
так наоборот все в консоль выводит 13:12:21.383 [main] ERROR acq.micro.cardaccinit.impl.KafkaConsumer -- Ошибка сохранения аккаунта из кафка com.google.gson.JsonSyntaxException: java.lang.IllegalStateException: Expected BEGIN_OBJECT but was STRING at line 1 column 1 path Adapter.read(ReflectiveTypeAdapterFactory.java:397) at com.google.gson.Gson.fromJson(Gson.java:1227) at com.google.gson.Gson.fromJson(Gson.java:1137) at com.google.gson.Gson.fromJson(Gson.java:1047) at com.google.gson.Gson.fromJson(Gson.java:982) at acq.micro.cardaccinit.impl.KafkaConsumer.onAccountMessage(KafkaConsumer.java:44) at acq.micro.cardaccinit.impl.KafkaConsumerTest.testOnAccountMessage_shouldHandleException(KafkaConsumerTest.java:80) at java.base/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:103) at java.base/java.lang.reflect.Method.invoke(Method.java:580) at org.junit.platform.commons.util.ReflectionUtils.invokeMethod(ReflectionUtils.java:728) at org.junit.jupiter.engine.execution.MethodInvocation.proceed(MethodInvocation.java:60) at org.junit.jupiter.engine.execution.InvocationInterceptorChainReflectiveInterceptorCall.lambda0(InterceptingExecutableInvoker.java:103) at org.junit.jupiter.engine.execution.InterceptingExecutableInvoker.lambda0(InterceptingExecutableInvoker.java:93) at org.junit.jupiter.engine.execution.InvocationInterceptorChaininvokeTestMethodexecuteRecursivelyexecuteRecursivelyexecuteRecursivelyexecuteRecursivelyexecuteRecursivelyexecuteRecursivelyexecuteRecursivelyexecuteRecursivelyexecuteRecursivelyexecuteRepeaterRepeater.startRunnerWithArgs(IdeaTestRunner.java:35) at com.intellij.rt.junit.JUnitStarter.prepareStreamsAndStart(JUnitStarter.java:232) at com.intellij.rt.junit.JUnitStarter.main(JUnitStarter.java:55) Caused by: java.lang.IllegalStateException: Expected BEGIN_OBJECT but was STRING at line 1 column 1 path Adapter.read(ReflectiveTypeAdapterFactory.java:386) ... 74 common frames omitted 13:12:21.390 [main] INFO acq.micro.cardaccinit.impl.KafkaConsumer -- invalid_json 13:12:21.390 [main] ERROR acq.micro.cardaccinit.impl.KafkaConsumer -- Ошибка сохранения клиента из кафка com.google.gson.JsonSyntaxException: java.lang.IllegalStateException: Expected BEGIN_OBJECT but was STRING at line 1 column 1 path Adapter.read(ReflectiveTypeAdapterFactory.java:397) at com.google.gson.Gson.fromJson(Gson.java:1227) at com.google.gson.Gson.fromJson(Gson.java:1137) at com.google.gson.Gson.fromJson(Gson.java:1047) at com.google.gson.Gson.fromJson(Gson.java:982) at acq.micro.cardaccinit.impl.KafkaConsumer.onClientMessage(KafkaConsumer.java:63) at acq.micro.cardaccinit.impl.KafkaConsumerTest.testOnClientMessage_shouldHandleException(KafkaConsumerTest.java:104) at java.base/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:103) at java.base/java.lang.reflect.Method.invoke(Method.java:580) at org.junit.platform.commons.util.ReflectionUtils.invokeMethod(ReflectionUtils.java:728) at org.junit.jupiter.engine.execution.MethodInvocation.proceed(MethodInvocation.java:60) at org.junit.jupiter.engine.execution.InvocationInterceptorChainReflectiveInterceptorCall.lambda0(InterceptingExecutableInvoker.java:103) at org.junit.jupiter.engine.execution.InterceptingExecutableInvoker.lambda0(InterceptingExecutableInvoker.java:93) at org.junit.jupiter.engine.execution.InvocationInterceptorChaininvokeTestMethodexecuteRecursivelyexecuteRecursivelyexecuteRecursivelyexecuteRecursivelyexecuteRecursivelyexecuteRecursivelyexecuteRecursivelyexecuteRecursivelyexecuteRecursivelyexecuteRepeaterRepeater.startRunnerWithArgs(IdeaTestRunner.java:35) at com.intellij.rt.junit.JUnitStarter.prepareStreamsAndStart(JUnitStarter.java:232) at com.intellij.rt.junit.JUnitStarter.main(JUnitStarter.java:55) Caused by: java.lang.IllegalStateException: Expected BEGIN_OBJECT but was STRING at line 1 column 1 path Adapter.read(ReflectiveTypeAdapterFactory.java:386) ... 74 common frames omitted
- Assistant
Если сообщения с ошибками и стеки ошибок всё равно выводятся в консоль после перенаправления
System.err, это может быть связано с несколькими факторами.Возможные причины:
-
Логи от сторонних библиотек: Если логгирование настроено через библиотеку, такую как SLF4J с backend'ом (например, Logback или Log4j), то логирование этих библиотек может не попадать в
System.errнапрямую. Вместо этого они могут обрабатывать свои логи в соответствии с собственными настройками, и эти сообщения могут выводиться в консоль, независимо от вашего перенаправления. -
Настройки логирования: Если у вас есть конфигурационный файл (например,
logback.xmlилиlog4j2.xml), убедитесь, что он правильно настроен, чтобы передать или перенаправить ошибки на консоль. Посмотрите, как настроено ваше приложение для логирования ошибок и в каких случаях оно действительно выводит сообщения.
Возможные решения:
-
Настройка уровня логирования:
- Проверьте конфигурацию вашего логгера. Убедитесь, что уровень логирования установлен таким образом, чтобы не выводить ошибки (например, уровни
INFOилиWARNмогут быть более приемлемыми для тестов). - Вы можете создать тестовую конфигурацию логирования, чтобы временно изменить уровень логирования. Например,
logback-test.xml:
<configuration> <root level="ERROR"> <appender-ref ref="STDOUT"/> </root> <logger name="acq.micro.cardaccinit.impl.KafkaConsumer" level="ERROR" /> </configuration> - Проверьте конфигурацию вашего логгера. Убедитесь, что уровень логирования установлен таким образом, чтобы не выводить ошибки (например, уровни
-
Использование
LogAppender: Если вы используете Logback, вы можете написать кастомныйAppender, который будет игнорировать логи во время тестов, или использоватьInMemoryAppender, чтобы перехватывать логи и потом их проверять, вместо вывода в консоль.Пример простого
Appender:public class SilentAppender extends AppenderBase<ILoggingEvent> { @Override protected void append(ILoggingEvent eventObject) { // Пустой метод, просто игнорируйте все логи } } -
Изменение
Loggerв тестах: Вы можете использовать mock-объекты для замены логгера и переопределить его поведение во время тестов. -
Перенаправление консольного вывода: Если вы хотите игнорировать все выводы от
System.outиSystem.errво время тестирования, убедитесь, что оба потока перенаправляются вByteArrayOutputStreamи затем не выводятся в консоль.
Пример корректного перенаправления
@BeforeEach public void setUp() { originalOut = System.out; originalErr = System.err; outContent = new ByteArrayOutputStream(); errContent = new ByteArrayOutputStream(); System.setOut(new PrintStream(outContent)); System.setErr(new PrintStream(errContent)); } @AfterEach public void tearDown() { System.setOut(originalOut); System.setErr(originalErr); } // В вашем тесте @Test public void testMethod() { // Ваша логика, которая может выбросить ошибку или записать лог kafkaConsumer.onAccountMessage("someTargetSystem", "invalidJson"); // Здесь вы можете проверить, что выводов нет assertTrue(errContent.toString().isEmpty()); // или проверяйте на наличие определенных сообщений }Заключение
Таким образом, если вы видите выводы сообщений об ошибках в консоли, обратите внимание на конфигурацию вашего логгера, а также как обрабатываются логи в вашей среде. Возможно, будет необходимо внести дополнения в вашу конфигурацию логирования или использовать специальные подходы для перехвата и обработки логов в тестах.
-
- User
а если мне только в тестах с исключениями нужно заглушить логи? @BeforeEach public void setUp() { MockitoAnnotations.openMocks(this); originalOut = System.out; originalErr = System.err; ByteArrayOutputStream outContent = new ByteArrayOutputStream(); ByteArrayOutputStream errContent = new ByteArrayOutputStream(); System.setOut(new PrintStream(outContent)); System.setErr(new PrintStream(errContent)); }
@AfterEach public void tearDown() { System.setOut(originalOut); System.setErr(originalErr); } @Test public void testOnAccountMessage_shouldSaveAccount_whenValidMessage() { String targetSystem = "ALL"; String accountJson = "{\"id\": 1, \"personId\": 123, \"type\": \"SAVINGS\", \"subtype\": \"REGULAR\", \"status\": \"ACTIVE\", \"number\": \"123456789\", \"createdDate\": \"2023-01-01\", \"updatedDate\": \"2023-01-02\", \"currency\": \"USD\", \"pss\": \"somePSS\", \"eds\": true}"; kafkaConsumer.onAccountMessage(targetSystem, accountJson); ArgumentCaptor<AccountDto> accountDtoCaptor = ArgumentCaptor.forClass(AccountDto.class); verify(accountHelpService).saveAccount(accountDtoCaptor.capture()); AccountDto capturedAccountDto = accountDtoCaptor.getValue(); AccountDto expectedAccountDto = new Gson().fromJson(accountJson, AccountDto.class); assertEquals(expectedAccountDto.getId(), capturedAccountDto.getId()); assertEquals(expectedAccountDto.getPersonId(), capturedAccountDto.getPersonId()); assertEquals(expectedAccountDto.getType(), capturedAccountDto.getType()); assertEquals(expectedAccountDto.getSubtype(), capturedAccountDto.getSubtype()); } @Test public void testOnAccountMessage_shouldHandleException() { String targetSystem = "ALL"; String accountJson = "invalid_json"; // Неверный JSON для проверки обработки исключений kafkaConsumer.onAccountMessage(targetSystem, accountJson); verify(accountHelpService, never()).saveAccount(any()); } @Test public void testOnClientMessage_shouldSaveClient_whenValidMessage() { String targetSystem = "ALL"; String accountJson = "{\"id\": 1, \"personId\": 123, \"type\": \"SAVINGS\", \"subtype\": \"REGULAR\", \"status\": \"ACTIVE\", \"number\": \"123456789\", \"createdDate\": \"2023-01-01\", \"updatedDate\": \"2023-01-02\", \"currency\": \"USD\", \"pss\": \"somePSS\", \"eds\": true}"; kafkaConsumer.onClientMessage(targetSystem, accountJson); ArgumentCaptor<ClientDto> clientDtoCaptor = ArgumentCaptor.forClass(ClientDto.class); verify(clientHelpService).saveClient(clientDtoCaptor.capture()); ClientDto capturedClientDto = clientDtoCaptor.getValue(); ClientDto expectedClientDto = new Gson().fromJson(accountJson, ClientDto.class); assertEquals(expectedClientDto.getStatus(), capturedClientDto.getStatus()); assertEquals(expectedClientDto.getMobilePhone(), capturedClientDto.getMobilePhone()); assertEquals(expectedClientDto.getFullName(), capturedClientDto.getFullName()); assertEquals(expectedClientDto.getUcid(), capturedClientDto.getUcid()); } @Test public void testOnClientMessage_shouldHandleException() { String targetSystem = "ALL"; String accountJson = "invalid_json"; kafkaConsumer.onClientMessage(targetSystem, accountJson); verify(accountHelpService, never()).saveAccount(any()); }}
- Assistant
Если вы хотите заглушить вывод логов только для тестов, где ожидается возникновение исключений, вы можете модифицировать вашу настройку логов так, чтобы она была условной. Таким образом, вы сможете временно перенаправлять
System.outиSystem.errтолько в тех тестах, где ожидается исключение.1. Используйте условное перенаправление
Вы можете использовать логическую переменную, чтобы указывать, нужно ли перенаправлять вывод, и делать это только в тех тестах, где ожидается исключение.
Пример:
Вот пример, как вы можете это реализовать:
import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.MockitoAnnotations; import java.io.ByteArrayOutputStream; import java.io.PrintStream; import static org.mockito.Mockito.*; public class KafkaConsumerTest { private PrintStream originalOut; private PrintStream originalErr; private ByteArrayOutputStream outContent; private ByteArrayOutputStream errContent; @BeforeEach public void setUp() { MockitoAnnotations.openMocks(this); originalOut = System.out; originalErr = System.err; outContent = new ByteArrayOutputStream(); errContent = new ByteArrayOutputStream(); } private void suppressLogs() { System.setOut(new PrintStream(outContent)); System.setErr(new PrintStream(errContent)); } @AfterEach public void tearDown() { System.setOut(originalOut); System.setErr(originalErr); } @Test public void testOnAccountMessage_shouldSaveAccount_whenValidMessage() { String targetSystem = "ALL"; String accountJson = "{\"id\": 1, \"personId\": 123, \"type\": \"SAVINGS\"}"; kafkaConsumer.onAccountMessage(targetSystem, accountJson); ArgumentCaptor<AccountDto> accountDtoCaptor = ArgumentCaptor.forClass(AccountDto.class); verify(accountHelpService).saveAccount(accountDtoCaptor.capture()); // Проверки значений... } @Test public void testOnAccountMessage_shouldHandleException() { suppressLogs(); // Заглушаем вывод логов только для этого теста String targetSystem = "ALL"; String accountJson = "invalid_json"; // Неверный JSON для проверки обработки исключений kafkaConsumer.onAccountMessage(targetSystem, accountJson); verify(accountHelpService, never()).saveAccount(any()); } @Test public void testOnClientMessage_shouldSaveClient_whenValidMessage() { // логика теста } @Test public void testOnClientMessage_shouldHandleException() { suppressLogs(); // Заглушаем вывод логов только для этого теста String targetSystem = "ALL"; String accountJson = "invalid_json"; kafkaConsumer.onClientMessage(targetSystem, accountJson); verify(accountHelpService, never()).saveAccount(any()); } }Объяснение:
-
Создание метода
suppressLogs(): Этот метод будет устанавливатьSystem.outиSystem.errв новый поток, который игнорирует все выводимые сообщения. -
Вызов
suppressLogs(): Вызывайте этот метод только в тех тестах, где вы ожидаете, что ошибки будут возникать. Например, в методах тестирования, которые проверяют обработку исключений. -
Отмена перенаправления в
tearDown(): После выполнения каждого теста вы всегда восстанавливаете оригинальные потоки вtearDown(), чтобы избежать влияния на другие тесты.
Таким образом, вы сможете контролировать, когда вывод должен быть заглушён, и гарантировать, что ваши тесты, которые ожидают исключения, не выводят лишнюю информацию в консоль.
-
- User
чем отличаются ? originalOut = System.out; originalErr = System.err;
- Assistant
originalOut = System.out;иoriginalErr = System.err;— это две строки кода, которые присваивают текущие стандартные потоки вывода (т.е. системные стримы) переменнымoriginalOutиoriginalErr. Давайте разберём эти две строки подробнее.System.outSystem.out— это стандартный поток вывода для вывода текстовой информации (например, сообщений, логов и т.д.) в консоль. Он является экземпляромPrintStream, который обычно выводит текст на консоль.
System.errSystem.err— это стандартный поток ошибок, используемый для вывода ошибок и предупреждений. Этот поток также является экземпляромPrintStream, но обычно выводимые через него сообщения могут отображаться в консоли в формате, отличном от стандартного вывода (System.out), и иногда они могут выводиться в разные места (например, на консоль, в файлы или в другие логирующие системы) в зависимости от конфигурации.
Назначение переменных
Когда вы используете:
originalOut = System.out; originalErr = System.err;вы сохраняете ссылки на текущие стандартные потоки
System.outиSystem.err. Это позволяет вам восстановить их после того, как вы перенаправили вывод, например, в тестах.Пример использования
-
Сохранение оригинальных потоков: Вы сохраняете значения
System.outиSystem.errвoriginalOutиoriginalErr, чтобы позже вы могли восстановить их, когда закончите тест. -
Перенаправление:
Вы можете перенаправить
System.outиSystem.errдля подавления вывода в консоль или для перехвата его в переменные:System.setOut(new PrintStream(new ByteArrayOutputStream())); System.setErr(new PrintStream(new ByteArrayOutputStream())); -
Восстановление оригинальных потоков: После завершения теста вы восстанавливаете оригинальные потоки:
System.setOut(originalOut); System.setErr(originalErr);
Заключение
Итак, разница между
System.outиSystem.errзаключается в их предназначении:System.outиспользуется для вывода обычной информации,System.errпредназначен для вывода ошибок и предупреждений.
Сохраняя оба потока, вы можете контролировать их поведение во время выполнения тестов, перенаправляя их так, как вам это необходимо, а затем восстанавливая их изначальные значения.
- User
например мне нужно заглушить лог log.error("[checkOrderStatus]", e); , мне использовать их оба нужно? @Scheduled(cron = "0 */30 * * * ?") @SchedulerLock(name = "OrderCheckStatusScheduler_checkOrderStatus", lockAtLeastFor = "PT30M", lockAtMostFor = "PT60M") public void checkOrderStatus() { log.info("[checkOrderStatus] Проверка статусов ордеров. Старт"); try { orderService.checkOrderStatus(); log.info("[checkOrderStatus] Проверка статусов ордеров. Стоп"); } catch (Exception e) { log.error("[checkOrderStatus]", e); } }
- Assistant
Если ваша цель — заглушить вывод только ошибочного лога
log.error("[checkOrderStatus]", e);в вашем методеcheckOrderStatus(), то вам не нужно перенаправлять оба потокаSystem.outиSystem.err. Дело в том, чтоlog.errorне выводит сообщения черезSystem.errв классическом понимании (например, какSystem.err.println()), а используя настройку логгирования вашей библиотеки (SLF4J, Logback, Log4j и т.д.).Что делать, чтобы заглушить только ошибки из логгера?
-
Использовать конфигурацию логирования:
- Вы можете изменить уровень логирования для вашего логгера в тестах или временно настроить его так, чтобы он не выводил сообщения уровня
ERROR.
- Вы можете изменить уровень логирования для вашего логгера в тестах или временно настроить его так, чтобы он не выводил сообщения уровня
-
Создать кастомный
Appender:- Можно создать Logger Appender, который будет игнорировать сообщения на уровне
ERRORво время выполнения тестов. Кастомный Appender позволяет отлавливать логи и вести себя в зависимости от ваших требований.
- Можно создать Logger Appender, который будет игнорировать сообщения на уровне
-
Перенаправить вывод, если необходимо:
- Если идея заключается в том, чтобы все сообщения, выводимые с использованием
log.error, не появлялись в консоли, вы могли бы временно перенаправить все ответы логгера с помощью мока.
- Если идея заключается в том, чтобы все сообщения, выводимые с использованием
Пример использования Mock
Если вы используете Mockito, вы можете замокировать логгер:
import static org.mockito.Mockito.*; public class MyServiceTest { private MyService myService; @Mock private Logger log; // или используйте реальный логгер, если желаете @BeforeEach public void setUp() { MockitoAnnotations.openMocks(this); myService = new MyService(); // передать мок логгера в конструктор } @Test public void testCheckOrderStatus_shouldSuppressErrorLog() { doNothing().when(log).error(anyString(), any(Throwable.class)); // заглушить log.error myService.checkOrderStatus(); verify(log, never()).error(anyString(), any(Throwable.class)); // убедиться, что log.error не вызван } }Пример временной конфигурации логирования
Если вы используете Logback, вы можете создать файл
logback-test.xmlс содержимым:<configuration> <logger name="имя вашего логгера" level="ERROR"> <appender-ref ref="NONE"/> </logger> </configuration>Эта конфигурация отменит все выводы логов с уровнем
ERRORдля указанного логгера. И в вашем тесте все вызовыlog.errorбудут игнорироваться.Заключение
Таким образом, если вам нужно только отключить сообщения об ошибках от
log.error:- Вы можете использовать подходы с Mock или временные настройки логирования, но инициируйте настройки только в тех тестах, где предполагаются ошибки.
- Не имеет смысла перенаправлять
System.outиSystem.errв данном случае, если вся ваша логика обращается к пользователю через систему логирования.
-
- User
когда я делаю вот так то не выводится стэк в консоль private PrintStream originalErr; private PrintStream originalOut; private ByteArrayOutputStream outContent; private ByteArrayOutputStream errContent;
@BeforeEach public void setUp() { MockitoAnnotations.openMocks(this); originalOut = System.out; originalErr = System.err; outContent = new ByteArrayOutputStream(); errContent = new ByteArrayOutputStream(); } private void suppressLogs() { System.setOut(new PrintStream(outContent)); System.setErr(new PrintStream(errContent)); } @AfterEach public void tearDown() { System.setOut(originalOut); System.setErr(originalErr); } @Test public void testCheckOrderStatus_Exception() throws IOException { suppressLogs(); doThrow(new RuntimeException("Ошибка проверки статуса")).when(orderServiceImpl).checkOrderStatus(); orderCheckStatusScheduler.checkOrderStatus(); verify(orderServiceImpl, times(1)).checkOrderStatus(); }}
- Assistant
Ваш код на самом деле корректно перенаправляет выводы стандартных потоков
System.outиSystem.err, и как результат, любые сообщения, которые бы обычно выводились в консоль, не отображаются. Однако, если вы не видите стек вызовов и сообщения об ошибках, это связано с тем, как конфигурируются и обрабатываются логи в вашей системе.Причины, по которым стек вызовов не отображается:
-
Логгирующий фреймворк: Как уже упоминалось ранее, самый распространённый способ журналирования (логгирования) сообщений — это с помощью библиотек, таких как SLF4J с Logback или Log4j. В этом случае вывод логов может происходить не через стандартные потоки
System.outиSystem.err, а может быть настроен для записи в файл, через другие аппендеры и т.д. -
Логирование исполняемого кода: В вашем коде, когда возникает ошибка, вы не перенаправляете логи, которые выводятся с помощью логгера, на стандартные потоки. Если в коде используется
log.error(...), эти сообщения возвращаются логирующей системе, а не в стандартный поток ошибок. Поэтому они продолжают отображаться в консоли, даже если вы перенаправляете стандартный вывод или поток ошибок.
Как исправить это:
Чтобы полностью заглушить вывод ошибок, вы можете:
-
Использовать конфигурацию логирования:
- Если вы используете библиотеку для логирования, вам, возможно, нужно изменять конфигурацию логирования. Например, в случае использования Logback или Log4j вы можете временно изменить настройки для вашего логгера в файле конфигурации (например, в
logback-test.xmlилиlog4j.properties).
- Если вы используете библиотеку для логирования, вам, возможно, нужно изменять конфигурацию логирования. Например, в случае использования Logback или Log4j вы можете временно изменить настройки для вашего логгера в файле конфигурации (например, в
-
Использование
Appender:- Если у вас есть возможность разработать пользовательский аппендер, вы можете создать аппендер, который будет игнорировать сообщения об ошибках во время тестов.
-
Mock логи:
- Вы можете замокировать ваш логгер, чтобы предотвратить вызовы методов логирования. Например, используя
Mockito, можно использоватьwhenдля обработки вызововlog.error(...), чтобы они ничего не делали.
- Вы можете замокировать ваш логгер, чтобы предотвратить вызовы методов логирования. Например, используя
Код с мокированием логгера
Если вы хотите замокировать логгер, вот пример, как это можно сделать:
import org.junit.jupiter.api.*; import org.mockito.InjectMocks; import org.mockito.Mock; import org.mockito.MockitoAnnotations; import static org.mockito.Mockito.*; public class OrderCheckStatusSchedulerTest { @Mock private OrderService orderServiceImpl; @InjectMocks private OrderCheckStatusScheduler orderCheckStatusScheduler; private ByteArrayOutputStream outContent; private ByteArrayOutputStream errContent; private PrintStream originalOut; private PrintStream originalErr; @BeforeEach public void setUp() { MockitoAnnotations.openMocks(this); originalOut = System.out; originalErr = System.err; outContent = new ByteArrayOutputStream(); errContent = new ByteArrayOutputStream(); System.setOut(new PrintStream(outContent)); System.setErr(new PrintStream(errContent)); } @AfterEach public void tearDown() { System.setOut(originalOut); System.setErr(originalErr); } @Test public void testCheckOrderStatus_Exception() throws IOException { // Указывать, что лог должен быть замокирован doThrow(new RuntimeException("Ошибка проверки статуса")).when(orderServiceImpl).checkOrderStatus(); try { orderCheckStatusScheduler.checkOrderStatus(); } catch (Exception e) { // Здесь вы можете проверить, что ошибка была выброшена } verify(orderServiceImpl, times(1)).checkOrderStatus(); } }Обратите внимание:
- В этом примере мы продолжали перенаправлять стандартные потоки. Но если у вас настроен логгер, который обрабатывает ошибки другим способом, вам нужно внести изменения в конфигурацию логгирования.
- Метод
suppressLogs()не нужно вызывать, если вы не хотите подавлять обычные сообщения, и если вы хотите аккуратно обрабатывать ошибки логирования, можете использовать mocking вместо подавления глобального потока.
Используя один из этих подходов, вы сможете контролировать, как обрабатываются и выводятся ваши ошибки, и подавить вывод стека ошибок, если это необходимо.
-
- User
объясни выражение с примером? if (maxSum.compareTo(paymentSum) < 0) { String errorInfo; if (maxSum.compareTo(BigDecimal.ZERO) > 0) { errorInfo = "Сумма платежа превышает ограничение по балансу счета. Максимальная сумму платежа: " + maxSum; } else { errorInfo = "Баланс счета превышает макимально допустимый размер (" + balanceLimitStr + ")"; } log.info("[checkAccountBalance] {}", errorInfo); return getFailResponse(errorInfo);
- Assistant
Давайте разберем ваше выражение на части и объясним его логику, а также приведем пример.
Обозначения и логика выражения
-
maxSum.compareTo(paymentSum) < 0:- Метод
compareTo()используется для сравнения двух объектов типаBigDecimal. - Он возвращает:
- 0, если значения равны;
- отрицательное значение, если
maxSumменьшеpaymentSum; - положительное значение, если
maxSumбольшеpaymentSum.
- Portanto, условие
maxSum.compareTo(paymentSum) < 0проверяет, превышает ли сумма платежа (paymentSum) максимальную сумму (maxSum). Если условие истинно, значит,paymentSumбольшеmaxSum.
- Метод
-
maxSum.compareTo(BigDecimal.ZERO) > 0:- Это условие проверяет, является ли
maxSumположительным значением. ЕслиmaxSumбольше нуля, значит, на счету есть предел.
- Это условие проверяет, является ли
-
errorInfo:- В зависимости от состояния переменных, формируется сообщение об ошибке, которое будет логироваться и, скорее всего, возвращаться пользователю.
Пример кода:
import java.math.BigDecimal; public class PaymentProcessor { private BigDecimal maxSum; private BigDecimal paymentSum; public PaymentProcessor(BigDecimal maxSum, BigDecimal paymentSum) { this.maxSum = maxSum; this.paymentSum = paymentSum; } public String checkAccountBalance() { String balanceLimitStr = "1000"; // пример текстового представления предела if (maxSum.compareTo(paymentSum) < 0) { String errorInfo; if (maxSum.compareTo(BigDecimal.ZERO) > 0) { errorInfo = "Сумма платежа превышает ограничение по балансу счета. Максимальная сумму платежа: " + maxSum; } else { errorInfo = "Баланс счета превышает максимально допустимый размер (" + balanceLimitStr + ")"; } System.out.println("[checkAccountBalance] " + errorInfo); return getFailResponse(errorInfo); } return "Платеж прошел успешно!"; } private String getFailResponse(String errorInfo) { return "Ошибка: " + errorInfo; } public static void main(String[] args) { PaymentProcessor processor = new PaymentProcessor(new BigDecimal("500"), new BigDecimal("600")); String result = processor.checkAccountBalance(); System.out.println(result); } }Пример исполнения:
-
Предусловия:
maxSum= 500 (максимальная сумма).paymentSum= 600 (сумма платежа, которую мы хотим провести).
-
Проверка логики:
- Условие
maxSum.compareTo(paymentSum) < 0будет истинным, так как 500 < 600. - Далее проверяется
maxSum.compareTo(BigDecimal.ZERO) > 0. Это также будет истиной, поскольку 500 > 0. - Следовательно, будет создано сообщение:
"Сумма платежа превышает ограничение по балансу счета. Максимальная сумма платежа: 500"
- Условие
-
Код выводит сообщение об ошибке и возвращает результат:
- Сообщение об ошибке будет выведено (или залогировано) и метод вернёт строку с ошибкой:
"Ошибка: Сумма платежа превышает ограничение по балансу счета. Максимальная сумма платежа: 500"
- Сообщение об ошибке будет выведено (или залогировано) и метод вернёт строку с ошибкой:
Заключение
Таким образом, этот код предназначен для проверки, превышает ли запрашиваемая сумма платежа максимальное лимитированное значение, и в случае превышения дает соответствующее сообщение об ошибке, которое может быть использовано для дальнейшей обработки.
-
- User
какой сценарий в тесте можно сделать, чтобы исключение было? try { Response response = disposalService.balance(new BalanceRequestDto(a), authorizationHeaderValue).execute(); if (response.isSuccessful()) { balanceResponseDto = response.body(); } else { log.warn("[getAccountsBalance] response.code() = {}", response.code()); } } catch (IOException e) { log.warn("[getAccountsBalance]", e); }
- Assistant
Чтобы создать тестовый сценарий, который вызывает исключение в
catchблоке вашего кода, вам нужно сымитировать ситуацию, в которой вызовdisposalService.balance(...)приводит кIOException. Это может быть достигнуто с использованием библиотеки для мокирования, такой как Mockito.Пример теста, который вызывает исключение
- Используйте Mockito для создания мока
disposalService. - Симулируйте поведение метода
balance(...), чтобы он выбрасывалIOException.
Пример тестового кода
Предположим, ваш класс, где находится этот код, называется
AccountService. Вот как может выглядеть тест:import static org.mockito.Mockito.*; import static org.junit.jupiter.api.Assertions.*; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mock; import org.mockito.MockitoAnnotations; import retrofit2.Call; import retrofit2.Response; import java.io.IOException; public class AccountServiceTest { @Mock private DisposalService disposalService; // предполагается, что это интерфейс @Mock private Call<BalanceResponseDto> mockCall; private AccountService accountService; // класс, содержащий код, который необходимо протестировать @BeforeEach public void setUp() { MockitoAnnotations.openMocks(this); accountService = new AccountService(disposalService); // передача мока } @Test public void testGetAccountsBalance_IOException() throws Exception { // Подготовка: Симуляция метода balance, чтобы он бросал IOException when(disposalService.balance(any(BalanceRequestDto.class), anyString())).thenReturn(mockCall); when(mockCall.execute()).thenThrow(new IOException("Network error")); // Вызываем метод, который использует disposalService Exception exception = assertThrows(IOException.class, () -> { accountService.getAccountsBalance(); // ваш метод, содержащий обработку }); // Проверяем, что исключение было выброшено как ожидается assertEquals("Network error", exception.getMessage()); // Дополнительные проверки (если нужны) // verify логирования и других действий } }Объяснение кода:
-
Создание моков:
- Создаем мок
disposalServiceиCall<BalanceResponseDto>.
- Создаем мок
-
Настройка мока:
- Настраиваем
whenдля методаbalance(...), чтобы возвращать наш замокированный вызовmockCall. - Дальше настраиваем
mockCallтак, чтобы методexecute()выбрасывалIOException.
- Настраиваем
-
Тестирование методу:
- Мы вызываем метод
getAccountsBalance()(предполагается, что это метод вашего классаAccountService, где содержится код с обработкой исключения). - Мы также проверяем, что
IOExceptionфактически выбрасывается при выполнении вызова.
- Мы вызываем метод
-
Проверка результата:
- Проверяем, что сообщение исключения совпадает с ожидаемым.
Итог
Таким образом, электрическая часть — это то, как вы настраиваете ваш мок для генерации исключений, что позволяет вам тестировать соответствующее поведение вашего метода обработки ошибок.
- Используйте Mockito для создания мока
- User
а это корректный тест для метода? public class MaskedCvcAdapter implements JsonSerializer { @Override public JsonElement serialize(String value, Type type, JsonSerializationContext jsonSerializationContext) { JsonObject object = new JsonObject(); object.addProperty("value", "***"); return object.get("value"); } }
@Test public void testSerialize() { MaskedCvcAdapter adapter = new MaskedCvcAdapter(); JsonSerializationContext context = mock(JsonSerializationContext.class); JsonElement result = adapter.serialize("123", mock(Type.class), context); assertEquals("***", result.getAsString()); }
- Assistant
Ваш тест для метода
serializeв классеMaskedCvcAdapterвыглядит почти правильно, но есть несколько моментов, на которые стоит обратить внимание.Обзор кода
-
Класс MaskedCvcAdapter:
- Вы создали адаптер для сериализации строки, который всегда возвращает JSON-элемент со значением "***".
-
Тестовый метод testSerialize:
- Создается экземпляр
MaskedCvcAdapter. - Вы создаете мок для
JsonSerializationContext, но не используете его в тесте, так как результат не зависит от него. - Вы вызываете метод
serializeс входными данными и затем проверяете результат.
- Создается экземпляр
Корректировка теста
Ваш тест проходит, но его необходимо немного изменить, чтобы он был более корректным и четким:
- Мокируйте только те компоненты, которые действительно нуждаются в мокировании. Поскольку
contextв этом тесте не используется, вы можете просто передать null или не создавать его вовсе. - Убедитесь, что вы проверяете, что возвращаемый
JsonElementдействительно содержит свойствоvalue, а не просто значение как строку.
Исправленный тестовый метод
Вот пример исправленного теста:
import com.google.gson.JsonElement; import com.google.gson.JsonObject; import com.google.gson.JsonSerializationContext; import org.junit.jupiter.api.Test; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.mockito.Mockito.mock; import java.lang.reflect.Type; public class MaskedCvcAdapterTest { @Test public void testSerialize() { MaskedCvcAdapter adapter = new MaskedCvcAdapter(); // Здесь можно передать null для Type, так как он не используется JsonElement result = adapter.serialize("123", null, mock(JsonSerializationContext.class)); // Проверяем, что вернулся JsonObject, который содержит свойство "value" с ожидаемым значением assertEquals("***", result.getAsString()); } }Пояснения:
- Передача параметров: Передача
nullдляType, так как методserializeне использует этот параметр непосредственно. - Проверка результата: Вы проверяете, что строка из объекта
JsonElementравна ожидаемому значению "***".
Этот тест теперь более корректен, поскольку он избегает использования ненужных моков и проверяет, что метод возвращает именно ожидаемое значение. Однако если вам нужно проверить, что объект имеет свойство (например,
value), которое равно"***", просто измените проверку:JsonObject resultObject = (JsonObject) result; // какой тип вы ожидаете assertEquals("***", resultObject.get("value").getAsString());Таким образом, ваш тест станет более полным, и вы убедитесь, что не просто возвращается ожидаемая строка, а вы получаете корректный объект JSON.
-
- User
напиши тесты для трех последних методоов public class CachedBodyServletInputStream extends ServletInputStream { private final InputStream cachedBodyInputStream;
public CachedBodyServletInputStream(byte[] cachedBody) { this.cachedBodyInputStream = new ByteArrayInputStream(cachedBody); } @Override public int read() throws IOException { return cachedBodyInputStream.read(); } @SneakyThrows @Override public boolean isFinished() { return cachedBodyInputStream.available() == 0; } @Override public boolean isReady() { return true; } @Override public void setReadListener(ReadListener readListener) { }}
- Assistant
Чтобы протестировать класс
CachedBodyServletInputStream, мы можем написать тесты для трех основных методов:read(),isFinished(), иisReady(). В данном случае, посколькуsetReadListener(ReadListener readListener)ничего не делает (пока что), мы не включим его в тесты, но вы можете легко добавить тест для этого метода, если потребуется.Подготовка теста
Сначала убедитесь, что у вас есть необходимые зависимости для написания тестов. Допустим, вы используете JUnit и Mockito. Пример конфигурации в
pom.xmlдля Maven:<dependency> <groupId>org.junit.jupiter</groupId> <artifactId>junit-jupiter</artifactId> <version>5.7.0</version> <scope>test</scope> </dependency>Пример теста
import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import javax.servlet.ReadListener; import javax.servlet.ServletInputStream; import java.io.IOException; import static org.junit.jupiter.api.Assertions.*; public class CachedBodyServletInputStreamTest { private CachedBodyServletInputStream inputStream; @BeforeEach public void setUp() { // Инициализируем CachedBodyServletInputStream с тестовыми данными byte[] testData = "Hello, World!".getBytes(); inputStream = new CachedBodyServletInputStream(testData); } @Test public void testRead() throws IOException { // Проверяем, что каждый байт читается корректно int byteRead; StringBuilder resultBuilder = new StringBuilder(); while ((byteRead = inputStream.read()) != -1) { resultBuilder.append((char) byteRead); } assertEquals("Hello, World!", resultBuilder.toString()); } @Test public void testIsFinished() throws IOException { // Прочитаем весь ввод while (inputStream.read() != -1) { // Читаем до конца } // Теперь inputStream должен быть "закончен" assertTrue(inputStream.isFinished()); } @Test public void testIsNotFinished() { // В начале inputStream не должен быть "закончен" assertFalse(inputStream.isFinished()); } @Test public void testIsReady() { // Проверяем, что isReady всегда возвращает true assertTrue(inputStream.isReady()); } @Test public void testSetReadListener() { // Убедимся, что метод setReadListener ничего не делает (просто проверка отсутствия исключений) assertDoesNotThrow(() -> inputStream.setReadListener(null)); } }Разбор тестов:
-
testRead():
- Проверяет, что метод
read()правильно считывает байты из потока и собирает их в строку. Мы создаем экземплярCachedBodyServletInputStreamс некоторыми данными и проверяем, что считываемое значение соответствует ожидаемому.
- Проверяет, что метод
-
testIsFinished():
- Считывает все данные из потока, после чего проверяет, что метод
isFinished()возвращаетtrue. Мы ожидаем, что после завершения чтения поток будет считаться "законченным".
- Считывает все данные из потока, после чего проверяет, что метод
-
testIsNotFinished():
- Проверяет, что в начале поток не считается "законченным".
-
testIsReady():
- Проверяет, что метод
isReady()всегда возвращаетtrue.
- Проверяет, что метод
-
testSetReadListener():
- Этот тест прост: он проверяет, что метод
setReadListener()не вызывает никаких исключений (независимо от того, будет ли это действие иметь эффект).
- Этот тест прост: он проверяет, что метод
Заключение
Эти тесты обеспечат покрытие для методов
read(),isFinished(), иisReady(). Имейте в виду, что для более сложных сценариев вам, возможно, придется реализовать дополнительные тесты в будущем, если вы измените логику работы классов. -
- User
на метод getReader() тест public class CachedBodyHttpServletRequest extends HttpServletRequestWrapper {
private final byte[] cachedBody; public CachedBodyHttpServletRequest(HttpServletRequest request) throws IOException { super(request); InputStream requestInputStream = request.getInputStream(); this.cachedBody = StreamUtils.copyToByteArray(requestInputStream); } @Override public ServletInputStream getInputStream() throws IOException { return new CachedBodyServletInputStream(this.cachedBody); } @Override public BufferedReader getReader() throws IOException { ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream(this.cachedBody); return new BufferedReader(new InputStreamReader(byteArrayInputStream)); } - Assistant
Для тестирования метода
getReader()в классеCachedBodyHttpServletRequestпомимо других компонентов, вам понадобятся мок-объекты, чтобы эмулировать поведениеHttpServletRequest. Мы можем использовать библиотеку Mockito для создания мокаHttpServletRequestи проверять, что методgetReader()возвращаетBufferedReader, который считывает данные из кэшированного тела запроса.Пример теста для метода
getReader()import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import javax.servlet.http.HttpServletRequest; import java.io.BufferedReader; import java.io.IOException; import java.io.InputStreamReader; import java.io.Reader; import java.io.StringReader; import java.nio.charset.StandardCharsets; import static org.junit.jupiter.api.Assertions.*; import static org.mockito.Mockito.*; public class CachedBodyHttpServletRequestTest { private HttpServletRequest mockRequest; private CachedBodyHttpServletRequest cachedBodyHttpServletRequest; private final String requestBody = "Hello, World!"; // Тестовое тело запроса @BeforeEach public void setUp() throws IOException { // Создаем мок для HttpServletRequest mockRequest = mock(HttpServletRequest.class); // Устанавливаем поведение мока, когда вызывается getInputStream() when(mockRequest.getInputStream()).thenReturn(new ServletInputStream() { private int index = 0; private final byte[] bodyBytes = requestBody.getBytes(StandardCharsets.UTF_8); @Override public boolean isFinished() { return index >= bodyBytes.length; } @Override public boolean isReady() { return true; } @Override public void setReadListener(ReadListener readListener) { // No-op } @Override public int read() { return (index < bodyBytes.length) ? bodyBytes[index++] : -1; } }); // Инициализируем CachedBodyHttpServletRequest cachedBodyHttpServletRequest = new CachedBodyHttpServletRequest(mockRequest); } @Test public void testGetReader() throws IOException { // Когда вызывается getReader(), он должен вернуть BufferedReader, который читает из кэшированного тела BufferedReader reader = cachedBodyHttpServletRequest.getReader(); // Читаем данные из BufferedReader String line = reader.readLine(); // Проверяем, что строка соответствует ожидаемому значению assertEquals(requestBody, line); // Закрываем reader чтобы освободить ресурсы reader.close(); } }Объяснение теста:
-
Создание мока
HttpServletRequest:- Мы используем Mockito для создания мок-объекта
HttpServletRequest. Устанавливаем поведение, чтобы методgetInputStream()возвращал наш собственныйServletInputStream, который читает исходимый поток байтов изrequestBody.
- Мы используем Mockito для создания мок-объекта
-
Инициализация
CachedBodyHttpServletRequest:- Мы передаем наш мок
HttpServletRequestв конструкторCachedBodyHttpServletRequest. Это создаст кэшированное тело на основе указанногоrequestBody.
- Мы передаем наш мок
-
Тестирование метода
getReader():- Мы вызываем
getReader()и проверяем, что он возвращает действительноBufferedReader, который считывает данные из кэшированного тела. - Используя методы
readLine(), мы получаем строку изBufferedReaderи сравниваем её с исходнымrequestBody, чтобы убедиться, что данные кэшируются и восстанавливаются правильно.
- Мы вызываем
-
Закрытие
BufferedReader:- Мы закрываем
BufferedReader, чтобы освободить ресурсы. Это рекомендуется делать в тестах и в общем использовании, если поток не будет использоваться больше.
- Мы закрываем
Заключение
Таким образом, тест
getReader()гарантирует, что кэшируемые данные правильно читаются из тела запроса, и что классCachedBodyHttpServletRequestработает так, как ожидалось. Если вам нужно будет расширять или дополнять функциональность, вы можете добавлять дополнительные тесты для других краевых случаев и сценариев. -