Bug 21230: Prevent Reserves.t to fail randomly
[koha.git] / t / db_dependent / Reserves.t
index 1d45893..406e450 100755 (executable)
@@ -17,7 +17,7 @@
 
 use Modern::Perl;
 
-use Test::More tests => 72;
+use Test::More tests => 57;
 use Test::MockModule;
 use Test::Warn;
 
@@ -27,26 +27,23 @@ use t::lib::TestBuilder;
 use MARC::Record;
 use DateTime::Duration;
 
-use C4::Biblio;
 use C4::Circulation;
 use C4::Items;
+use C4::Biblio;
 use C4::Members;
 use C4::Reserves;
+use Koha::Caches;
 use Koha::DateUtils;
 use Koha::Holds;
 use Koha::Libraries;
+use Koha::Notice::Templates;
+use Koha::Patrons;
 use Koha::Patron::Categories;
 
 BEGIN {
     require_ok('C4::Reserves');
 }
 
-# a very minimal mack of userenv for use by the test of DelItemCheck
-my $module = new Test::MockModule('C4::Context');
-$module->mock('userenv', sub {
-    { }
-});
-
 # Start transaction
 my $database = Koha::Database->new();
 my $schema = $database->schema();
@@ -55,8 +52,18 @@ my $dbh = C4::Context->dbh;
 
 my $builder = t::lib::TestBuilder->new;
 
+my $frameworkcode = q//;
+
+
+t::lib::Mocks::mock_preference('ReservesNeedReturns', 1);
+
 # Somewhat arbitrary field chosen for age restriction unit tests. Must be added to db before the framework is cached
-$dbh->do("update marc_subfield_structure set kohafield='biblioitems.agerestriction' where tagfield='521' and tagsubfield='a'");
+$dbh->do("update marc_subfield_structure set kohafield='biblioitems.agerestriction' where tagfield='521' and tagsubfield='a' and frameworkcode=?", undef, $frameworkcode);
+my $cache = Koha::Caches->get_instance;
+$cache->clear_from_cache("MarcStructure-0-$frameworkcode");
+$cache->clear_from_cache("MarcStructure-1-$frameworkcode");
+$cache->clear_from_cache("default_value_for_mod_marc-");
+$cache->clear_from_cache("MarcSubfieldStructure-$frameworkcode");
 
 ## Setup Test
 # Add branches
@@ -70,6 +77,9 @@ my $category_2 = $builder->build({ source => 'Category' })->{ categorycode };
 my $itemtype = $builder->build(
     { source => 'Itemtype', value => { notforloan => undef } } )->{itemtype};
 
+C4::Context->set_userenv(
+    undef, undef, undef, undef, undef, undef, $branch_1
+);
 
 # Create a helper biblio
 my $bib = MARC::Record->new();
@@ -86,8 +96,7 @@ else {
         MARC::Field->new('245', '', '', a => $title),
     );
 }
-my ($bibnum, $bibitemnum);
-($bibnum, $title, $bibitemnum) = AddBiblio($bib, '');
+my ( $bibnum ) = AddBiblio($bib, $frameworkcode);
 
 # Create a helper item instance for testing
 my ( $item_bibnum, $item_bibitemnum, $itemnumber ) = AddItem(
@@ -111,8 +120,8 @@ my %data = (
     branchcode => $branch_1,
 );
 Koha::Patron::Categories->find($category_1)->set({ enrolmentfee => 0})->store;
-my $borrowernumber = AddMember(%data);
-my $borrower = GetMember( borrowernumber => $borrowernumber );
+my $borrowernumber = Koha::Patron->new(\%data)->store->borrowernumber;
+my $borrower = Koha::Patrons->find( $borrowernumber )->unblessed;
 my $biblionumber   = $bibnum;
 my $barcode        = $testbarcode;
 
@@ -163,28 +172,28 @@ t::lib::Mocks::mock_preference( 'ReservesControlBranch', $ReservesControlBranch
 ### Regression test for bug 10272
 ###
 my %requesters = ();
-$requesters{$branch_1} = AddMember(
+$requesters{$branch_1} = Koha::Patron->new({
     branchcode   => $branch_1,
     categorycode => $category_2,
     surname      => "borrower from $branch_1",
-);
+})->store->borrowernumber;
 for my $i ( 2 .. 5 ) {
-    $requesters{"CPL$i"} = AddMember(
+    $requesters{"CPL$i"} = Koha::Patron->new({
         branchcode   => $branch_1,
         categorycode => $category_2,
         surname      => "borrower $i from $branch_1",
-    );
+    })->store->borrowernumber;
 }
-$requesters{$branch_2} = AddMember(
+$requesters{$branch_2} = Koha::Patron->new({
     branchcode   => $branch_2,
     categorycode => $category_2,
     surname      => "borrower from $branch_2",
-);
-$requesters{$branch_3} = AddMember(
+})->store->borrowernumber;
+$requesters{$branch_3} = Koha::Patron->new({
     branchcode   => $branch_3,
     categorycode => $category_2,
     surname      => "borrower from $branch_3",
-);
+})->store->borrowernumber;
 
 # Configure rules so that $branch_1 allows only $branch_1 patrons
 # to request its items, while $branch_2 will allow its items
@@ -228,7 +237,7 @@ $bib2->append_fields(
 );
 
 # create one item belonging to FPL and one belonging to CPL
-my ($bibnum2, $bibitemnum2) = AddBiblio($bib, '');
+my ( $bibnum2 ) = AddBiblio($bib, $frameworkcode);
 my ($itemnum_cpl, $itemnum_fpl);
 ( undef, undef, $itemnum_cpl ) = AddItem(
     {   homebranch    => $branch_1,
@@ -263,14 +272,13 @@ AddReserve($branch_1,  $requesters{$branch_1}, $bibnum2,
 ModReserveAffect($itemnum_cpl, $requesters{$branch_3}, 0);
 
 # Now it should have different priorities.
-my $title_reserves = GetReservesFromBiblionumber({biblionumber => $bibnum2});
-# Sort by reserve number in case the database gives us oddly ordered results
-my @reserves = sort { $a->{reserve_id} <=> $b->{reserve_id} } @$title_reserves;
-is($reserves[0]{priority}, 0, 'Item is correctly waiting');
-is($reserves[1]{priority}, 1, 'Item is correctly priority 1');
-is($reserves[2]{priority}, 2, 'Item is correctly priority 2');
-
-@reserves = Koha::Holds->search({ borrowernumber => $requesters{$branch_3} })->waiting();
+my $biblio = Koha::Biblios->find( $bibnum2 );
+my $holds = $biblio->holds({}, { order_by => 'reserve_id' });;
+is($holds->next->priority, 0, 'Item is correctly waiting');
+is($holds->next->priority, 1, 'Item is correctly priority 1');
+is($holds->next->priority, 2, 'Item is correctly priority 2');
+
+my @reserves = Koha::Holds->search({ borrowernumber => $requesters{$branch_3} })->waiting();
 is( @reserves, 1, 'GetWaiting got only the waiting reserve' );
 is( $reserves[0]->borrowernumber(), $requesters{$branch_3}, 'GetWaiting got the reserve for the correct borrower' );
 
@@ -310,25 +318,10 @@ is( $messages->{ResFound}->{borrowernumber},
     $requesters{$branch_3},
     'for generous library, its items fill first hold request in line (bug 10272)');
 
-my $reserves = GetReservesFromBiblionumber({biblionumber => $biblionumber});
-isa_ok($reserves, 'ARRAY');
-is(scalar @$reserves, 1, "Only one reserves for this biblio");
-my $reserve_id = $reserves->[0]->{reserve_id};
-
-$reserve = GetReserve($reserve_id);
-isa_ok($reserve, 'HASH', "GetReserve return");
-is($reserve->{biblionumber}, $biblionumber);
-
-$reserve = CancelReserve({reserve_id => $reserve_id});
-isa_ok($reserve, 'HASH', "CancelReserve return");
-is($reserve->{biblionumber}, $biblionumber);
-
-$reserve = GetReserve($reserve_id);
-is($reserve, undef, "GetReserve returns undef after deletion");
-
-$reserve = CancelReserve({reserve_id => $reserve_id});
-is($reserve, undef, "CancelReserve return undef if reserve does not exist");
-
+$biblio = Koha::Biblios->find( $biblionumber );
+$holds = $biblio->holds;
+is($holds->count, 1, "Only one reserves for this biblio");
+my $reserve_id = $holds->next->reserve_id;
 
 # Tests for bug 9761 (ConfirmFutureHolds): new CheckReserves lookahead parameter, and corresponding change in AddReturn
 # Note that CheckReserve uses its lookahead parameter and does not check ConfirmFutureHolds pref (it should be passed if needed like AddReturn does)
@@ -397,11 +390,11 @@ is(
     'item that is captured to fill a hold cannot be deleted',
 );
 
-my $letter = ReserveSlip($branch_1, $requesters{$branch_1}, $bibnum);
+my $letter = ReserveSlip( { branchcode => $branch_1, borrowernumber => $requesters{$branch_1}, biblionumber => $bibnum } );
 ok(defined($letter), 'can successfully generate hold slip (bug 10949)');
 
-# Tests for bug 9788: Does GetReservesFromItemnumber return a future wait?
-# 9788a: GetReservesFromItemnumber does not return future next available hold
+# Tests for bug 9788: Does Koha::Item->current_holds return a future wait?
+# 9788a: current_holds does not return future next available hold
 $dbh->do("DELETE FROM reserves WHERE biblionumber=?",undef,($bibnum));
 t::lib::Mocks::mock_preference('ConfirmFutureHolds', 2);
 t::lib::Mocks::mock_preference('AllowHoldDateInFuture', 1);
@@ -411,19 +404,22 @@ $resdate=output_pref($resdate);
 AddReserve($branch_1,  $requesters{$branch_1}, $bibnum,
            $bibitems,  1, $resdate, $expdate, $notes,
            $title,      $checkitem, $found);
-my @results= GetReservesFromItemnumber($itemnumber);
-is(defined $results[3]?1:0, 0, 'GetReservesFromItemnumber does not return a future next available hold');
-# 9788b: GetReservesFromItemnumber does not return future item level hold
+my $item = Koha::Items->find( $itemnumber );
+$holds = $item->current_holds;
+my $dtf = Koha::Database->new->schema->storage->datetime_parser;
+my $future_holds = $holds->search({ reservedate => { '>' => $dtf->format_date( dt_from_string ) } } );
+is( $future_holds->count, 0, 'current_holds does not return a future next available hold');
+# 9788b: current_holds does not return future item level hold
 $dbh->do("DELETE FROM reserves WHERE biblionumber=?",undef,($bibnum));
 AddReserve($branch_1,  $requesters{$branch_1}, $bibnum,
            $bibitems,  1, $resdate, $expdate, $notes,
            $title,      $itemnumber, $found); #item level hold
-@results= GetReservesFromItemnumber($itemnumber);
-is(defined $results[3]?1:0, 0, 'GetReservesFromItemnumber does not return a future item level hold');
-# 9788c: GetReservesFromItemnumber returns future wait (confirmed future hold)
+$future_holds = $holds->search({ reservedate => { '>' => $dtf->format_date( dt_from_string ) } } );
+is( $future_holds->count, 0, 'current_holds does not return a future item level hold' );
+# 9788c: current_holds returns future wait (confirmed future hold)
 ModReserveAffect( $itemnumber,  $requesters{$branch_1} , 0); #confirm hold
-@results= GetReservesFromItemnumber($itemnumber);
-is(defined $results[3]?1:0, 1, 'GetReservesFromItemnumber returns a future wait (confirmed future hold)');
+$future_holds = $holds->search({ reservedate => { '>' => $dtf->format_date( dt_from_string ) } } );
+is( $future_holds->count, 1, 'current_holds returns a future wait (confirmed future hold)' );
 # End of tests for bug 9788
 
 $dbh->do("DELETE FROM reserves WHERE biblionumber=?",undef,($bibnum));
@@ -521,130 +517,32 @@ t::lib::Mocks::mock_preference( 'AgeRestrictionMarker', 'FSK|PEGI|Age|K' );
 #Reserving an not-agerestricted Biblio by a Borrower with no dateofbirth is tested previously.
 
 #Set the ageRestriction for the Biblio
-my $record = GetMarcBiblio( $bibnum );
+my $record = GetMarcBiblio({ biblionumber =>  $bibnum });
 my ( $ageres_tagid, $ageres_subfieldid ) = GetMarcFromKohaField( "biblioitems.agerestriction" );
 $record->append_fields(  MARC::Field->new($ageres_tagid, '', '', $ageres_subfieldid => 'PEGI 16')  );
-C4::Biblio::ModBiblio( $record, $bibnum, '' );
+C4::Biblio::ModBiblio( $record, $bibnum, $frameworkcode );
 
 is( C4::Reserves::CanBookBeReserved($borrowernumber, $biblionumber) , 'OK', "Reserving an ageRestricted Biblio without a borrower dateofbirth succeeds" );
 
-#Set the dateofbirth for the Borrower making him "too young".
-my $now = DateTime->now();
-C4::Members::SetAge( $borrower, '0015-00-00' );
-C4::Members::ModMember( borrowernumber => $borrowernumber, dateofbirth => $borrower->{dateofbirth} );
+#Set the dateofbirth for the Borrower making them "too young".
+$borrower->{dateofbirth} = DateTime->now->add( years => -15 );
+Koha::Patrons->find( $borrowernumber )->set({ dateofbirth => $borrower->{dateofbirth} })->store;
 
 is( C4::Reserves::CanBookBeReserved($borrowernumber, $biblionumber) , 'ageRestricted', "Reserving a 'PEGI 16' Biblio by a 15 year old borrower fails");
 
-#Set the dateofbirth for the Borrower making him "too old".
-C4::Members::SetAge( $borrower, '0030-00-00' );
-C4::Members::ModMember( borrowernumber => $borrowernumber, dateofbirth => $borrower->{dateofbirth} );
+#Set the dateofbirth for the Borrower making them "too old".
+$borrower->{dateofbirth} = DateTime->now->add( years => -30 );
+Koha::Patrons->find( $borrowernumber )->set({ dateofbirth => $borrower->{dateofbirth} })->store;
 
 is( C4::Reserves::CanBookBeReserved($borrowernumber, $biblionumber) , 'OK', "Reserving a 'PEGI 16' Biblio by a 30 year old borrower succeeds");
        ####
 ####### EO Bug 13113 <<<
        ####
 
-my $item = GetItem($itemnumber);
+$item = GetItem($itemnumber);
 
 ok( C4::Reserves::IsAvailableForItemLevelRequest($item, $borrower), "Reserving a book on item level" );
 
-my $itype = C4::Reserves::_get_itype($item);
-my $categorycode = $borrower->{categorycode};
-my $holdingbranch = $item->{holdingbranch};
-my $rule = C4::Circulation::GetIssuingRule($categorycode, $itype, $holdingbranch);
-
-$dbh->do(
-    "UPDATE issuingrules SET onshelfholds = 1 WHERE categorycode = ? AND itemtype= ? and branchcode = ?",
-    undef,
-    $rule->{categorycode}, $rule->{itemtype}, $rule->{branchcode}
-);
-ok( C4::Reserves::OnShelfHoldsAllowed($item, $borrower), "OnShelfHoldsAllowed() allowed" );
-$dbh->do(
-    "UPDATE issuingrules SET onshelfholds = 0 WHERE categorycode = ? AND itemtype= ? and branchcode = ?",
-    undef,
-    $rule->{categorycode}, $rule->{itemtype}, $rule->{branchcode}
-);
-ok( !C4::Reserves::OnShelfHoldsAllowed($item, $borrower), "OnShelfHoldsAllowed() disallowed" );
-
-# Tests for bug 14464
-
-$dbh->do("DELETE FROM reserves WHERE biblionumber=?",undef,($bibnum));
-my ( undef, undef, $bz14464_fines ) = GetMemberIssuesAndFines( $borrowernumber );
-is( !$bz14464_fines || $bz14464_fines==0, 1, 'Bug 14464 - No fines at beginning' );
-
-# First, test cancelling a reserve when there's no charge configured.
-t::lib::Mocks::mock_preference('ExpireReservesMaxPickUpDelayCharge', 0);
-
-my $bz14464_reserve = AddReserve(
-    $branch_1,
-    $borrowernumber,
-    $bibnum,
-    undef,
-    '1',
-    undef,
-    undef,
-    '',
-    $title,
-    $itemnumber,
-    'W'
-);
-
-ok( $bz14464_reserve, 'Bug 14464 - 1st reserve correctly created' );
-
-CancelReserve({ reserve_id => $bz14464_reserve, charge_cancel_fee => 1 });
-
-my $old_reserve = Koha::Database->new()->schema()->resultset('OldReserve')->find( $bz14464_reserve );
-is($old_reserve->get_column('found'), 'W', 'Bug 14968 - Keep found column from reserve');
-
-( undef, undef, $bz14464_fines ) = GetMemberIssuesAndFines( $borrowernumber );
-is( !$bz14464_fines || $bz14464_fines==0, 1, 'Bug 14464 - No fines after cancelling reserve with no charge configured' );
-
-# Then, test cancelling a reserve when there's no charge desired.
-t::lib::Mocks::mock_preference('ExpireReservesMaxPickUpDelayCharge', 42);
-
-$bz14464_reserve = AddReserve(
-    $branch_1,
-    $borrowernumber,
-    $bibnum,
-    undef,
-    '1',
-    undef,
-    undef,
-    '',
-    $title,
-    $itemnumber,
-    'W'
-);
-
-ok( $bz14464_reserve, 'Bug 14464 - 2nd reserve correctly created' );
-
-CancelReserve({ reserve_id => $bz14464_reserve });
-
-( undef, undef, $bz14464_fines ) = GetMemberIssuesAndFines( $borrowernumber );
-is( !$bz14464_fines || $bz14464_fines==0, 1, 'Bug 14464 - No fines after cancelling reserve with no charge desired' );
-
-# Finally, test cancelling a reserve when there's a charge desired and configured.
-$bz14464_reserve = AddReserve(
-    $branch_1,
-    $borrowernumber,
-    $bibnum,
-    undef,
-    '1',
-    undef,
-    undef,
-    '',
-    $title,
-    $itemnumber,
-    'W'
-);
-
-ok( $bz14464_reserve, 'Bug 14464 - 1st reserve correctly created' );
-
-CancelReserve({ reserve_id => $bz14464_reserve, charge_cancel_fee => 1 });
-
-( undef, undef, $bz14464_fines ) = GetMemberIssuesAndFines( $borrowernumber );
-is( int( $bz14464_fines ), 42, 'Bug 14464 - Fine applied after cancelling reserve with charge desired and configured' );
-
 # tests for MoveReserve in relation to ConfirmFutureHolds (BZ 14526)
 #   hold from A pos 1, today, no fut holds: MoveReserve should fill it
 $dbh->do('DELETE FROM reserves', undef, ($bibnum));
@@ -695,8 +593,131 @@ MoveReserve( $itemnumber, $borrowernumber );
 is( $status, 'Reserved', 'MoveReserve did not fill future hold of 3 days');
 $dbh->do('DELETE FROM reserves', undef, ($bibnum));
 
-# we reached the finish
-$schema->storage->txn_rollback();
+$cache->clear_from_cache("MarcStructure-0-$frameworkcode");
+$cache->clear_from_cache("MarcStructure-1-$frameworkcode");
+$cache->clear_from_cache("default_value_for_mod_marc-");
+$cache->clear_from_cache("MarcSubfieldStructure-$frameworkcode");
+
+subtest '_koha_notify_reserve() tests' => sub {
+
+    plan tests => 2;
+
+    my $wants_hold_and_email = {
+        wants_digest => '0',
+        transports => {
+            sms => 'HOLD',
+            email => 'HOLD',
+            },
+        letter_code => 'HOLD'
+    };
+
+    my $mp = Test::MockModule->new( 'C4::Members::Messaging' );
+
+    $mp->mock("GetMessagingPreferences",$wants_hold_and_email);
+
+    $dbh->do('DELETE FROM letter');
+
+    my $email_hold_notice = $builder->build({
+            source => 'Letter',
+            value => {
+                message_transport_type => 'email',
+                branchcode => '',
+                code => 'HOLD',
+                module => 'reserves',
+                lang => 'default',
+            }
+        });
+
+    my $sms_hold_notice = $builder->build({
+            source => 'Letter',
+            value => {
+                message_transport_type => 'sms',
+                branchcode => '',
+                code => 'HOLD',
+                module => 'reserves',
+                lang=>'default',
+            }
+        });
+
+    my $hold_borrower = $builder->build({
+            source => 'Borrower',
+            value => {
+                smsalertnumber=>'5555555555',
+                email=>'a@b.com',
+            }
+        })->{borrowernumber};
+
+    C4::Reserves::AddReserve(
+        $item->{homebranch}, $hold_borrower,
+        $item->{biblionumber} );
+
+    ModReserveAffect($item->{itemnumber}, $hold_borrower, 0);
+    my $sms_message_address = $schema->resultset('MessageQueue')->search({
+            letter_code     => 'HOLD',
+            message_transport_type => 'sms',
+            borrowernumber => $hold_borrower,
+        })->next()->to_address();
+    is($sms_message_address, undef ,"We should not populate the sms message with the sms number, sending will do so");
+
+    my $email_message_address = $schema->resultset('MessageQueue')->search({
+            letter_code     => 'HOLD',
+            message_transport_type => 'email',
+            borrowernumber => $hold_borrower,
+        })->next()->to_address();
+    is($email_message_address, undef ,"We should not populate the hold message with the email address, sending will do so");
+
+};
+
+subtest 'ReservesNeedReturns' => sub {
+    plan tests => 4;
+
+    my $biblioitem = $builder->build_object( { class => 'Koha::Biblioitems' } );
+    my $library    = $builder->build_object( { class => 'Koha::Libraries' } );
+    my $itemtype   = $builder->build_object( { class => 'Koha::ItemTypes', value => { rentalcharge => 0 } } );
+    my $item_info  = {
+        biblionumber     => $biblioitem->biblionumber,
+        biblioitemnumber => $biblioitem->biblioitemnumber,
+        homebranch       => $library->branchcode,
+        holdingbranch    => $library->branchcode,
+        itype            => $itemtype->itemtype,
+    };
+    my $item = $builder->build_object( { class => 'Koha::Items', value => $item_info } );
+    my $patron   = $builder->build_object(
+        {
+            class => 'Koha::Patrons',
+            value => { branchcode => $library->branchcode, }
+        }
+    );
+
+    my $priority = 1;
+    my ( $hold_id, $hold );
+
+    t::lib::Mocks::mock_preference('ReservesNeedReturns', 0); # '0' means 'Automatically mark a hold as found and waiting'
+    $hold_id = C4::Reserves::AddReserve(
+        $library->branchcode, $patron->borrowernumber,
+        $item->biblionumber,  '',
+        $priority,            undef,
+        undef,                '',
+        "title for fee",      $item->itemnumber,
+    );
+    $hold = Koha::Holds->find($hold_id);
+    is( $hold->priority, 0, 'If ReservesNeedReturns is 0, priority must have been set to 0' );
+    is( $hold->found, 'W', 'If ReservesNeedReturns is 0, found must have been set waiting' );
+
+    $hold->delete; # cleanup
+
+    t::lib::Mocks::mock_preference('ReservesNeedReturns', 1); # '0' means "Don't automatically mark a hold as found and waiting"
+    $hold_id = C4::Reserves::AddReserve(
+        $library->branchcode, $patron->borrowernumber,
+        $item->biblionumber,  '',
+        $priority,            undef,
+        undef,                '',
+        "title for fee",      $item->itemnumber,
+    );
+    $hold = Koha::Holds->find($hold_id);
+    is( $hold->priority, $priority, 'If ReservesNeedReturns is 1, priority must not have been set to changed' );
+    is( $hold->found, undef, 'If ReservesNeedReturns is 1, found must not have been set waiting' );
+};
 
 sub count_hold_print_messages {
     my $message_count = $dbh->selectall_arrayref(q{
@@ -707,3 +728,6 @@ sub count_hold_print_messages {
     });
     return $message_count->[0]->[0];
 }
+
+# we reached the finish
+$schema->storage->txn_rollback();