// $Id$
/*
* 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.jsr303.tck.tests.constraints.groups;
import java.util.Set;
import javax.validation.ConstraintViolation;
import javax.validation.GroupDefinitionException;
import javax.validation.Validator;
import javax.validation.groups.Default;
import javax.validation.metadata.BeanDescriptor;
import javax.validation.metadata.ConstraintDescriptor;
import javax.validation.metadata.PropertyDescriptor;
import org.jboss.test.audit.annotations.SpecAssertion;
import org.jboss.test.audit.annotations.SpecAssertions;
import org.jboss.testharness.AbstractTest;
import org.jboss.testharness.impl.packaging.Artifact;
import org.jboss.testharness.impl.packaging.ArtifactType;
import org.jboss.testharness.impl.packaging.Classes;
import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertTrue;
import static org.testng.Assert.fail;
import org.testng.annotations.Test;
import org.hibernate.jsr303.tck.util.TestUtil;
import static org.hibernate.jsr303.tck.util.TestUtil.assertCorrectConstraintViolationMessages;
import static org.hibernate.jsr303.tck.util.TestUtil.assertCorrectNumberOfViolations;
import static org.hibernate.jsr303.tck.util.TestUtil.assertCorrectPropertyPaths;
import static org.hibernate.jsr303.tck.util.TestUtil.assertEqualPaths;
/**
* Tests for the group and group sequence feature.
*
* @author Hardy Ferentschik
*/
@Artifact(artifactType = ArtifactType.JSR303)
@Classes({ TestUtil.class, TestUtil.PathImpl.class, TestUtil.NodeImpl.class })
public class GroupTest extends AbstractTest {
@Test
@SpecAssertion(section = "3.4", id = "a")
public void testConstraintWithNoExplicitlySpecifiedGroupBelongsToDefault() {
Validator validator = TestUtil.getValidatorUnderTest();
BeanDescriptor beanDescriptor = validator.getConstraintsForClass( User.class );
assertTrue( beanDescriptor.isBeanConstrained() );
PropertyDescriptor propDesc = beanDescriptor.getConstraintsForProperty( "firstname" );
assertTrue( propDesc.getConstraintDescriptors().size() == 1 );
ConstraintDescriptor descriptor = propDesc.getConstraintDescriptors().iterator().next();
assertTrue( descriptor.getGroups().size() == 1 );
assertEquals(
descriptor.getGroups().iterator().next(),
Default.class,
"Constraint should implicitly belong to the Default group."
);
}
@Test
@SpecAssertions({
@SpecAssertion(section = "3.4", id = "b"),
@SpecAssertion(section = "3.4", id = "d")
})
public void testValidateAgainstDifferentGroups() {
User user = new User();
// all fields per default null. Depending on the validation groups there should be a different amount
// of constraint failures.
Validator validator = TestUtil.getValidatorUnderTest();
Set<ConstraintViolation<User>> constraintViolations = validator.validate( user );
assertEquals(
constraintViolations.size(),
2,
"There should be two violations against the implicit default group"
);
constraintViolations = validator.validate( user, Default.class );
assertEquals(
constraintViolations.size(),
2,
"There should be two violations against the explicit default group"
);
constraintViolations = validator.validate( user, User.Billable.class );
assertEquals(
constraintViolations.size(),
1,
"There should be one violation against Billable"
);
constraintViolations = validator.validate( user, Default.class, User.Billable.class );
assertEquals(
constraintViolations.size(),
3,
"There should be 3 violation against Default and Billable"
);
constraintViolations = validator.validate( user, User.BuyInOneClick.class );
assertEquals(
constraintViolations.size(),
3,
"Three violations expected since BuyInOneClick extends Default and Billable"
);
constraintViolations = validator.validate( user, User.BuyInOneClick.class, User.Billable.class );
assertEquals(
constraintViolations.size(),
3,
"BuyInOneClick already contains all other groups. Adding Billable does not change the number of violations"
);
constraintViolations = validator.validate( user, User.BuyInOneClick.class, Default.class );
assertEquals(
constraintViolations.size(),
3,
"BuyInOneClick already contains all other groups. Adding Default does not change the number of violations"
);
constraintViolations = validator.validate( user, User.BuyInOneClick.class, Default.class, User.Billable.class );
assertEquals(
constraintViolations.size(),
3,
"BuyInOneClick already contains all other groups. Adding Billable and Default does not change the number of violations"
);
constraintViolations = validator.validate( user, User.Billable.class, User.Billable.class );
assertEquals(
constraintViolations.size(),
1,
"Adding the same group twice is still only leads to a single violation"
);
}
@Test
@SpecAssertion(section = "3.4", id = "c")
public void testConstraintCanBelongToMoreThanOneGroup() {
Validator validator = TestUtil.getValidatorUnderTest();
BeanDescriptor beanDescriptor = validator.getConstraintsForClass( User.class );
assertTrue( beanDescriptor.isBeanConstrained() );
PropertyDescriptor propDesc = beanDescriptor.getConstraintsForProperty( "defaultCreditCard" );
assertTrue( propDesc.getConstraintDescriptors().size() == 1 );
ConstraintDescriptor descriptor = propDesc.getConstraintDescriptors().iterator().next();
assertTrue( descriptor.getGroups().size() == 2 );
}
@Test
@SpecAssertion(section = "3.4", id = "d")
public void testGroups() {
Validator validator = TestUtil.getValidatorUnderTest();
Author author = new Author();
author.setLastName( "" );
author.setFirstName( "" );
Book book = new Book();
book.setTitle( "" );
book.setAuthor( author );
Set<ConstraintViolation<Book>> constraintViolations = validator.validate(
book, First.class, Second.class, Last.class
);
assertEquals( constraintViolations.size(), 3, "Wrong number of constraints" );
author.setFirstName( "Gavin" );
author.setLastName( "King" );
constraintViolations = validator.validate( book, First.class, Second.class, Last.class );
ConstraintViolation constraintViolation = constraintViolations.iterator().next();
assertEquals( constraintViolations.size(), 1, "Wrong number of constraints" );
assertEquals( constraintViolation.getRootBean(), book, "Wrong root entity" );
assertEquals( constraintViolation.getInvalidValue(), book.getTitle(), "Wrong value" );
assertCorrectPropertyPaths( constraintViolations, "title" );
book.setTitle( "Hibernate Persistence with JPA" );
book.setSubtitle( "Revised Edition of Hibernate in Action" );
constraintViolations = validator.validate( book, First.class, Second.class, Last.class );
assertCorrectNumberOfViolations( constraintViolations, 1 );
assertCorrectConstraintViolationMessages(
constraintViolations, "The book's subtitle can only have 30 characters"
);
constraintViolation = constraintViolations.iterator().next();
assertEquals( constraintViolation.getRootBean(), book, "Wrong root entity" );
assertEquals( constraintViolation.getInvalidValue(), book.getSubtitle(), "Wrong value" );
assertCorrectPropertyPaths( constraintViolations, "subtitle" );
book.setSubtitle( "Revised Edition" );
author.setCompany( "JBoss a division of RedHat" );
constraintViolations = validator.validate( book, First.class, Second.class, Last.class );
constraintViolation = constraintViolations.iterator().next();
assertCorrectNumberOfViolations( constraintViolations, 1 );
assertCorrectConstraintViolationMessages(
constraintViolations, "The company name can only have 20 characters"
);
assertEquals( constraintViolation.getRootBean(), book, "Wrong root entity" );
assertEquals( constraintViolation.getInvalidValue(), author.getCompany(), "Wrong value" );
assertCorrectPropertyPaths( constraintViolations, "author.company" );
author.setCompany( "JBoss" );
constraintViolations = validator.validate( book, First.class, Second.class, Last.class );
assertEquals( constraintViolations.size(), 0, "Wrong number of constraints" );
}
@Test
@SpecAssertions({
@SpecAssertion(section = "3.4.2", id = "b"),
@SpecAssertion(section = "3.4.2", id = "d")
})
public void testGroupSequence() {
Validator validator = TestUtil.getValidatorUnderTest();
Author author = new Author();
author.setLastName( "" );
author.setFirstName( "" );
Book book = new Book();
book.setAuthor( author );
Set<ConstraintViolation<Book>> constraintViolations = validator.validate( book, Book.All.class );
assertEquals( constraintViolations.size(), 2, "Wrong number of constraints" );
author.setFirstName( "Gavin" );
author.setLastName( "King" );
constraintViolations = validator.validate( book, Book.All.class );
assertCorrectNumberOfViolations( constraintViolations, 1 );
assertCorrectConstraintViolationMessages( constraintViolations, "The book title cannot be null" );
ConstraintViolation constraintViolation = constraintViolations.iterator().next();
assertEquals( constraintViolation.getRootBean(), book, "Wrong root entity" );
assertEquals( constraintViolation.getInvalidValue(), book.getTitle(), "Wrong value" );
assertCorrectPropertyPaths( constraintViolations, "title" );
book.setTitle( "Hibernate Persistence with JPA" );
book.setSubtitle( "Revised Edition of Hibernate in Action" );
constraintViolations = validator.validate( book, Book.All.class );
assertEquals( constraintViolations.size(), 1, "Wrong number of constraints" );
book.setSubtitle( "Revised Edition" );
author.setCompany( "JBoss a division of RedHat" );
constraintViolations = validator.validate( book, Book.All.class );
assertEquals( constraintViolations.size(), 1, "Wrong number of constraints" );
author.setCompany( "JBoss" );
constraintViolations = validator.validate( book, Book.All.class );
assertEquals( constraintViolations.size(), 0, "Wrong number of constraints" );
}
@Test
@SpecAssertions({
@SpecAssertion(section = "3.4", id = "c"),
@SpecAssertion(section = "3.5", id = "b")
})
public void testValidationFailureInMultipleGroups() {
Validator validator = TestUtil.getValidatorUnderTest();
Animal elephant = new Animal();
elephant.setName( "" );
elephant.setDomain( Animal.Domain.EUKARYOTA );
Set<ConstraintViolation<Animal>> constraintViolations = validator.validate(
elephant, First.class, Second.class
);
assertEquals(
constraintViolations.size(),
1,
"The should be only one invalid constraint even though the constraint belongs to both groups"
);
}
@Test
@SpecAssertion(section = "3.4", id = "d")
public void testGroupSequenceFollowedByGroup() {
User user = new User();
user.setFirstname( "Foo" );
user.setLastname( "Bar" );
user.setPhoneNumber( "+46 123-456" );
Validator validator = TestUtil.getValidatorUnderTest();
Set<ConstraintViolation<User>> constraintViolations = validator.validate(
user, User.BuyInOneClick.class, User.Optional.class
);
assertEquals(
constraintViolations.size(),
2,
"There should be two violations against the implicit default group"
);
for ( ConstraintViolation<User> constraintViolation : constraintViolations ) {
if ( assertEqualPaths(
constraintViolation.getPropertyPath(), TestUtil.PathImpl.createPathFromString( "defaultCreditCard" )
) ) {
TestUtil.assertConstraintViolation(
constraintViolation,
User.class,
null,
"defaultCreditCard"
);
}
else if ( assertEqualPaths(
constraintViolation.getPropertyPath(), TestUtil.PathImpl.createPathFromString( "phoneNumber" )
) ) {
TestUtil.assertConstraintViolation(
constraintViolation,
User.class,
"+46 123-456",
"phoneNumber"
);
}
else {
fail( "Unexpected violation" );
}
}
}
@Test
@SpecAssertion(section = "3.4.4", id = "a")
public void testImplicitGrouping() {
Validator validator = TestUtil.getValidatorUnderTest();
BeanDescriptor beanDescriptor = validator.getConstraintsForClass( Order.class );
assertTrue( beanDescriptor.isBeanConstrained() );
// validating the Default Group should validate all 5 constraints
Order order = new Order();
Set<ConstraintViolation<Order>> violations = validator.validate( order );
assertTrue( violations.size() == 5, "All 5 NotNull constraints should fail." );
// use implicit group Auditable - only the constraints defined on Auditable should be validated
violations = validator.validate( order, Auditable.class );
assertTrue( violations.size() == 4, "All 4 NotNull constraints on Auditable should fail." );
}
@Test(expectedExceptions = GroupDefinitionException.class)
@SpecAssertions({
@SpecAssertion(section = "3.4.2", id = "e"),
@SpecAssertion(section = "3.4.2", id = "f"),
@SpecAssertion(section = "3.4.2", id = "i"),
@SpecAssertion(section = "8.4", id = "a")
})
public void testCyclicGroupSequence() {
Validator validator = TestUtil.getValidatorUnderTest();
validator.validate( new Order(), CyclicGroupSequence.class );
}
}