/
SpringBootContextLoaderTests.java
464 lines (361 loc) · 16.1 KB
/
SpringBootContextLoaderTests.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
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
/*
* Copyright 2012-2022 the original author or authors.
*
* 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
*
* https://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.springframework.boot.test.context;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.BeanCreationException;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.SpringBootConfiguration;
import org.springframework.boot.test.context.SpringBootTest.UseMainMethod;
import org.springframework.boot.test.util.TestPropertyValues;
import org.springframework.boot.web.reactive.context.GenericReactiveWebApplicationContext;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.PropertySource;
import org.springframework.core.env.StandardEnvironment;
import org.springframework.test.context.ActiveProfiles;
import org.springframework.test.context.ApplicationContextFailureProcessor;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.ContextHierarchy;
import org.springframework.test.context.MergedContextConfiguration;
import org.springframework.test.context.TestContext;
import org.springframework.test.context.TestContextManager;
import org.springframework.test.context.TestPropertySource;
import org.springframework.test.context.support.TestPropertySourceUtils;
import org.springframework.test.util.ReflectionTestUtils;
import org.springframework.web.context.WebApplicationContext;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
/**
* Tests for {@link SpringBootContextLoader}
*
* @author Stephane Nicoll
* @author Scott Frederick
* @author Madhura Bhave
*/
class SpringBootContextLoaderTests {
@BeforeEach
void setUp() {
ContextLoaderApplicationContextFailureProcessor.reset();
}
@Test
void environmentPropertiesSimple() {
Map<String, Object> config = getMergedContextConfigurationProperties(SimpleConfig.class);
assertKey(config, "key", "myValue");
assertKey(config, "anotherKey", "anotherValue");
}
@Test
void environmentPropertiesSimpleNonAlias() {
Map<String, Object> config = getMergedContextConfigurationProperties(SimpleConfigNonAlias.class);
assertKey(config, "key", "myValue");
assertKey(config, "anotherKey", "anotherValue");
}
@Test
void environmentPropertiesOverrideDefaults() {
Map<String, Object> config = getMergedContextConfigurationProperties(OverrideConfig.class);
assertKey(config, "server.port", "2345");
}
@Test
void environmentPropertiesAppend() {
Map<String, Object> config = getMergedContextConfigurationProperties(AppendConfig.class);
assertKey(config, "key", "myValue");
assertKey(config, "otherKey", "otherValue");
}
@Test
void environmentPropertiesSeparatorInValue() {
Map<String, Object> config = getMergedContextConfigurationProperties(SameSeparatorInValue.class);
assertKey(config, "key", "my=Value");
assertKey(config, "anotherKey", "another:Value");
}
@Test
void environmentPropertiesAnotherSeparatorInValue() {
Map<String, Object> config = getMergedContextConfigurationProperties(AnotherSeparatorInValue.class);
assertKey(config, "key", "my:Value");
assertKey(config, "anotherKey", "another=Value");
}
@Test // gh-4384
@Disabled
void environmentPropertiesNewLineInValue() {
Map<String, Object> config = getMergedContextConfigurationProperties(NewLineInValue.class);
assertKey(config, "key", "myValue");
assertKey(config, "variables", "foo=FOO\n bar=BAR");
}
@Test
void noActiveProfiles() {
assertThat(getActiveProfiles(SimpleConfig.class)).isEmpty();
}
@Test
void multipleActiveProfiles() {
assertThat(getActiveProfiles(MultipleActiveProfiles.class)).containsExactly("profile1", "profile2");
}
@Test
void activeProfileWithComma() {
assertThat(getActiveProfiles(ActiveProfileWithComma.class)).containsExactly("profile1,2");
}
@Test // gh-28776
void testPropertyValuesShouldTakePrecedenceWhenInlinedPropertiesPresent() {
TestContext context = new ExposedTestContextManager(SimpleConfig.class).getExposedTestContext();
StandardEnvironment environment = (StandardEnvironment) context.getApplicationContext().getEnvironment();
TestPropertyValues.of("key=thisValue").applyTo(environment);
assertThat(environment.getProperty("key")).isEqualTo("thisValue");
assertThat(environment.getPropertySources().get("active-test-profiles")).isNull();
}
@Test
void testPropertyValuesShouldTakePrecedenceWhenInlinedPropertiesPresentAndProfilesActive() {
TestContext context = new ExposedTestContextManager(ActiveProfileWithInlinedProperties.class)
.getExposedTestContext();
StandardEnvironment environment = (StandardEnvironment) context.getApplicationContext().getEnvironment();
TestPropertyValues.of("key=thisValue").applyTo(environment);
assertThat(environment.getProperty("key")).isEqualTo("thisValue");
assertThat(environment.getPropertySources().get("active-test-profiles")).isNotNull();
}
@Test
void propertySourceOrdering() {
TestContext context = new ExposedTestContextManager(PropertySourceOrdering.class).getExposedTestContext();
ConfigurableEnvironment environment = (ConfigurableEnvironment) context.getApplicationContext()
.getEnvironment();
List<String> names = environment.getPropertySources().stream().map(PropertySource::getName)
.collect(Collectors.toCollection(ArrayList::new));
String last = names.remove(names.size() - 1);
assertThat(names).containsExactly("configurationProperties", "Inlined Test Properties", "commandLineArgs",
"servletConfigInitParams", "servletContextInitParams", "systemProperties", "systemEnvironment",
"random");
assertThat(last).startsWith("Config resource");
}
@Test
void whenEnvironmentChangesWebApplicationTypeToNoneThenContextTypeChangesAccordingly() {
TestContext context = new ExposedTestContextManager(ChangingWebApplicationTypeToNone.class)
.getExposedTestContext();
assertThat(context.getApplicationContext()).isNotInstanceOf(WebApplicationContext.class);
}
@Test
void whenEnvironmentChangesWebApplicationTypeToReactiveThenContextTypeChangesAccordingly() {
TestContext context = new ExposedTestContextManager(ChangingWebApplicationTypeToReactive.class)
.getExposedTestContext();
assertThat(context.getApplicationContext()).isInstanceOf(GenericReactiveWebApplicationContext.class);
}
@Test
void whenUseMainMethodAlwaysAndMainMethodThrowsException() {
TestContext testContext = new ExposedTestContextManager(UseMainMethodAlwaysAndMainMethodThrowsException.class)
.getExposedTestContext();
assertThatIllegalStateException().isThrownBy(testContext::getApplicationContext).havingCause()
.withMessageContaining("ThrownFromMain");
}
@Test
void whenUseMainMethodWhenAvailableAndNoMainMethod() {
TestContext testContext = new ExposedTestContextManager(UseMainMethodWhenAvailableAndNoMainMethod.class)
.getExposedTestContext();
ApplicationContext applicationContext = testContext.getApplicationContext();
assertThat(applicationContext.getEnvironment().getActiveProfiles()).isEmpty();
}
@Test
void whenUseMainMethodWhenAvailableAndMainMethod() {
TestContext testContext = new ExposedTestContextManager(UseMainMethodWhenAvailableAndMainMethod.class)
.getExposedTestContext();
ApplicationContext applicationContext = testContext.getApplicationContext();
assertThat(applicationContext.getEnvironment().getActiveProfiles()).contains("frommain");
}
@Test
void whenUseMainMethodNever() {
TestContext testContext = new ExposedTestContextManager(UseMainMethodNever.class).getExposedTestContext();
ApplicationContext applicationContext = testContext.getApplicationContext();
assertThat(applicationContext.getEnvironment().getActiveProfiles()).isEmpty();
}
@Test
void whenUseMainMethodWithBeanThrowingException() {
TestContext testContext = new ExposedTestContextManager(UseMainMethodWithBeanThrowingException.class)
.getExposedTestContext();
assertThatIllegalStateException().isThrownBy(testContext::getApplicationContext).havingCause()
.satisfies((exception) -> {
assertThat(exception).isInstanceOf(BeanCreationException.class);
assertThat(exception)
.isSameAs(ContextLoaderApplicationContextFailureProcessor.contextLoadException);
});
assertThat(ContextLoaderApplicationContextFailureProcessor.failedContext).isNotNull();
}
@Test
void whenNoMainMethodWithBeanThrowingException() {
TestContext testContext = new ExposedTestContextManager(NoMainMethodWithBeanThrowingException.class)
.getExposedTestContext();
assertThatIllegalStateException().isThrownBy(testContext::getApplicationContext).havingCause()
.satisfies((exception) -> {
assertThat(exception).isInstanceOf(BeanCreationException.class);
assertThat(exception)
.isSameAs(ContextLoaderApplicationContextFailureProcessor.contextLoadException);
});
assertThat(ContextLoaderApplicationContextFailureProcessor.failedContext).isNotNull();
}
@Test
void whenUseMainMethodWithContextHierarchyThrowsException() {
TestContext testContext = new ExposedTestContextManager(UseMainMethodWithContextHierarchy.class)
.getExposedTestContext();
assertThatIllegalStateException().isThrownBy(testContext::getApplicationContext).havingCause()
.withMessage("UseMainMethod.ALWAYS cannot be used with @ContextHierarchy tests");
}
private String[] getActiveProfiles(Class<?> testClass) {
TestContext testContext = new ExposedTestContextManager(testClass).getExposedTestContext();
ApplicationContext applicationContext = testContext.getApplicationContext();
return applicationContext.getEnvironment().getActiveProfiles();
}
private Map<String, Object> getMergedContextConfigurationProperties(Class<?> testClass) {
TestContext context = new ExposedTestContextManager(testClass).getExposedTestContext();
MergedContextConfiguration config = (MergedContextConfiguration) ReflectionTestUtils.getField(context,
"mergedContextConfiguration");
return TestPropertySourceUtils.convertInlinedPropertiesToMap(config.getPropertySourceProperties());
}
private void assertKey(Map<String, Object> actual, String key, Object value) {
assertThat(actual.containsKey(key)).as("Key '" + key + "' not found").isTrue();
assertThat(actual.get(key)).isEqualTo(value);
}
@SpringBootTest(properties = { "key=myValue", "anotherKey:anotherValue" }, classes = Config.class)
static class SimpleConfig {
}
@SpringBootTest(properties = { "key=myValue", "anotherKey:anotherValue" }, classes = Config.class)
static class SimpleConfigNonAlias {
}
@SpringBootTest(properties = "server.port=2345", classes = Config.class)
static class OverrideConfig {
}
@SpringBootTest(properties = { "key=myValue", "otherKey=otherValue" }, classes = Config.class)
static class AppendConfig {
}
@SpringBootTest(properties = { "key=my=Value", "anotherKey:another:Value" }, classes = Config.class)
static class SameSeparatorInValue {
}
@SpringBootTest(properties = { "key=my:Value", "anotherKey:another=Value" }, classes = Config.class)
static class AnotherSeparatorInValue {
}
@SpringBootTest(properties = { "key=myValue", "variables=foo=FOO\n bar=BAR" }, classes = Config.class)
static class NewLineInValue {
}
@SpringBootTest(classes = Config.class)
@ActiveProfiles({ "profile1", "profile2" })
static class MultipleActiveProfiles {
}
@SpringBootTest(classes = Config.class)
@ActiveProfiles({ "profile1,2" })
static class ActiveProfileWithComma {
}
@SpringBootTest(properties = { "key=myValue" }, classes = Config.class)
@ActiveProfiles({ "profile1,2" })
static class ActiveProfileWithInlinedProperties {
}
@SpringBootTest(classes = Config.class, args = "args", properties = "one=1")
@TestPropertySource(properties = "two=2")
static class PropertySourceOrdering {
}
@SpringBootTest(classes = Config.class, args = "--spring.main.web-application-type=none")
static class ChangingWebApplicationTypeToNone {
}
@SpringBootTest(classes = Config.class, args = "--spring.main.web-application-type=reactive")
static class ChangingWebApplicationTypeToReactive {
}
@SpringBootTest(classes = ConfigWithMainThrowingException.class, useMainMethod = UseMainMethod.ALWAYS)
static class UseMainMethodAlwaysAndMainMethodThrowsException {
}
@SpringBootTest(classes = ConfigWithNoMain.class, useMainMethod = UseMainMethod.WHEN_AVAILABLE)
static class UseMainMethodWhenAvailableAndNoMainMethod {
}
@SpringBootTest(classes = ConfigWithMain.class, useMainMethod = UseMainMethod.WHEN_AVAILABLE)
static class UseMainMethodWhenAvailableAndMainMethod {
}
@SpringBootTest(classes = ConfigWithMain.class, useMainMethod = UseMainMethod.NEVER)
static class UseMainMethodNever {
}
@SpringBootTest(classes = ConfigWithMainWithBeanThrowingException.class, useMainMethod = UseMainMethod.ALWAYS)
static class UseMainMethodWithBeanThrowingException {
}
@SpringBootTest(classes = ConfigWithNoMainWithBeanThrowingException.class, useMainMethod = UseMainMethod.NEVER)
static class NoMainMethodWithBeanThrowingException {
}
@SpringBootTest(useMainMethod = UseMainMethod.ALWAYS)
@ContextHierarchy({ @ContextConfiguration(classes = ConfigWithMain.class),
@ContextConfiguration(classes = AnotherConfigWithMain.class) })
static class UseMainMethodWithContextHierarchy {
}
@Configuration(proxyBeanMethods = false)
static class Config {
}
@SpringBootConfiguration(proxyBeanMethods = false)
public static class ConfigWithMain {
public static void main(String[] args) {
new SpringApplication(ConfigWithMain.class).run("--spring.profiles.active=frommain");
}
}
@SpringBootConfiguration(proxyBeanMethods = false)
public static class AnotherConfigWithMain {
public static void main(String[] args) {
new SpringApplication(AnotherConfigWithMain.class).run("--spring.profiles.active=anotherfrommain");
}
}
@SpringBootConfiguration(proxyBeanMethods = false)
static class ConfigWithNoMain {
}
@SpringBootConfiguration(proxyBeanMethods = false)
public static class ConfigWithMainWithBeanThrowingException {
public static void main(String[] args) {
new SpringApplication(ConfigWithMainWithBeanThrowingException.class).run();
}
@Bean
String failContextLoad() {
throw new RuntimeException("ThrownFromBeanMethod");
}
}
@SpringBootConfiguration(proxyBeanMethods = false)
static class ConfigWithNoMainWithBeanThrowingException {
@Bean
String failContextLoad() {
throw new RuntimeException("ThrownFromBeanMethod");
}
}
@SpringBootConfiguration(proxyBeanMethods = false)
public static class ConfigWithMainThrowingException {
public static void main(String[] args) {
throw new RuntimeException("ThrownFromMain");
}
}
/**
* {@link TestContextManager} which exposes the {@link TestContext}.
*/
static class ExposedTestContextManager extends TestContextManager {
ExposedTestContextManager(Class<?> testClass) {
super(testClass);
}
final TestContext getExposedTestContext() {
return super.getTestContext();
}
}
private static class ContextLoaderApplicationContextFailureProcessor implements ApplicationContextFailureProcessor {
static ApplicationContext failedContext;
static Throwable contextLoadException;
@Override
public void processLoadFailure(ApplicationContext context, Throwable exception) {
failedContext = context;
contextLoadException = exception;
}
private static void reset() {
failedContext = null;
contextLoadException = null;
}
}
}