Skip to content

Commit

Permalink
Example test cases for spring-projectsgh-31746
Browse files Browse the repository at this point in the history
  • Loading branch information
@k-seth
k-seth committed Dec 5, 2023
1 parent cd62dfe commit c0035aa
Show file tree
Hide file tree
Showing 2 changed files with 232 additions and 25 deletions.
10 changes: 10 additions & 0 deletions .../src/main/java/org/springframework/validation/beanvalidation/MethodValidationAdapter.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -452,6 +452,7 @@ public BeanResultBuilder(MethodParameter param, @Nullable Object arg, Path.Node
this.parameter = param;
this.bean = leafBean;
this.container = (arg != null && !arg.equals(leafBean) ? arg : null);
// this.container = (isContainerElement(node) ? arg : null);
this.containerIndex = node.getIndex();
this.containerKey = node.getKey();
this.errors = createBindingResult(param, leafBean);
Expand All @@ -467,6 +468,15 @@ public ParameterErrors build() {
this.parameter, this.bean, this.errors, this.container,
this.containerIndex, this.containerKey);
}

private static boolean isContainerElement(Path.Node node) {
return switch (node.getKind()) {
case BEAN -> node.as(Path.BeanNode.class).getContainerClass() != null;
case PROPERTY -> node.as(Path.PropertyNode.class).getContainerClass() != null;
case CONTAINER_ELEMENT -> true;
default -> false;
};
}
}


Expand Down
247 changes: 222 additions & 25 deletions ...test/java/org/springframework/validation/beanvalidation/MethodValidationAdapterTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
import org.springframework.context.MessageSourceResolvable;
import org.springframework.lang.Nullable;
import org.springframework.util.ClassUtils;
import org.springframework.validation.FieldError;
import org.springframework.validation.ObjectError;
import org.springframework.validation.method.MethodValidationResult;
import org.springframework.validation.method.ParameterErrors;
import org.springframework.validation.method.ParameterValidationResult;
Expand All @@ -54,6 +54,12 @@ public class MethodValidationAdapterTests {

private static final Person cayetana6789 = new Person("Cayetana6789", List.of(" "));

private static final Person baure4567 = new Person("Baure4567", List.of());

private static final Course programming203 = new Course("Effective Unit Testing", Set.of(faustino1234), baure4567);

private static final Course programming142 = new Course("Debugging Fundamentals", Set.of(baure4567), cayetana6789);


private final MethodValidationAdapter validationAdapter = new MethodValidationAdapter();

Expand Down Expand Up @@ -85,6 +91,7 @@ void validateArguments() {
arguments [org.springframework.context.support.DefaultMessageSourceResolvable: \
codes [student.name,name]; arguments []; default message [name],10,1]; \
default message [size must be between 1 and 10]"""));
assertThat(ex.getBeanResults().get(0).getContainer()).isNull();

assertBeanResult(ex.getBeanResults().get(1), 1, "guardian", cayetana6789, List.of("""
Field error in object 'guardian' on field 'name': rejected value [Cayetana6789]; \
Expand All @@ -98,6 +105,7 @@ void validateArguments() {
[org.springframework.context.support.DefaultMessageSourceResolvable: codes \
[guardian.hobbies[0],hobbies[0]]; arguments []; default message [hobbies[0]]]; \
default message [must not be blank]"""));
assertThat(ex.getBeanResults().get(1).getContainer()).isNull();

assertValueResult(ex.getValueResults().get(0), 2, 3, List.of("""
org.springframework.context.support.DefaultMessageSourceResolvable: \
Expand Down Expand Up @@ -125,6 +133,7 @@ void validateArgumentWithCustomObjectName() {
arguments [org.springframework.context.support.DefaultMessageSourceResolvable: \
codes [studentToAdd.name,name]; arguments []; default message [name],10,1]; \
default message [size must be between 1 and 10]"""));
assertThat(ex.getBeanResults().get(0).getContainer()).isNull();
});
}

Expand Down Expand Up @@ -159,6 +168,7 @@ void validateReturnValueBean() {
arguments [org.springframework.context.support.DefaultMessageSourceResolvable: \
codes [person.name,name]; arguments []; default message [name],10,1]; \
default message [size must be between 1 and 10]"""));
assertThat(ex.getBeanResults().get(0).getContainer()).isNull();
});
}

Expand All @@ -167,7 +177,8 @@ void validateListArgument() {
MyService target = new MyService();
Method method = getMethod(target, "addPeople");

testArgs(target, method, new Object[] {List.of(faustino1234, cayetana6789)}, ex -> {
List<Person> arg = List.of(faustino1234, cayetana6789);
testArgs(target, method, new Object[] {arg}, ex -> {

assertThat(ex.getAllValidationResults()).hasSize(2);

Expand All @@ -181,6 +192,7 @@ void validateListArgument() {
arguments [org.springframework.context.support.DefaultMessageSourceResolvable: \
codes [people.name,name]; arguments []; default message [name],10,1]; \
default message [size must be between 1 and 10]"""));
assertThat(results.get(0).getContainer()).isEqualTo(arg);

assertBeanResult(results.get(1), paramIndex, objectName, cayetana6789, List.of("""
Field error in object 'people' on field 'name': rejected value [Cayetana6789]; \
Expand All @@ -194,6 +206,7 @@ void validateListArgument() {
[org.springframework.context.support.DefaultMessageSourceResolvable: codes \
[people.hobbies[0],hobbies[0]]; arguments []; default message [hobbies[0]]]; \
default message [must not be blank]"""));
assertThat(results.get(0).getContainer()).isEqualTo(arg);
});
}

Expand All @@ -202,7 +215,8 @@ void validateSetArgument() {
MyService target = new MyService();
Method method = getMethod(target, "addPeople");

testArgs(target, method, new Object[] {Set.of(faustino1234, cayetana6789)}, ex -> {
Set<Person> arg = Set.of(faustino1234, cayetana6789);
testArgs(target, method, new Object[] {arg}, ex -> {

assertThat(ex.getAllValidationResults()).hasSize(2);

Expand All @@ -211,28 +225,194 @@ void validateSetArgument() {
List<ParameterErrors> results = ex.getBeanResults();

assertThat(results).satisfiesExactlyInAnyOrder(
result -> assertBeanResult(result, paramIndex, objectName, faustino1234, List.of("""
Field error in object 'people' on field 'name': rejected value [Faustino1234]; \
codes [Size.people.name,Size.name,Size.java.lang.String,Size]; \
arguments [org.springframework.context.support.DefaultMessageSourceResolvable: \
codes [people.name,name]; arguments []; default message [name],10,1]; \
default message [size must be between 1 and 10]""")),
result -> assertBeanResult(result, paramIndex, objectName, cayetana6789, List.of("""
Field error in object 'people' on field 'name': rejected value [Cayetana6789]; \
codes [Size.people.name,Size.name,Size.java.lang.String,Size]; \
arguments [org.springframework.context.support.DefaultMessageSourceResolvable: \
codes [people.name,name]; arguments []; default message [name],10,1]; \
default message [size must be between 1 and 10]""", """
Field error in object 'people' on field 'hobbies[0]': rejected value [ ]; \
codes [NotBlank.people.hobbies[0],NotBlank.people.hobbies,NotBlank.hobbies[0],\
NotBlank.hobbies,NotBlank.java.lang.String,NotBlank]; arguments \
[org.springframework.context.support.DefaultMessageSourceResolvable: codes \
[people.hobbies[0],hobbies[0]]; arguments []; default message [hobbies[0]]]; \
default message [must not be blank]"""))
result -> {
assertBeanResult(result, paramIndex, objectName, faustino1234, List.of("""
Field error in object 'people' on field 'name': rejected value [Faustino1234]; \
codes [Size.people.name,Size.name,Size.java.lang.String,Size]; \
arguments [org.springframework.context.support.DefaultMessageSourceResolvable: \
codes [people.name,name]; arguments []; default message [name],10,1]; \
default message [size must be between 1 and 10]"""));
assertThat(result.getContainer()).isEqualTo(arg);
},
result -> {
assertBeanResult(result, paramIndex, objectName, cayetana6789, List.of("""
Field error in object 'people' on field 'name': rejected value [Cayetana6789]; \
codes [Size.people.name,Size.name,Size.java.lang.String,Size]; \
arguments [org.springframework.context.support.DefaultMessageSourceResolvable: \
codes [people.name,name]; arguments []; default message [name],10,1]; \
default message [size must be between 1 and 10]""", """
Field error in object 'people' on field 'hobbies[0]': rejected value [ ]; \
codes [NotBlank.people.hobbies[0],NotBlank.people.hobbies,NotBlank.hobbies[0],\
NotBlank.hobbies,NotBlank.java.lang.String,NotBlank]; arguments \
[org.springframework.context.support.DefaultMessageSourceResolvable: codes \
[people.hobbies[0],hobbies[0]]; arguments []; default message [hobbies[0]]]; \
default message [must not be blank]"""));
assertThat(result.getContainer()).isEqualTo(arg);
}
);
});
}

// Problem 1 - Cascaded validation produces JSR error on some paths
@Test
void problemOne_validateNestedArgument() {
MyService target = new MyService();
Method method = getMethod(target, "registerCourse");

// Fails attempting to validate as path professor.name is not valid for type Person
testArgs(target, method, new Object[] {programming142}, ex -> {

assertThat(ex.getAllValidationResults()).hasSize(1);

assertBeanResult(ex.getBeanResults().get(0), 0, "course", faustino1234, List.of("""
Field error in object 'course' on field 'professor.name': rejected value [Faustino1234]; \
codes [Size.course.professor.name,Size.professor.name,Size.name,Size]; \
arguments [org.springframework.context.support.DefaultMessageSourceResolvable: \
codes [course.professor.name,professor.name]; arguments []; default message [professor.name],10,1]; \
default message [size must be between 1 and 10]"""));
assertThat(ex.getBeanResults().get(0).getContainer()).isNull();
});
}

@Test
void problemOne_validateNestedReturnValueBean() {
MyService target = new MyService();

// Fails attempting to validate as path professor.name is not valid for type Person
testReturnValue(target, getMethod(target, "getCourse"), programming142, ex -> {

assertThat(ex.getAllValidationResults()).hasSize(1);

assertBeanResult(ex.getBeanResults().get(0), -1, "course", faustino1234, List.of("""
Field error in object 'course' on field 'professor.name': rejected value [Faustino1234]; \
codes [Size.course.professor.name,Size.professor.name,Size.name,Size]; \
arguments [org.springframework.context.support.DefaultMessageSourceResolvable: \
codes [course.professor.name,professor.name]; arguments []; default message [professor.name],10,1]; \
default message [size must be between 1 and 10]"""));
assertThat(ex.getBeanResults().get(0).getContainer()).isNull();
});
}


// Problem 2 - Container argument incorrect when validating non-field object error
@Test
void problemTwo_validateListArgument() {
MyService target = new MyService();
Method method = getMethod(target, "setHobbiesList");

List<String> arg = List.of(" ", "Developing", "");
testArgs(target, method, new Object[] {arg}, ex -> {

assertThat(ex.getAllValidationResults()).hasSize(2);

int paramIndex = 0;
String objectName = "hobbies";
List<ParameterErrors> results = ex.getBeanResults();

assertThat(results).satisfiesExactlyInAnyOrder(
result -> {
// Fails argument assertion as the argument is set as the service class
assertBeanResult(result, paramIndex, objectName, " ", List.of("""
Error in object 'hobbies': \
codes [NotBlank.hobbies,NotBlank]; \
arguments [org.springframework.context.support.DefaultMessageSourceResolvable: \
codes [hobbies]; arguments []; default message []]; \
default message [must not be blank]"""));
assertThat(result.getContainer()).isEqualTo(arg);
},
result -> {
// Fails argument assertion as the argument is set as the service class
assertBeanResult(result, paramIndex, objectName, "", List.of("""
Error in object 'hobbies': \
codes [NotBlank.hobbies,NotBlank]; \
arguments [org.springframework.context.support.DefaultMessageSourceResolvable: \
codes [hobbies]; arguments []; default message []]; \
default message [must not be blank]"""));
assertThat(result.getContainer()).isEqualTo(arg);
}
);
});
}

@Test
void problemTwo_validateSetArgument() {
MyService target = new MyService();
Method method = getMethod(target, "setHobbiesSet");

Set<String> arg = Set.of(" ", "Developing", "");
testArgs(target, method, new Object[] {arg}, ex -> {

// Fails result count as all violations are mapped to the service class
assertThat(ex.getAllValidationResults()).hasSize(2);

int paramIndex = 0;
String objectName = "hobbies";
List<ParameterErrors> results = ex.getBeanResults();

assertThat(results).satisfiesExactlyInAnyOrder(
result -> {
assertBeanResult(result, paramIndex, objectName, " ", List.of("""
Error in object 'hobbies': \
codes [NotBlank.hobbies,NotBlank]; \
arguments [org.springframework.context.support.DefaultMessageSourceResolvable: \
codes [hobbies]; arguments []; default message []]; \
default message [must not be blank]"""));
assertThat(result.getContainer()).isEqualTo(arg);
},
result -> {
assertBeanResult(result, paramIndex, objectName, "", List.of("""
Error in object 'hobbies': \
codes [NotBlank.hobbies,NotBlank]; \
arguments [org.springframework.context.support.DefaultMessageSourceResolvable: \
codes [people.name,name]; arguments []; default message []]; \
default message [must not be blank]"""));
assertThat(result.getContainer()).isEqualTo(arg);
}
);
});
}


// Problem 3 - Bean result container incorrectly set on nested validation
@Test
void problemThree_validateNestedArgument() {
MyService target = new MyService();
Method method = getMethod(target, "registerCourse");

testArgs(target, method, new Object[] {programming203}, ex -> {

assertThat(ex.getAllValidationResults()).hasSize(1);

assertBeanResult(ex.getBeanResults().get(0), 0, "course", faustino1234, List.of("""
Field error in object 'course' on field 'students[].name': rejected value [Faustino1234]; \
codes [Size.course.students[].name,Size.course.students.name,Size.students[].name,Size.students.name,Size.name,Size]; \
arguments [org.springframework.context.support.DefaultMessageSourceResolvable: \
codes [course.students[].name,students[].name]; arguments []; default message [students[].name],10,1]; \
default message [size must be between 1 and 10]"""));
// Fails as the container type is set due because leaf bean != arg
assertThat(ex.getBeanResults().get(0).getContainer()).isNull();
});
}

@Test
void problemThree_validateNestedReturnValueBean() {
MyService target = new MyService();

testReturnValue(target, getMethod(target, "getCourse"), programming203, ex -> {

assertThat(ex.getAllValidationResults()).hasSize(1);

assertBeanResult(ex.getBeanResults().get(0), -1, "course", faustino1234, List.of("""
Field error in object 'course' on field 'students[].name': rejected value [Faustino1234]; \
codes [Size.course.students[].name,Size.course.students.name,Size.students[].name,Size.students.name,Size.name,Size]; \
arguments [org.springframework.context.support.DefaultMessageSourceResolvable: \
codes [course.students[].name,students[].name]; arguments []; default message [students[].name],10,1]; \
default message [size must be between 1 and 10]"""));
// Fails as the container type is set due because leaf bean != arg
assertThat(ex.getBeanResults().get(0).getContainer()).isNull();
});
}

private void testArgs(Object target, Method method, Object[] args, Consumer<MethodValidationResult> consumer) {
consumer.accept(this.validationAdapter.validateArguments(target, method, null, args, new Class<?>[0]));
}
Expand All @@ -243,15 +423,15 @@ private void testReturnValue(Object target, Method method, @Nullable Object valu

private static void assertBeanResult(
ParameterErrors errors, int parameterIndex, String objectName, @Nullable Object argument,
List<String> fieldErrors) {
List<String> objectErrors) {

assertThat(errors.getMethodParameter().getParameterIndex()).isEqualTo(parameterIndex);
assertThat(errors.getObjectName()).isEqualTo(objectName);
assertThat(errors.getArgument()).isSameAs(argument);

assertThat(errors.getFieldErrors())
.extracting(FieldError::toString)
.containsExactlyInAnyOrderElementsOf(fieldErrors);
assertThat(errors.getAllErrors())
.extracting(ObjectError::toString)
.containsExactlyInAnyOrderElementsOf(objectErrors);
}

private static void assertValueResult(
Expand Down Expand Up @@ -288,8 +468,25 @@ public Person getPerson() {
public void addPeople(@Valid Collection<Person> people) {
}

public void registerCourse(@Valid Course course) {
}

@Valid
public Course getCourse() {
throw new UnsupportedOperationException();
}

public void setHobbiesSet(@Valid Set<@NotBlank String> hobbies) {
}

public void setHobbiesList(@Valid List<@NotBlank String> hobbies) {
}

}

@SuppressWarnings("unused")
private record Course(@NotBlank String title, @Valid Set<Person> students, @Valid Person professor) {
}

@SuppressWarnings("unused")
private record Person(@Size(min = 1, max = 10) String name, List<@NotBlank String> hobbies) {
Expand Down

0 comments on commit c0035aa

Please sign in to comment.