-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
ExtensionContextTests.java
318 lines (268 loc) · 13.9 KB
/
ExtensionContextTests.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
/*
* Copyright 2015-2018 the original author or authors.
*
* All rights reserved. This program and the accompanying materials are
* made available under the terms of the Eclipse Public License v2.0 which
* accompanies this distribution and is available at
*
* http://www.eclipse.org/legal/epl-v20.html
*/
package org.junit.jupiter.engine.execution;
import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertAll;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.DynamicTest.dynamicTest;
import static org.mockito.Mockito.mock;
import java.lang.reflect.Method;
import java.util.Collections;
import java.util.Map;
import java.util.Optional;
import java.util.stream.Stream;
import org.junit.jupiter.api.DynamicTest;
import org.junit.jupiter.api.Tag;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.TestFactory;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.junit.jupiter.api.extension.ExtensionContext.Namespace;
import org.junit.jupiter.engine.descriptor.ClassExtensionContext;
import org.junit.jupiter.engine.descriptor.ClassTestDescriptor;
import org.junit.jupiter.engine.descriptor.JupiterEngineDescriptor;
import org.junit.jupiter.engine.descriptor.JupiterEngineExtensionContext;
import org.junit.jupiter.engine.descriptor.MethodExtensionContext;
import org.junit.jupiter.engine.descriptor.NestedClassTestDescriptor;
import org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor;
import org.junit.platform.commons.util.PreconditionViolationException;
import org.junit.platform.engine.ConfigurationParameters;
import org.junit.platform.engine.EngineExecutionListener;
import org.junit.platform.engine.TestDescriptor;
import org.junit.platform.engine.UniqueId;
import org.junit.platform.engine.reporting.ReportEntry;
import org.junit.platform.engine.support.hierarchical.OpenTest4JAwareThrowableCollector;
import org.mockito.ArgumentCaptor;
import org.mockito.Mockito;
/**
* Unit tests for concrete implementations of {@link ExtensionContext}:
* {@link JupiterEngineExtensionContext}, {@link ClassExtensionContext}, and
* {@link MethodExtensionContext}.
*
* @since 5.0
* @see ExtensionValuesStoreTests
*/
class ExtensionContextTests {
private final ConfigurationParameters configParams = mock(ConfigurationParameters.class);
@Test
void fromJupiterEngineDescriptor() {
JupiterEngineDescriptor engineTestDescriptor = new JupiterEngineDescriptor(
UniqueId.root("engine", "junit-jupiter"));
JupiterEngineExtensionContext engineContext = new JupiterEngineExtensionContext(null, engineTestDescriptor,
configParams);
// @formatter:off
assertAll("engineContext",
() -> assertThat(engineContext.getElement()).isEmpty(),
() -> assertThat(engineContext.getTestClass()).isEmpty(),
() -> assertThat(engineContext.getTestInstance()).isEmpty(),
() -> assertThat(engineContext.getTestMethod()).isEmpty(),
() -> assertThrows(PreconditionViolationException.class, () -> engineContext.getRequiredTestClass()),
() -> assertThrows(PreconditionViolationException.class, () -> engineContext.getRequiredTestInstance()),
() -> assertThrows(PreconditionViolationException.class, () -> engineContext.getRequiredTestMethod()),
() -> assertThat(engineContext.getDisplayName()).isEqualTo(engineTestDescriptor.getDisplayName()),
() -> assertThat(engineContext.getParent()).isEmpty(),
() -> assertThat(engineContext.getRoot()).isSameAs(engineContext)
);
// @formatter:on
}
@Test
@SuppressWarnings("resource")
void fromClassTestDescriptor() {
ClassTestDescriptor nestedClassDescriptor = nestedClassDescriptor();
ClassTestDescriptor outerClassDescriptor = outerClassDescriptor(nestedClassDescriptor);
ClassExtensionContext outerExtensionContext = new ClassExtensionContext(null, null, outerClassDescriptor,
configParams, null);
// @formatter:off
assertAll("outerContext",
() -> assertThat(outerExtensionContext.getElement()).contains(OuterClass.class),
() -> assertThat(outerExtensionContext.getTestClass()).contains(OuterClass.class),
() -> assertThat(outerExtensionContext.getTestInstance()).isEmpty(),
() -> assertThat(outerExtensionContext.getTestMethod()).isEmpty(),
() -> assertThat(outerExtensionContext.getRequiredTestClass()).isEqualTo(OuterClass.class),
() -> assertThrows(PreconditionViolationException.class, () -> outerExtensionContext.getRequiredTestInstance()),
() -> assertThrows(PreconditionViolationException.class, () -> outerExtensionContext.getRequiredTestMethod()),
() -> assertThat(outerExtensionContext.getDisplayName()).isEqualTo(outerClassDescriptor.getDisplayName()),
() -> assertThat(outerExtensionContext.getParent()).isEmpty()
);
// @formatter:on
ClassExtensionContext nestedExtensionContext = new ClassExtensionContext(outerExtensionContext, null,
nestedClassDescriptor, configParams, null);
assertThat(nestedExtensionContext.getParent()).containsSame(outerExtensionContext);
}
@Test
@SuppressWarnings("resource")
void tagsCanBeRetrievedInExtensionContext() {
ClassTestDescriptor nestedClassDescriptor = nestedClassDescriptor();
ClassTestDescriptor outerClassDescriptor = outerClassDescriptor(nestedClassDescriptor);
TestMethodTestDescriptor methodTestDescriptor = methodDescriptor();
outerClassDescriptor.addChild(methodTestDescriptor);
ClassExtensionContext outerExtensionContext = new ClassExtensionContext(null, null, outerClassDescriptor,
configParams, null);
assertThat(outerExtensionContext.getTags()).containsExactly("outer-tag");
assertThat(outerExtensionContext.getRoot()).isSameAs(outerExtensionContext);
ClassExtensionContext nestedExtensionContext = new ClassExtensionContext(outerExtensionContext, null,
nestedClassDescriptor, configParams, null);
assertThat(nestedExtensionContext.getTags()).containsExactlyInAnyOrder("outer-tag", "nested-tag");
assertThat(nestedExtensionContext.getRoot()).isSameAs(outerExtensionContext);
MethodExtensionContext methodExtensionContext = new MethodExtensionContext(outerExtensionContext, null,
methodTestDescriptor, configParams, new OuterClass(), new OpenTest4JAwareThrowableCollector());
assertThat(methodExtensionContext.getTags()).containsExactlyInAnyOrder("outer-tag", "method-tag");
assertThat(methodExtensionContext.getRoot()).isSameAs(outerExtensionContext);
}
@Test
@SuppressWarnings("resource")
void fromMethodTestDescriptor() {
TestMethodTestDescriptor methodTestDescriptor = methodDescriptor();
ClassTestDescriptor classTestDescriptor = outerClassDescriptor(methodTestDescriptor);
JupiterEngineDescriptor engineDescriptor = new JupiterEngineDescriptor(UniqueId.forEngine("junit-jupiter"));
engineDescriptor.addChild(classTestDescriptor);
Object testInstance = new OuterClass();
Method testMethod = methodTestDescriptor.getTestMethod();
JupiterEngineExtensionContext engineExtensionContext = new JupiterEngineExtensionContext(null, engineDescriptor,
configParams);
ClassExtensionContext classExtensionContext = new ClassExtensionContext(engineExtensionContext, null,
classTestDescriptor, configParams, null);
MethodExtensionContext methodExtensionContext = new MethodExtensionContext(classExtensionContext, null,
methodTestDescriptor, configParams, testInstance, new OpenTest4JAwareThrowableCollector());
// @formatter:off
assertAll("methodContext",
() -> assertThat(methodExtensionContext.getElement()).contains(testMethod),
() -> assertThat(methodExtensionContext.getTestClass()).contains(OuterClass.class),
() -> assertThat(methodExtensionContext.getTestInstance()).contains(testInstance),
() -> assertThat(methodExtensionContext.getTestMethod()).contains(testMethod),
() -> assertThat(methodExtensionContext.getRequiredTestClass()).isEqualTo(OuterClass.class),
() -> assertThat(methodExtensionContext.getRequiredTestInstance()).isEqualTo(testInstance),
() -> assertThat(methodExtensionContext.getRequiredTestMethod()).isEqualTo(testMethod),
() -> assertThat(methodExtensionContext.getDisplayName()).isEqualTo(methodTestDescriptor.getDisplayName()),
() -> assertThat(methodExtensionContext.getParent()).contains(classExtensionContext),
() -> assertThat(methodExtensionContext.getRoot()).isSameAs(engineExtensionContext)
);
// @formatter:on
}
@Test
@SuppressWarnings("resource")
void reportEntriesArePublishedToExecutionContext() {
ClassTestDescriptor classTestDescriptor = outerClassDescriptor(null);
EngineExecutionListener engineExecutionListener = Mockito.spy(EngineExecutionListener.class);
ExtensionContext extensionContext = new ClassExtensionContext(null, engineExecutionListener,
classTestDescriptor, configParams, null);
Map<String, String> map1 = Collections.singletonMap("key", "value");
Map<String, String> map2 = Collections.singletonMap("other key", "other value");
extensionContext.publishReportEntry(map1);
extensionContext.publishReportEntry(map2);
extensionContext.publishReportEntry("3rd key", "third value");
ArgumentCaptor<ReportEntry> entryCaptor = ArgumentCaptor.forClass(ReportEntry.class);
Mockito.verify(engineExecutionListener, Mockito.times(3)).reportingEntryPublished(
Mockito.eq(classTestDescriptor), entryCaptor.capture());
ReportEntry reportEntry1 = entryCaptor.getAllValues().get(0);
ReportEntry reportEntry2 = entryCaptor.getAllValues().get(1);
ReportEntry reportEntry3 = entryCaptor.getAllValues().get(2);
assertEquals(map1, reportEntry1.getKeyValuePairs());
assertEquals(map2, reportEntry2.getKeyValuePairs());
assertEquals("third value", reportEntry3.getKeyValuePairs().get("3rd key"));
}
@Test
@SuppressWarnings("resource")
void usingStore() {
TestMethodTestDescriptor methodTestDescriptor = methodDescriptor();
ClassTestDescriptor classTestDescriptor = outerClassDescriptor(methodTestDescriptor);
ExtensionContext parentContext = new ClassExtensionContext(null, null, classTestDescriptor, configParams, null);
MethodExtensionContext childContext = new MethodExtensionContext(parentContext, null, methodTestDescriptor,
configParams, new OuterClass(), new OpenTest4JAwareThrowableCollector());
ExtensionContext.Store childStore = childContext.getStore(Namespace.GLOBAL);
ExtensionContext.Store parentStore = parentContext.getStore(Namespace.GLOBAL);
final Object key1 = "key 1";
final String value1 = "a value";
childStore.put(key1, value1);
assertEquals(value1, childStore.get(key1));
assertEquals(value1, childStore.remove(key1));
assertNull(childStore.get(key1));
childStore.put(key1, value1);
assertEquals(value1, childStore.get(key1));
assertEquals(value1, childStore.remove(key1, String.class));
assertNull(childStore.get(key1));
final Object key2 = "key 2";
final String value2 = "other value";
assertEquals(value2, childStore.getOrComputeIfAbsent(key2, key -> value2));
assertEquals(value2, childStore.getOrComputeIfAbsent(key2, key -> value2, String.class));
assertEquals(value2, childStore.get(key2));
assertEquals(value2, childStore.get(key2, String.class));
final Object parentKey = "parent key";
final String parentValue = "parent value";
parentStore.put(parentKey, parentValue);
assertEquals(parentValue, childStore.getOrComputeIfAbsent(parentKey, k -> "a different value"));
assertEquals(parentValue, childStore.get(parentKey));
}
@TestFactory
Stream<DynamicTest> configurationParameter() throws Exception {
ConfigurationParameters echo = new EchoParameters();
String key = "123";
Optional<String> expected = Optional.of(key);
UniqueId engineUniqueId = UniqueId.parse("[engine:junit-jupiter]");
JupiterEngineDescriptor engineDescriptor = new JupiterEngineDescriptor(engineUniqueId);
UniqueId classUniqueId = UniqueId.parse("[engine:junit-jupiter]/[class:MyClass]");
ClassTestDescriptor classTestDescriptor = new ClassTestDescriptor(classUniqueId, getClass());
Method method = getClass().getDeclaredMethod("configurationParameter");
UniqueId methodUniqueId = UniqueId.parse("[engine:junit-jupiter]/[class:MyClass]/[method:myMethod]");
TestMethodTestDescriptor methodTestDescriptor = new TestMethodTestDescriptor(methodUniqueId, getClass(),
method);
return Stream.of( //
(ExtensionContext) new JupiterEngineExtensionContext(null, engineDescriptor, echo), //
new ClassExtensionContext(null, null, classTestDescriptor, echo, null), //
new MethodExtensionContext(null, null, methodTestDescriptor, echo, null, null) //
).map(context -> dynamicTest(context.getClass().getSimpleName(),
() -> assertEquals(expected, context.getConfigurationParameter(key))));
}
private ClassTestDescriptor nestedClassDescriptor() {
return new NestedClassTestDescriptor(UniqueId.root("nested-class", "NestedClass"),
OuterClass.NestedClass.class);
}
private ClassTestDescriptor outerClassDescriptor(TestDescriptor child) {
ClassTestDescriptor classTestDescriptor = new ClassTestDescriptor(UniqueId.root("class", "OuterClass"),
OuterClass.class);
if (child != null) {
classTestDescriptor.addChild(child);
}
return classTestDescriptor;
}
private TestMethodTestDescriptor methodDescriptor() {
try {
return new TestMethodTestDescriptor(UniqueId.root("method", "aMethod"), OuterClass.class,
OuterClass.class.getDeclaredMethod("aMethod"));
}
catch (NoSuchMethodException e) {
throw new RuntimeException(e);
}
}
@Tag("outer-tag")
static class OuterClass {
@Tag("nested-tag")
class NestedClass {
}
@Tag("method-tag")
void aMethod() {
}
}
private static class EchoParameters implements ConfigurationParameters {
@Override
public Optional<String> get(String key) {
return Optional.of(key);
}
@Override
public Optional<Boolean> getBoolean(String key) {
throw new UnsupportedOperationException("getBoolean(String) should not be called");
}
@Override
public int size() {
throw new UnsupportedOperationException("size() should not be called");
}
}
}