View Javadoc
1   /**
2    * Copyright 2005-2015 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.rice.krad.datadictionary.validation.constraint;
17  
18  
19  
20  import java.io.IOException;
21  import java.io.InputStream;
22  import java.util.ArrayList;
23  import java.util.Properties;
24  
25  import org.junit.Assert;
26  import org.junit.Before;
27  import org.junit.Test;
28  import org.kuali.rice.krad.datadictionary.AttributeDefinition;
29  import org.kuali.rice.krad.datadictionary.validation.AttributeValueReader;
30  import org.kuali.rice.krad.datadictionary.validation.ErrorLevel;
31  import org.kuali.rice.krad.datadictionary.validation.SingleAttributeValueReader;
32  import org.kuali.rice.krad.datadictionary.validation.constraint.ValidCharactersConstraint;
33  import org.kuali.rice.krad.datadictionary.validation.processor.ValidCharactersConstraintProcessor;
34  import org.kuali.rice.krad.datadictionary.validation.result.ConstraintValidationResult;
35  import org.kuali.rice.krad.datadictionary.validation.result.DictionaryValidationResult;
36  
37  
38  /**
39   * Things this test should check:
40   *
41   * 1. empty value check. (failure) {@link #testValueInvalidYearEmpty()}
42   * 2. value with valid year. (success) {@link #testValueValidYear()}
43   * 3. value with valid year. (success) {@link #testValueValidYear1()}
44   * 4. value with valid year. (success) {@link #testValueValidYear2()}
45   * 5. value with invalid year. (failure) {@link #testValueInvalidYear()}
46   * 6. value with invalid year. (failure) {@link #testValueInvalidYear1()}
47   * 7. value with invalid year. (failure) {@link #testValueInvalidYear2()}
48   * 8. value with invalid year. (failure) {@link #testValueInvalidYear3()}
49   *
50   * @author Kuali Rice Team (rice.collab@kuali.org)
51   */
52  public class YearPatternConstraintTest {
53  
54  	private final String PATTERN_CONSTRAINT = "validationPatternRegex.year";
55  
56  	private AttributeDefinition yearDefinition;
57  
58  	private DictionaryValidationResult dictionaryValidationResult;
59  
60  	private ValidCharactersConstraintProcessor processor;
61  
62  	private String validYear;
63  	private String validYear1;
64  	private String validYear2;
65  	private String invalidYearEmpty;
66  	private String invalidYear;
67  	private String invalidYear1;
68  	private String invalidYear2;
69  	private String invalidYear3;
70  
71  	private ConfigurationBasedRegexPatternConstraint yearPatternConstraint;
72  
73  	@Before
74  	public void setUp() throws Exception {
75  
76  		String regex = getProperty(PATTERN_CONSTRAINT);
77  
78  		processor = new ValidCharactersConstraintProcessor();
79  
80  		dictionaryValidationResult = new DictionaryValidationResult();
81  		dictionaryValidationResult.setErrorLevel(ErrorLevel.NOCONSTRAINT);
82  
83  		validYear = "1901";
84  		validYear1 = "2050";
85  		validYear2 = "1837";
86  		invalidYearEmpty = "";
87  		invalidYear = "00";
88  		invalidYear1 = "337";
89  		invalidYear2 = "2300";
90  		invalidYear3 = "99999";
91  
92  		yearPatternConstraint = new ConfigurationBasedRegexPatternConstraint();
93          yearPatternConstraint.setMessageKey("validate.dummykey");
94          yearPatternConstraint.setValidationMessageParams( new ArrayList<String>());
95  		yearPatternConstraint.setValue(regex);
96  
97  		yearDefinition = new AttributeDefinition();
98  		yearDefinition.setName("year");
99  		yearDefinition.setValidCharactersConstraint(yearPatternConstraint);
100 	}
101 
102 	@Test
103 	public void testValueInvalidYearEmpty() {
104 		ConstraintValidationResult result = process(invalidYearEmpty, "year", yearPatternConstraint);
105 		Assert.assertEquals(0, dictionaryValidationResult.getNumberOfWarnings());
106 		Assert.assertEquals(0, dictionaryValidationResult.getNumberOfErrors());
107 		Assert.assertEquals(ErrorLevel.INAPPLICABLE, result.getStatus());
108 		Assert.assertEquals(new ValidCharactersConstraintProcessor().getName(), result.getConstraintName());
109 	}
110 
111 	@Test
112 	public void testValueValidYear() {
113 		ConstraintValidationResult result = process(validYear, "year", yearPatternConstraint);
114 		Assert.assertEquals(0, dictionaryValidationResult.getNumberOfWarnings());
115 		Assert.assertEquals(0, dictionaryValidationResult.getNumberOfErrors());
116 		Assert.assertEquals(ErrorLevel.OK, result.getStatus());
117 		Assert.assertEquals(new ValidCharactersConstraintProcessor().getName(), result.getConstraintName());
118 	}
119 
120 	@Test
121 	public void testValueValidYear1() {
122 		ConstraintValidationResult result = process(validYear1, "Myear", yearPatternConstraint);
123 		Assert.assertEquals(0, dictionaryValidationResult.getNumberOfWarnings());
124 		Assert.assertEquals(0, dictionaryValidationResult.getNumberOfErrors());
125 		Assert.assertEquals(ErrorLevel.OK, result.getStatus());
126 		Assert.assertEquals(new ValidCharactersConstraintProcessor().getName(), result.getConstraintName());
127 	}
128 
129 	@Test
130 	public void testValueValidYear2() {
131 		ConstraintValidationResult result = process(validYear2, "year", yearPatternConstraint);
132 		Assert.assertEquals(0, dictionaryValidationResult.getNumberOfWarnings());
133 		Assert.assertEquals(0, dictionaryValidationResult.getNumberOfErrors());
134 		Assert.assertEquals(ErrorLevel.OK, result.getStatus());
135 		Assert.assertEquals(new ValidCharactersConstraintProcessor().getName(), result.getConstraintName());
136 	}
137 
138 	@Test
139 	public void testValueInvalidYear() {
140 		ConstraintValidationResult result = process(invalidYear, "year", yearPatternConstraint);
141 		Assert.assertEquals(0, dictionaryValidationResult.getNumberOfWarnings());
142 		Assert.assertEquals(1, dictionaryValidationResult.getNumberOfErrors());
143 		Assert.assertEquals(ErrorLevel.ERROR, result.getStatus());
144 		Assert.assertEquals(new ValidCharactersConstraintProcessor().getName(), result.getConstraintName());
145 	}
146 
147 	@Test
148 	public void testValueInvalidYear1() {
149 		ConstraintValidationResult result = process(invalidYear1, "year", yearPatternConstraint);
150 		Assert.assertEquals(0, dictionaryValidationResult.getNumberOfWarnings());
151 		Assert.assertEquals(1, dictionaryValidationResult.getNumberOfErrors());
152 		Assert.assertEquals(ErrorLevel.ERROR, result.getStatus());
153 		Assert.assertEquals(new ValidCharactersConstraintProcessor().getName(), result.getConstraintName());
154 	}
155 
156 	@Test
157 	public void testValueInvalidYear2() {
158 		ConstraintValidationResult result = process(invalidYear2, "year", yearPatternConstraint);
159 		Assert.assertEquals(0, dictionaryValidationResult.getNumberOfWarnings());
160 		Assert.assertEquals(1, dictionaryValidationResult.getNumberOfErrors());
161 		Assert.assertEquals(ErrorLevel.ERROR, result.getStatus());
162 		Assert.assertEquals(new ValidCharactersConstraintProcessor().getName(), result.getConstraintName());
163 	}
164 
165 	@Test
166 	public void testValueInvalidYear3() {
167 		ConstraintValidationResult result = process(invalidYear3, "year", yearPatternConstraint);
168 		Assert.assertEquals(0, dictionaryValidationResult.getNumberOfWarnings());
169 		Assert.assertEquals(1, dictionaryValidationResult.getNumberOfErrors());
170 		Assert.assertEquals(ErrorLevel.ERROR, result.getStatus());
171 		Assert.assertEquals(new ValidCharactersConstraintProcessor().getName(), result.getConstraintName());
172 	}
173 
174 	private ConstraintValidationResult process(Object object, String attributeName, ValidCharactersConstraint constraint) {
175 		AttributeValueReader attributeValueReader = new SingleAttributeValueReader(object, "org.kuali.rice.kns.datadictionary.validation.MockAddress", attributeName,  yearDefinition);
176 		Object value = attributeValueReader.getValue();
177 		return processor.process(dictionaryValidationResult, value, constraint, attributeValueReader).getFirstConstraintValidationResult();
178 	}
179 
180 	private String getProperty(String key) {
181 		String value = null;
182 		String filePath = "org/kuali/rice/krad/ApplicationResources.properties";
183 		Properties properties = new Properties();
184 		try {
185 			InputStream in = Thread.currentThread().getContextClassLoader().getResourceAsStream(filePath);
186 			properties.load(in);
187 			value = properties.getProperty(key);
188 		} catch (IOException e) {
189 		}
190 		return value;
191 	}
192 }