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
|
/*
* Copyright © 2016-2017 European Support Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openecomp.sdc.logging.slf4j;
import static org.junit.Assert.assertTrue;
import static org.junit.Assume.assumeTrue;
import static org.openecomp.sdc.logging.slf4j.ContextPropagationTestHelper.EXPECT_EMPTY;
import static org.openecomp.sdc.logging.slf4j.ContextPropagationTestHelper.EXPECT_EXCEPTION_FROM_INNER;
import static org.openecomp.sdc.logging.slf4j.ContextPropagationTestHelper.EXPECT_INNER_RUN;
import static org.openecomp.sdc.logging.slf4j.ContextPropagationTestHelper.EXPECT_NOT_COPIED;
import static org.openecomp.sdc.logging.slf4j.ContextPropagationTestHelper.EXPECT_OUTER_RUN;
import static org.openecomp.sdc.logging.slf4j.ContextPropagationTestHelper.EXPECT_POPULATED;
import static org.openecomp.sdc.logging.slf4j.ContextPropagationTestHelper.EXPECT_PROPAGATED_TO_CHILD;
import static org.openecomp.sdc.logging.slf4j.ContextPropagationTestHelper.EXPECT_REMAIN_EMPTY;
import static org.openecomp.sdc.logging.slf4j.ContextPropagationTestHelper.EXPECT_REPLACED_WITH_STORED;
import static org.openecomp.sdc.logging.slf4j.ContextPropagationTestHelper.EXPECT_RETAINED_IN_CURRENT;
import static org.openecomp.sdc.logging.slf4j.ContextPropagationTestHelper.EXPECT_RETAINED_IN_PARENT;
import static org.openecomp.sdc.logging.slf4j.ContextPropagationTestHelper.EXPECT_REVERTED_ON_EXCEPTION;
import static org.openecomp.sdc.logging.slf4j.ContextPropagationTestHelper.IS_SUITABLE_LOGBACK_VERSION;
import static org.openecomp.sdc.logging.slf4j.ContextPropagationTestHelper.assertContextEmpty;
import static org.openecomp.sdc.logging.slf4j.ContextPropagationTestHelper.assertContextFields;
import static org.openecomp.sdc.logging.slf4j.ContextPropagationTestHelper.putUniqueValues;
import java.util.Map;
import java.util.concurrent.atomic.AtomicBoolean;
import org.junit.Before;
import org.junit.Test;
import org.openecomp.sdc.logging.spi.LoggingContextService;
/**
* Unit-testing logging context propagation to Runnable.
*
* @author evitaliy
* @since 08 Jan 18
*/
@SuppressWarnings("DefaultAnnotationParam")
public class RunnableContextPropagationTest {
private final LoggingContextService ctxService = new SLF4JLoggingServiceProvider();
@Before
public void checkSuitableLogbackVersion() {
assumeTrue(IS_SUITABLE_LOGBACK_VERSION);
}
@Test
public void contextNotCopiedToChildThreadByDefault() throws InterruptedException {
Map<ContextField, String> values = putUniqueValues();
AtomicBoolean complete = new AtomicBoolean(false);
// create thread right away without copying context
Thread thread = new Thread(() -> {
assertContextEmpty("Data unexpectedly copied to a child thread. "
+ "Are you using an old version of SLF4J diagnostic context implementation (e.g. logback)?");
complete.set(true);
});
thread.start();
thread.join();
assertContextFields(EXPECT_RETAINED_IN_CURRENT, values);
assertTrue(EXPECT_INNER_RUN, complete.get());
}
@Test
public void contextCopiedWhenToRunnableCalled() throws InterruptedException {
Map<ContextField, String> values = putUniqueValues();
AtomicBoolean complete = new AtomicBoolean(false);
// pass the runnable to the context service first
Thread thread = new Thread(ctxService.copyToRunnable(() -> {
assertContextFields(EXPECT_PROPAGATED_TO_CHILD, values);
complete.set(true);
}));
thread.start();
thread.join();
assertContextFields(EXPECT_RETAINED_IN_CURRENT, values);
assertTrue(EXPECT_INNER_RUN, complete.get());
}
@Test
public void copiedContextRetainedEvenWhenAnotherPushed() throws InterruptedException {
Map<ContextField, String> innerValues = putUniqueValues();
AtomicBoolean innerComplete = new AtomicBoolean(false);
// should run with the context of main thread
Runnable inner = ctxService.copyToRunnable(() -> {
assertContextFields(EXPECT_PROPAGATED_TO_CHILD, innerValues);
innerComplete.set(true);
});
// pushes its context, but the inner must run with its own context
AtomicBoolean outerComplete = new AtomicBoolean(false);
Thread outer = new Thread(() -> {
Map<ContextField, String> outerValues = putUniqueValues();
inner.run();
assertContextFields(EXPECT_REPLACED_WITH_STORED, outerValues);
outerComplete.set(true);
});
outer.start();
outer.join();
assertContextFields(EXPECT_RETAINED_IN_CURRENT, innerValues);
assertTrue(EXPECT_OUTER_RUN, outerComplete.get());
assertTrue(EXPECT_INNER_RUN, innerComplete.get());
}
@Test
public void contextRemainsEmptyWhenParentWasEmpty() throws InterruptedException {
ctxService.clear();
assertContextEmpty(EXPECT_EMPTY);
final AtomicBoolean complete = new AtomicBoolean(false);
Runnable runnable = ctxService.copyToRunnable(() -> {
assertContextEmpty(EXPECT_EMPTY);
complete.set(true);
});
Thread thread = new Thread(runnable);
thread.start();
thread.join();
assertContextEmpty(EXPECT_EMPTY);
assertTrue(EXPECT_INNER_RUN, complete.get());
}
@Test
public void childThreadCleanedUpAfterRunnableRuns() throws Exception {
Map<ContextField, String> innerValues = putUniqueValues();
AtomicBoolean innerComplete = new AtomicBoolean(false);
// should run with the context of main thread
Runnable inner = ctxService.copyToRunnable(() -> {
assertContextFields(EXPECT_PROPAGATED_TO_CHILD, innerValues);
innerComplete.set(true);
});
// pushes its own context, but runs the inner
AtomicBoolean outerComplete = new AtomicBoolean(false);
Thread outer = new Thread(() -> {
assertContextEmpty(EXPECT_NOT_COPIED);
inner.run();
assertContextEmpty(EXPECT_REMAIN_EMPTY);
outerComplete.set(true);
});
outer.start();
outer.join();
assertContextFields(EXPECT_RETAINED_IN_PARENT, innerValues);
assertTrue(EXPECT_OUTER_RUN, outerComplete.get());
assertTrue(EXPECT_INNER_RUN, innerComplete.get());
}
@Test
public void childThreadCleanedUpAfterException() throws Exception {
Map<ContextField, String> innerValues = putUniqueValues();
// should run with the context of main thread
AtomicBoolean innerComplete = new AtomicBoolean(false);
Runnable inner = ctxService.copyToRunnable(() -> {
assertContextFields(EXPECT_PROPAGATED_TO_CHILD, innerValues);
innerComplete.set(true);
throw new IllegalArgumentException();
});
// pushes its own context, but runs the inner runnable
AtomicBoolean outerComplete = new AtomicBoolean(false);
AtomicBoolean exceptionThrown = new AtomicBoolean(false);
Thread outer = new Thread(() -> {
Map<ContextField, String> outerValues = putUniqueValues();
assertContextFields(EXPECT_POPULATED, outerValues);
try {
inner.run();
} catch (IllegalArgumentException e) {
exceptionThrown.set(true);
} finally {
assertContextFields(EXPECT_REVERTED_ON_EXCEPTION, outerValues);
outerComplete.set(true);
}
});
outer.start();
outer.join();
assertContextFields(EXPECT_RETAINED_IN_PARENT, innerValues);
assertTrue(EXPECT_OUTER_RUN, outerComplete.get());
assertTrue(EXPECT_INNER_RUN, innerComplete.get());
assertTrue(EXPECT_EXCEPTION_FROM_INNER, exceptionThrown.get());
}
}
|
