-
Notifications
You must be signed in to change notification settings - Fork 40.1k
/
ValidationAutoConfigurationTests.java
425 lines (343 loc) · 15.2 KB
/
ValidationAutoConfigurationTests.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
/*
* Copyright 2012-2021 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.autoconfigure.validation;
import java.util.HashSet;
import java.util.Set;
import javax.validation.ConstraintViolationException;
import javax.validation.Validator;
import javax.validation.constraints.Min;
import javax.validation.constraints.Size;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.BeanFactoryUtils;
import org.springframework.beans.factory.config.BeanPostProcessor;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.autoconfigure.validation.ValidationAutoConfigurationTests.CustomValidatorConfiguration.TestBeanPostProcessor;
import org.springframework.boot.test.context.assertj.AssertableApplicationContext;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
import org.springframework.boot.validation.beanvalidation.MethodValidationExcludeFilter;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.test.util.ReflectionTestUtils;
import org.springframework.validation.annotation.Validated;
import org.springframework.validation.beanvalidation.CustomValidatorBean;
import org.springframework.validation.beanvalidation.LocalValidatorFactoryBean;
import org.springframework.validation.beanvalidation.MethodValidationPostProcessor;
import org.springframework.validation.beanvalidation.OptionalValidatorFactoryBean;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
import static org.assertj.core.api.Assertions.assertThatNoException;
import static org.mockito.Mockito.mock;
/**
* Tests for {@link ValidationAutoConfiguration}.
*
* @author Stephane Nicoll
* @author Phillip Webb
*/
class ValidationAutoConfigurationTests {
private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
.withConfiguration(AutoConfigurations.of(ValidationAutoConfiguration.class));
@Test
void validationAutoConfigurationShouldConfigureDefaultValidator() {
this.contextRunner.run((context) -> {
assertThat(context.getBeanNamesForType(Validator.class)).containsExactly("defaultValidator");
assertThat(context.getBeanNamesForType(org.springframework.validation.Validator.class))
.containsExactly("defaultValidator");
assertThat(context.getBean(Validator.class)).isInstanceOf(LocalValidatorFactoryBean.class)
.isEqualTo(context.getBean(org.springframework.validation.Validator.class));
assertThat(isPrimaryBean(context, "defaultValidator")).isTrue();
});
}
@Test
void validationAutoConfigurationWhenUserProvidesValidatorShouldBackOff() {
this.contextRunner.withUserConfiguration(UserDefinedValidatorConfig.class).run((context) -> {
assertThat(context.getBeanNamesForType(Validator.class)).containsExactly("customValidator");
assertThat(context.getBeanNamesForType(org.springframework.validation.Validator.class))
.containsExactly("customValidator");
assertThat(context.getBean(Validator.class)).isInstanceOf(OptionalValidatorFactoryBean.class)
.isEqualTo(context.getBean(org.springframework.validation.Validator.class));
assertThat(isPrimaryBean(context, "customValidator")).isFalse();
});
}
@Test
void validationAutoConfigurationWhenUserProvidesDefaultValidatorShouldNotEnablePrimary() {
this.contextRunner.withUserConfiguration(UserDefinedDefaultValidatorConfig.class).run((context) -> {
assertThat(context.getBeanNamesForType(Validator.class)).containsExactly("defaultValidator");
assertThat(context.getBeanNamesForType(org.springframework.validation.Validator.class))
.containsExactly("defaultValidator");
assertThat(isPrimaryBean(context, "defaultValidator")).isFalse();
});
}
@Test
void validationAutoConfigurationWhenUserProvidesJsrValidatorShouldBackOff() {
this.contextRunner.withUserConfiguration(UserDefinedJsrValidatorConfig.class).run((context) -> {
assertThat(context.getBeanNamesForType(Validator.class)).containsExactly("customValidator");
assertThat(context.getBeanNamesForType(org.springframework.validation.Validator.class)).isEmpty();
assertThat(isPrimaryBean(context, "customValidator")).isFalse();
});
}
@Test
void validationAutoConfigurationWhenUserProvidesSpringValidatorShouldCreateJsrValidator() {
this.contextRunner.withUserConfiguration(UserDefinedSpringValidatorConfig.class).run((context) -> {
assertThat(context.getBeanNamesForType(Validator.class)).containsExactly("defaultValidator");
assertThat(context.getBeanNamesForType(org.springframework.validation.Validator.class))
.containsExactly("customValidator", "anotherCustomValidator", "defaultValidator");
assertThat(context.getBean(Validator.class)).isInstanceOf(LocalValidatorFactoryBean.class)
.isEqualTo(context.getBean(org.springframework.validation.Validator.class));
assertThat(isPrimaryBean(context, "defaultValidator")).isTrue();
});
}
@Test
void validationAutoConfigurationWhenUserProvidesPrimarySpringValidatorShouldRemovePrimaryFlag() {
this.contextRunner.withUserConfiguration(UserDefinedPrimarySpringValidatorConfig.class).run((context) -> {
assertThat(context.getBeanNamesForType(Validator.class)).containsExactly("defaultValidator");
assertThat(context.getBeanNamesForType(org.springframework.validation.Validator.class))
.containsExactly("customValidator", "anotherCustomValidator", "defaultValidator");
assertThat(context.getBean(Validator.class)).isInstanceOf(LocalValidatorFactoryBean.class);
assertThat(context.getBean(org.springframework.validation.Validator.class))
.isEqualTo(context.getBean("anotherCustomValidator"));
assertThat(isPrimaryBean(context, "defaultValidator")).isFalse();
});
}
@Test
void whenUserProvidesSpringValidatorInParentContextThenAutoConfiguredValidatorIsPrimary() {
new ApplicationContextRunner().withUserConfiguration(UserDefinedSpringValidatorConfig.class).run((parent) -> {
this.contextRunner.withParent(parent).run((context) -> {
assertThat(context.getBeanNamesForType(Validator.class)).containsExactly("defaultValidator");
assertThat(context.getBeanNamesForType(org.springframework.validation.Validator.class))
.containsExactly("defaultValidator");
assertThat(BeanFactoryUtils.beanNamesForTypeIncludingAncestors(context.getBeanFactory(),
org.springframework.validation.Validator.class)).containsExactly("defaultValidator",
"customValidator", "anotherCustomValidator");
assertThat(isPrimaryBean(context, "defaultValidator")).isTrue();
});
});
}
@Test
void whenUserProvidesPrimarySpringValidatorInParentContextThenAutoConfiguredValidatorIsPrimary() {
new ApplicationContextRunner().withUserConfiguration(UserDefinedPrimarySpringValidatorConfig.class)
.run((parent) -> {
this.contextRunner.withParent(parent).run((context) -> {
assertThat(context.getBeanNamesForType(Validator.class)).containsExactly("defaultValidator");
assertThat(context.getBeanNamesForType(org.springframework.validation.Validator.class))
.containsExactly("defaultValidator");
assertThat(BeanFactoryUtils.beanNamesForTypeIncludingAncestors(context.getBeanFactory(),
org.springframework.validation.Validator.class)).containsExactly("defaultValidator",
"customValidator", "anotherCustomValidator");
assertThat(isPrimaryBean(context, "defaultValidator")).isTrue();
});
});
}
@Test
void validationIsEnabled() {
this.contextRunner.withUserConfiguration(SampleService.class).run((context) -> {
assertThat(context.getBeansOfType(Validator.class)).hasSize(1);
SampleService service = context.getBean(SampleService.class);
service.doSomething("Valid");
assertThatExceptionOfType(ConstraintViolationException.class).isThrownBy(() -> service.doSomething("KO"));
});
}
@Test
void classCanBeExcludedFromValidation() {
this.contextRunner.withUserConfiguration(ExcludedServiceConfiguration.class).run((context) -> {
assertThat(context.getBeansOfType(Validator.class)).hasSize(1);
ExcludedService service = context.getBean(ExcludedService.class);
service.doSomething("Valid");
assertThatNoException().isThrownBy(() -> service.doSomething("KO"));
});
}
@Test
void validationUsesCglibProxy() {
this.contextRunner.withUserConfiguration(DefaultAnotherSampleService.class).run((context) -> {
assertThat(context.getBeansOfType(Validator.class)).hasSize(1);
DefaultAnotherSampleService service = context.getBean(DefaultAnotherSampleService.class);
service.doSomething(42);
assertThatExceptionOfType(ConstraintViolationException.class).isThrownBy(() -> service.doSomething(2));
});
}
@Test
void validationCanBeConfiguredToUseJdkProxy() {
this.contextRunner.withUserConfiguration(AnotherSampleServiceConfiguration.class)
.withPropertyValues("spring.aop.proxy-target-class=false").run((context) -> {
assertThat(context.getBeansOfType(Validator.class)).hasSize(1);
assertThat(context.getBeansOfType(DefaultAnotherSampleService.class)).isEmpty();
AnotherSampleService service = context.getBean(AnotherSampleService.class);
service.doSomething(42);
assertThatExceptionOfType(ConstraintViolationException.class)
.isThrownBy(() -> service.doSomething(2));
});
}
@Test
void userDefinedMethodValidationPostProcessorTakesPrecedence() {
this.contextRunner.withUserConfiguration(SampleConfiguration.class).run((context) -> {
assertThat(context.getBeansOfType(Validator.class)).hasSize(1);
Object userMethodValidationPostProcessor = context.getBean("testMethodValidationPostProcessor");
assertThat(context.getBean(MethodValidationPostProcessor.class))
.isSameAs(userMethodValidationPostProcessor);
assertThat(context.getBeansOfType(MethodValidationPostProcessor.class)).hasSize(1);
assertThat(context.getBean(Validator.class))
.isNotSameAs(ReflectionTestUtils.getField(userMethodValidationPostProcessor, "validator"));
});
}
@Test
void methodValidationPostProcessorValidatorDependencyDoesNotTriggerEarlyInitialization() {
this.contextRunner.withUserConfiguration(CustomValidatorConfiguration.class)
.run((context) -> assertThat(context.getBean(TestBeanPostProcessor.class).postProcessed)
.contains("someService"));
}
@Test
void validationIsEnabledInChildContext() {
this.contextRunner.run((parent) -> new ApplicationContextRunner()
.withConfiguration(AutoConfigurations.of(ValidationAutoConfiguration.class))
.withUserConfiguration(SampleService.class).withParent(parent).run((context) -> {
assertThat(context.getBeansOfType(Validator.class)).hasSize(0);
assertThat(parent.getBeansOfType(Validator.class)).hasSize(1);
SampleService service = context.getBean(SampleService.class);
service.doSomething("Valid");
assertThatExceptionOfType(ConstraintViolationException.class)
.isThrownBy(() -> service.doSomething("KO"));
}));
}
private boolean isPrimaryBean(AssertableApplicationContext context, String beanName) {
return ((BeanDefinitionRegistry) context.getSourceApplicationContext()).getBeanDefinition(beanName).isPrimary();
}
@Configuration(proxyBeanMethods = false)
static class Config {
}
@Configuration(proxyBeanMethods = false)
static class UserDefinedValidatorConfig {
@Bean
OptionalValidatorFactoryBean customValidator() {
return new OptionalValidatorFactoryBean();
}
}
@Configuration(proxyBeanMethods = false)
static class UserDefinedDefaultValidatorConfig {
@Bean
OptionalValidatorFactoryBean defaultValidator() {
return new OptionalValidatorFactoryBean();
}
}
@Configuration(proxyBeanMethods = false)
static class UserDefinedJsrValidatorConfig {
@Bean
Validator customValidator() {
return mock(Validator.class);
}
}
@Configuration(proxyBeanMethods = false)
static class UserDefinedSpringValidatorConfig {
@Bean
org.springframework.validation.Validator customValidator() {
return mock(org.springframework.validation.Validator.class);
}
@Bean
org.springframework.validation.Validator anotherCustomValidator() {
return mock(org.springframework.validation.Validator.class);
}
}
@Configuration(proxyBeanMethods = false)
static class UserDefinedPrimarySpringValidatorConfig {
@Bean
org.springframework.validation.Validator customValidator() {
return mock(org.springframework.validation.Validator.class);
}
@Bean
@Primary
org.springframework.validation.Validator anotherCustomValidator() {
return mock(org.springframework.validation.Validator.class);
}
}
@Validated
static class SampleService {
void doSomething(@Size(min = 3, max = 10) String name) {
}
}
@Configuration(proxyBeanMethods = false)
static final class ExcludedServiceConfiguration {
@Bean
ExcludedService excludedService() {
return new ExcludedService();
}
@Bean
MethodValidationExcludeFilter exclusionFilter() {
return (type) -> type.equals(ExcludedService.class);
}
}
@Validated
static final class ExcludedService {
void doSomething(@Size(min = 3, max = 10) String name) {
}
}
interface AnotherSampleService {
void doSomething(@Min(42) Integer counter);
}
@Validated
static class DefaultAnotherSampleService implements AnotherSampleService {
@Override
public void doSomething(Integer counter) {
}
}
@Configuration(proxyBeanMethods = false)
static class AnotherSampleServiceConfiguration {
@Bean
AnotherSampleService anotherSampleService() {
return new DefaultAnotherSampleService();
}
}
@Configuration(proxyBeanMethods = false)
static class SampleConfiguration {
@Bean
MethodValidationPostProcessor testMethodValidationPostProcessor() {
return new MethodValidationPostProcessor();
}
}
@org.springframework.context.annotation.Configuration(proxyBeanMethods = false)
static class CustomValidatorConfiguration {
CustomValidatorConfiguration(SomeService someService) {
}
@Bean
Validator customValidator() {
return new CustomValidatorBean();
}
@Bean
static TestBeanPostProcessor testBeanPostProcessor() {
return new TestBeanPostProcessor();
}
@Configuration(proxyBeanMethods = false)
static class SomeServiceConfiguration {
@Bean
SomeService someService() {
return new SomeService();
}
}
static class SomeService {
}
static class TestBeanPostProcessor implements BeanPostProcessor {
private Set<String> postProcessed = new HashSet<>();
@Override
public Object postProcessAfterInitialization(Object bean, String name) {
this.postProcessed.add(name);
return bean;
}
@Override
public Object postProcessBeforeInitialization(Object bean, String name) {
return bean;
}
}
}
}