View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.validator.routines;
18  
19  import java.text.Format;
20  import java.text.DateFormat;
21  import java.util.Calendar;
22  import java.util.Date;
23  import java.util.Locale;
24  import java.util.TimeZone;
25  
26  /**
27   * Test Case for CalendarValidator.
28   * 
29   * @version $Revision$
30   */
31  public class CalendarValidatorTest extends AbstractCalendarValidatorTest {
32      
33      private static final int DATE_2005_11_23 = 20051123;
34      private static final int TIME_12_03_45   = 120345;
35  
36      private CalendarValidator calValidator;
37  
38      /**
39       * Constructor
40       * @param name test name
41       */
42      public CalendarValidatorTest(String name) {
43          super(name);
44      }
45  
46      @Override
47      protected void setUp() throws Exception {
48          super.setUp();
49          calValidator = new CalendarValidator();
50          validator         = calValidator;
51      }
52  
53      /**
54       * Test CalendarValidator validate Methods
55       */
56      public void testCalendarValidatorMethods() {
57          Locale.setDefault(Locale.US);
58          Locale locale     = Locale.GERMAN;
59          String pattern    = "yyyy-MM-dd";
60          String patternVal = "2005-12-31";
61          String germanVal     = "31 Dez 2005";
62          String germanPattern = "dd MMM yyyy";
63          String localeVal  = "31.12.2005";
64          String defaultVal = "12/31/05";
65          String XXXX    = "XXXX"; 
66          Date expected = createCalendar(null, 20051231, 0).getTime();
67          assertEquals("validate(A) default", expected, CalendarValidator.getInstance().validate(defaultVal).getTime());
68          assertEquals("validate(A) locale ", expected, CalendarValidator.getInstance().validate(localeVal, locale).getTime());
69          assertEquals("validate(A) pattern", expected, CalendarValidator.getInstance().validate(patternVal, pattern).getTime());
70          assertEquals("validate(A) both",    expected, CalendarValidator.getInstance().validate(germanVal, germanPattern, Locale.GERMAN).getTime());
71  
72          assertTrue("isValid(A) default", CalendarValidator.getInstance().isValid(defaultVal));
73          assertTrue("isValid(A) locale ", CalendarValidator.getInstance().isValid(localeVal, locale));
74          assertTrue("isValid(A) pattern", CalendarValidator.getInstance().isValid(patternVal, pattern));
75          assertTrue("isValid(A) both",    CalendarValidator.getInstance().isValid(germanVal, germanPattern, Locale.GERMAN));
76  
77          assertNull("validate(B) default", CalendarValidator.getInstance().validate(XXXX));
78          assertNull("validate(B) locale ", CalendarValidator.getInstance().validate(XXXX, locale));
79          assertNull("validate(B) pattern", CalendarValidator.getInstance().validate(XXXX, pattern));
80          assertNull("validate(B) both",    CalendarValidator.getInstance().validate("31 Dec 2005", germanPattern, Locale.GERMAN));
81  
82          assertFalse("isValid(B) default", CalendarValidator.getInstance().isValid(XXXX));
83          assertFalse("isValid(B) locale ", CalendarValidator.getInstance().isValid(XXXX, locale));
84          assertFalse("isValid(B) pattern", CalendarValidator.getInstance().isValid(XXXX, pattern));
85          assertFalse("isValid(B) both",    CalendarValidator.getInstance().isValid("31 Dec 2005", germanPattern, Locale.GERMAN));
86  
87          // Test Time Zone
88          TimeZone zone = (TimeZone.getDefault().getRawOffset() == EET.getRawOffset() ? EST : EET); 
89          Date expectedZone = createCalendar(zone, 20051231, 0).getTime();
90          assertFalse("default/EET same ", expected.getTime() == expectedZone.getTime());
91  
92          assertEquals("validate(C) default", expectedZone, CalendarValidator.getInstance().validate(defaultVal, zone).getTime());
93          assertEquals("validate(C) locale ", expectedZone, CalendarValidator.getInstance().validate(localeVal, locale, zone).getTime());
94          assertEquals("validate(C) pattern", expectedZone, CalendarValidator.getInstance().validate(patternVal, pattern, zone).getTime());
95          assertEquals("validate(C) both",    expectedZone, CalendarValidator.getInstance().validate(germanVal, germanPattern, Locale.GERMAN, zone).getTime());
96      }
97  
98      /**
99       * Test compare date methods
100      */
101     public void testCompare() {
102         int sameTime = 124522;
103         int testDate = 20050823;
104         Calendar diffHour    = createCalendar(GMT, testDate, 115922);    // same date, different time
105         Calendar diffMin     = createCalendar(GMT, testDate, 124422);    // same date, different time
106         Calendar diffSec     = createCalendar(GMT, testDate, 124521);    // same date, different time
107 
108         Calendar value       = createCalendar(GMT, testDate, sameTime);   // test value
109         Calendar cal20050824 = createCalendar(GMT, 20050824, sameTime);   // +1 day
110         Calendar cal20050822 = createCalendar(GMT, 20050822, sameTime);   // -1 day
111 
112         Calendar cal20050830 = createCalendar(GMT, 20050830, sameTime);   // +1 week
113         Calendar cal20050816 = createCalendar(GMT, 20050816, sameTime);   // -1 week
114 
115         Calendar cal20050901 = createCalendar(GMT, 20050901, sameTime);   // +1 month
116         Calendar cal20050801 = createCalendar(GMT, 20050801, sameTime);   // same month
117         Calendar cal20050731 = createCalendar(GMT, 20050731, sameTime);   // -1 month
118 
119         Calendar cal20051101 = createCalendar(GMT, 20051101, sameTime);   // +1 quarter (Feb Start)
120         Calendar cal20051001 = createCalendar(GMT, 20051001, sameTime);   // +1 quarter
121         Calendar cal20050701 = createCalendar(GMT, 20050701, sameTime);   // same quarter
122         Calendar cal20050630 = createCalendar(GMT, 20050630, sameTime);   // -1 quarter
123 
124         Calendar cal20060101 = createCalendar(GMT, 20060101, sameTime);   // +1 year
125         Calendar cal20050101 = createCalendar(GMT, 20050101, sameTime);   // same year
126         Calendar cal20041231 = createCalendar(GMT, 20041231, sameTime);   // -1 year
127 
128         assertEquals("hour GT", 1, calValidator.compare(value, diffHour, Calendar.HOUR_OF_DAY));
129         assertEquals("hour EQ", 0, calValidator.compare(value, diffMin,  Calendar.HOUR_OF_DAY));
130         assertEquals("mins GT", 1, calValidator.compare(value, diffMin,  Calendar.MINUTE));
131         assertEquals("mins EQ", 0, calValidator.compare(value, diffSec,  Calendar.MINUTE));
132         assertEquals("secs GT", 1, calValidator.compare(value, diffSec,  Calendar.SECOND));
133 
134         assertEquals("date LT", -1, calValidator.compareDates(value, cal20050824)); // +1 day
135         assertEquals("date EQ", 0,  calValidator.compareDates(value, diffHour));    // same day, diff hour
136         assertEquals("date(B)", 0,  calValidator.compare(value, diffHour, Calendar.DAY_OF_YEAR));    // same day, diff hour
137         assertEquals("date GT", 1,  calValidator.compareDates(value, cal20050822)); // -1 day
138 
139         assertEquals("week LT", -1, calValidator.compareWeeks(value, cal20050830)); // +1 week 
140         assertEquals("week =1", 0,  calValidator.compareWeeks(value, cal20050824)); // +1 day
141         assertEquals("week =2", 0,  calValidator.compareWeeks(value, cal20050822)); // same week
142         assertEquals("week =3", 0,  calValidator.compare(value, cal20050822, Calendar.WEEK_OF_MONTH)); // same week
143         assertEquals("week =4", 0,  calValidator.compareWeeks(value, cal20050822)); // -1 day
144         assertEquals("week GT", 1,  calValidator.compareWeeks(value, cal20050816)); // -1 week
145 
146         assertEquals("mnth LT", -1, calValidator.compareMonths(value, cal20050901)); // +1 month 
147         assertEquals("mnth =1", 0,  calValidator.compareMonths(value, cal20050830)); // +1 week 
148         assertEquals("mnth =2", 0,  calValidator.compareMonths(value, cal20050801)); // same month
149         assertEquals("mnth =3", 0,  calValidator.compareMonths(value, cal20050816)); // -1 week
150         assertEquals("mnth GT", 1,  calValidator.compareMonths(value, cal20050731)); // -1 month
151 
152         assertEquals("qtrA <1", -1, calValidator.compareQuarters(value, cal20051101)); // +1 quarter (Feb) 
153         assertEquals("qtrA <2", -1, calValidator.compareQuarters(value, cal20051001)); // +1 quarter 
154         assertEquals("qtrA =1", 0,  calValidator.compareQuarters(value, cal20050901)); // +1 month 
155         assertEquals("qtrA =2", 0,  calValidator.compareQuarters(value, cal20050701)); // same quarter
156         assertEquals("qtrA =3", 0,  calValidator.compareQuarters(value, cal20050731)); // -1 month
157         assertEquals("qtrA GT", 1,  calValidator.compareQuarters(value, cal20050630)); // -1 quarter
158 
159         // Change quarter 1 to start in Feb
160         assertEquals("qtrB LT", -1, calValidator.compareQuarters(value, cal20051101, 2)); // +1 quarter (Feb) 
161         assertEquals("qtrB =1", 0,  calValidator.compareQuarters(value, cal20051001, 2));  // same quarter 
162         assertEquals("qtrB =2", 0,  calValidator.compareQuarters(value, cal20050901, 2)); // +1 month 
163         assertEquals("qtrB =3", 1,  calValidator.compareQuarters(value, cal20050701, 2)); // same quarter
164         assertEquals("qtrB =4", 1,  calValidator.compareQuarters(value, cal20050731, 2)); // -1 month
165         assertEquals("qtrB GT", 1,  calValidator.compareQuarters(value, cal20050630, 2)); // -1 quarter
166 
167         assertEquals("year LT", -1, calValidator.compareYears(value, cal20060101)); // +1 year 
168         assertEquals("year EQ", 0,  calValidator.compareYears(value, cal20050101)); // same year
169         assertEquals("year GT", 1,  calValidator.compareYears(value, cal20041231)); // -1 year
170 
171         // invalid compare
172         try {
173             calValidator.compare(value, value,  -1);
174             fail("Invalid Compare field - expected IllegalArgumentException to be thrown");
175         } catch (IllegalArgumentException e) {
176             assertEquals("check message", "Invalid field: -1", e.getMessage());
177         }
178     }
179 
180     /**
181      * Test Date/Time style Validator (there isn't an implementation for this)
182      */
183     public void testDateTimeStyle() {
184         // Set the default Locale
185         Locale origDefault = Locale.getDefault();
186         Locale.setDefault(Locale.UK);
187 
188         AbstractCalendarValidator dateTimeValidator = 
189             new AbstractCalendarValidator(true, DateFormat.SHORT, DateFormat.SHORT) {
190                 private static final long serialVersionUID = 1L;
191 
192             @Override
193             protected Object processParsedValue(Object value, Format formatter) {
194                 return value;
195             }
196         };
197         assertTrue("validate(A) default", dateTimeValidator.isValid("31/12/05 14:23"));
198         assertTrue("validate(A) locale ", dateTimeValidator.isValid("12/31/05 2:23 PM", Locale.US));
199 
200         // Restore the original default
201         Locale.setDefault(origDefault);
202     }
203 
204     /**
205      * Test format methods
206      */
207     @Override
208     public void testFormat() {
209         // Set the default Locale
210         Locale origDefault = Locale.getDefault();
211         Locale.setDefault(Locale.UK);
212 
213         Calendar cal20050101 = createCalendar(GMT, 20051231, 11500);
214         assertNull("null", calValidator.format(null));
215         assertEquals("default",  "31/12/05",         calValidator.format(cal20050101));
216         assertEquals("locale",   "12/31/05",         calValidator.format(cal20050101, Locale.US));
217         assertEquals("patternA", "2005-12-31 01:15", calValidator.format(cal20050101, "yyyy-MM-dd HH:mm"));
218         assertEquals("patternB", "2005-12-31 GMT",   calValidator.format(cal20050101, "yyyy-MM-dd z"));
219         assertEquals("both",     "31 Dez 2005",      calValidator.format(cal20050101, "dd MMM yyyy", Locale.GERMAN));
220 
221         // EST Time Zone
222         assertEquals("EST default",  "30/12/05",         calValidator.format(cal20050101, EST));
223         assertEquals("EST locale",   "12/30/05",         calValidator.format(cal20050101, Locale.US, EST));
224         assertEquals("EST patternA", "2005-12-30 20:15", calValidator.format(cal20050101, "yyyy-MM-dd HH:mm", EST));
225         assertEquals("EST patternB", "2005-12-30 EST",   calValidator.format(cal20050101, "yyyy-MM-dd z", EST));
226         assertEquals("EST both",     "30 Dez 2005",      calValidator.format(cal20050101, "dd MMM yyyy", Locale.GERMAN, EST));
227 
228         // Restore the original default
229         Locale.setDefault(origDefault);
230     }
231 
232     /**
233      * Test adjustToTimeZone() method
234      */
235     public void testAdjustToTimeZone() {
236 
237         Calendar calEST = createCalendar(EST, DATE_2005_11_23, TIME_12_03_45);
238         Date dateEST = calEST.getTime();
239 
240         Calendar calGMT = createCalendar(GMT, DATE_2005_11_23, TIME_12_03_45);
241         Date dateGMT = calGMT.getTime();
242 
243         Calendar calCET = createCalendar(EET, DATE_2005_11_23, TIME_12_03_45);
244         Date dateCET = calCET.getTime();
245 
246         // Check the dates don't match
247         assertFalse("Check GMT != CET", dateGMT.getTime() == dateCET.getTime());
248         assertFalse("Check GMT != EST", dateGMT.getTime() == dateEST.getTime());
249         assertFalse("Check CET != EST", dateCET.getTime() == dateEST.getTime());
250 
251         // EST to GMT and back
252         CalendarValidator.adjustToTimeZone(calEST, GMT);
253         assertEquals("EST to GMT", dateGMT, calEST.getTime());
254         assertFalse("Check EST = GMT", dateEST == calEST.getTime());
255         CalendarValidator.adjustToTimeZone(calEST, EST);
256         assertEquals("back to EST", dateEST, calEST.getTime());
257         assertFalse("Check EST != GMT", dateGMT == calEST.getTime());
258 
259         // CET to GMT and back
260         CalendarValidator.adjustToTimeZone(calCET, GMT);
261         assertEquals("CET to GMT", dateGMT, calCET.getTime());
262         assertFalse("Check CET = GMT", dateCET == calCET.getTime());
263         CalendarValidator.adjustToTimeZone(calCET, EET);
264         assertEquals("back to CET", dateCET, calCET.getTime());
265         assertFalse("Check CET != GMT", dateGMT == calCET.getTime());
266 
267         // Adjust to TimeZone with Same rules
268         Calendar calUTC = createCalendar(UTC, DATE_2005_11_23, TIME_12_03_45);
269         assertTrue("SAME: UTC = GMT",  UTC.hasSameRules(GMT));
270         assertEquals("SAME: Check time (A)", calUTC.getTime(), calGMT.getTime());
271         assertFalse("SAME: Check GMT(A)", GMT.equals(calUTC.getTimeZone()));
272         assertTrue("SAME: Check UTC(A)",  UTC.equals(calUTC.getTimeZone()));
273         CalendarValidator.adjustToTimeZone(calUTC, GMT);
274         assertEquals("SAME: Check time (B)", calUTC.getTime(), calGMT.getTime());
275         assertTrue("SAME: Check GMT(B)", GMT.equals(calUTC.getTimeZone()));
276         assertFalse("SAME: Check UTC(B)",  UTC.equals(calUTC.getTimeZone()));
277     }
278     
279 }