From 2eb6c36c4ddec644619486dea5520e89ef9af56b Mon Sep 17 00:00:00 2001 From: Marcel de Rooy Date: Sat, 13 May 2023 12:18:02 +0000 Subject: [PATCH] Bug 33727: Merge both Calendar tests The old t tests become part of the first subtest. Test plan: Run the new t/db_dependent/Calendar.t Signed-off-by: Marcel de Rooy Signed-off-by: Katrin Fischer Signed-off-by: Tomas Cohen Arazi --- t/Calendar.t | 312 -------------------------------------- t/db_dependent/Calendar.t | 290 ++++++++++++++++++++++++++++++++++- 2 files changed, 284 insertions(+), 318 deletions(-) delete mode 100755 t/Calendar.t diff --git a/t/Calendar.t b/t/Calendar.t deleted file mode 100755 index 9c6bf4c890..0000000000 --- a/t/Calendar.t +++ /dev/null @@ -1,312 +0,0 @@ -#!/usr/bin/perl - -# This file is part of Koha. -# -# Koha is free software; you can redistribute it and/or modify it -# under the terms of the GNU General Public License as published by -# the Free Software Foundation; either version 3 of the License, or -# (at your option) any later version. -# -# Koha is distributed in the hope that it will be useful, but -# WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Koha; if not, see . - -use Modern::Perl; - -use Test::More tests => 38; -use Test::MockModule; - -use DateTime; -use DateTime::Duration; -use Koha::Caches; -use Koha::Calendar; -use Koha::Database; -use Koha::DateUtils qw( dt_from_string ); - -use t::lib::Mocks; -use t::lib::TestBuilder; - -my $builder = t::lib::TestBuilder->new; -my $schema = Koha::Database->new->schema; -$schema->storage->txn_begin; - -# We need to mock the C4::Context->preference method for -# simplicity and re-usability of the session definition. Any -# syspref fits for syspref-agnostic tests. -my $module_context = Test::MockModule->new('C4::Context'); -$module_context->mock( - 'preference', - sub { - return 'Calendar'; - } -); - -my $mpl = $builder->build_object({ class => 'Koha::Libraries' })->branchcode; -my $cpl = $builder->build_object({ class => 'Koha::Libraries' })->branchcode; -my $rows = [ # add weekly holidays - { branchcode => $mpl, weekday => 0 }, # sundays - { branchcode => $mpl, weekday => 6 }, # saturdays - { branchcode => $mpl, day => 1, month => 1 }, # new year's day - { branchcode => $mpl, day => 25, month => 12 }, # chrismas -]; -$schema->resultset('RepeatableHoliday')->delete_all; -$schema->resultset('RepeatableHoliday')->create({ %$_, description => q{} }) for @$rows; - -$rows = [ # exception holidays - { branchcode => $mpl, day => 11, month => 11, year => 2012, isexception => 1 }, # sunday exception - { branchcode => $mpl, day => 1, month => 6, year => 2011, isexception => 0 }, - { branchcode => $mpl, day => 4, month => 7, year => 2012, isexception => 0 }, - { branchcode => $cpl, day => 6, month => 8, year => 2012, isexception => 0 }, - { branchcode => $mpl, day => 7, month => 7, year => 2012, isexception => 1 }, # holiday exception - { branchcode => $mpl, day => 7, month => 7, year => 2012, isexception => 0 }, # holiday -]; -$schema->resultset('SpecialHoliday')->delete_all; -$schema->resultset('SpecialHoliday')->create({ %$_, description => q{} }) for @$rows; - -my $cache = Koha::Caches->get_instance(); -$cache->clear_from_cache('MPL_holidays'); -$cache->clear_from_cache('CPL_holidays'); - -# $mpl branch is arbitrary, is not used at all but is needed for initialization -my $cal = Koha::Calendar->new( branchcode => $mpl ); - -isa_ok( $cal, 'Koha::Calendar', 'Calendar class returned' ); - -my $saturday = DateTime->new( - year => 2012, - month => 11, - day => 24, -); - -my $sunday = DateTime->new( - year => 2012, - month => 11, - day => 25, -); - -my $monday = DateTime->new( - year => 2012, - month => 11, - day => 26, -); - -my $new_year = DateTime->new( - year => 2013, - month => 1, - day => 1, -); - -my $single_holiday = DateTime->new( - year => 2011, - month => 6, - day => 1, -); # should be a holiday - -my $notspecial = DateTime->new( - year => 2011, - month => 6, - day => 2 -); # should NOT be a holiday - -my $sunday_exception = DateTime->new( - year => 2012, - month => 11, - day => 11 -); - -my $day_after_christmas = DateTime->new( - year => 2012, - month => 12, - day => 26 -); # for testing negative addDuration - -my $holiday_for_another_branch = DateTime->new( - year => 2012, - month => 8, - day => 6, # This is a monday -); - -my $holiday_excepted = DateTime->new( - year => 2012, - month => 7, - day => 7, # Both a holiday and exception -); - -{ # Syspref-agnostic tests - is ( $saturday->day_of_week, 6, '\'$saturday\' is actually a saturday (6th day of week)'); - is ( $sunday->day_of_week, 7, '\'$sunday\' is actually a sunday (7th day of week)'); - is ( $monday->day_of_week, 1, '\'$monday\' is actually a monday (1st day of week)'); - is ( $cal->is_holiday($saturday), 1, 'Saturday is a closed day' ); - is ( $cal->is_holiday($sunday), 1, 'Sunday is a closed day' ); - is ( $cal->is_holiday($monday), 0, 'Monday is not a closed day' ); - is ( $cal->is_holiday($new_year), 1, 'Month/Day closed day test (New year\'s day)' ); - is ( $cal->is_holiday($single_holiday), 1, 'Single holiday closed day test' ); - is ( $cal->is_holiday($notspecial), 0, 'Fixed single date that is not a holiday test' ); - is ( $cal->is_holiday($sunday_exception), 0, 'Exception holiday is not a closed day test' ); - is ( $cal->is_holiday($holiday_for_another_branch), 0, 'Holiday defined for another branch should not be defined as an holiday' ); - is ( $cal->is_holiday($holiday_excepted), 0, 'Holiday defined and excepted should not be a holiday' ); -} - -{ # Bugzilla #8966 - is_holiday truncates referenced date - my $later_dt = DateTime->new( # Monday - year => 2012, - month => 9, - day => 17, - hour => 17, - minute => 30, - time_zone => 'Europe/London', - ); - - - is( $cal->is_holiday($later_dt), 0, 'bz-8966 (1/2) Apply is_holiday for the next test' ); - cmp_ok( $later_dt, 'eq', '2012-09-17T17:30:00', 'bz-8966 (2/2) Date should be the same after is_holiday' ); -} - -{ # Bugzilla #8800 - is_holiday should use truncated date for 'contains' call - my $single_holiday_time = DateTime->new( - year => 2011, - month => 6, - day => 1, - hour => 11, - minute => 2 - ); - - is( $cal->is_holiday($single_holiday_time), - $cal->is_holiday($single_holiday) , - 'bz-8800 is_holiday should truncate the date for holiday validation' ); -} - - my $one_day_dur = DateTime::Duration->new( days => 1 ); - my $two_day_dur = DateTime::Duration->new( days => 2 ); - my $seven_day_dur = DateTime::Duration->new( days => 7 ); - - my $dt = dt_from_string( '2012-07-03','iso' ); #tuesday - - my $test_dt = DateTime->new( # Monday - year => 2012, - month => 7, - day => 23, - hour => 11, - minute => 53, - ); - - my $later_dt = DateTime->new( # Monday - year => 2012, - month => 9, - day => 17, - hour => 17, - minute => 30, - time_zone => 'Europe/London', - ); - -{ ## 'Datedue' tests - - $cal = Koha::Calendar->new( branchcode => $mpl, days_mode => 'Datedue' ); - - is($cal->addDuration( $dt, $one_day_dur, 'days' ), # tuesday - dt_from_string('2012-07-05','iso'), - 'Single day add (Datedue, matches holiday, shift)' ); - - is($cal->addDuration( $dt, $two_day_dur, 'days' ), - dt_from_string('2012-07-05','iso'), - 'Two days add, skips holiday (Datedue)' ); - - cmp_ok($cal->addDuration( $test_dt, $seven_day_dur, 'days' ), 'eq', - '2012-07-30T11:53:00', - 'Add 7 days (Datedue)' ); - - is( $cal->addDuration( $saturday, $one_day_dur, 'days' )->day_of_week, 1, - 'addDuration skips closed Sunday (Datedue)' ); - - is( $cal->addDuration($day_after_christmas, -1, 'days')->ymd(), '2012-12-24', - 'Negative call to addDuration (Datedue)' ); - - ## Note that the days_between API says closed days are not considered. - ## This tests are here as an API test. - cmp_ok( $cal->days_between( $test_dt, $later_dt )->in_units('days'), - '==', 40, 'days_between calculates correctly (Days)' ); - - cmp_ok( $cal->days_between( $later_dt, $test_dt )->in_units('days'), - '==', 40, 'Test parameter order not relevant (Days)' ); -} - -{ ## 'Calendar' tests' - - $cal = Koha::Calendar->new( branchcode => $mpl, days_mode => 'Calendar' ); - - $dt = dt_from_string('2012-07-03','iso'); - - is($cal->addDuration( $dt, $one_day_dur, 'days' ), - dt_from_string('2012-07-05','iso'), - 'Single day add (Calendar)' ); - - cmp_ok($cal->addDuration( $test_dt, $seven_day_dur, 'days' ), 'eq', - '2012-08-01T11:53:00', - 'Add 7 days (Calendar)' ); - - is( $cal->addDuration( $saturday, $one_day_dur, 'days' )->day_of_week, 1, - 'addDuration skips closed Sunday (Calendar)' ); - - is( $cal->addDuration($day_after_christmas, -1, 'days')->ymd(), '2012-12-24', - 'Negative call to addDuration (Calendar)' ); - - cmp_ok( $cal->days_between( $test_dt, $later_dt )->in_units('days'), - '==', 40, 'days_between calculates correctly (Calendar)' ); - - cmp_ok( $cal->days_between( $later_dt, $test_dt )->in_units('days'), - '==', 40, 'Test parameter order not relevant (Calendar)' ); -} - - -{ ## 'Days' tests - - $cal = Koha::Calendar->new( branchcode => $mpl, days_mode => 'Days' ); - - $dt = dt_from_string('2012-07-03','iso'); - - is($cal->addDuration( $dt, $one_day_dur, 'days' ), - dt_from_string('2012-07-04','iso'), - 'Single day add (Days)' ); - - cmp_ok($cal->addDuration( $test_dt, $seven_day_dur, 'days' ),'eq', - '2012-07-30T11:53:00', - 'Add 7 days (Days)' ); - - is( $cal->addDuration( $saturday, $one_day_dur, 'days' )->day_of_week, 7, - 'addDuration doesn\'t skip closed Sunday (Days)' ); - - is( $cal->addDuration($day_after_christmas, -1, 'days')->ymd(), '2012-12-25', - 'Negative call to addDuration (Days)' ); - - ## Note that the days_between API says closed days are not considered. - ## This tests are here as an API test. - cmp_ok( $cal->days_between( $test_dt, $later_dt )->in_units('days'), - '==', 40, 'days_between calculates correctly (Days)' ); - - cmp_ok( $cal->days_between( $later_dt, $test_dt )->in_units('days'), - '==', 40, 'Test parameter order not relevant (Days)' ); - -} - -{ - $cal = Koha::Calendar->new( branchcode => $cpl ); - is ( $cal->is_holiday($single_holiday), 0, 'Single holiday for MPL, not CPL' ); - is ( $cal->is_holiday($holiday_for_another_branch), 1, 'Holiday defined for CPL should be defined as an holiday' ); -} - -subtest 'days_mode parameter' => sub { - plan tests => 1; - - t::lib::Mocks::mock_preference('useDaysMode', 'Days'); - - $cal = Koha::Calendar->new( branchcode => $cpl, days_mode => 'Calendar' ); - is( $cal->{days_mode}, 'Calendar', q|If set, days_mode is correctly set|); -}; - -$cache->clear_from_cache('MPL_holidays'); -$cache->clear_from_cache('CPL_holidays'); -$schema->storage->txn_rollback; diff --git a/t/db_dependent/Calendar.t b/t/db_dependent/Calendar.t index 4b8a7057c2..43af3a3224 100755 --- a/t/db_dependent/Calendar.t +++ b/t/db_dependent/Calendar.t @@ -24,12 +24,14 @@ use t::lib::Mocks; use t::lib::TestBuilder; use DateTime; +use DateTime::Duration; use Koha::Caches; +use Koha::Calendar; +use Koha::Database; use Koha::DateUtils qw( dt_from_string ); -use_ok('Koha::Calendar'); - my $schema = Koha::Database->new->schema; +my $builder = t::lib::TestBuilder->new; $schema->storage->txn_begin; my $today = dt_from_string(); @@ -38,8 +40,286 @@ $holiday_dt->add(days => 3); Koha::Caches->get_instance()->flush_all(); -my $builder = t::lib::TestBuilder->new(); +subtest 'Original tests from t' => sub { + # We need to mock the C4::Context->preference method for + # simplicity and re-usability of the session definition. Any + # syspref fits for syspref-agnostic tests. + my $module_context = Test::MockModule->new('C4::Context'); + $module_context->mock( + 'preference', + sub { + return 'Calendar'; + } + ); + + my $mpl = $builder->build_object({ class => 'Koha::Libraries' })->branchcode; + my $cpl = $builder->build_object({ class => 'Koha::Libraries' })->branchcode; + my $rows = [ # add weekly holidays + { branchcode => $mpl, weekday => 0 }, # sundays + { branchcode => $mpl, weekday => 6 }, # saturdays + { branchcode => $mpl, day => 1, month => 1 }, # new year's day + { branchcode => $mpl, day => 25, month => 12 }, # chrismas + ]; + $schema->resultset('RepeatableHoliday')->delete_all; + $schema->resultset('RepeatableHoliday')->create({ %$_, description => q{} }) for @$rows; + + $rows = [ # exception holidays + { branchcode => $mpl, day => 11, month => 11, year => 2012, isexception => 1 }, # sunday exception + { branchcode => $mpl, day => 1, month => 6, year => 2011, isexception => 0 }, + { branchcode => $mpl, day => 4, month => 7, year => 2012, isexception => 0 }, + { branchcode => $cpl, day => 6, month => 8, year => 2012, isexception => 0 }, + { branchcode => $mpl, day => 7, month => 7, year => 2012, isexception => 1 }, # holiday exception + { branchcode => $mpl, day => 7, month => 7, year => 2012, isexception => 0 }, # holiday + ]; + $schema->resultset('SpecialHoliday')->delete_all; + $schema->resultset('SpecialHoliday')->create({ %$_, description => q{} }) for @$rows; + + my $cache = Koha::Caches->get_instance(); + $cache->clear_from_cache( $mpl.'_holidays' ); + $cache->clear_from_cache( $cpl.'_holidays' ); + + # $mpl branch is arbitrary, is not used at all but is needed for initialization + my $cal = Koha::Calendar->new( branchcode => $mpl ); + + isa_ok( $cal, 'Koha::Calendar', 'Calendar class returned' ); + + my $saturday = DateTime->new( + year => 2012, + month => 11, + day => 24, + ); + + my $sunday = DateTime->new( + year => 2012, + month => 11, + day => 25, + ); + + my $monday = DateTime->new( + year => 2012, + month => 11, + day => 26, + ); + + my $new_year = DateTime->new( + year => 2013, + month => 1, + day => 1, + ); + + my $single_holiday = DateTime->new( + year => 2011, + month => 6, + day => 1, + ); # should be a holiday + + my $notspecial = DateTime->new( + year => 2011, + month => 6, + day => 2 + ); # should NOT be a holiday + + my $sunday_exception = DateTime->new( + year => 2012, + month => 11, + day => 11 + ); + + my $day_after_christmas = DateTime->new( + year => 2012, + month => 12, + day => 26 + ); # for testing negative addDuration + + my $holiday_for_another_branch = DateTime->new( + year => 2012, + month => 8, + day => 6, # This is a monday + ); + + my $holiday_excepted = DateTime->new( + year => 2012, + month => 7, + day => 7, # Both a holiday and exception + ); + + { # Syspref-agnostic tests + is ( $saturday->day_of_week, 6, '\'$saturday\' is actually a saturday (6th day of week)'); + is ( $sunday->day_of_week, 7, '\'$sunday\' is actually a sunday (7th day of week)'); + is ( $monday->day_of_week, 1, '\'$monday\' is actually a monday (1st day of week)'); + is ( $cal->is_holiday($saturday), 1, 'Saturday is a closed day' ); + is ( $cal->is_holiday($sunday), 1, 'Sunday is a closed day' ); + is ( $cal->is_holiday($monday), 0, 'Monday is not a closed day' ); + is ( $cal->is_holiday($new_year), 1, 'Month/Day closed day test (New year\'s day)' ); + is ( $cal->is_holiday($single_holiday), 1, 'Single holiday closed day test' ); + is ( $cal->is_holiday($notspecial), 0, 'Fixed single date that is not a holiday test' ); + is ( $cal->is_holiday($sunday_exception), 0, 'Exception holiday is not a closed day test' ); + is ( $cal->is_holiday($holiday_for_another_branch), 0, 'Holiday defined for another branch should not be defined as an holiday' ); + is ( $cal->is_holiday($holiday_excepted), 0, 'Holiday defined and excepted should not be a holiday' ); + } + + { # Bugzilla #8966 - is_holiday truncates referenced date + my $later_dt = DateTime->new( # Monday + year => 2012, + month => 9, + day => 17, + hour => 17, + minute => 30, + time_zone => 'Europe/London', + ); + + + is( $cal->is_holiday($later_dt), 0, 'bz-8966 (1/2) Apply is_holiday for the next test' ); + cmp_ok( $later_dt, 'eq', '2012-09-17T17:30:00', 'bz-8966 (2/2) Date should be the same after is_holiday' ); + } + + { # Bugzilla #8800 - is_holiday should use truncated date for 'contains' call + my $single_holiday_time = DateTime->new( + year => 2011, + month => 6, + day => 1, + hour => 11, + minute => 2 + ); + + is( $cal->is_holiday($single_holiday_time), + $cal->is_holiday($single_holiday) , + 'bz-8800 is_holiday should truncate the date for holiday validation' ); + } + + my $one_day_dur = DateTime::Duration->new( days => 1 ); + my $two_day_dur = DateTime::Duration->new( days => 2 ); + my $seven_day_dur = DateTime::Duration->new( days => 7 ); + + my $dt = dt_from_string( '2012-07-03','iso' ); #tuesday + + my $test_dt = DateTime->new( # Monday + year => 2012, + month => 7, + day => 23, + hour => 11, + minute => 53, + ); + + my $later_dt = DateTime->new( # Monday + year => 2012, + month => 9, + day => 17, + hour => 17, + minute => 30, + time_zone => 'Europe/London', + ); + + { ## 'Datedue' tests + + $cal = Koha::Calendar->new( branchcode => $mpl, days_mode => 'Datedue' ); + + is($cal->addDuration( $dt, $one_day_dur, 'days' ), # tuesday + dt_from_string('2012-07-05','iso'), + 'Single day add (Datedue, matches holiday, shift)' ); + + is($cal->addDuration( $dt, $two_day_dur, 'days' ), + dt_from_string('2012-07-05','iso'), + 'Two days add, skips holiday (Datedue)' ); + + cmp_ok($cal->addDuration( $test_dt, $seven_day_dur, 'days' ), 'eq', + '2012-07-30T11:53:00', + 'Add 7 days (Datedue)' ); + + is( $cal->addDuration( $saturday, $one_day_dur, 'days' )->day_of_week, 1, + 'addDuration skips closed Sunday (Datedue)' ); + + is( $cal->addDuration($day_after_christmas, -1, 'days')->ymd(), '2012-12-24', + 'Negative call to addDuration (Datedue)' ); + + ## Note that the days_between API says closed days are not considered. + ## This tests are here as an API test. + cmp_ok( $cal->days_between( $test_dt, $later_dt )->in_units('days'), + '==', 40, 'days_between calculates correctly (Days)' ); + + cmp_ok( $cal->days_between( $later_dt, $test_dt )->in_units('days'), + '==', 40, 'Test parameter order not relevant (Days)' ); + } + + { ## 'Calendar' tests' + + $cal = Koha::Calendar->new( branchcode => $mpl, days_mode => 'Calendar' ); + + $dt = dt_from_string('2012-07-03','iso'); + + is($cal->addDuration( $dt, $one_day_dur, 'days' ), + dt_from_string('2012-07-05','iso'), + 'Single day add (Calendar)' ); + + cmp_ok($cal->addDuration( $test_dt, $seven_day_dur, 'days' ), 'eq', + '2012-08-01T11:53:00', + 'Add 7 days (Calendar)' ); + + is( $cal->addDuration( $saturday, $one_day_dur, 'days' )->day_of_week, 1, + 'addDuration skips closed Sunday (Calendar)' ); + + is( $cal->addDuration($day_after_christmas, -1, 'days')->ymd(), '2012-12-24', + 'Negative call to addDuration (Calendar)' ); + + cmp_ok( $cal->days_between( $test_dt, $later_dt )->in_units('days'), + '==', 40, 'days_between calculates correctly (Calendar)' ); + + cmp_ok( $cal->days_between( $later_dt, $test_dt )->in_units('days'), + '==', 40, 'Test parameter order not relevant (Calendar)' ); + } + + + { ## 'Days' tests + + $cal = Koha::Calendar->new( branchcode => $mpl, days_mode => 'Days' ); + + $dt = dt_from_string('2012-07-03','iso'); + + is($cal->addDuration( $dt, $one_day_dur, 'days' ), + dt_from_string('2012-07-04','iso'), + 'Single day add (Days)' ); + + cmp_ok($cal->addDuration( $test_dt, $seven_day_dur, 'days' ),'eq', + '2012-07-30T11:53:00', + 'Add 7 days (Days)' ); + + is( $cal->addDuration( $saturday, $one_day_dur, 'days' )->day_of_week, 7, + 'addDuration doesn\'t skip closed Sunday (Days)' ); + + is( $cal->addDuration($day_after_christmas, -1, 'days')->ymd(), '2012-12-25', + 'Negative call to addDuration (Days)' ); + + ## Note that the days_between API says closed days are not considered. + ## This tests are here as an API test. + cmp_ok( $cal->days_between( $test_dt, $later_dt )->in_units('days'), + '==', 40, 'days_between calculates correctly (Days)' ); + + cmp_ok( $cal->days_between( $later_dt, $test_dt )->in_units('days'), + '==', 40, 'Test parameter order not relevant (Days)' ); + + } + + { + $cal = Koha::Calendar->new( branchcode => $cpl ); + is ( $cal->is_holiday($single_holiday), 0, 'Single holiday for MPL, not CPL' ); + is ( $cal->is_holiday($holiday_for_another_branch), 1, 'Holiday defined for CPL should be defined as an holiday' ); + } + + subtest 'days_mode parameter' => sub { + plan tests => 1; + + t::lib::Mocks::mock_preference('useDaysMode', 'Days'); + + $cal = Koha::Calendar->new( branchcode => $cpl, days_mode => 'Calendar' ); + is( $cal->{days_mode}, 'Calendar', q|If set, days_mode is correctly set|); + }; + + $cache->clear_from_cache( $mpl.'_holidays' ); + $cache->clear_from_cache( $cpl.'_holidays' ); +}; + my $library = $builder->build_object({ class => 'Koha::Libraries' }); +my $calendar = Koha::Calendar->new( branchcode => $library->branchcode, days_mode => 'Calendar' ); my $holiday = $builder->build( { source => 'SpecialHoliday', @@ -54,11 +334,9 @@ my $holiday = $builder->build( } ); -my $calendar = Koha::Calendar->new( branchcode => $library->branchcode, days_mode => 'Calendar' ); - subtest 'days_forward' => sub { - plan tests => 4; + my $forwarded_dt = $calendar->days_forward( $today, 2 ); my $expected = $today->clone->add( days => 2 ); is( $forwarded_dt->ymd, $expected->ymd, 'With no holiday on the perioddays_forward should add 2 days' );