Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: Calling addConstraintViolation on a ConstraintValidatorContext results in a wrong validation message #444

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
package io.micronaut.docs.validation;

import io.micronaut.context.annotation.Property;
import io.micronaut.context.annotation.Requires;
import io.micronaut.core.annotation.AnnotationValue;
import io.micronaut.core.annotation.Introspected;
import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.test.extensions.junit5.annotation.MicronautTest;
import io.micronaut.validation.validator.Validator;
import io.micronaut.validation.validator.constraints.ConstraintValidator;
import io.micronaut.validation.validator.constraints.ConstraintValidatorContext;
import jakarta.inject.Inject;
import jakarta.inject.Singleton;
import jakarta.validation.Constraint;
import jakarta.validation.ConstraintViolation;
import jakarta.validation.Payload;
import jakarta.validation.constraints.Pattern;
import org.junit.jupiter.api.Test;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Set;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.ElementType.TYPE_USE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.empty;
import static org.hamcrest.Matchers.not;

@Property(name = "spec.name", value = "CustomerConstraintTest")
@MicronautTest(startApplication = false)
class CustomerConstraintTest {

@Inject
Validator validator;


@Test
void should_return_interpolated_message() {
// Given
var bean = new ExampleBean();
bean.getList().add("11111");

// When
Set<ConstraintViolation<ExampleBean>> violations = validator.validate(bean);

// Then
assertThat("violations", violations, not(empty()));
assertThat("violations[0].message", violations.iterator().next().getMessage(), containsString("[a-z]"));
assertThat("violations[0].message", violations.iterator().next().getMessageTemplate(), containsString("regexp"));
}

@Introspected
static class ExampleBean {
@CollectionPattern(regexp = "[a-z]")
private List<String> list = new ArrayList<>();

public List<String> getList() {
return list;
}

public void setList(List<String> list) {
this.list = list;
}
}

@Target({FIELD, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {CollectionPatternValidator.class})
@interface CollectionPattern {

String regexp();

Pattern.Flag[] flags() default {};

String message() default "{jakarta.validation.constraints.Pattern.message}";

Class<?>[] groups() default {};

Class<? extends Payload>[] payload() default {};
}

@Requires(property = "spec.name", value = "CustomerConstraintTest")
@Singleton
static class CollectionPatternValidator implements ConstraintValidator<CollectionPattern, Collection<String>> {

@Override
public boolean isValid(@Nullable Collection<String> values,
@NonNull AnnotationValue<CollectionPattern> annotationMetadata,
@NonNull ConstraintValidatorContext context) {

if (values == null || values.isEmpty()) {
return true;
}

final String regexp = annotationMetadata.getRequiredValue("regexp", String.class);
final java.util.regex.Pattern regex = java.util.regex.Pattern.compile(regexp);

context.disableDefaultConstraintViolation();

boolean valid = true;
for (String value : values) {
if (value != null && !regex.matcher(value).matches()) {

context.buildConstraintViolationWithTemplate("must match \"{regexp}\"")
.addPropertyNode("[" + value + "]")
.addConstraintViolation();

valid = false;
}
}
return valid;
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,6 @@ public ConstraintValidatorContext addConstraintViolation() {
constraintValidatorContext.getRootClass(),
null,
null,
messageTemplate,
messageInterpolator.interpolate(messageTemplate, new MessageInterpolator.Context() {
@Override
public ConstraintDescriptor<?> getConstraintDescriptor() {
Expand All @@ -138,6 +137,7 @@ public <T> T unwrap(Class<T> type) {
throw new ValidationException("Not supported!");
}
}),
messageTemplate,
validationPath.iterator().hasNext() ? validationPath : new ValidationPath(constraintValidatorContext.getCurrentPath()),
constraintValidatorContext.constraint,
null,
Expand Down
Loading