Skip to content

Commit 32dbd0e

Browse files
committed
add test assertion to verify logger not enabled at levels when env not set. also some cleanups.
1 parent df97834 commit 32dbd0e

File tree

1 file changed

+15
-45
lines changed

1 file changed

+15
-45
lines changed

gax-java/gax/src/test/java/com/google/api/gax/logging/LoggingUtilsTest.java

Lines changed: 15 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -30,24 +30,18 @@
3030

3131
package com.google.api.gax.logging;
3232

33-
import static org.junit.Assert.assertEquals;
34-
import static org.junit.Assert.assertFalse;
35-
import static org.junit.Assert.assertNotEquals;
36-
import static org.junit.Assert.assertTrue;
3733
import static org.mockito.ArgumentMatchers.anyString;
3834
import static org.mockito.Mockito.mock;
3935
import static org.mockito.Mockito.when;
4036

4137
import ch.qos.logback.classic.LoggerContext;
42-
import ch.qos.logback.classic.encoder.PatternLayoutEncoder;
4338
import ch.qos.logback.classic.spi.ILoggingEvent;
44-
import ch.qos.logback.core.ConsoleAppender;
4539
import com.google.api.gax.logging.LoggingUtils.LoggerFactoryProvider;
4640
import com.google.api.gax.rpc.internal.EnvironmentProvider;
4741
import java.util.HashMap;
4842
import java.util.Map;
4943
import org.junit.jupiter.api.AfterEach;
50-
import org.junit.jupiter.api.BeforeEach;
44+
import org.junit.jupiter.api.Assertions;
5145
import org.junit.jupiter.api.Test;
5246
import org.mockito.Mockito;
5347
import org.slf4j.ILoggerFactory;
@@ -60,32 +54,6 @@ class LoggingUtilsTest {
6054
private static final Logger LOGGER = LoggerFactory.getLogger(LoggingUtilsTest.class);
6155
private EnvironmentProvider envProvider = Mockito.mock(EnvironmentProvider.class);
6256

63-
@BeforeEach
64-
void setup() {
65-
EnvironmentProvider envProvider = Mockito.mock(EnvironmentProvider.class);
66-
67-
// need to setup a ConsoleAppender and attach to root logger because TestAppender
68-
// does not correctly capture MDC info
69-
LoggerContext loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory();
70-
71-
PatternLayoutEncoder patternLayoutEncoder = new PatternLayoutEncoder();
72-
patternLayoutEncoder.setPattern("%-4relative [%thread] %-5level %logger{35} - %msg%n");
73-
patternLayoutEncoder.setContext(loggerContext);
74-
75-
patternLayoutEncoder.start();
76-
77-
ConsoleAppender<ILoggingEvent> consoleAppender = new ConsoleAppender<>();
78-
consoleAppender.setEncoder(patternLayoutEncoder);
79-
80-
consoleAppender.setContext(loggerContext);
81-
consoleAppender.setName("CONSOLE");
82-
83-
consoleAppender.start();
84-
85-
ch.qos.logback.classic.Logger rootLogger = loggerContext.getLogger(Logger.ROOT_LOGGER_NAME);
86-
rootLogger.addAppender(consoleAppender);
87-
}
88-
8957
@AfterEach
9058
void tearDown() {
9159
LoggerContext loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory();
@@ -97,8 +65,8 @@ void testGetLogger_loggingEnabled_slf4jBindingPresent() {
9765
Mockito.when(envProvider.getenv(LoggingUtils.GOOGLE_SDK_JAVA_LOGGING)).thenReturn("true");
9866
LoggingUtils.setEnvironmentProvider(envProvider);
9967
Logger logger = LoggingUtils.getLogger(LoggingUtilsTest.class);
100-
assertTrue(logger instanceof org.slf4j.Logger);
101-
assertNotEquals(logger.getClass(), NOPLogger.class);
68+
Assertions.assertInstanceOf(Logger.class, logger);
69+
Assertions.assertNotEquals(NOPLogger.class, logger.getClass());
10270
}
10371

10472
@Test
@@ -107,7 +75,9 @@ void testGetLogger_loggingDisabled() {
10775
LoggingUtils.setEnvironmentProvider(envProvider);
10876

10977
Logger logger = LoggingUtils.getLogger(LoggingUtilsTest.class);
110-
assertEquals(NOPLogger.class, logger.getClass());
78+
Assertions.assertEquals(NOPLogger.class, logger.getClass());
79+
Assertions.assertFalse(logger.isInfoEnabled());
80+
Assertions.assertFalse(logger.isDebugEnabled());
11181
}
11282

11383
@Test
@@ -125,26 +95,26 @@ void testGetLogger_loggingEnabled_noBinding() {
12595
Logger logger = LoggingUtils.getLogger(LoggingUtilsTest.class, mockLoggerFactoryProvider);
12696

12797
// Assert that the returned logger is a NOPLogger
128-
assertTrue(logger instanceof org.slf4j.helpers.NOPLogger);
98+
Assertions.assertInstanceOf(NOPLogger.class, logger);
12999
}
130100

131101
@Test
132102
void testIsLoggingEnabled_true() {
133103
Mockito.when(envProvider.getenv(LoggingUtils.GOOGLE_SDK_JAVA_LOGGING)).thenReturn("true");
134104
LoggingUtils.setEnvironmentProvider(envProvider);
135-
assertTrue(LoggingUtils.isLoggingEnabled());
105+
Assertions.assertTrue(LoggingUtils.isLoggingEnabled());
136106
Mockito.when(envProvider.getenv(LoggingUtils.GOOGLE_SDK_JAVA_LOGGING)).thenReturn("TRUE");
137107
LoggingUtils.setEnvironmentProvider(envProvider);
138-
assertTrue(LoggingUtils.isLoggingEnabled());
108+
Assertions.assertTrue(LoggingUtils.isLoggingEnabled());
139109
Mockito.when(envProvider.getenv(LoggingUtils.GOOGLE_SDK_JAVA_LOGGING)).thenReturn("True");
140110
LoggingUtils.setEnvironmentProvider(envProvider);
141-
assertTrue(LoggingUtils.isLoggingEnabled());
111+
Assertions.assertTrue(LoggingUtils.isLoggingEnabled());
142112
}
143113

144114
@Test
145115
void testIsLoggingEnabled_defaultToFalse() {
146116
LoggingUtils.setEnvironmentProvider(envProvider);
147-
assertFalse(LoggingUtils.isLoggingEnabled());
117+
Assertions.assertFalse(LoggingUtils.isLoggingEnabled());
148118
}
149119

150120
private TestAppender setupTestLogger(Class<?> clazz) {
@@ -156,20 +126,20 @@ private TestAppender setupTestLogger(Class<?> clazz) {
156126
}
157127

158128
@Test
159-
public void testLogWithMDC_slf4jLogger() {
129+
void testLogWithMDC_slf4jLogger() {
160130
TestAppender testAppender = setupTestLogger(LoggingUtilsTest.class);
161131
Map<String, String> contextMap = new HashMap<>();
162132
contextMap.put("key", "value");
163133
LoggingUtils.logWithMDC(LOGGER, org.slf4j.event.Level.DEBUG, contextMap, "test message");
164134

165-
assertEquals(1, testAppender.events.size());
166-
assertEquals(
135+
Assertions.assertEquals(1, testAppender.events.size());
136+
Assertions.assertEquals(
167137
"{\"message\":\"test message\",\"key\":\"value\"}",
168138
testAppender.events.get(0).getFormattedMessage());
169139

170140
// Verify MDC content
171141
ILoggingEvent event = testAppender.events.get(0);
172-
assertEquals("value", event.getMDCPropertyMap().get("key"));
142+
Assertions.assertEquals("value", event.getMDCPropertyMap().get("key"));
173143
testAppender.stop();
174144
}
175145
}

0 commit comments

Comments
 (0)