/
DefaultDittoDiagnosticLoggingAdapterTest.java
341 lines (290 loc) · 13.4 KB
/
DefaultDittoDiagnosticLoggingAdapterTest.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
/*
* Copyright (c) 2020 Contributors to the Eclipse Foundation
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.internal.utils.pekko.logging;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
import static org.assertj.core.api.Assertions.assertThatNullPointerException;
import java.time.Duration;
import java.util.Map;
import org.apache.pekko.event.DiagnosticLoggingAdapter;
import org.assertj.core.api.JUnitSoftAssertions;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TestName;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.junit.MockitoJUnitRunner;
/**
* Unit test for {@link DefaultDittoDiagnosticLoggingAdapter}.
*/
@RunWith(MockitoJUnitRunner.class)
public final class DefaultDittoDiagnosticLoggingAdapterTest {
private static final String CORRELATION_ID_KEY = CommonMdcEntryKey.CORRELATION_ID.toString();
private static final String CONNECTION_ID_KEY = "connection-id";
private static final String CONNECTION_ID_VALUE = "my-connection";
private static final String LOGGER_NAME = DefaultDittoDiagnosticLoggingAdapterTest.class.getName();
@Rule
public final TestName testName = new TestName();
@Rule
public final JUnitSoftAssertions softly = new JUnitSoftAssertions();
@Mock
private DiagnosticLoggingAdapter plainLoggingAdapter;
@Test
public void getInstanceWithNullLogger() {
assertThatNullPointerException()
.isThrownBy(() -> DefaultDittoDiagnosticLoggingAdapter.of(null, LOGGER_NAME))
.withMessage("The loggingAdapter must not be null!")
.withNoCause();
}
@Test
public void getInstanceWithNullLoggerName() {
assertThatNullPointerException()
.isThrownBy(() -> DefaultDittoDiagnosticLoggingAdapter.of(plainLoggingAdapter, null))
.withMessage("The loggerName must not be null!")
.withNoCause();
}
@Test
public void getInstanceWithBlankLoggerName() {
assertThatIllegalArgumentException()
.isThrownBy(() -> DefaultDittoDiagnosticLoggingAdapter.of(plainLoggingAdapter, ""))
.withMessage("The argument 'loggerName' must not be empty!")
.withNoCause();
}
@Test
public void getNameReturnsExpected() {
final DefaultDittoDiagnosticLoggingAdapter underTest =
DefaultDittoDiagnosticLoggingAdapter.of(plainLoggingAdapter, LOGGER_NAME);
assertThat(underTest.getName()).isEqualTo(LOGGER_NAME);
}
@Test
public void withCorrelationIdLogInfo() {
final String correlationId = getCorrelationId();
final String msg1 = "Foo!";
final String msg2 = "Bar!";
Mockito.when(plainLoggingAdapter.isInfoEnabled()).thenReturn(true);
final DefaultDittoDiagnosticLoggingAdapter underTest =
DefaultDittoDiagnosticLoggingAdapter.of(plainLoggingAdapter, LOGGER_NAME);
underTest.withCorrelationId(correlationId);
underTest.info(msg1);
underTest.info(msg2);
Mockito.verify(plainLoggingAdapter, Mockito.times(2)).setMDC(Map.of(CORRELATION_ID_KEY, correlationId));
Mockito.verify(plainLoggingAdapter).notifyInfo(msg1);
Mockito.verify(plainLoggingAdapter).notifyInfo(msg2);
}
@Test
public void withMdcEntryLogDebug() {
final String msg = "Foo!";
Mockito.when(plainLoggingAdapter.isDebugEnabled()).thenReturn(true);
final DefaultDittoDiagnosticLoggingAdapter underTest =
DefaultDittoDiagnosticLoggingAdapter.of(plainLoggingAdapter, LOGGER_NAME);
underTest.withMdcEntry(CONNECTION_ID_KEY, CONNECTION_ID_VALUE);
underTest.debug(msg);
Mockito.verify(plainLoggingAdapter).setMDC(Map.of(CONNECTION_ID_KEY, CONNECTION_ID_VALUE));
Mockito.verify(plainLoggingAdapter).notifyDebug(msg);
}
@Test
public void withTwoMdcEntryPairsLogDebug() {
final String correlationId = getCorrelationId();
final String msg = "Foo!";
Mockito.when(plainLoggingAdapter.isDebugEnabled()).thenReturn(true);
final DefaultDittoDiagnosticLoggingAdapter underTest =
DefaultDittoDiagnosticLoggingAdapter.of(plainLoggingAdapter, LOGGER_NAME);
underTest.withMdcEntries(CORRELATION_ID_KEY, correlationId, CONNECTION_ID_KEY, CONNECTION_ID_VALUE);
underTest.debug(msg);
Mockito.verify(plainLoggingAdapter)
.setMDC(Map.of(CORRELATION_ID_KEY, correlationId, CONNECTION_ID_KEY, CONNECTION_ID_VALUE));
Mockito.verify(plainLoggingAdapter).notifyDebug(msg);
}
@Test
public void withThreeMdcEntryPairsLogDebug() {
final String correlationId = getCorrelationId();
final String k3 = "plumbus";
final String v3 = "fleeb";
final String msg = "Foo!";
Mockito.when(plainLoggingAdapter.isDebugEnabled()).thenReturn(true);
final DefaultDittoDiagnosticLoggingAdapter underTest =
DefaultDittoDiagnosticLoggingAdapter.of(plainLoggingAdapter, LOGGER_NAME);
underTest.withMdcEntries(CORRELATION_ID_KEY, correlationId, CONNECTION_ID_KEY, CONNECTION_ID_VALUE, k3, v3);
underTest.debug(msg);
Mockito.verify(plainLoggingAdapter)
.setMDC(Map.of(CORRELATION_ID_KEY, correlationId, CONNECTION_ID_KEY, CONNECTION_ID_VALUE, k3, v3));
Mockito.verify(plainLoggingAdapter).notifyDebug(msg);
}
@Test
public void withTwoMdcEntriesLogWarning() {
final String correlationId = getCorrelationId();
final String msg = "Foo!";
Mockito.when(plainLoggingAdapter.isWarningEnabled()).thenReturn(true);
final DefaultDittoDiagnosticLoggingAdapter underTest =
DefaultDittoDiagnosticLoggingAdapter.of(plainLoggingAdapter, LOGGER_NAME);
underTest.withMdcEntry(MdcEntry.of(CORRELATION_ID_KEY, correlationId),
MdcEntry.of(CONNECTION_ID_KEY, CONNECTION_ID_VALUE));
underTest.warning(msg);
Mockito.verify(plainLoggingAdapter)
.setMDC(Map.of(CORRELATION_ID_KEY, correlationId, CONNECTION_ID_KEY, CONNECTION_ID_VALUE));
Mockito.verify(plainLoggingAdapter).notifyWarning(msg);
}
@Test
public void logDebugAndWarnWithTwoMdcValuesThenDiscardMdcEntries() {
final String correlationId = getCorrelationId();
final String connectionId = "my-connection";
final String debugMsg = "Foo!";
final String warnMsg = "Behold!";
Mockito.when(plainLoggingAdapter.isDebugEnabled()).thenReturn(true);
Mockito.when(plainLoggingAdapter.isWarningEnabled()).thenReturn(true);
final DefaultDittoDiagnosticLoggingAdapter underTest =
DefaultDittoDiagnosticLoggingAdapter.of(plainLoggingAdapter, LOGGER_NAME);
underTest.putMdcEntry(CORRELATION_ID_KEY, correlationId);
underTest.putMdcEntry(CONNECTION_ID_KEY, connectionId);
underTest.debug(debugMsg);
underTest.warning(warnMsg);
underTest.discardMdcEntries();
Mockito.verify(plainLoggingAdapter).notifyDebug(debugMsg);
Mockito.verify(plainLoggingAdapter).notifyWarning(warnMsg);
Mockito.verify(plainLoggingAdapter, Mockito.times(2))
.setMDC(Map.of(CORRELATION_ID_KEY, correlationId, CONNECTION_ID_KEY, connectionId));
Mockito.verify(plainLoggingAdapter).setMDC(Map.of());
}
@Test
public void removeMdcEntryViaKey() {
Mockito.when(plainLoggingAdapter.isDebugEnabled()).thenReturn(true);
final String correlationId = getCorrelationId();
final String connectionId = "my-connection";
final DefaultDittoDiagnosticLoggingAdapter underTest =
DefaultDittoDiagnosticLoggingAdapter.of(plainLoggingAdapter, LOGGER_NAME);
underTest.putMdcEntry(CORRELATION_ID_KEY, correlationId);
underTest.putMdcEntry(CONNECTION_ID_KEY, connectionId);
underTest.debug("Foo");
underTest.removeMdcEntry(CONNECTION_ID_KEY);
underTest.debug("Bar");
Mockito.verify(plainLoggingAdapter)
.setMDC(Map.of(CORRELATION_ID_KEY, correlationId, CONNECTION_ID_KEY, connectionId));
Mockito.verify(plainLoggingAdapter).setMDC(Map.of(CORRELATION_ID_KEY, correlationId));
}
@Test
public void removeMdcEntryViaNullValue() {
Mockito.when(plainLoggingAdapter.isDebugEnabled()).thenReturn(true);
final String correlationId = getCorrelationId();
final String connectionId = "my-connection";
final DefaultDittoDiagnosticLoggingAdapter underTest =
DefaultDittoDiagnosticLoggingAdapter.of(plainLoggingAdapter, LOGGER_NAME);
underTest.putMdcEntry(CORRELATION_ID_KEY, correlationId);
underTest.putMdcEntry(CONNECTION_ID_KEY, connectionId);
underTest.debug("Foo");
underTest.putMdcEntry(CORRELATION_ID_KEY, null);
underTest.debug("Bar");
Mockito.verify(plainLoggingAdapter)
.setMDC(Map.of(CORRELATION_ID_KEY, correlationId, CONNECTION_ID_KEY, connectionId));
Mockito.verify(plainLoggingAdapter).setMDC(Map.of(CONNECTION_ID_KEY, connectionId));
}
@Test
public void logMoreThan4LoggingArgsError() {
final String template = "one: {}, two: {}, three: {}, four: {}, five: {}, six: {}";
Mockito.when(plainLoggingAdapter.isErrorEnabled()).thenReturn(true);
final DefaultDittoDiagnosticLoggingAdapter underTest =
DefaultDittoDiagnosticLoggingAdapter.of(plainLoggingAdapter, LOGGER_NAME);
underTest.error(template,
"one",
"two",
"three",
"four",
"five",
"six");
Mockito.verify(plainLoggingAdapter, Mockito.atLeastOnce()).isErrorEnabled();
Mockito.verify(plainLoggingAdapter).notifyError(String.format(template.replace("{}", "%s"),
"one",
"two",
"three",
"four",
"five",
"six"
));
}
@Test
public void logMoreThan4LoggingArgsWarning() {
final String template = "one: {}, two: {}, three: {}, four: {}, five: {}, six: {}, seven: {}";
final Duration oneSecond = Duration.ofSeconds(1);
final Duration twoSeconds = Duration.ofSeconds(2);
final Duration threeSeconds = Duration.ofSeconds(3);
final Duration fourSeconds = Duration.ofSeconds(4);
final Duration fiveSeconds = Duration.ofSeconds(5);
final Duration sixSeconds = Duration.ofSeconds(6);
final Duration sevenSeconds = Duration.ofSeconds(7);
Mockito.when(plainLoggingAdapter.isWarningEnabled()).thenReturn(true);
final DefaultDittoDiagnosticLoggingAdapter underTest =
DefaultDittoDiagnosticLoggingAdapter.of(plainLoggingAdapter, LOGGER_NAME);
underTest.warning(template,
oneSecond,
twoSeconds,
threeSeconds,
fourSeconds,
fiveSeconds,
sixSeconds,
sevenSeconds);
Mockito.verify(plainLoggingAdapter, Mockito.atLeastOnce()).isWarningEnabled();
Mockito.verify(plainLoggingAdapter).notifyWarning(String.format(template.replace("{}", "%s"),
oneSecond,
twoSeconds,
threeSeconds,
fourSeconds,
fiveSeconds,
sixSeconds,
sevenSeconds
));
}
@Test
public void logMoreThan4LoggingArgsInfo() {
final String template = "one: {}, two: {}, three: {}, four: {}, five: {}";
Mockito.when(plainLoggingAdapter.isInfoEnabled()).thenReturn(true);
final DefaultDittoDiagnosticLoggingAdapter underTest =
DefaultDittoDiagnosticLoggingAdapter.of(plainLoggingAdapter, LOGGER_NAME);
underTest.info(template,
1,
2,
3,
4,
5);
Mockito.verify(plainLoggingAdapter, Mockito.atLeastOnce()).isInfoEnabled();
Mockito.verify(plainLoggingAdapter).notifyInfo(String.format(template.replace("{}", "%s"),
1,
2,
3,
4,
5
));
}
@Test
public void logMoreThan4LoggingArgsDebug() {
Mockito.when(plainLoggingAdapter.isDebugEnabled()).thenReturn(true);
final String template = "one: {}, two: {}, three: {}, four: {}, five: {}";
final DefaultDittoDiagnosticLoggingAdapter underTest =
DefaultDittoDiagnosticLoggingAdapter.of(plainLoggingAdapter, LOGGER_NAME);
underTest.debug(template,
1,
2,
3,
4,
"foobar");
Mockito.verify(plainLoggingAdapter, Mockito.atLeastOnce()).isDebugEnabled();
Mockito.verify(plainLoggingAdapter).notifyDebug(String.format(template.replace("{}", "%s"),
1,
2,
3,
4,
"foobar"));
}
private String getCorrelationId() {
return testName.getMethodName();
}
}