ConstrainedPropertyTests.java

package grails.validation;

import grails.core.DefaultGrailsApplication;
import grails.core.GrailsApplication;
import grails.core.GrailsDomainClass;
import grails.util.Holders;
import groovy.lang.GroovyClassLoader;
import groovy.lang.GroovyObject;
import groovy.lang.IntRange;
import groovy.lang.ObjectRange;
import junit.framework.TestCase;
import org.grails.core.artefact.DomainClassArtefactHandler;
import org.grails.plugins.MockGrailsPluginManager;
import org.springframework.validation.BindException;
import org.springframework.validation.Errors;

import java.math.BigDecimal;
import java.math.BigInteger;
import java.util.Collection;
import java.util.Date;
import java.util.Iterator;
import java.util.Map;

public class ConstrainedPropertyTests extends TestCase {

    private int testValidatorValue = 0;

    @Override
    protected void setUp() throws Exception {
        super.setUp();
        MockGrailsPluginManager pluginManager = new MockGrailsPluginManager();
        Holders.setPluginManager(pluginManager);
//        pluginManager.registerMockPlugin(MockHibernatePluginHelper.FAKE_HIBERNATE_PLUGIN);
    }

    @Override
    protected void tearDown() throws Exception {
        super.tearDown();
        Holders.setPluginManager(null);
    }

    public int getTestValidatorValue() {
        return testValidatorValue;
    }

    public void setTestValidatorValue(int testValidatorValue) {
        this.testValidatorValue = testValidatorValue;
    }

    public void testGetSetURL() {
        ConstrainedProperty cp = new ConstrainedProperty(ConstrainedPropertyTests.class,"testProperty", String.class);
        cp.setUrl(true);

        assertTrue("should be an url", cp.isUrl());
    }

    public void testGetSetEmail() {
        ConstrainedProperty cp = new ConstrainedProperty(ConstrainedPropertyTests.class,"testProperty", String.class);
        cp.setEmail(true);

        assertTrue("should be an email", cp.isEmail());
    }

    public void testGetSetBlank() {
        ConstrainedProperty cp = new ConstrainedProperty(ConstrainedPropertyTests.class,"testProperty", String.class);
        
        cp.setBlank(true);
        assertTrue("should be blank", cp.isBlank());
        assertNull("Blank constraint should not be present", cp.getAppliedConstraint("blank"));
        
        cp.setBlank(false);
        assertFalse("should not be blank", cp.isBlank());
        assertNotNull("Blank constraint should be present", cp.getAppliedConstraint("blank"));

        // make sure setting it back to true works
        cp.setBlank(true);
        assertTrue("should be blank", cp.isBlank());
        assertNull("Blank constraint should not be present", cp.getAppliedConstraint("blank"));
    }

    public void testGetSetMatches() {
        ConstrainedProperty cp = new ConstrainedProperty(ConstrainedPropertyTests.class,"testProperty", String.class);
        cp.setMatches("\\.+");

        assertEquals("should match expression","\\.+", cp.getMatches());
    }

    public void testGetSetCreditCart() {
        ConstrainedProperty cp = new ConstrainedProperty(ConstrainedPropertyTests.class,"testProperty", String.class);
        cp.setCreditCard(true);

        assertTrue("should be credit cart", cp.isCreditCard());
    }

    /*
     * Test method for 'org.codehaus.groovy.grails.validation.ConstrainedProperty.supportsContraint(String)'
     */
    public void testSupportsContraint() {
        ConstrainedProperty cp = new ConstrainedProperty(ConstrainedPropertyTests.class,"testProperty", String.class);

        assertTrue(cp.supportsContraint(ConstrainedProperty.BLANK_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.EMAIL_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.MATCHES_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.IN_LIST_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.MAX_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.MIN_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.NOT_EQUAL_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.NULLABLE_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.RANGE_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.URL_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.VALIDATOR_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.MAX_SIZE_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.MIN_SIZE_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.SIZE_CONSTRAINT));

        assertFalse(cp.supportsContraint(ConstrainedProperty.SCALE_CONSTRAINT));

        cp = new ConstrainedProperty(ConstrainedPropertyTests.class,"testProperty", Collection.class);

        assertTrue(cp.supportsContraint(ConstrainedProperty.MAX_SIZE_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.MIN_SIZE_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.SIZE_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.IN_LIST_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.NOT_EQUAL_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.NULLABLE_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.VALIDATOR_CONSTRAINT));

        assertFalse(cp.supportsContraint(ConstrainedProperty.BLANK_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.EMAIL_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.MATCHES_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.MAX_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.MIN_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.RANGE_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.SCALE_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.URL_CONSTRAINT));

        cp = new ConstrainedProperty(ConstrainedPropertyTests.class,"testProperty", Number.class);

        assertTrue(cp.supportsContraint(ConstrainedProperty.IN_LIST_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.NOT_EQUAL_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.NULLABLE_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.MAX_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.MIN_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.RANGE_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.VALIDATOR_CONSTRAINT));

        assertFalse(cp.supportsContraint(ConstrainedProperty.MAX_SIZE_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.MIN_SIZE_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.SIZE_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.BLANK_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.EMAIL_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.MATCHES_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.SCALE_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.URL_CONSTRAINT));

        cp = new ConstrainedProperty(ConstrainedPropertyTests.class,"testProperty", Date.class);
        assertTrue(cp.supportsContraint(ConstrainedProperty.MAX_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.MIN_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.RANGE_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.IN_LIST_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.NOT_EQUAL_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.NULLABLE_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.VALIDATOR_CONSTRAINT));

        assertFalse(cp.supportsContraint(ConstrainedProperty.BLANK_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.EMAIL_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.MATCHES_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.SCALE_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.URL_CONSTRAINT));

        cp = new ConstrainedProperty(ConstrainedPropertyTests.class,"testProperty", Object.class);

        assertTrue(cp.supportsContraint(ConstrainedProperty.IN_LIST_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.NOT_EQUAL_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.NULLABLE_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.VALIDATOR_CONSTRAINT));

        assertFalse(cp.supportsContraint(ConstrainedProperty.MAX_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.MIN_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.RANGE_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.BLANK_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.EMAIL_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.MATCHES_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.URL_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.MAX_SIZE_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.MIN_SIZE_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.SIZE_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.SCALE_CONSTRAINT));

        cp = new ConstrainedProperty(ConstrainedPropertyTests.class,"testProperty", Comparable.class);

        assertTrue(cp.supportsContraint(ConstrainedProperty.IN_LIST_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.NOT_EQUAL_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.NULLABLE_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.MAX_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.MIN_CONSTRAINT));
        assertTrue(cp.supportsContraint(ConstrainedProperty.RANGE_CONSTRAINT));

        assertFalse(cp.supportsContraint(ConstrainedProperty.BLANK_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.EMAIL_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.MATCHES_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.SCALE_CONSTRAINT));
        assertFalse(cp.supportsContraint(ConstrainedProperty.URL_CONSTRAINT));

        cp = new ConstrainedProperty(ConstrainedPropertyTests.class,"testProperty", Float.class);
        assertTrue(cp.supportsContraint(ConstrainedProperty.SCALE_CONSTRAINT));

        cp = new ConstrainedProperty(ConstrainedPropertyTests.class,"testProperty", Double.class);
        assertTrue(cp.supportsContraint(ConstrainedProperty.SCALE_CONSTRAINT));

        cp = new ConstrainedProperty(ConstrainedPropertyTests.class,"testProperty", BigDecimal.class);
        assertTrue(cp.supportsContraint(ConstrainedProperty.SCALE_CONSTRAINT));

        cp = new ConstrainedProperty(ConstrainedPropertyTests.class,"testProperty", Integer.class);
        assertFalse(cp.supportsContraint(ConstrainedProperty.SCALE_CONSTRAINT));

        cp = new ConstrainedProperty(ConstrainedPropertyTests.class,"testProperty", Long.class);
        assertFalse(cp.supportsContraint(ConstrainedProperty.SCALE_CONSTRAINT));

        cp = new ConstrainedProperty(ConstrainedPropertyTests.class,"testProperty", BigInteger.class);
        assertFalse(cp.supportsContraint(ConstrainedProperty.SCALE_CONSTRAINT));
    }

    public void testGetMin() {
        // validate that getMin returns null if the property has no min constraint and no range constraint
        ConstrainedProperty cp = new ConstrainedProperty(TestClass.class, "testDouble", Double.class);
        assertNull(cp.getMin());

        // validate that getMin returns the correct value when the min constraint is defined for the property (but no range constraint is defined)
        cp.applyConstraint(ConstrainedProperty.MIN_CONSTRAINT, 123.45d);
        assertEquals(123.45d, cp.getMin());

        // validate that getMin returns the correct value when the range constraint is defined for the property (but no min constraint is defined)
        cp = new ConstrainedProperty(TestClass.class, "testDouble", Double.class);
        cp.applyConstraint(ConstrainedProperty.RANGE_CONSTRAINT, new ObjectRange(123.45d, 678.9d));
        assertEquals(123.45d, cp.getMin());

        // validate that getMin returns the maximum of the min constraint and the lower bound of the range constraint
        //   1) validate where the lower bound of the range constraint is greater than the min constraint
        cp = new ConstrainedProperty(TestClass.class, "testDouble", Double.class);
        cp.applyConstraint(ConstrainedProperty.MIN_CONSTRAINT, 1.23d);
        cp.applyConstraint(ConstrainedProperty.RANGE_CONSTRAINT, new ObjectRange(4.56d, 7.89d));
        assertEquals(4.56d, cp.getMin());

        //   2) validate where the min constraint is greater than the lower bound of the range constraint
        cp = new ConstrainedProperty(TestClass.class, "testDouble", Double.class);
        cp.applyConstraint(ConstrainedProperty.MIN_CONSTRAINT, 4.56d);
        cp.applyConstraint(ConstrainedProperty.RANGE_CONSTRAINT, new ObjectRange(1.23d, 7.89d));
        assertEquals(4.56d, cp.getMin());
    }

    public void testGetMinSize() {
        // validate that getMinSize returns null if the property has no minSize constraint and no size constraint
        ConstrainedProperty cp = new ConstrainedProperty(getClass(), "testURL", String.class);
        assertNull(cp.getMinSize());

        // validate that getMinSize returns the correct value when the minSize constraint is defined for the property (but no size constraint is defined)
        cp.applyConstraint(ConstrainedProperty.MIN_SIZE_CONSTRAINT, 5);
        assertEquals(5, cp.getMinSize().intValue());

        // validate that getMinSize returns the correct value when the size constraint is defined for the property (but no minSize constraint is defined)
        cp = new ConstrainedProperty(getClass(), "testURL", String.class);
        cp.applyConstraint(ConstrainedProperty.SIZE_CONSTRAINT, new IntRange(10, 20));
        assertEquals(10, cp.getMinSize().intValue());

        // validate that getMinSize returns the maximum of the minSize constraint and the lower bound of the size constraint
        //   1) validate where the lower bound of the size constraint is greater than the minSize constraint
        cp = new ConstrainedProperty(getClass(), "testURL", String.class);
        cp.applyConstraint(ConstrainedProperty.MIN_SIZE_CONSTRAINT, 6);
        cp.applyConstraint(ConstrainedProperty.SIZE_CONSTRAINT, new IntRange(11, 21));
        assertEquals(11, cp.getMinSize().intValue());

        //   2) validate where the minSize constraint is greater than the lower bound of the size constraint
        cp = new ConstrainedProperty(getClass(), "testURL", String.class);
        cp.applyConstraint(ConstrainedProperty.MIN_SIZE_CONSTRAINT, 12);
        cp.applyConstraint(ConstrainedProperty.SIZE_CONSTRAINT, new IntRange(9, 22));
        assertEquals(12, cp.getMinSize().intValue());
    }

    public void testGetMax() {
        // validate that getMax returns null if the property has no max constraint and no range constraint
        ConstrainedProperty cp = new ConstrainedProperty(TestClass.class, "testDouble", Double.class);
        assertNull(cp.getMax());

        // validate that getMax returns the correct value when the max constraint is defined for the property (but no range constraint is defined)
        cp.applyConstraint(ConstrainedProperty.MAX_CONSTRAINT, 123.45d);
        assertEquals(123.45d, cp.getMax());

        // validate that getMax returns the correct value when the range constraint is defined for the property (but no max constraint is defined)
        cp = new ConstrainedProperty(TestClass.class, "testDouble", Double.class);
        cp.applyConstraint(ConstrainedProperty.RANGE_CONSTRAINT, new ObjectRange(123.45d, 678.9d));
        assertEquals(678.9d, cp.getMax());

        // validate that getMax returns the minimum of the max constraint and the upper bound of the range constraint
        //   1) validate where the upper bound of the range constraint is less than the max constraint
        cp = new ConstrainedProperty(TestClass.class, "testDouble", Double.class);
        cp.applyConstraint(ConstrainedProperty.MAX_CONSTRAINT, 7.89d);
        cp.applyConstraint(ConstrainedProperty.RANGE_CONSTRAINT, new ObjectRange(1.23d, 4.56d));
        assertEquals(4.56d, cp.getMax());

        //   2) validate where the max constraint is less than the upper bound of the range constraint
        cp = new ConstrainedProperty(TestClass.class, "testDouble", Double.class);
        cp.applyConstraint(ConstrainedProperty.MAX_CONSTRAINT, 4.56d);
        cp.applyConstraint(ConstrainedProperty.RANGE_CONSTRAINT, new ObjectRange(1.23d, 7.89d));
        assertEquals(4.56d, cp.getMax());
    }

    public void testGetMaxSize() {
        // validate that getMaxSize returns null if the property has no maxSize constraint and no size constraint
        ConstrainedProperty cp = new ConstrainedProperty(getClass(), "testURL", String.class);
        assertNull(cp.getMaxSize());

        // validate that getMaxSize returns the correct value when the maxSize constraint is defined for the property (but no size constraint is defined)
        cp.applyConstraint(ConstrainedProperty.MAX_SIZE_CONSTRAINT, 5);
        assertEquals(5, cp.getMaxSize().intValue());

        // validate that getMaxSize returns the correct value when the size constraint is defined for the property (but no maxSize constraint is defined)
        cp = new ConstrainedProperty(getClass(), "testURL", String.class);
        cp.applyConstraint(ConstrainedProperty.SIZE_CONSTRAINT, new IntRange(10, 20));
        assertEquals(20, cp.getMaxSize().intValue());

        // validate that getMaxSize returns the minimum of the maxSize constraint and the upper bound of the size constraint
        //   1) validate where the upper bound of the size constraint is less than the maxSize constraint
        cp = new ConstrainedProperty(getClass(), "testURL", String.class);
        cp.applyConstraint(ConstrainedProperty.MAX_SIZE_CONSTRAINT, 29);
        cp.applyConstraint(ConstrainedProperty.SIZE_CONSTRAINT, new IntRange(11, 21));
        assertEquals(21, cp.getMaxSize().intValue());

        //   2) validate where the maxSize constraint is less than the upper bound of the size constraint
        cp = new ConstrainedProperty(getClass(), "testURL", String.class);
        cp.applyConstraint(ConstrainedProperty.MAX_SIZE_CONSTRAINT, 12);
        cp.applyConstraint(ConstrainedProperty.SIZE_CONSTRAINT, new IntRange(9, 22));
        assertEquals(12, cp.getMaxSize().intValue());
    }

    @SuppressWarnings("rawtypes")
    public void testConstraintBuilder() throws Exception {
        GroovyClassLoader gcl = new GroovyClassLoader();

        Class groovyClass = gcl.parseClass("class TestClass {\n" +
                        "Long id\n" +
                        "Long version\n" +
                        "String login\n" +
                        "String other\n" +
                        "String email\n" +
                        "static constraints = {\n" +
                            "login(size:5..15,nullable:false,blank:false)\n" +
                            "other(blank:false,size:5..15,nullable:false)\n" +
                            "email(email:true)\n" +
                        "}\n" +
                        "}");

        GrailsApplication ga = new DefaultGrailsApplication(groovyClass);
        ga.initialise();
        new MappingContextBuilder(ga).build(groovyClass);

        GrailsDomainClass domainClass = (GrailsDomainClass)ga.getArtefact(DomainClassArtefactHandler.TYPE, "TestClass");

        Map constrainedProperties = domainClass.getConstrainedProperties();
        assert constrainedProperties.size() == 3;
        grails.gorm.validation.ConstrainedProperty loginConstraint = (grails.gorm.validation.ConstrainedProperty)constrainedProperties.get("login");
        Collection appliedConstraints = loginConstraint.getAppliedConstraints();
        assertTrue(appliedConstraints.size() == 3);

        // Check the order of the constraints for the 'login' property...
        int index = 0;
        String[] constraintNames = new String[] { "size", "nullable", "blank" };
        for (Iterator iter = appliedConstraints.iterator(); iter.hasNext();) {
            Constraint c = (Constraint) iter.next();
            assertEquals(constraintNames[index], c.getName());
            index++;
        }

        // ...and for the 'other' property.
        appliedConstraints = ((grails.gorm.validation.ConstrainedProperty) constrainedProperties.get("other")).getAppliedConstraints();
        index = 0;
        constraintNames = new String[] { "blank", "size", "nullable" };
        for (Iterator iter = appliedConstraints.iterator(); iter.hasNext();) {
            Constraint c = (Constraint) iter.next();
            assertEquals(constraintNames[index], c.getName());
            index++;
        }

        grails.gorm.validation.ConstrainedProperty emailConstraint = (grails.gorm.validation.ConstrainedProperty)constrainedProperties.get("email");
        assertEquals(2,emailConstraint.getAppliedConstraints().size());

        GroovyObject go = (GroovyObject)groovyClass.newInstance();
        go.setProperty("email", "rubbish_email");
        Errors errors = new BindException(go, "TestClass");
        emailConstraint.validate(go, go.getProperty("email"), errors);

        assertTrue(errors.hasErrors());
        go.setProperty("email", "valid@email.com");
        errors = new BindException(go, "TestClass");
        emailConstraint.validate(go, go.getProperty("email"), errors);
        assertFalse(errors.hasErrors());
    }
}