Support cross-parameter validation

Closes gh-33271
This commit is contained in:
rstoyanchev
2024-08-09 18:53:30 +03:00
parent 0d64c90a79
commit b61eee7fb0
11 changed files with 187 additions and 39 deletions

View File

@@ -16,18 +16,27 @@
package org.springframework.validation.beanvalidation;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import java.lang.reflect.Method;
import java.util.List;
import java.util.Locale;
import java.util.Set;
import java.util.function.Consumer;
import jakarta.validation.Constraint;
import jakarta.validation.ConstraintValidator;
import jakarta.validation.ConstraintValidatorContext;
import jakarta.validation.ConstraintViolation;
import jakarta.validation.Payload;
import jakarta.validation.Valid;
import jakarta.validation.constraints.Max;
import jakarta.validation.constraints.Min;
import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.Size;
import jakarta.validation.constraintvalidation.SupportedValidationTarget;
import jakarta.validation.constraintvalidation.ValidationTarget;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
@@ -40,6 +49,9 @@ import org.springframework.validation.method.MethodValidationResult;
import org.springframework.validation.method.ParameterErrors;
import org.springframework.validation.method.ParameterValidationResult;
import static java.lang.annotation.ElementType.CONSTRUCTOR;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import static org.assertj.core.api.Assertions.assertThat;
/**
@@ -77,7 +89,7 @@ class MethodValidationAdapterTests {
testArgs(target, method, new Object[] {faustino1234, cayetana6789, 3}, ex -> {
assertThat(ex.getAllValidationResults()).hasSize(3);
assertThat(ex.getParameterValidationResults()).hasSize(3);
assertBeanResult(ex.getBeanResults().get(0), 0, "student", faustino1234, List.of("""
Field error in object 'student' on field 'name': rejected value [Faustino1234]; \
@@ -117,7 +129,7 @@ class MethodValidationAdapterTests {
testArgs(target, method, new Object[] {faustino1234, new Person("Joe", List.of()), 1}, ex -> {
assertThat(ex.getAllValidationResults()).hasSize(1);
assertThat(ex.getParameterValidationResults()).hasSize(1);
assertBeanResult(ex.getBeanResults().get(0), 0, "studentToAdd", faustino1234, List.of("""
Field error in object 'studentToAdd' on field 'name': rejected value [Faustino1234]; \
@@ -134,7 +146,7 @@ class MethodValidationAdapterTests {
testReturnValue(target, getMethod(target, "getIntValue"), 4, ex -> {
assertThat(ex.getAllValidationResults()).hasSize(1);
assertThat(ex.getParameterValidationResults()).hasSize(1);
assertValueResult(ex.getValueResults().get(0), -1, 4, List.of("""
org.springframework.validation.beanvalidation.MethodValidationAdapter$ViolationMessageSourceResolvable: \
@@ -151,7 +163,7 @@ class MethodValidationAdapterTests {
testReturnValue(target, getMethod(target, "getPerson"), faustino1234, ex -> {
assertThat(ex.getAllValidationResults()).hasSize(1);
assertThat(ex.getParameterValidationResults()).hasSize(1);
assertBeanResult(ex.getBeanResults().get(0), -1, "person", faustino1234, List.of("""
Field error in object 'person' on field 'name': rejected value [Faustino1234]; \
@@ -169,7 +181,7 @@ class MethodValidationAdapterTests {
testArgs(target, method, new Object[] {List.of(faustino1234, cayetana6789)}, ex -> {
assertThat(ex.getAllValidationResults()).hasSize(2);
assertThat(ex.getParameterValidationResults()).hasSize(2);
int paramIndex = 0;
String objectName = "people";
@@ -203,7 +215,7 @@ class MethodValidationAdapterTests {
Method method = getMethod(target, "addHobbies");
testArgs(target, method, new Object[] {List.of(" ")}, ex -> {
assertThat(ex.getAllValidationResults()).hasSize(1);
assertThat(ex.getParameterValidationResults()).hasSize(1);
assertValueResult(ex.getValueResults().get(0), 0, " ", List.of("""
org.springframework.validation.beanvalidation.MethodValidationAdapter$ViolationMessageSourceResolvable: \
codes [NotBlank.myService#addHobbies.hobbies,NotBlank.hobbies,NotBlank.java.util.List,NotBlank]; \
@@ -219,7 +231,7 @@ class MethodValidationAdapterTests {
Method method = getMethod(target, "addUniqueHobbies");
testArgs(target, method, new Object[] {Set.of("test", " ")}, ex -> {
assertThat(ex.getAllValidationResults()).hasSize(1);
assertThat(ex.getParameterValidationResults()).hasSize(1);
assertValueResult(ex.getValueResults().get(0), 0, Set.of("test", " "), List.of("""
org.springframework.validation.beanvalidation.MethodValidationAdapter$ViolationMessageSourceResolvable: \
codes [NotBlank.myService#addUniqueHobbies.hobbies,NotBlank.hobbies,NotBlank.java.util.Set,NotBlank]; \
@@ -229,6 +241,23 @@ class MethodValidationAdapterTests {
});
}
@Test
void validateCrossParams() {
MyService target = new MyService();
Method method = getMethod(target, "addRange");
testArgs(target, method, new Object[] {90, 50}, ex -> {
assertThat(ex.getParameterValidationResults()).isEmpty();
assertThat(ex.getCrossParameterValidationResults()).hasSize(1);
assertThat(ex.getCrossParameterValidationResults().get(0).toString()).isEqualTo("""
org.springframework.validation.beanvalidation.MethodValidationAdapter$ViolationMessageSourceResolvable: \
codes [RangeParams.myService#addRange,RangeParams]; \
arguments [org.springframework.context.support.DefaultMessageSourceResolvable: \
codes [myService#addRange]; \
arguments []; default message []]; default message [Invalid range]""");
});
}
private void testArgs(Object target, Method method, Object[] args, Consumer<MethodValidationResult> consumer) {
consumer.accept(this.validationAdapter.validateArguments(target, method, null, args, new Class<?>[0]));
}
@@ -294,6 +323,10 @@ class MethodValidationAdapterTests {
public void addUniqueHobbies(Set<@NotBlank String> hobbies) {
}
@RangeParams
public void addRange(int from, int to) {
}
}
@@ -301,4 +334,29 @@ class MethodValidationAdapterTests {
private record Person(@Size(min = 1, max = 10) String name, List<@NotBlank String> hobbies) {
}
@Documented
@Constraint(validatedBy = RangeParamsValidator.class)
@Target({ CONSTRUCTOR, METHOD })
@Retention(RUNTIME)
public @interface RangeParams {
String message() default "Invalid range";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}
@SupportedValidationTarget(ValidationTarget.PARAMETERS)
public static final class RangeParamsValidator implements ConstraintValidator<RangeParams, Object[]> {
@Override
public boolean isValid(final Object[] parameters, final ConstraintValidatorContext context) {
return false;
}
}
}

View File

@@ -81,7 +81,7 @@ class MethodValidationProxyReactorTests {
StepVerifier.create(myService.addPerson(personMono))
.expectErrorSatisfies(t -> {
MethodValidationException ex = (MethodValidationException) t;
assertThat(ex.getAllValidationResults()).hasSize(1);
assertThat(ex.getParameterValidationResults()).hasSize(1);
ParameterErrors errors = ex.getBeanResults().get(0);
assertThat(errors.getErrorCount()).isEqualTo(1);