Bug 26922: Regression tests
[koha.git] / t / DateUtils.t
blob5b00c77124736ca2ae70a795b3663922b7383ebf
1 use Modern::Perl;
2 use DateTime;
3 use DateTime::TimeZone;
5 use C4::Context;
7 use Test::More tests => 79;
9 use Test::MockModule;
10 use Test::Warn;
11 use Time::HiRes qw/ gettimeofday /;
12 use Try::Tiny;
14 use t::lib::Mocks;
16 BEGIN { use_ok('Koha::DateUtils'); }
18 t::lib::Mocks::mock_preference('dateformat', 'us');
19 t::lib::Mocks::mock_preference('TimeFormat', 'This_is_not_used_but_called');
21 my $tz = C4::Context->tz;
23 isa_ok( $tz, 'DateTime::TimeZone', 'Context returns timezone object' );
25 my $testdate_iso = '2011-06-16';                   # Bloomsday 2011
26 my $dt = dt_from_string( $testdate_iso, 'iso' );
28 isa_ok( $dt, 'DateTime', 'dt_from_string returns a DateTime object' );
30 cmp_ok( $dt->ymd(), 'eq', $testdate_iso, 'Returned object matches input' );
32 $dt->set_hour(12);
33 $dt->set_minute(0);
35 my $date_string;
37 my $dateformat = C4::Context->preference('dateformat');
38 cmp_ok  output_pref({ dt => $dt, dateformat => $dateformat }),
39         'eq',
40         output_pref($dt),
41         'output_pref gives an hashref or a dt';
43 $date_string = output_pref({ dt => $dt, dateformat => 'iso', timeformat => '24hr' });
44 cmp_ok $date_string, 'eq', '2011-06-16 12:00', 'iso output';
46 $date_string = output_pref({ dt => $dt, dateformat => 'iso', timeformat => '12hr' });
47 cmp_ok $date_string, 'eq', '2011-06-16 12:00 PM', 'iso output 12hr';
49 $date_string = output_pref({ dt => $dt, dateformat => 'rfc3339' });
50 like($date_string, qr/2011-06-16T12:00:00\+|-\d\d:\d\d/, 'RFC3339 output');
52 $date_string = output_pref({ dt => $dt, dateformat => 'rfc3339', dateonly => 1 });
53 is($date_string, '2011-06-16', 'RFC3339 output');
55 # "notime" doesn't actually mean anything in this context, but we
56 # can't pass undef or output_pref will try to access the database
57 $date_string = output_pref({ dt => $dt, dateformat => 'iso', timeformat => 'notime', dateonly => 1 });
58 cmp_ok $date_string, 'eq', '2011-06-16', 'iso output (date only)';
60 $date_string = output_pref({ dt => $dt, dateformat => 'us', timeformat => '24hr' });
61 cmp_ok $date_string, 'eq', '06/16/2011 12:00', 'us output';
63 $date_string = output_pref({ dt => $dt, dateformat => 'us', timeformat => '12hr' });
64 cmp_ok $date_string, 'eq', '06/16/2011 12:00 PM', 'us output 12hr';
66 $date_string = output_pref({ dt => $dt, dateformat => 'us', timeformat => 'notime', dateonly => 1 });
67 cmp_ok $date_string, 'eq', '06/16/2011', 'us output (date only)';
69 # metric should return the French Revolutionary Calendar Really
70 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '24hr' });
71 cmp_ok $date_string, 'eq', '16/06/2011 12:00', 'metric output';
73 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => 'notime', dateonly => 1 });
74 cmp_ok $date_string, 'eq', '16/06/2011', 'metric output (date only)';
76 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '24hr' });
77 cmp_ok $date_string, 'eq', '16/06/2011 12:00',
78   'output_pref preserves non midnight HH:SS';
80 my $dear_dirty_dublin = DateTime::TimeZone->new( name => 'Europe/Dublin' );
81 my $new_dt = dt_from_string( '16/06/2011', 'metric', $dear_dirty_dublin );
82 isa_ok( $new_dt, 'DateTime', 'Create DateTime with different timezone' );
83 cmp_ok( $new_dt->ymd(), 'eq', $testdate_iso,
84     'Returned Dublin object matches input' );
86 SKIP: {
87     skip "Don't test execution time of dt_from_string on slow servers", 6 if $ENV{SLOW_SERVER};
88     for ( qw/ 2014-01-01 2100-01-01 9999-01-01 / ) {
89         my $duration = gettimeofday();
90         $new_dt = dt_from_string($_, 'iso', $dear_dirty_dublin);
91         $duration = gettimeofday() - $duration;
92         cmp_ok $duration, '<', 1, "Create DateTime with dt_from_string() for $_ with TZ in less than 1s";
93         $duration = gettimeofday();
94         output_pref( { dt => $new_dt } );
95         $duration = gettimeofday() - $duration;
96         cmp_ok $duration, '<', 1, "Create DateTime with output_pref() for $_ with TZ in less than 1s";
97     }
100 $new_dt = dt_from_string( '2011-06-16 12:00', 'sql' );
101 isa_ok( $new_dt, 'DateTime', 'Create DateTime from (mysql) sql' );
102 cmp_ok( $new_dt->ymd(), 'eq', $testdate_iso, 'sql returns correct date' );
104 $new_dt = dt_from_string( $dt, 'iso' );
105 isa_ok( $new_dt, 'DateTime', 'Passed a DateTime dt_from_string returns it' );
107 my $ymd = '2012-01-01';
108 my $dt0 = dt_from_string( '00/01/2012', 'metric' );
109 isa_ok( $dt0, 'DateTime',
110     'dt_from_string returns a DateTime object passed a zero metric day' );
111 cmp_ok( $dt0->ymd(), 'eq', $ymd, 'Returned object corrects metric day 0' );
113 $dt0 = dt_from_string( '01/00/2012', 'us' );
114 isa_ok( $dt0, 'DateTime',
115     'dt_from_string returns a DateTime object passed a zero us day' );
116 cmp_ok( $dt0->ymd(), 'eq', $ymd, 'Returned object corrects us day 0' );
118 $dt0 = dt_from_string( '2012-01-00', 'iso' );
119 isa_ok( $dt0, 'DateTime',
120     'dt_from_string returns a DateTime object passed a zero iso day' );
121 cmp_ok( $dt0->ymd(), 'eq', $ymd, 'Returned object corrects iso day 0' );
123 $dt0 = dt_from_string( '2012-01-00T12:00:00Z', 'rfc3339' );
124 isa_ok( $dt0, 'DateTime',
125     'dt_from_string returns a DateTime object passed a zero rfc3339 day' );
126 cmp_ok( $dt0->ymd(), 'eq', $ymd, 'Returned object corrects rfc3339 day 0' );
128 $dt0 = dt_from_string( '2012-01-01T23:59:00.0Z', 'rfc3339' );
129 cmp_ok( $dt0->epoch(), 'eq', '1325462340', 'dt_from_string handles seconds with 1 decimal place' );
131 $dt0 = dt_from_string( '2012-01-01T23:59:00.00Z', 'rfc3339' );
132 cmp_ok( $dt0->epoch(), 'eq', '1325462340', 'dt_from_string handles seconds with 2 decimal places' );
134 $dt0 = dt_from_string( '2012-01-01t23:59:59.999z', 'rfc3339' );
135 cmp_ok( $dt0->epoch(), 'eq', '1325462399', 'dt_from_string handles seconds with 3 decimal places' );
137 $dt0 = dt_from_string( '2012-01-01T23:59:59.999Z+02:00', 'rfc3339' );
138 cmp_ok( $dt0->epoch(), 'eq', '1325462399', 'dt_from_string handles seconds with 3 decimal places and a timezone' );
140 # Return undef if passed mysql 0 dates
141 $dt0 = dt_from_string( '0000-00-00', 'iso' );
142 is( $dt0, undef, "undefined returned for 0 iso date" );
144 # Return undef if passed mysql 9999-* date
145 my $dt9999 = dt_from_string( '9999-12-31', 'sql' );
146 is( $dt9999->ymd(), '9999-12-31', "dt_from_string should return a DateTime object for 9999-12-31" );
148 my $formatted = format_sqldatetime( '2011-06-16 12:00:07', 'metric', '24hr' );
149 cmp_ok( $formatted, 'eq', '16/06/2011 12:00', 'format_sqldatetime conversion' );
151 $formatted = format_sqldatetime( undef, 'metric' );
152 cmp_ok( $formatted, 'eq', q{},
153     'format_sqldatetime formats undef as empty string' );
155 # Test the as_due_date parameter
156 $dt = DateTime->new(
157     year       => 2013,
158     month      => 12,
159     day        => 11,
160     hour       => 23,
161     minute     => 59,
163 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '24hr', as_due_date => 1 });
164 cmp_ok $date_string, 'eq', '11/12/2013', 'as_due_date with hours and timeformat 24hr';
166 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '24hr', dateonly => 1, as_due_date => 1});
167 cmp_ok $date_string, 'eq', '11/12/2013', 'as_due_date without hours and timeformat 24hr';
169 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '12hr', as_due_date => 1 });
170 cmp_ok $date_string, 'eq', '11/12/2013', 'as_due_date with hours and timeformat 12hr';
172 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '12hr', dateonly => 1, as_due_date => 1});
173 cmp_ok $date_string, 'eq', '11/12/2013', 'as_due_date without hours and timeformat 12hr';
175 # Test as_due_date for hourly loans
176 $dt = DateTime->new(
177     year       => 2013,
178     month      => 12,
179     day        => 11,
180     hour       => 18,
181     minute     => 35,
183 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '24hr', as_due_date => 1 });
184 cmp_ok $date_string, 'eq', '11/12/2013 18:35', 'as_due_date with hours and timeformat 24hr (non-midnight time)';
185 $date_string = output_pref({ dt => $dt, dateformat => 'us', timeformat => '12hr', as_due_date => 1 });
186 cmp_ok $date_string, 'eq', '12/11/2013 06:35 PM', 'as_due_date with hours and timeformat 12hr (non-midnight time)';
188 my $now = DateTime->now;
189 is( dt_from_string, $now, "Without parameter, dt_from_string should return today" );
191 my $module_context = Test::MockModule->new('C4::Context');
192 $module_context->mock(
193     'tz',
194     sub {
195         return DateTime::TimeZone->new( name => 'Europe/Lisbon' );
196     }
199 $dt = dt_from_string('1979-04-01');
200 isa_ok( $dt, 'DateTime', 'dt_from_string should return a DateTime object if a DST is given' );
202 $module_context->mock(
203     'tz',
204     sub {
205         return DateTime::TimeZone->new( name => 'Europe/Paris' );
206     }
209 $dt = dt_from_string('2014-03-30 02:00:00');
210 isa_ok( $dt, 'DateTime', 'dt_from_string should return a DateTime object if a DST is given' );
212 # Test dt_from_string
213 t::lib::Mocks::mock_preference('dateformat', 'metric');
214 t::lib::Mocks::mock_preference('TimeFormat', '24hr');
216 # dt_from_string should take into account the dateformat pref, or the given parameter
217 $dt = dt_from_string('31/01/2015');
218 is( ref($dt), 'DateTime', '31/01/2015 is a correct date in metric format' );
219 is( output_pref( { dt => $dt, dateonly => 1 } ), '31/01/2015' );
220 $dt = eval { dt_from_string( '31/01/2015', 'iso' ); };
221 is( ref($dt), '', '31/01/2015 is not a correct date in iso format' );
222 $dt = eval { dt_from_string( '01/01/2015', 'iso' ); };
223 is( ref($dt), '', '01/01/2015 is not a correct date in iso format' );
224 $dt = eval { dt_from_string( '01/01/2015', 'rfc3339' ); };
225 is( ref($dt), '', '01/01/2015 is not a correct date in rfc3339 format' );
226 $dt = eval { dt_from_string( '31/01/2015', 'us' ); };
227 is( ref($dt), '', '31/01/2015 is not a correct date in us format' );
228 $dt = dt_from_string( '01/01/2015', 'us' );
229 is( ref($dt), 'DateTime', '01/01/2015 is a correct date in us format' );
230 $dt = dt_from_string( '01.01.2015', 'dmydot' );
231 is( ref($dt), 'DateTime', '01.01.2015 is a correct date in dmydot format' );
234 # default value for hh and mm is 00:00
235 $dt = dt_from_string('31/01/2015');
236 is( output_pref( { dt => $dt } ), '31/01/2015 00:00', 'dt_from_string should generate a DT object with 00:00 as default hh:mm' );
238 $dt = dt_from_string('31/01/2015 12:34');
239 is( output_pref( { dt => $dt } ), '31/01/2015 12:34', 'dt_from_string should match hh:mm' );
241 $dt = dt_from_string('31/01/2015 12:34:56');
242 is( output_pref( { dt => $dt } ), '31/01/2015 12:34', 'dt_from_string should match hh:mm:ss' );
244 # date before 1900
245 $dt = dt_from_string('01/01/1900');
246 is( output_pref( { dt => $dt, dateonly => 1 } ), '01/01/1900', 'dt_from_string should manage date < 1900' );
248 # fallback
249 $dt = dt_from_string('2015-01-31 01:02:03');
250 is( output_pref( {dt => $dt} ), '31/01/2015 01:02', 'dt_from_string should fallback to sql format' );
252 # 12hr format
253 $dt = dt_from_string('2015-01-31 01:02 AM');
254 is( output_pref( {dt => $dt} ), '31/01/2015 01:02', 'dt_from_string ' );
255 $dt = dt_from_string('2015-01-31 01:02:03 AM');
256 is( output_pref( {dt => $dt} ), '31/01/2015 01:02', 'dt_from_string ' );
257 $dt = dt_from_string('2015-01-31 01:02 PM');
258 is( output_pref( {dt => $dt} ), '31/01/2015 13:02', 'dt_from_string ' );
259 $dt = dt_from_string('2015-01-31 01:02:03 PM');
260 is( output_pref( {dt => $dt} ), '31/01/2015 13:02', 'dt_from_string ' );
261 $dt = dt_from_string('2015-01-31 12:02 AM');
262 is( output_pref( {dt => $dt} ), '31/01/2015 00:02', 'dt_from_string ' );
263 $dt = dt_from_string('2015-01-31 12:02:03 AM');
264 is( output_pref( {dt => $dt} ), '31/01/2015 00:02', 'dt_from_string ' );
266 subtest 'TimeFormat 12hr' => sub {
267     plan tests => 4;
269     $dt = DateTime->new( year => 2020, month => 5, day => 28, hour => 12, minute => 49 );
270     t::lib::Mocks::mock_preference('TimeFormat', '12hr');
271     my $output = output_pref({ dt => $dt, dateformat => 'iso' });
272     $dt = dt_from_string( $output, 'iso' );
273     is( output_pref( {dt => $dt} ), '28/05/2020 12:49 PM', "12 NOON formatted correctly in 12hr format" );
274     t::lib::Mocks::mock_preference('TimeFormat', '24hr');
275     is( output_pref( {dt => $dt} ), '28/05/2020 12:49' , "12 NOON formatted correctly in 24hr format" );
277     $dt = DateTime->new( year => 2020, month => 5, day => 28, hour => 0, minute => 49 );
278     t::lib::Mocks::mock_preference('TimeFormat', '12hr');
279     $output = output_pref({ dt => $dt, dateformat => 'iso' });
280     $dt = dt_from_string( $output, 'iso' );
281     is( output_pref( {dt => $dt} ), '28/05/2020 12:49 AM', "12 MIDNIGHT formatted correctly in 12hr format" );
282     t::lib::Mocks::mock_preference('TimeFormat', '24hr');
283     is( output_pref( {dt => $dt} ), '28/05/2020 00:49', "12 MIDNIGHT formatted correctly in 24hr format" );
286 # output_pref with no parameters, single parameter (no hash)
287 is( output_pref(), undef, 'Call output_pref without parameters' );
288 try {
289     output_pref( 'no_dt' );
290     ok( 0, 'Passed single invalid dt to output_pref' );
291 } catch {
292     is( ref($_), 'Koha::Exceptions::WrongParameter',
293         'Passed single invalid dt to output_pref' );
296 # pass invalid dt via hash
297 try {
298     output_pref({ dt => 'no_dt' });
299     ok( 0, 'Passed invalid dt in hash to output_pref' );
300 } catch {
301     is( ref($_), 'Koha::Exceptions::WrongParameter',
302         'Passed invalid dt in hash to output_pref' );
305 # output_pref with str parameter
306 is( output_pref( { 'str' => $testdate_iso, dateformat => 'iso', dateonly => 1 } ), $testdate_iso, 'output_pref should handle correctly the iso parameter' );
307 my $output_for_invalid_date;
308 try {
309     $output_for_invalid_date = output_pref({ str => 'invalid_date' });
310     ok( 0, 'Invalid date string passed to output_pref' );
311 } catch {
312     is( ref($_), 'Koha::Exceptions::WrongParameter',
313         'Invalid date string passed to output_pref' );
315 is( $output_for_invalid_date, undef, 'No return value from output_pref' );
316 try {
317     output_pref({ 'str' => $testdate_iso, dt => $dt, dateformat => 'iso', dateonly => 1 });
318     ok( 0, 'output_pref should carp if str and dt parameters are passed together' );
319 } catch {
320     is( ref($_), 'Koha::Exceptions::WrongParameter', 'output_pref should throw an exception if str and dt parameters are passed together' );
323 # End of tests