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

Customize ConstructorValidator #13

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
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
@@ -1,10 +1,13 @@
package org.unbrokendome.jackson.beanvalidation;

import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.Version;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.Module;
import com.fasterxml.jackson.databind.deser.DeserializationProblemHandler;

import javax.annotation.Nullable;
import javax.validation.ConstraintViolationException;
import javax.validation.ValidatorFactory;
import java.io.IOException;
Expand All @@ -15,6 +18,7 @@ public final class BeanValidationModule extends Module {

private final ValidatorFactory validatorFactory;
private final EnumSet<BeanValidationFeature> features;
@Nullable private ConstructorValidatorFactory constructorValidatorFactory;


public BeanValidationModule(ValidatorFactory validatorFactory) {
Expand Down Expand Up @@ -56,13 +60,19 @@ public BeanValidationModule disable(BeanValidationFeature feature) {
return this;
}

public BeanValidationModule setConstructorValidatorFactory(@Nullable ConstructorValidatorFactory factory) {
this.constructorValidatorFactory = factory;
return this;
}


@Override
public void setupModule(SetupContext context) {

BeanValidationFeatureSet featureSet = new BeanValidationFeatureSet(features);

context.addBeanDeserializerModifier(new ValidationBeanDeserializerModifier(validatorFactory, featureSet));
context.addBeanDeserializerModifier(new ValidationBeanDeserializerModifier(
validatorFactory, featureSet, constructorValidatorFactory));

context.addDeserializationProblemHandler(new DeserializationProblemHandler() {
@Override
Expand All @@ -75,6 +85,19 @@ public Object handleInstantiationProblem(DeserializationContext ctxt, Class<?> i
return super.handleInstantiationProblem(ctxt, instClass, argument, t);
}
}

@Override
public boolean handleUnknownProperty(
DeserializationContext ctxt, JsonParser p, JsonDeserializer<?> deserializer,
Object beanOrClass, String propertyName
) throws IOException {

if (beanOrClass instanceof InvalidObject) {
p.skipChildren();
return true;
}
return super.handleUnknownProperty(ctxt, p, deserializer, beanOrClass, propertyName);
}
});
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
package org.unbrokendome.jackson.beanvalidation;

import javax.validation.Validator;
import javax.validation.ValidatorFactory;
import java.lang.reflect.Constructor;

public interface ConstructorValidatorFactory {
Validator getValidator(ValidatorFactory validatorFactory, Constructor constructor, Object[] parameterValues);
}
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import javax.validation.ConstraintViolationException;
import javax.validation.ElementKind;
import javax.validation.Path;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;
import javax.validation.executable.ExecutableValidator;
import java.io.IOException;
Expand All @@ -32,16 +33,21 @@ class ValidatingValueInstantiator extends AbstractDelegatingValueInstantiator {

private final ValidatorFactory validatorFactory;
private final BeanValidationFeatureSet features;
private final ConstructorValidatorFactory constructorValidatorFactory;
private boolean validationEnabled = false;


ValidatingValueInstantiator(
StdValueInstantiator delegate, ValidatorFactory validatorFactory,
BeanValidationFeatureSet features
BeanValidationFeatureSet features,
@Nullable ConstructorValidatorFactory constructorValidatorFactory
) {
super(delegate);
this.validatorFactory = validatorFactory;
this.features = features;
this.constructorValidatorFactory = constructorValidatorFactory != null
? constructorValidatorFactory
: (factory, constructor, parameterValues) -> factory.getValidator();
}


Expand Down Expand Up @@ -182,11 +188,11 @@ private Set<ConstraintViolation<?>> validateCreatorArgs(
}

Member creatorMember = getWithArgsCreator().getMember();
ExecutableValidator executableValidator = validatorFactory.getValidator().forExecutables();

if (creatorMember instanceof Constructor) {
return (Set) executableValidator.validateConstructorParameters(
(Constructor<?>) creatorMember, args);
Constructor constructor = (Constructor) creatorMember;
Validator validator = constructorValidatorFactory.getValidator(validatorFactory, constructor, args);
return validator.forExecutables().validateConstructorParameters(constructor, args);

} else if (creatorMember instanceof Method) {
// Bean validation doesn't support parameter validation for static methods :-(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
import com.fasterxml.jackson.databind.deser.impl.MethodProperty;
import com.fasterxml.jackson.databind.deser.std.StdValueInstantiator;

import javax.annotation.Nullable;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;
import java.util.ArrayList;
Expand All @@ -18,11 +19,14 @@ final class ValidationBeanDeserializerModifier extends BeanDeserializerModifier

private final ValidatorFactory validatorFactory;
private final BeanValidationFeatureSet features;
private final ConstructorValidatorFactory constructorValidatorFactory;


ValidationBeanDeserializerModifier(ValidatorFactory validatorFactory, BeanValidationFeatureSet features) {
ValidationBeanDeserializerModifier(ValidatorFactory validatorFactory, BeanValidationFeatureSet features,
@Nullable ConstructorValidatorFactory constructorValidatorFactory) {
this.validatorFactory = validatorFactory;
this.features = features;
this.constructorValidatorFactory = constructorValidatorFactory;
}


Expand All @@ -49,7 +53,7 @@ public BeanDeserializerBuilder updateBuilder(
ValueInstantiator valueInstantiator = builder.getValueInstantiator();
if (valueInstantiator instanceof StdValueInstantiator) {
builder.setValueInstantiator(new ValidatingValueInstantiator(
(StdValueInstantiator) valueInstantiator, validatorFactory, features));
(StdValueInstantiator) valueInstantiator, validatorFactory, features, constructorValidatorFactory));
}

return builder;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,15 @@ import javax.validation.ConstraintViolationException
import javax.validation.Validation


abstract class AbstractValidationTest {
abstract class AbstractValidationTest(constructorValidatorFactory: ConstructorValidatorFactory? = null) {

private val validatorFactory = Validation.byDefaultProvider()
.configure()
.messageInterpolator(ParameterMessageInterpolator())
.buildValidatorFactory()

protected val beanValidationModule: BeanValidationModule = BeanValidationModule(validatorFactory)
.setConstructorValidatorFactory(constructorValidatorFactory)

protected val objectMapper: ObjectMapper = ObjectMapper()
.registerModule(beanValidationModule)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ class KotlinValidationTest : AbstractValidationTest() {

private class NestedListArgumentsProvider : ArgumentsProvider {
override fun provideArguments(context: ExtensionContext): Stream<Arguments> = Stream.of(
Arguments.of("nested[0].value", """{ "nested": [{}] }"""),
Arguments.of("nested[0].value", """{ "nested": [{}, {"value":"v1"}] }"""),
Arguments.of("nested[1].value", """{ "nested": [{"value":"test"},{}] }"""),
Arguments.of("nested[2].value", """{ "nested": [{"value":"1"},{"value":"2"},{}] }""")
)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
package org.unbrokendome.jackson.beanvalidation.constraints

import org.hibernate.validator.HibernateValidatorFactory
import org.unbrokendome.jackson.beanvalidation.ConstructorValidatorFactory
import java.lang.reflect.Constructor
import javax.validation.Validator
import javax.validation.ValidatorFactory

class HibernateConstructorValidatorFactory : ConstructorValidatorFactory {
override fun getValidator(validatorFactory: ValidatorFactory, constructor: Constructor<Any>, parameterValues: Array<out Any>): Validator {
val declaredFields = constructor.declaringClass.declaredFields
val payload: Map<String, Any> = parameterValues
.mapIndexed { index, value -> declaredFields[index].name to value}
.toMap()

return validatorFactory.unwrap(HibernateValidatorFactory::class.java)
.usingContext().constraintValidatorPayload(payload).validator
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
package org.unbrokendome.jackson.beanvalidation.constraints

import javax.validation.Constraint
import javax.validation.Payload
import kotlin.annotation.AnnotationTarget.*
import kotlin.reflect.KClass

@Target(FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER, FIELD, ANNOTATION_CLASS, CONSTRUCTOR, VALUE_PARAMETER)
@Retention
@MustBeDocumented
@Constraint(validatedBy = [NotNullWhenValidator::class])
annotation class NotNullWhen(
val field: String,
val value: String,
val message: String = "{javax.validation.constraints.NotNull.message}",
val groups: Array<KClass<*>> = [],
val payload: Array<KClass<out Payload>> = []
)

Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
package org.unbrokendome.jackson.beanvalidation.constraints

import assertk.assertThat
import assertk.assertions.hasSize
import com.fasterxml.jackson.annotation.JsonCreator
import com.fasterxml.jackson.annotation.JsonProperty
import org.junit.jupiter.api.Test
import org.unbrokendome.jackson.beanvalidation.AbstractValidationTest
import org.unbrokendome.jackson.beanvalidation.JsonValidated
import org.unbrokendome.jackson.beanvalidation.assertions.hasViolation

class NotNullWhenValidationTest : AbstractValidationTest(HibernateConstructorValidatorFactory()) {

@JsonValidated
class BeanWithCrossValidation
@JsonCreator constructor(
@param:JsonProperty("hasDetails")
val hasDetails: Boolean,
@param:JsonProperty("details")
@NotNullWhen(field = "hasDetails", value = "true")
val details: String?
)

@Test
fun `should not report violation when precondition is not matched`() {

val json = """{ "hasDetails": false, "details": "" }"""

assertNoViolationsOnDeserialization<BeanWithCrossValidation>(json)
}


@Test
fun `should not report violation when precondition is matched and value is valid`() {

val json = """{ "hasDetails": false, "details": "secure" }"""

assertNoViolationsOnDeserialization<BeanWithCrossValidation>(json)
}

@Test
fun `should report violation when precondition is matched and value is null`() {

val json = """{ "hasDetails": true }"""

val violations = assertViolationsOnDeserialization<BeanWithCrossValidation>(json)

assertThat(violations).hasSize(1)
assertThat(violations).hasViolation<NotNullWhen>("details")
}

@Test
fun `should not report violation when precondition is matched and value is empty`() {

val json = """{ "hasDetails": true, "details": "" }"""

assertNoViolationsOnDeserialization<BeanWithCrossValidation>(json)
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
package org.unbrokendome.jackson.beanvalidation.constraints

import org.hibernate.validator.constraintvalidation.HibernateConstraintValidatorContext
import java.util.*
import javax.validation.ConstraintValidator
import javax.validation.ConstraintValidatorContext

class NotNullWhenValidator : ConstraintValidator<NotNullWhen, String?> {
private var field: String = ""
private var value: String = ""

override fun initialize(notNullWhen: NotNullWhen) {
field = notNullWhen.field
value = notNullWhen.value
}

override fun isValid(data: String?, context: ConstraintValidatorContext): Boolean {
val hibernateValidatorCtx = context.unwrap(HibernateConstraintValidatorContext::class.java)
val constructorParams = hibernateValidatorCtx.getConstraintValidatorPayload(Map::class.java)
val actualValue = constructorParams[field]
return actualValue == null ||
!Objects.equals(actualValue.toString(), value) ||
data != null
}
}