/*
* JBoss, Home of Professional Open Source
* Copyright 2009, Red Hat, Inc. and/or its affiliates, and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* 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
* http://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.hibernate.beanvalidation.tck.tests.validation;
import java.lang.annotation.Annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import java.util.Set;
import javax.validation.Constraint;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import javax.validation.ConstraintViolation;
import javax.validation.ElementKind;
import javax.validation.Payload;
import javax.validation.UnexpectedTypeException;
import javax.validation.ValidationException;
import javax.validation.Validator;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;
import javax.validation.groups.Default;
import javax.validation.metadata.BeanDescriptor;
import javax.validation.metadata.ConstraintDescriptor;
import javax.validation.metadata.PropertyDescriptor;
import org.jboss.arquillian.container.test.api.Deployment;
import org.jboss.arquillian.testng.Arquillian;
import org.jboss.shrinkwrap.api.spec.WebArchive;
import org.jboss.test.audit.annotations.SpecAssertion;
import org.jboss.test.audit.annotations.SpecAssertions;
import org.jboss.test.audit.annotations.SpecVersion;
import org.testng.annotations.Test;
import org.hibernate.beanvalidation.tck.util.TestUtil;
import org.hibernate.beanvalidation.tck.util.shrinkwrap.WebArchiveBuilder;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import static org.hibernate.beanvalidation.tck.util.TestUtil.assertCorrectConstraintTypes;
import static org.hibernate.beanvalidation.tck.util.TestUtil.assertCorrectNumberOfViolations;
import static org.hibernate.beanvalidation.tck.util.TestUtil.assertCorrectPathNodeKinds;
import static org.hibernate.beanvalidation.tck.util.TestUtil.assertCorrectPathNodeNames;
import static org.hibernate.beanvalidation.tck.util.TestUtil.assertCorrectPropertyPaths;
import static org.hibernate.beanvalidation.tck.util.TestUtil.kinds;
import static org.hibernate.beanvalidation.tck.util.TestUtil.names;
import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertNotNull;
import static org.testng.Assert.assertNull;
import static org.testng.Assert.assertTrue;
/**
* Tests for the implementation of <code>Validator</code>.
*
* @author Hardy Ferentschik
*/
@SpecVersion(spec = "beanvalidation", version = "1.1.0")
public class ValidateTest extends Arquillian {
@Deployment
public static WebArchive createTestArchive() {
return new WebArchiveBuilder()
.withTestClass( ValidateTest.class )
.withClasses(
Engine.class,
Boy.class,
Actor.class,
ActorArrayBased.class,
ActorListBased.class,
PlayedWith.class,
Customer.class,
Person.class,
Order.class,
Address.class,
BadlyBehavedEntity.class,
Last.class,
NotEmpty.class
)
.build();
}
@Test(expectedExceptions = UnexpectedTypeException.class)
// UnexpectedTypeException is a subclass of ValidationException
@SpecAssertions({
@SpecAssertion(section = "4.1", id = "a"),
@SpecAssertion(section = "4.6.4", id = "h"),
@SpecAssertion(section = "6.1", id = "c")
})
public void testUnexpectedTypeException() {
Boy boy = new Boy();
TestUtil.getValidatorUnderTest().validate( boy );
}
@Test
@SpecAssertion(section = "6.1", id = "a")
public void testConstraintDescriptorWithoutExplicitGroup() {
Validator validator = TestUtil.getValidatorUnderTest();
BeanDescriptor beanDescriptor = validator.getConstraintsForClass( Order.class );
PropertyDescriptor propertyDescriptor = beanDescriptor.getConstraintsForProperty( "orderNumber" );
Set<ConstraintDescriptor<?>> descriptors = propertyDescriptor.getConstraintDescriptors();
assertEquals( descriptors.size(), 1, "There should be only one constraint descriptor" );
ConstraintDescriptor<?> descriptor = descriptors.iterator().next();
Set<Class<?>> groups = descriptor.getGroups();
assertTrue( groups.size() == 1, "There should be only one group" );
assertEquals(
groups.iterator().next(),
Default.class,
"The declared constraint does not explicitly define a group, hence Default is expected"
);
}
@Test(expectedExceptions = IllegalArgumentException.class)
@SpecAssertion(section = "6.1", id = "b")
public void testNullParameterToGetConstraintsForClass() {
TestUtil.getValidatorUnderTest().getConstraintsForClass( null );
}
@Test(expectedExceptions = IllegalArgumentException.class)
@SpecAssertion(section = "5.1.1", id = "b")
public void testValidateWithNullValue() {
Validator validator = TestUtil.getValidatorUnderTest();
validator.validate( null );
}
@Test(expectedExceptions = IllegalArgumentException.class)
@SpecAssertion(section = "5.1.1", id = "b")
public void testValidateWithNullGroup() {
Validator validator = TestUtil.getValidatorUnderTest();
validator.validate( new Boy(), (Class<?>) null );
}
@Test
@SpecAssertions({
@SpecAssertion(section = "5.1.1", id = "a"),
@SpecAssertion(section = "5.1.1", id = "c")
})
public void testMultipleViolationOfTheSameType() {
Validator validator = TestUtil.getValidatorUnderTest();
Engine engine = new Engine();
engine.setSerialNumber( "mail@foobar.com" );
Set<ConstraintViolation<Engine>> constraintViolations = validator.validate( engine );
assertCorrectNumberOfViolations( constraintViolations, 2 );
engine.setSerialNumber( "ABCDEFGH1234" );
constraintViolations = validator.validate( engine );
assertCorrectNumberOfViolations( constraintViolations, 1 );
engine.setSerialNumber( "ABCD-EFGH-1234" );
constraintViolations = validator.validate( engine );
assertCorrectNumberOfViolations( constraintViolations, 0 );
}
@Test
@SpecAssertions({
@SpecAssertion(section = "4.6", id = "c"),
@SpecAssertion(section = "5.1.1", id = "c")
})
public void testMultipleConstraintViolationOfDifferentTypes() {
Validator validator = TestUtil.getValidatorUnderTest();
Address address = new Address();
address.setStreet( null );
address.setZipCode( null );
address.setCity( "Llanfairpwllgwyngyllgogerychwyrndrobwyll-llantysiliogogogoch" ); //town in North Wales
Set<ConstraintViolation<Address>> constraintViolations = validator.validate( address );
assertCorrectNumberOfViolations( constraintViolations, 2 );
assertCorrectConstraintTypes( constraintViolations, Size.class, NotEmpty.class );
}
@Test
@SpecAssertions({
@SpecAssertion(section = "4.1", id = "a"),
@SpecAssertion(section = "4.6", id = "a"),
@SpecAssertion(section = "4.6", id = "c"),
@SpecAssertion(section = "5.2", id = "a"),
@SpecAssertion(section = "5.2", id = "b"),
@SpecAssertion(section = "5.2", id = "c"),
@SpecAssertion(section = "5.2", id = "e"),
@SpecAssertion(section = "5.2", id = "f"),
@SpecAssertion(section = "5.2", id = "i"),
@SpecAssertion(section = "5.2", id = "g"),
@SpecAssertion(section = "5.2", id = "h"),
@SpecAssertion(section = "5.2", id = "k"),
@SpecAssertion(section = "6.11", id = "a"),
})
public void testConstraintViolation() {
Validator validator = TestUtil.getValidatorUnderTest();
Engine engine = new Engine();
engine.setSerialNumber( "ABCDEFGH1234" );
Set<ConstraintViolation<Engine>> constraintViolations = validator.validate( engine );
assertCorrectNumberOfViolations( constraintViolations, 1 );
ConstraintViolation<Engine> violation = constraintViolations.iterator().next();
assertEquals( violation.getMessage(), "must match ^....-....-....$", "Wrong message" );
assertEquals( violation.getMessageTemplate(), "must match {regexp}", "Wrong message template" );
assertEquals( violation.getRootBean(), engine, "Wrong root entity." );
assertEquals( violation.getRootBeanClass(), Engine.class, "Wrong root bean class." );
assertEquals( violation.getLeafBean(), engine );
assertEquals( violation.getInvalidValue(), "ABCDEFGH1234", "Wrong validated value" );
assertNull( violation.getExecutableParameters() );
assertNull( violation.getExecutableReturnValue() );
assertNotNull( violation.getConstraintDescriptor(), "Constraint descriptor should not be null" );
Annotation ann = violation.getConstraintDescriptor().getAnnotation();
assertEquals( ann.annotationType(), Pattern.class, "Wrong annotation type" );
assertCorrectPropertyPaths( constraintViolations, "serialNumber" );
engine.setSerialNumber( "ABCD-EFGH-1234" );
constraintViolations = validator.validate( engine );
assertCorrectNumberOfViolations( constraintViolations, 0 );
}
@Test
@SpecAssertions({
@SpecAssertion(section = "4.6", id = "a"),
@SpecAssertion(section = "5.2", id = "c"),
@SpecAssertion(section = "5.2", id = "e"),
@SpecAssertion(section = "5.2", id = "f"),
@SpecAssertion(section = "5.2", id = "i")
})
public void testClassLevelConstraintViolation() {
Validator validator = TestUtil.getValidatorUnderTest();
DirtBike bike = new DirtBike();
Set<ConstraintViolation<DirtBike>> constraintViolations = validator.validate( bike );
assertCorrectNumberOfViolations( constraintViolations, 1 );
ConstraintViolation<DirtBike> violation = constraintViolations.iterator().next();
assertEquals( violation.getRootBean(), bike, "Wrong root entity." );
assertEquals( violation.getRootBeanClass(), DirtBike.class, "Wrong root bean class." );
assertEquals( violation.getLeafBean(), bike, "Wrong leaf bean." );
assertEquals( violation.getInvalidValue(), bike, "Wrong validated value" );
assertNotNull( violation.getConstraintDescriptor(), "Constraint descriptor should not be null" );
Annotation ann = violation.getConstraintDescriptor().getAnnotation();
assertEquals( ann.annotationType(), ValidDirtBike.class, "Wrong annotation type" );
assertCorrectPathNodeKinds( constraintViolations, kinds( ElementKind.BEAN ) );
assertCorrectPathNodeNames( constraintViolations, names( (String) null ) );
}
@Test
@SpecAssertions({
@SpecAssertion(section = "3.4", id = "r"),
@SpecAssertion(section = "4.6", id = "a"),
@SpecAssertion(section = "5.2", id = "f")
})
public void testGraphValidationWithList() {
Validator validator = TestUtil.getValidatorUnderTest();
Actor clint = new ActorListBased( "Clint", "Eastwood" );
Actor morgan = new ActorListBased( "Morgan", null );
Actor charlie = new ActorListBased( "Charlie", "Sheen" );
clint.addPlayedWith( charlie );
charlie.addPlayedWith( clint );
charlie.addPlayedWith( morgan );
morgan.addPlayedWith( charlie );
morgan.addPlayedWith( clint );
clint.addPlayedWith( morgan );
Set<ConstraintViolation<Actor>> constraintViolations = validator.validate( clint );
assertCorrectNumberOfViolations( constraintViolations, 2 );
ConstraintViolation<Actor> constraintViolation = constraintViolations.iterator().next();
assertEquals( constraintViolation.getMessage(), "Everyone has a last name.", "Wrong message" );
assertEquals( constraintViolation.getRootBean(), clint, "Wrong root entity" );
assertEquals( constraintViolation.getLeafBean(), morgan );
assertEquals( constraintViolation.getInvalidValue(), morgan.getLastName(), "Wrong value" );
assertCorrectPropertyPaths(
constraintViolations,
"playedWith[0].playedWith[1].lastName",
"playedWith[1].lastName"
);
}
@Test
@SpecAssertions({
@SpecAssertion(section = "3.4", id = "r"),
@SpecAssertion(section = "4.1.3", id = "i"),
@SpecAssertion(section = "4.1.3", id = "d")
})
public void testGraphValidationWithArray() {
Validator validator = TestUtil.getValidatorUnderTest();
Actor clint = new ActorArrayBased( "Clint", "Eastwood" );
Actor morgan = new ActorArrayBased( "Morgan", null );
Actor charlie = new ActorArrayBased( "Charlie", "Sheen" );
clint.addPlayedWith( charlie );
charlie.addPlayedWith( clint );
charlie.addPlayedWith( morgan );
morgan.addPlayedWith( charlie );
morgan.addPlayedWith( clint );
clint.addPlayedWith( morgan );
Set<ConstraintViolation<Actor>> constraintViolations = validator.validate( clint );
assertCorrectNumberOfViolations( constraintViolations, 2 );
ConstraintViolation<Actor> constraintViolation = constraintViolations.iterator().next();
assertEquals( constraintViolation.getMessage(), "Everyone has a last name.", "Wrong message" );
assertEquals( constraintViolation.getRootBean(), clint, "Wrong root entity" );
assertEquals( constraintViolation.getInvalidValue(), morgan.getLastName(), "Wrong value" );
assertCorrectPropertyPaths(
constraintViolations,
"playedWith[0].playedWith[1].lastName",
"playedWith[1].lastName"
);
}
@Test
@SpecAssertion(section = "4.4.2", id = "b")
public void testOnlyFirstGroupInSequenceGetEvaluated() {
Validator validator = TestUtil.getValidatorUnderTest();
Car car = new Car( "USd-298" );
Set<ConstraintViolation<Car>> violations = validator.validateProperty(
car, "licensePlateNumber", First.class, Second.class
);
assertCorrectNumberOfViolations( violations, 1 );
car.setLicensePlateNumber( "USD-298" );
violations = validator.validateProperty(
car, "licensePlateNumber", First.class, Second.class
);
assertCorrectNumberOfViolations( violations, 0 );
}
@Test(expectedExceptions = ValidationException.class)
@SpecAssertion(section = "5.1.1", id = "k")
public void testUnexpectedExceptionsInValidateGetWrappedInValidationExceptions() {
Validator validator = TestUtil.getValidatorUnderTest();
validator.validate( new BadlyBehavedEntity() );
}
private static class Car {
@Pattern(regexp = "[A-Z][A-Z][A-Z]-[0-9][0-9][0-9]", groups = { First.class, Second.class })
private String licensePlateNumber;
Car(String licensePlateNumber) {
this.licensePlateNumber = licensePlateNumber;
}
@SuppressWarnings("unused")
public String getLicensePlateNumber() {
return licensePlateNumber;
}
public void setLicensePlateNumber(String licensePlateNumber) {
this.licensePlateNumber = licensePlateNumber;
}
}
@ValidDirtBike
private static class DirtBike {
}
private interface First {
}
private interface Second {
}
@Constraint(validatedBy = ValidDirtBike.Validator.class)
@Documented
@Target({ TYPE })
@Retention(RUNTIME)
public @interface ValidDirtBike {
String message() default "{ValidDirtBike.message}";
Class<?>[] groups() default { };
Class<? extends Payload>[] payload() default { };
public static class Validator implements ConstraintValidator<ValidDirtBike, DirtBike> {
@Override
public void initialize(ValidDirtBike constraint) {
}
@Override
public boolean isValid(DirtBike bike, ConstraintValidatorContext constraintValidatorContext) {
return false;
}
}
}
}