t/DateUtils.t

   1 use Modern::Perl;
   2 use DateTime;
   3 use DateTime::TimeZone;
   4
   5 use C4::Context;
   6
   7 use Test::More tests => 79;
   8
   9 use Test::MockModule;
  10 use Test::Warn;
  11 use Time::HiRes qw/ gettimeofday /;
  12 use Try::Tiny;
  13
  14 use Koha::DateUtils qw( dt_from_string output_pref format_sqldatetime );
  15
  16 use t::lib::Mocks;
  17
  18 t::lib::Mocks::mock_preference('dateformat', 'us');
  19 t::lib::Mocks::mock_preference('TimeFormat', 'This_is_not_used_but_called');
  20
  21 my $tz = C4::Context->tz;
  22
  23 isa_ok( $tz, 'DateTime::TimeZone', 'Context returns timezone object' );
  24
  25 my $testdate_iso = '2011-06-16';                   # Bloomsday 2011
  26 my $dt = dt_from_string( $testdate_iso, 'iso' );
  27
  28 isa_ok( $dt, 'DateTime', 'dt_from_string returns a DateTime object' );
  29
  30 cmp_ok( $dt->ymd(), 'eq', $testdate_iso, 'Returned object matches input' );
  31
  32 $dt->set_hour(12);
  33 $dt->set_minute(0);
  34
  35 my $date_string;
  36
  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';
  42
  43 $date_string = output_pref({ dt => $dt, dateformat => 'iso', timeformat => '24hr' });
  44 cmp_ok $date_string, 'eq', '2011-06-16 12:00', 'iso output';
  45
  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';
  48
  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');
  51
  52 $date_string = output_pref({ dt => $dt, dateformat => 'rfc3339', dateonly => 1 });
  53 is($date_string, '2011-06-16', 'RFC3339 output');
  54
  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)';
  59
  60 $date_string = output_pref({ dt => $dt, dateformat => 'us', timeformat => '24hr' });
  61 cmp_ok $date_string, 'eq', '06/16/2011 12:00', 'us output';
  62
  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';
  65
  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)';
  68
  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';
  72
  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)';
  75
  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';
  79
  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' );
  85
  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     }
  98 };
  99
 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' );
 103
 104 $new_dt = dt_from_string( $dt, 'iso' );
 105 isa_ok( $new_dt, 'DateTime', 'Passed a DateTime dt_from_string returns it' );
 106
 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' );
 112
 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' );
 117
 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' );
 122
 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' );
 127
 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' );
 130
 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' );
 133
 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' );
 136
 137 $dt0 = dt_from_string( '2012-01-01T23:59:59.999+02:00', 'rfc3339' );
 138 cmp_ok( $dt0->epoch(), 'eq', '1325455199', 'dt_from_string handles seconds with 3 decimal places and a timezone' );
 139
 140 eval {
 141     $dt0 = dt_from_string( '2012-01-01T23:59:59.999Z+02:00', 'rfc3339' );
 142 };
 143 like( $@, qr/.*does not match the date format \(rfc3339\).*/, 'dt_from_string should die when passed a bad date string' );
 144
 145 # ISO string tests
 146 subtest 'dt_from_string - iso format' => sub {
 147     plan tests => 6;
 148
 149     # Dateonly
 150     my $dt_iso = dt_from_string( '2012-01-01', 'iso' );
 151     cmp_ok( $dt_iso->epoch(), 'eq', '1325376000', 'dt_from_string handles dateonly string' );
 152
 153     eval {
 154         $dt_iso = dt_from_string( '2012-01-32', 'iso' );
 155     };
 156     like( $@, qr/^Validation failed/, 'Fail on invalid dateonly string');
 157
 158     # Datetime
 159     $dt_iso = dt_from_string( '2012-01-01T23:59:59', 'iso' );
 160     cmp_ok( $dt_iso->epoch(), 'eq', '1325455199', 'dt_from_string with no offset assumes "local"' );
 161
 162     # Datetime with timezone
 163     $dt_iso = dt_from_string( '2012-01-01T23:59:59Z', 'iso' );
 164     cmp_ok( $dt_iso->epoch(), 'eq', '1325455199', 'dt_from_string with UTC prescribed as Z' );
 165
 166     $dt_iso = dt_from_string( '2012-01-01T23:59:59+02:00', 'iso' );
 167     cmp_ok( $dt_iso->epoch(), 'eq', '1325455199', 'dt_from_string with offset' );
 168
 169     $dt_iso = dt_from_string( '2012-01-01T23:59:59+02:00', 'iso' );
 170     cmp_ok( $dt_iso->epoch(), 'eq', '1325455199', 'dt_from_string handles an offset' );
 171
 172 };
 173
 174 # Return undef if passed mysql 0 dates
 175 $dt0 = dt_from_string( '0000-00-00', 'iso' );
 176 is( $dt0, undef, "undefined returned for 0 iso date" );
 177
 178 # Return undef if passed mysql 9999-* date
 179 my $dt9999 = dt_from_string( '9999-12-31', 'sql' );
 180 is( $dt9999->ymd(), '9999-12-31', "dt_from_string should return a DateTime object for 9999-12-31" );
 181
 182 my $formatted = format_sqldatetime( '2011-06-16 12:00:07', 'metric', '24hr' );
 183 cmp_ok( $formatted, 'eq', '16/06/2011 12:00', 'format_sqldatetime conversion' );
 184
 185 $formatted = format_sqldatetime( undef, 'metric' );
 186 cmp_ok( $formatted, 'eq', q{},
 187     'format_sqldatetime formats undef as empty string' );
 188
 189 # Test the as_due_date parameter
 190 $dt = DateTime->new(
 191     year       => 2013,
 192     month      => 12,
 193     day        => 11,
 194     hour       => 23,
 195     minute     => 59,
 196 );
 197 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '24hr', as_due_date => 1 });
 198 cmp_ok $date_string, 'eq', '11/12/2013', 'as_due_date with hours and timeformat 24hr';
 199
 200 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '24hr', dateonly => 1, as_due_date => 1});
 201 cmp_ok $date_string, 'eq', '11/12/2013', 'as_due_date without hours and timeformat 24hr';
 202
 203 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '12hr', as_due_date => 1 });
 204 cmp_ok $date_string, 'eq', '11/12/2013', 'as_due_date with hours and timeformat 12hr';
 205
 206 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '12hr', dateonly => 1, as_due_date => 1});
 207 cmp_ok $date_string, 'eq', '11/12/2013', 'as_due_date without hours and timeformat 12hr';
 208
 209 # Test as_due_date for hourly loans
 210 $dt = DateTime->new(
 211     year       => 2013,
 212     month      => 12,
 213     day        => 11,
 214     hour       => 18,
 215     minute     => 35,
 216 );
 217 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '24hr', as_due_date => 1 });
 218 cmp_ok $date_string, 'eq', '11/12/2013 18:35', 'as_due_date with hours and timeformat 24hr (non-midnight time)';
 219 $date_string = output_pref({ dt => $dt, dateformat => 'us', timeformat => '12hr', as_due_date => 1 });
 220 cmp_ok $date_string, 'eq', '12/11/2013 06:35 PM', 'as_due_date with hours and timeformat 12hr (non-midnight time)';
 221
 222 my $now = DateTime->now;
 223 is( dt_from_string, $now, "Without parameter, dt_from_string should return today" );
 224
 225 my $module_context = Test::MockModule->new('C4::Context');
 226 $module_context->mock(
 227     'tz',
 228     sub {
 229         return DateTime::TimeZone->new( name => 'Europe/Lisbon' );
 230     }
 231 );
 232
 233 $dt = dt_from_string('1979-04-01');
 234 isa_ok( $dt, 'DateTime', 'dt_from_string should return a DateTime object if a DST is given' );
 235
 236 $module_context->mock(
 237     'tz',
 238     sub {
 239         return DateTime::TimeZone->new( name => 'Europe/Paris' );
 240     }
 241 );
 242
 243 $dt = dt_from_string('2014-03-30 02:00:00');
 244 isa_ok( $dt, 'DateTime', 'dt_from_string should return a DateTime object if a DST is given' );
 245
 246 # Test dt_from_string
 247 t::lib::Mocks::mock_preference('dateformat', 'metric');
 248 t::lib::Mocks::mock_preference('TimeFormat', '24hr');
 249
 250 # dt_from_string should take into account the dateformat pref, or the given parameter
 251 $dt = dt_from_string('31/01/2015');
 252 is( ref($dt), 'DateTime', '31/01/2015 is a correct date in metric format' );
 253 is( output_pref( { dt => $dt, dateonly => 1 } ), '31/01/2015' );
 254 $dt = eval { dt_from_string( '31/01/2015', 'iso' ); };
 255 is( ref($dt), '', '31/01/2015 is not a correct date in iso format' );
 256 $dt = eval { dt_from_string( '01/01/2015', 'iso' ); };
 257 is( ref($dt), '', '01/01/2015 is not a correct date in iso format' );
 258 $dt = eval { dt_from_string( '01/01/2015', 'rfc3339' ); };
 259 is( ref($dt), '', '01/01/2015 is not a correct date in rfc3339 format' );
 260 $dt = eval { dt_from_string( '31/01/2015', 'us' ); };
 261 is( ref($dt), '', '31/01/2015 is not a correct date in us format' );
 262 $dt = dt_from_string( '01/01/2015', 'us' );
 263 is( ref($dt), 'DateTime', '01/01/2015 is a correct date in us format' );
 264 $dt = dt_from_string( '01.01.2015', 'dmydot' );
 265 is( ref($dt), 'DateTime', '01.01.2015 is a correct date in dmydot format' );
 266
 267
 268 # default value for hh and mm is 00:00
 269 $dt = dt_from_string('31/01/2015');
 270 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' );
 271
 272 $dt = dt_from_string('31/01/2015 12:34');
 273 is( output_pref( { dt => $dt } ), '31/01/2015 12:34', 'dt_from_string should match hh:mm' );
 274
 275 $dt = dt_from_string('31/01/2015 12:34:56');
 276 is( output_pref( { dt => $dt } ), '31/01/2015 12:34', 'dt_from_string should match hh:mm:ss' );
 277
 278 # date before 1900
 279 $dt = dt_from_string('01/01/1900');
 280 is( output_pref( { dt => $dt, dateonly => 1 } ), '01/01/1900', 'dt_from_string should manage date < 1900' );
 281
 282 # fallback
 283 $dt = dt_from_string('2015-01-31 01:02:03');
 284 is( output_pref( {dt => $dt} ), '31/01/2015 01:02', 'dt_from_string should fallback to sql format' );
 285
 286 # 12hr format
 287 $dt = dt_from_string('2015-01-31 01:02 AM');
 288 is( output_pref( {dt => $dt} ), '31/01/2015 01:02', 'dt_from_string ' );
 289 $dt = dt_from_string('2015-01-31 01:02:03 AM');
 290 is( output_pref( {dt => $dt} ), '31/01/2015 01:02', 'dt_from_string ' );
 291 $dt = dt_from_string('2015-01-31 01:02 PM');
 292 is( output_pref( {dt => $dt} ), '31/01/2015 13:02', 'dt_from_string ' );
 293 $dt = dt_from_string('2015-01-31 01:02:03 PM');
 294 is( output_pref( {dt => $dt} ), '31/01/2015 13:02', 'dt_from_string ' );
 295 $dt = dt_from_string('2015-01-31 12:02 AM');
 296 is( output_pref( {dt => $dt} ), '31/01/2015 00:02', 'dt_from_string ' );
 297 $dt = dt_from_string('2015-01-31 12:02:03 AM');
 298 is( output_pref( {dt => $dt} ), '31/01/2015 00:02', 'dt_from_string ' );
 299
 300 subtest 'TimeFormat 12hr' => sub {
 301     plan tests => 4;
 302
 303     $dt = DateTime->new( year => 2020, month => 5, day => 28, hour => 12, minute => 49 );
 304     t::lib::Mocks::mock_preference('TimeFormat', '12hr');
 305     my $output = output_pref({ dt => $dt, dateformat => 'iso' });
 306     $dt = dt_from_string( $output, 'iso' );
 307     is( output_pref( {dt => $dt} ), '28/05/2020 12:49 PM', "12 NOON formatted correctly in 12hr format" );
 308     t::lib::Mocks::mock_preference('TimeFormat', '24hr');
 309     is( output_pref( {dt => $dt} ), '28/05/2020 12:49' , "12 NOON formatted correctly in 24hr format" );
 310
 311     $dt = DateTime->new( year => 2020, month => 5, day => 28, hour => 0, minute => 49 );
 312     t::lib::Mocks::mock_preference('TimeFormat', '12hr');
 313     $output = output_pref({ dt => $dt, dateformat => 'iso' });
 314     $dt = dt_from_string( $output, 'iso' );
 315     is( output_pref( {dt => $dt} ), '28/05/2020 12:49 AM', "12 MIDNIGHT formatted correctly in 12hr format" );
 316     t::lib::Mocks::mock_preference('TimeFormat', '24hr');
 317     is( output_pref( {dt => $dt} ), '28/05/2020 00:49', "12 MIDNIGHT formatted correctly in 24hr format" );
 318 };
 319
 320 # output_pref with no parameters, single parameter (no hash)
 321 is( output_pref(), undef, 'Call output_pref without parameters' );
 322 try {
 323     output_pref( 'no_dt' );
 324     ok( 0, 'Passed single invalid dt to output_pref' );
 325 } catch {
 326     is( ref($_), 'Koha::Exceptions::WrongParameter',
 327         'Passed single invalid dt to output_pref' );
 328 };
 329
 330 # pass invalid dt via hash
 331 try {
 332     output_pref({ dt => 'no_dt' });
 333     ok( 0, 'Passed invalid dt in hash to output_pref' );
 334 } catch {
 335     is( ref($_), 'Koha::Exceptions::WrongParameter',
 336         'Passed invalid dt in hash to output_pref' );
 337 };
 338
 339 # output_pref with str parameter
 340 is( output_pref( { 'str' => $testdate_iso, dateformat => 'iso', dateonly => 1 } ), $testdate_iso, 'output_pref should handle correctly the iso parameter' );
 341 my $output_for_invalid_date;
 342 try {
 343     $output_for_invalid_date = output_pref({ str => 'invalid_date' });
 344     ok( 0, 'Invalid date string passed to output_pref' );
 345 } catch {
 346     is( ref($_), 'Koha::Exceptions::WrongParameter',
 347         'Invalid date string passed to output_pref' );
 348 };
 349 is( $output_for_invalid_date, undef, 'No return value from output_pref' );
 350 try {
 351     output_pref({ 'str' => $testdate_iso, dt => $dt, dateformat => 'iso', dateonly => 1 });
 352     ok( 0, 'output_pref should carp if str and dt parameters are passed together' );
 353 } catch {
 354     is( ref($_), 'Koha::Exceptions::WrongParameter', 'output_pref should throw an exception if str and dt parameters are passed together' );
 355 };
 356
 357 # End of tests