Added support for validating marshalled fields (gc0096)

Author: Kevin Seim

build.gradle

@@ -42,7 +42,7 @@ configurations {
 
 dependencies {
     testCompile group: 'junit', name: 'junit', version: '4.11'
-    testCompile group: 'org.codehaus.groovy', name: 'groovy-all', version: '1.8.9'
+    testCompile group: 'org.codehaus.groovy', name: 'groovy-all', version: '2.3.6'
     testRuntime group: 'commons-logging', name: 'commons-logging', version: '1.1.2'
     //emma group: 'emma', name: 'emma', version: '2.0.5312'
     //emma group: 'emma', name: 'emma', version: '2.0.5312' 

changelog.txt

@@ -6,6 +6,8 @@ Changes in version 3.0.0 (TBD)
 * Requires JDK 1.7 or higher
 * Removed support for ASM class rewriting
 * Removed Spring framework support
+* Fixed IOUtil.getResource() to use ClassLoader argument (gc0109)
+* Added support for validating marshalled fields (gc0096)
 
 Changes in version 2.1.0 (2014-09-06)
 -------------------------------------

src/org/beanio/BeanWriter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2013 Kevin Seim
+ * Copyright 2010-2014 Kevin Seim
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -38,6 +38,8 @@ public interface BeanWriter extends Debuggable {
      *   or in a few other rare (but fatal) cases
      * @throws BeanWriterIOException if the underlying output stream throws an {@link IOException},
      *   or if this writer is closed
+     * @throws InvalidBeanException if BeanIO is configured to validate fields during marshalling,
+     *   and a field does not meet the configured validation rules
      */
     public void write(Object bean) throws BeanWriterException, BeanWriterIOException;
 
@@ -49,6 +51,8 @@ public interface BeanWriter extends Debuggable {
      *   or in a few other rare (but fatal) cases
      * @throws BeanWriterIOException if the underlying output stream throws an {@link IOException},
      *   or if this writer is closed
+     * @throws InvalidBeanException if BeanIO is configured to validate fields during marshalling,
+     *   and a field does not meet the configured validation rules
      */
     public void write(String recordName, Object bean) throws BeanWriterException;
 

src/org/beanio/InvalidBeanException.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright 2014 Kevin Seim
+ * 
+ * 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.beanio;
+
+/**
+ * Exception thrown by a {@link BeanWriter} or {@link Marshaller}, when a bean
+ * cannot be marshalled to meet the configured field validation rules.
+ * @author Kevin Seim
+ */
+public class InvalidBeanException extends BeanWriterException {
+
+    private static final long serialVersionUID = 1L;
+
+    /**
+     * Constructs a new InvalidBeanException.
+     * @param message the error message
+     */
+    public InvalidBeanException(String message) {
+        super(message);
+    }
+
+    /**
+     * Constructs a new InvalidBeanException.
+     * @param message the error message
+     * @param cause the root cause
+     */
+    public InvalidBeanException(String message, Throwable cause) {
+        super(message, cause);
+    }
+
+    /**
+     * Constructs a new InvalidBeanException.
+     * @param cause the root cause
+     */
+    public InvalidBeanException(Throwable cause) {
+        super(cause);
+    }
+}

src/org/beanio/Marshaller.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2013 Kevin Seim
+ * Copyright 2012-2014 Kevin Seim
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -52,6 +52,8 @@ public interface Marshaller extends Debuggable {
      * @return this <tt>Marshaller</tt>
      * @throws BeanWriterException if a record is not matched for the given bean object,
      *   or in some other rare (but fatal) conditions
+     * @throws InvalidBeanException if BeanIO is configured to validate fields during marshalling,
+     *   and a field does not meet the configured validation rules
      */
     public Marshaller marshal(Object bean) throws BeanWriterException;
 
@@ -62,6 +64,8 @@ public interface Marshaller extends Debuggable {
      * @return this <tt>Marshaller</tt>
      * @throws BeanWriterException if a record is not matched for the given record name
      *   and bean object, or in some other rare (but fatal) conditions
+     * @throws InvalidBeanException if BeanIO is configured to validate fields during marshalling,
+     *   and a field does not meet the configured validation rules
      */
     public Marshaller marshal(String recordName, Object bean) throws BeanWriterException;
 

src/org/beanio/internal/config/beanio.properties

@@ -1,4 +1,4 @@
-## Copyright 2010-2013 Kevin Seim
+## Copyright 2010-2014 Kevin Seim
 ##
 ## Licensed under the Apache License, Version 2.0 (the "License");
 ## you may not use this file except in compliance with the License.
@@ -91,5 +91,8 @@ org.beanio.useDefaultIfMissing=true
 ## whether non-public fields and methods can be made accessible
 org.beanio.allowProtectedAccess=true
 
+## whether to validate marshalled fields
+org.beanio.validateOnMarshal=false
+
 org.beanio.typeHandler.string-xml = org.beanio.types.StringTypeHandler
 org.beanio.typeHandler.int = org.beanio.types.IntegerTypeHandler

src/org/beanio/internal/parser/Field.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011-2013 Kevin Seim
+ * Copyright 2011-2014 Kevin Seim
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -38,6 +38,9 @@ public class Field extends ParserComponent implements Property {
 
     private static final boolean USE_DEFAULT_IF_MISSING = 
         Settings.getInstance().getBoolean(Settings.USE_DEFAULT_IF_MISSING);
+
+    private static final boolean VALIDATE_ON_MARSHAL = 
+            Settings.getInstance().getBoolean(Settings.VALIDATE_ON_MARSHAL);
 
     private static final boolean marshalDefault = 
         Settings.getInstance().getBoolean(Settings.DEFAULT_MARSHALLING_ENABLED);
@@ -194,6 +197,38 @@ public boolean marshal(MarshallingContext context) {
             text = formatValue(value);
         }
 
+        if (VALIDATE_ON_MARSHAL) {
+            if (text == Value.NIL) {
+                if (!format.isNillable()) {
+                    throw new InvalidBeanException("Invalid field '" + getName() + "', the value is not nillable");    
+                } else if (required) {
+                    throw new InvalidBeanException("Invalid field '" + getName() + "', a value is required");    
+                }
+            }
+            else if (text == null) {
+                if (required) {
+                    throw new InvalidBeanException("Invalid field '" + getName() + "', a value is required");
+                }
+            }
+            else {
+                // validate minimum length
+                if (text.length() < minLength) {
+                    throw new InvalidBeanException("Invalid field '" + getName() + "', '" + 
+                        text + "' does not meet minimum length of " + minLength);
+                }
+                // validate maximum length
+                if (text.length() > maxLength) {
+                    throw new InvalidBeanException("Invalid field '" + getName() + "', '" + 
+                        text + "' exceeds maximum length of " + maxLength);
+                }
+                // validate the regular expression
+                if (regex != null && !regex.matcher(text).matches()) {
+                    throw new InvalidBeanException("Invalid field '" + getName() + "', '" + 
+                        text + "' does not match pattern '" + regex.pattern() + "'");
+                }
+            }
+        }
+        
         format.insertField(context, text);
         return true;
     }

src/org/beanio/internal/util/Settings.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2013 Kevin Seim
+ * Copyright 2010-2014 Kevin Seim
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -125,6 +125,11 @@ public class Settings {
      * Whether non-public fields and methods may be made accessible.
      */
     public static final String ALLOW_PROTECTED_PROPERTY_ACCESS = "org.beanio.allowProtectedAccess";
+    /**
+     * Whether to validate marshalled fields.
+     * @since 3.0.0
+     */
+    public static final String VALIDATE_ON_MARSHAL = "org.beanio.validateOnMarshal";
 
     private static final String DEFAULT_CONFIGURATION_PATH = "org/beanio/internal/config/beanio.properties";
     private static final String DEFAULT_CONFIGURATION_FILENAME = "beanio.properties";

test/org/beanio/parser/validation/MarshalledFieldValidationTest.groovy

@@ -0,0 +1,71 @@
+package org.beanio.parser.validation
+
+import org.beanio.*
+import org.beanio.parser.AbstractParserTest
+import org.junit.Ignore;
+import org.junit.Test
+
+/**
+ * Unit tests for marshalled field validation (which is disabled by default,
+ * hence the Ignore unless configured).
+ * @author Kevin Seim
+ */
+@Ignore
+class MarshalledFieldValidationTest extends AbstractParserTest {
+
+    @Test(expected=InvalidBeanException.class)
+    void testRequired() {
+        StreamFactory factory = createFactory("""
+            <stream name="s" format="csv" strict="true">
+              <record name="record" class="map">
+                <field name="field" type="String" required="true" />
+              </record>
+            </stream>""");
+    
+        Marshaller m = factory.createMarshaller("s")
+        Map bean = ["field":null]
+        m.marshal(bean)
+    }
+    
+    @Test(expected=InvalidBeanException.class)
+    void testMinLength() {
+        StreamFactory factory = createFactory("""
+            <stream name="s" format="csv" strict="true">
+              <record name="record" class="map">
+                <field name="field" minLength="3" />
+              </record>
+            </stream>""");
+    
+        Marshaller m = factory.createMarshaller("s")
+        Map bean = ["field":"ab"]
+        m.marshal(bean)
+    }
+    
+    @Test(expected=InvalidBeanException.class)
+    void testMaxLength() {
+        StreamFactory factory = createFactory("""
+            <stream name="s" format="csv" strict="true">
+              <record name="record" class="map">
+                <field name="field" maxLength="3" />
+              </record>
+            </stream>""");
+    
+        Marshaller m = factory.createMarshaller("s")
+        Map bean = ["field":"abcd"]
+        m.marshal(bean)
+    }
+    
+    @Test(expected=InvalidBeanException.class)
+    void testRegex() {
+        StreamFactory factory = createFactory("""
+            <stream name="s" format="csv" strict="true">
+              <record name="record" class="map">
+                <field name="field" regex="\\d+" />
+              </record>
+            </stream>""");
+    
+        Marshaller m = factory.createMarshaller("s")
+        Map bean = ["field":"abc"]
+        m.marshal(bean)
+    }
+}