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    *      https://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 static org.junit.jupiter.api.Assertions.assertEquals;
20  import static org.junit.jupiter.api.Assertions.assertFalse;
21  import static org.junit.jupiter.api.Assertions.assertNotEquals;
22  import static org.junit.jupiter.api.Assertions.assertNull;
23  import static org.junit.jupiter.api.Assertions.assertTrue;
24  
25  import java.text.DateFormat;
26  import java.text.SimpleDateFormat;
27  import java.util.Calendar;
28  import java.util.Date;
29  import java.util.Locale;
30  import java.util.TimeZone;
31  
32  import org.apache.commons.lang3.time.TimeZones;
33  import org.apache.commons.validator.util.TestTimeZones;
34  import org.junit.jupiter.api.BeforeEach;
35  import org.junit.jupiter.api.Test;
36  import org.junitpioneer.jupiter.DefaultLocale;
37  
38  /**
39   * Test Case for DateValidator.
40   */
41  class DateValidatorTest extends AbstractCalendarValidatorTest {
42  
43      private DateValidator dateValidator;
44  
45      /**
46       * Sets up test fixtures.
47       */
48      @BeforeEach
49      protected void setUp() {
50          dateValidator = new DateValidator();
51          validator = dateValidator;
52      }
53  
54      /**
55       * Test compare date methods
56       */
57      @Test
58      void testCompare() {
59          final int sameTime = 124522;
60          final int testDate = 20050823;
61          final Date diffHour = createDate(TimeZones.GMT, testDate, 115922); // same date, different time
62  
63          final Date value = createDate(TimeZones.GMT, testDate, sameTime); // test value
64          final Date date20050824 = createDate(TimeZones.GMT, 20050824, sameTime); // +1 day
65          final Date date20050822 = createDate(TimeZones.GMT, 20050822, sameTime); // -1 day
66  
67          final Date date20050830 = createDate(TimeZones.GMT, 20050830, sameTime); // +1 week
68          final Date date20050816 = createDate(TimeZones.GMT, 20050816, sameTime); // -1 week
69  
70          final Date date20050901 = createDate(TimeZones.GMT, 20050901, sameTime); // +1 month
71          final Date date20050801 = createDate(TimeZones.GMT, 20050801, sameTime); // same month
72          final Date date20050731 = createDate(TimeZones.GMT, 20050731, sameTime); // -1 month
73  
74          final Date date20051101 = createDate(TimeZones.GMT, 20051101, sameTime); // +1 quarter (Feb Start)
75          final Date date20051001 = createDate(TimeZones.GMT, 20051001, sameTime); // +1 quarter
76          final Date date20050701 = createDate(TimeZones.GMT, 20050701, sameTime); // same quarter
77          final Date date20050630 = createDate(TimeZones.GMT, 20050630, sameTime); // -1 quarter
78          final Date date20050110 = createDate(TimeZones.GMT, 20050110, sameTime); // Previous Year qtr (Fen start)
79  
80          final Date date20060101 = createDate(TimeZones.GMT, 20060101, sameTime); // +1 year
81          final Date date20050101 = createDate(TimeZones.GMT, 20050101, sameTime); // same year
82          final Date date20041231 = createDate(TimeZones.GMT, 20041231, sameTime); // -1 year
83  
84          assertEquals(-1, dateValidator.compareDates(value, date20050824, TimeZones.GMT), "date LT"); // +1 day
85          assertEquals(0, dateValidator.compareDates(value, diffHour, TimeZones.GMT), "date EQ"); // same day, diff hour
86          assertEquals(1, dateValidator.compareDates(value, date20050822, TimeZones.GMT), "date GT"); // -1 day
87  
88          assertEquals(-1, dateValidator.compareWeeks(value, date20050830, TimeZones.GMT), "week LT"); // +1 week
89          assertEquals(0, dateValidator.compareWeeks(value, date20050824, TimeZones.GMT), "week =1"); // +1 day
90          assertEquals(0, dateValidator.compareWeeks(value, date20050822, TimeZones.GMT), "week =2"); // same week
91          assertEquals(0, dateValidator.compareWeeks(value, date20050822, TimeZones.GMT), "week =3"); // -1 day
92          assertEquals(1, dateValidator.compareWeeks(value, date20050816, TimeZones.GMT), "week GT"); // -1 week
93  
94          assertEquals(-1, dateValidator.compareMonths(value, date20050901, TimeZones.GMT), "mnth LT"); // +1 month
95          assertEquals(0, dateValidator.compareMonths(value, date20050830, TimeZones.GMT), "mnth =1"); // +1 week
96          assertEquals(0, dateValidator.compareMonths(value, date20050801, TimeZones.GMT), "mnth =2"); // same month
97          assertEquals(0, dateValidator.compareMonths(value, date20050816, TimeZones.GMT), "mnth =3"); // -1 week
98          assertEquals(1, dateValidator.compareMonths(value, date20050731, TimeZones.GMT), "mnth GT"); // -1 month
99  
100         assertEquals(-1, dateValidator.compareQuarters(value, date20051101, TimeZones.GMT), "qtrA <1"); // +1 quarter (Feb)
101         assertEquals(-1, dateValidator.compareQuarters(value, date20051001, TimeZones.GMT), "qtrA <2"); // +1 quarter
102         assertEquals(0, dateValidator.compareQuarters(value, date20050901, TimeZones.GMT), "qtrA =1"); // +1 month
103         assertEquals(0, dateValidator.compareQuarters(value, date20050701, TimeZones.GMT), "qtrA =2"); // same quarter
104         assertEquals(0, dateValidator.compareQuarters(value, date20050731, TimeZones.GMT), "qtrA =3"); // -1 month
105         assertEquals(1, dateValidator.compareQuarters(value, date20050630, TimeZones.GMT), "qtrA GT"); // -1 quarter
106 
107         // Change quarter 1 to start in Feb
108         assertEquals(-1, dateValidator.compareQuarters(value, date20051101, TimeZones.GMT, 2), "qtrB LT"); // +1 quarter (Feb)
109         assertEquals(0, dateValidator.compareQuarters(value, date20051001, TimeZones.GMT, 2), "qtrB =1"); // same quarter
110         assertEquals(0, dateValidator.compareQuarters(value, date20050901, TimeZones.GMT, 2), "qtrB =2"); // +1 month
111         assertEquals(1, dateValidator.compareQuarters(value, date20050701, TimeZones.GMT, 2), "qtrB =3"); // same quarter
112         assertEquals(1, dateValidator.compareQuarters(value, date20050731, TimeZones.GMT, 2), "qtrB =4"); // -1 month
113         assertEquals(1, dateValidator.compareQuarters(value, date20050630, TimeZones.GMT, 2), "qtrB GT"); // -1 quarter
114         assertEquals(1, dateValidator.compareQuarters(value, date20050110, TimeZones.GMT, 2), "qtrB prev"); // Jan Prev year qtr
115 
116         assertEquals(-1, dateValidator.compareYears(value, date20060101, TimeZones.GMT), "year LT"); // +1 year
117         assertEquals(0, dateValidator.compareYears(value, date20050101, TimeZones.GMT), "year EQ"); // same year
118         assertEquals(1, dateValidator.compareYears(value, date20041231, TimeZones.GMT), "year GT"); // -1 year
119 
120         // Compare using alternative TimeZone
121         final Date sameDayTwoAm = createDate(TimeZones.GMT, testDate, 20000);
122         assertEquals(-1, dateValidator.compareDates(value, date20050824, TestTimeZones.EST), "date LT"); // +1 day
123         assertEquals(0, dateValidator.compareDates(value, diffHour, TestTimeZones.EST), "date EQ"); // same day, diff hour
124         assertEquals(1, dateValidator.compareDates(value, sameDayTwoAm, TestTimeZones.EST), "date EQ"); // same day, diff hour
125         assertEquals(1, dateValidator.compareDates(value, date20050822, TestTimeZones.EST), "date GT"); // -1 day
126     }
127 
128     /**
129      * Test DateValidator validate Methods
130      */
131     @Test
132     @DefaultLocale(country = "US", language = "en")
133     void testDateValidatorMethods() {
134         final Locale locale = Locale.GERMAN;
135         final String pattern = "yyyy-MM-dd";
136         final String patternVal = "2005-12-31";
137         final String germanPattern = "dd MMM yyyy";
138         // Don't rely on specific German format - it varies between JVMs
139         final DateFormat df = new SimpleDateFormat(germanPattern, locale);
140         final Calendar cal = Calendar.getInstance(Locale.US);
141         cal.set(2005, Calendar.DECEMBER, 31); // month is 0-based
142         final String germanVal = df.format(cal.getTime());
143         final String localeVal = "31.12.2005";
144         final String defaultVal = "12/31/05";
145         final String xxxx = "XXXX";
146         final Date expected = createCalendar(null, 20051231, 0).getTime();
147 
148         assertEquals(expected, DateValidator.getInstance().validate(defaultVal), "validate(A) default");
149         assertEquals(expected, DateValidator.getInstance().validate(localeVal, locale), "validate(A) locale ");
150         assertEquals(expected, DateValidator.getInstance().validate(patternVal, pattern), "validate(A) pattern");
151         assertEquals(expected, DateValidator.getInstance().validate(germanVal, germanPattern, Locale.GERMAN), "validate(A) both");
152 
153         assertTrue(DateValidator.getInstance().isValid(defaultVal), "isValid(A) default");
154         assertTrue(DateValidator.getInstance().isValid(localeVal, locale), "isValid(A) locale ");
155         assertTrue(DateValidator.getInstance().isValid(patternVal, pattern), "isValid(A) pattern");
156         assertTrue(DateValidator.getInstance().isValid(germanVal, germanPattern, Locale.GERMAN), "isValid(A) both");
157 
158         assertNull(DateValidator.getInstance().validate(xxxx), "validate(B) default");
159         assertNull(DateValidator.getInstance().validate(xxxx, locale), "validate(B) locale ");
160         assertNull(DateValidator.getInstance().validate(xxxx, pattern), "validate(B) pattern");
161         assertNull(DateValidator.getInstance().validate("31 Dec 2005", germanPattern, Locale.GERMAN), "validate(B) both");
162 
163         assertFalse(DateValidator.getInstance().isValid(xxxx), "isValid(B) default");
164         assertFalse(DateValidator.getInstance().isValid(xxxx, locale), "isValid(B) locale ");
165         assertFalse(DateValidator.getInstance().isValid(xxxx, pattern), "isValid(B) pattern");
166         assertFalse(DateValidator.getInstance().isValid("31 Dec 2005", germanPattern, Locale.GERMAN), "isValid(B) both");
167 
168         // Test Time Zone
169         final TimeZone zone = TimeZone.getDefault().getRawOffset() == TestTimeZones.EET.getRawOffset() ? TestTimeZones.EST : TestTimeZones.EET;
170         final Date expectedZone = createCalendar(zone, 20051231, 0).getTime();
171         assertNotEquals(expected.getTime(), expectedZone.getTime(), "default/zone same " + zone);
172 
173         assertEquals(expectedZone, DateValidator.getInstance().validate(defaultVal, zone), "validate(C) default");
174         assertEquals(expectedZone, DateValidator.getInstance().validate(localeVal, locale, zone), "validate(C) locale ");
175         assertEquals(expectedZone, DateValidator.getInstance().validate(patternVal, pattern, zone), "validate(C) pattern");
176         assertEquals(expectedZone, DateValidator.getInstance().validate(germanVal, germanPattern, Locale.GERMAN, zone), "validate(C) both");
177     }
178 }