Bug 15244: t/db_dependent/Reserves.t depends on external data/configuration
[koha.git] / t / db_dependent / Holds.t
blob8767223b06f0c71e740cba8a083f0a1fd462a836
1 #!/usr/bin/perl
3 use Modern::Perl;
5 use t::lib::Mocks;
6 use t::lib::TestBuilder;
8 use C4::Context;
9 use C4::Branch;
11 use Test::More tests => 56;
12 use MARC::Record;
13 use C4::Biblio;
14 use C4::Items;
15 use C4::Members;
16 use C4::Calendar;
17 use Koha::Database;
18 use Koha::DateUtils qw( dt_from_string output_pref );
19 use Koha::Holds;
21 BEGIN {
22 use FindBin;
23 use lib $FindBin::Bin;
24 use_ok('C4::Reserves');
27 my $schema = Koha::Database->new->schema;
28 $schema->storage->txn_begin;
30 my $builder = t::lib::TestBuilder->new();
31 my $dbh = C4::Context->dbh;
33 # Create two random branches
34 my $branch_1 = $builder->build({ source => 'Branch' })->{ branchcode };
35 my $branch_2 = $builder->build({ source => 'Branch' })->{ branchcode };
37 my $borrowers_count = 5;
39 $dbh->do('DELETE FROM itemtypes');
40 $dbh->do('DELETE FROM reserves');
41 my $insert_sth = $dbh->prepare('INSERT INTO itemtypes (itemtype) VALUES (?)');
42 $insert_sth->execute('CAN');
43 $insert_sth->execute('CANNOT');
44 $insert_sth->execute('DUMMY');
45 $insert_sth->execute('ONLY1');
47 # Setup Test------------------------
48 # Create a biblio instance for testing
49 my ($bibnum, $title, $bibitemnum) = create_helper_biblio('DUMMY');
51 # Create item instance for testing.
52 my ($item_bibnum, $item_bibitemnum, $itemnumber)
53 = AddItem({ homebranch => $branch_1, holdingbranch => $branch_1 } , $bibnum);
55 # Create some borrowers
56 my @borrowernumbers;
57 foreach (1..$borrowers_count) {
58 my $borrowernumber = AddMember(
59 firstname => 'my firstname',
60 surname => 'my surname ' . $_,
61 categorycode => 'S',
62 branchcode => $branch_1,
64 push @borrowernumbers, $borrowernumber;
67 my $biblionumber = $bibnum;
69 # Create five item level holds
70 foreach my $borrowernumber ( @borrowernumbers ) {
71 AddReserve(
72 $branch_1,
73 $borrowernumber,
74 $biblionumber,
75 my $bibitems = q{},
76 my $priority = 1,
77 my $resdate,
78 my $expdate,
79 my $notes = q{},
80 $title,
81 my $checkitem = $itemnumber,
82 my $found,
86 my $reserves = GetReservesFromBiblionumber({ biblionumber => $biblionumber });
87 is( scalar(@$reserves), $borrowers_count, "Test GetReserves()" );
89 is( $reserves->[0]->{priority}, 1, "Reserve 1 has a priority of 1" );
90 is( $reserves->[1]->{priority}, 2, "Reserve 2 has a priority of 2" );
91 is( $reserves->[2]->{priority}, 3, "Reserve 3 has a priority of 3" );
92 is( $reserves->[3]->{priority}, 4, "Reserve 4 has a priority of 4" );
93 is( $reserves->[4]->{priority}, 5, "Reserve 5 has a priority of 5" );
95 my ( $reservedate, $borrowernumber, $branch_1code, $reserve_id ) = GetReservesFromItemnumber($itemnumber);
96 is( $reservedate, output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 }), "GetReservesFromItemnumber should return a valid reserve date");
97 is( $borrowernumber, $borrowernumbers[0], "GetReservesFromItemnumber should return a valid borrowernumber");
98 is( $branch_1code, $branch_1, "GetReservesFromItemnumber should return a valid branchcode");
99 ok($reserve_id, "Test GetReservesFromItemnumber()");
101 my $hold = Koha::Holds->find( $reserve_id );
102 ok( $hold, "Koha::Holds found the hold" );
103 my $hold_biblio = $hold->biblio();
104 ok( $hold_biblio, "Got biblio using biblio() method" );
105 ok( $hold_biblio == $hold->biblio(), "biblio method returns stashed biblio" );
106 my $hold_item = $hold->item();
107 ok( $hold_item, "Got item using item() method" );
108 ok( $hold_item == $hold->item(), "item method returns stashed item" );
109 my $hold_branch = $hold->branch();
110 ok( $hold_branch, "Got branch using branch() method" );
111 ok( $hold_branch == $hold->branch(), "branch method returns stashed branch" );
112 my $hold_found = $hold->found();
113 $hold->set({ found => 'W'})->store();
114 is( Koha::Holds->waiting()->count(), 1, "Koha::Holds->waiting returns waiting holds" );
116 my ( $reserve ) = GetReservesFromBorrowernumber($borrowernumbers[0]);
117 ok( $reserve->{'borrowernumber'} eq $borrowernumbers[0], "Test GetReservesFromBorrowernumber()");
120 ok( GetReserveCount( $borrowernumbers[0] ), "Test GetReserveCount()" );
123 CancelReserve({ 'reserve_id' => $reserve_id });
124 $reserves = GetReservesFromBiblionumber({ biblionumber => $biblionumber });
125 is( scalar(@$reserves), $borrowers_count - 1, "Test CancelReserve()" );
128 ( $reservedate, $borrowernumber, $branch_1code, $reserve_id ) = GetReservesFromItemnumber($itemnumber);
129 ModReserve({
130 reserve_id => $reserve_id,
131 rank => '4',
132 branchcode => $branch_1,
133 itemnumber => $itemnumber,
134 suspend_until => output_pref( { dt => dt_from_string( "2013-01-01", "iso" ), dateonly => 1 } ),
137 $reserve = GetReserve( $reserve_id );
138 ok( $reserve->{'priority'} eq '4', "Test GetReserve(), priority changed correctly" );
139 ok( $reserve->{'suspend'}, "Test GetReserve(), suspend hold" );
140 is( $reserve->{'suspend_until'}, '2013-01-01 00:00:00', "Test GetReserve(), suspend until date" );
142 ToggleSuspend( $reserve_id );
143 $reserve = GetReserve( $reserve_id );
144 ok( !$reserve->{'suspend'}, "Test ToggleSuspend(), no date" );
146 ToggleSuspend( $reserve_id, '2012-01-01' );
147 $reserve = GetReserve( $reserve_id );
148 ok( $reserve->{'suspend_until'} eq '2012-01-01 00:00:00', "Test ToggleSuspend(), with date" );
150 AutoUnsuspendReserves();
151 $reserve = GetReserve( $reserve_id );
152 ok( !$reserve->{'suspend'}, "Test AutoUnsuspendReserves()" );
154 # Add a new hold for the borrower whose hold we canceled earlier, this time at the bib level
155 AddReserve(
156 $branch_1,
157 $borrowernumbers[0],
158 $biblionumber,
159 my $bibitems = q{},
160 my $priority,
161 my $resdate,
162 my $expdate,
163 my $notes = q{},
164 $title,
165 my $checkitem,
166 my $found,
168 ( $reserve ) = GetReservesFromBorrowernumber($borrowernumber);
169 my $reserveid = C4::Reserves::GetReserveId(
171 biblionumber => $biblionumber,
172 borrowernumber => $borrowernumber
175 is( $reserveid, $reserve->{reserve_id}, "Test GetReserveId" );
176 ModReserveMinusPriority( $itemnumber, $reserve->{'reserve_id'} );
177 ( $reserve ) = GetReservesFromBorrowernumber($borrowernumber);
178 ok( $reserve->{'itemnumber'} eq $itemnumber, "Test ModReserveMinusPriority()" );
181 my $reserve2 = GetReserveInfo( $reserve->{'reserve_id'} );
182 ok( $reserve->{'reserve_id'} eq $reserve2->{'reserve_id'}, "Test GetReserveInfo()" );
185 $reserves = GetReservesFromBiblionumber({ biblionumber => $biblionumber, all_dates => 1 });
186 $reserve = $reserves->[1];
187 AlterPriority( 'top', $reserve->{'reserve_id'} );
188 $reserve = GetReserve( $reserve->{'reserve_id'} );
189 is( $reserve->{'priority'}, '1', "Test AlterPriority(), move to top" );
191 AlterPriority( 'down', $reserve->{'reserve_id'} );
192 $reserve = GetReserve( $reserve->{'reserve_id'} );
193 is( $reserve->{'priority'}, '2', "Test AlterPriority(), move down" );
195 AlterPriority( 'up', $reserve->{'reserve_id'} );
196 $reserve = GetReserve( $reserve->{'reserve_id'} );
197 is( $reserve->{'priority'}, '1', "Test AlterPriority(), move up" );
199 AlterPriority( 'bottom', $reserve->{'reserve_id'} );
200 $reserve = GetReserve( $reserve->{'reserve_id'} );
201 is( $reserve->{'priority'}, '5', "Test AlterPriority(), move to bottom" );
203 # Regression test for bug 2394
205 # If IndependentBranches is ON and canreservefromotherbranches is OFF,
206 # a patron is not permittedo to request an item whose homebranch (i.e.,
207 # owner of the item) is different from the patron's own library.
208 # However, if canreservefromotherbranches is turned ON, the patron can
209 # create such hold requests.
211 # Note that canreservefromotherbranches has no effect if
212 # IndependentBranches is OFF.
214 my ($foreign_bibnum, $foreign_title, $foreign_bibitemnum) = create_helper_biblio('DUMMY');
215 my ($foreign_item_bibnum, $foreign_item_bibitemnum, $foreign_itemnumber)
216 = AddItem({ homebranch => $branch_2, holdingbranch => $branch_2 } , $foreign_bibnum);
217 $dbh->do('DELETE FROM issuingrules');
218 $dbh->do(
219 q{INSERT INTO issuingrules (categorycode, branchcode, itemtype, reservesallowed)
220 VALUES (?, ?, ?, ?)},
222 '*', '*', '*', 25
224 $dbh->do(
225 q{INSERT INTO issuingrules (categorycode, branchcode, itemtype, reservesallowed)
226 VALUES (?, ?, ?, ?)},
228 '*', '*', 'CANNOT', 0
231 # make sure some basic sysprefs are set
232 t::lib::Mocks::mock_preference('ReservesControlBranch', 'ItemHomeLibrary');
233 t::lib::Mocks::mock_preference('item-level_itypes', 1);
235 # if IndependentBranches is OFF, a $branch_1 patron can reserve an $branch_2 item
236 t::lib::Mocks::mock_preference('IndependentBranches', 0);
238 CanItemBeReserved($borrowernumbers[0], $foreign_itemnumber) eq 'OK',
239 '$branch_1 patron allowed to reserve $branch_2 item with IndependentBranches OFF (bug 2394)'
242 # if IndependentBranches is OFF, a $branch_1 patron cannot reserve an $branch_2 item
243 t::lib::Mocks::mock_preference('IndependentBranches', 1);
244 t::lib::Mocks::mock_preference('canreservefromotherbranches', 0);
246 CanItemBeReserved($borrowernumbers[0], $foreign_itemnumber) eq 'cannotReserveFromOtherBranches',
247 '$branch_1 patron NOT allowed to reserve $branch_2 item with IndependentBranches ON ... (bug 2394)'
250 # ... unless canreservefromotherbranches is ON
251 t::lib::Mocks::mock_preference('canreservefromotherbranches', 1);
253 CanItemBeReserved($borrowernumbers[0], $foreign_itemnumber) eq 'OK',
254 '... unless canreservefromotherbranches is ON (bug 2394)'
257 # Regression test for bug 11336
258 ($bibnum, $title, $bibitemnum) = create_helper_biblio('DUMMY');
259 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => $branch_1, holdingbranch => $branch_1 } , $bibnum);
260 AddReserve(
261 $branch_1,
262 $borrowernumbers[0],
263 $bibnum,
268 my $reserveid1 = C4::Reserves::GetReserveId(
270 biblionumber => $bibnum,
271 borrowernumber => $borrowernumbers[0]
275 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => $branch_1, holdingbranch => $branch_1 } , $bibnum);
276 AddReserve(
277 $branch_1,
278 $borrowernumbers[1],
279 $bibnum,
283 my $reserveid2 = C4::Reserves::GetReserveId(
285 biblionumber => $bibnum,
286 borrowernumber => $borrowernumbers[1]
290 CancelReserve({ reserve_id => $reserveid1 });
292 $reserve2 = GetReserve( $reserveid2 );
293 is( $reserve2->{priority}, 1, "After cancelreserve, the 2nd reserve becomes the first on the waiting list" );
295 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => $branch_1, holdingbranch => $branch_1 } , $bibnum);
296 AddReserve(
297 $branch_1,
298 $borrowernumbers[0],
299 $bibnum,
303 my $reserveid3 = C4::Reserves::GetReserveId(
305 biblionumber => $bibnum,
306 borrowernumber => $borrowernumbers[0]
310 my $reserve3 = GetReserve( $reserveid3 );
311 is( $reserve3->{priority}, 2, "New reserve for patron 0, the reserve has a priority = 2" );
313 ModReserve({ reserve_id => $reserveid2, rank => 'del' });
314 $reserve3 = GetReserve( $reserveid3 );
315 is( $reserve3->{priority}, 1, "After ModReserve, the 3rd reserve becomes the first on the waiting list" );
317 ModItem({ damaged => 1 }, $item_bibnum, $itemnumber);
318 C4::Context->set_preference( 'AllowHoldsOnDamagedItems', 1 );
319 ok( CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'OK', "Patron can reserve damaged item with AllowHoldsOnDamagedItems enabled" );
320 ok( defined( ( CheckReserves($itemnumber) )[1] ), "Hold can be trapped for damaged item with AllowHoldsOnDamagedItems enabled" );
321 C4::Context->set_preference( 'AllowHoldsOnDamagedItems', 0 );
322 ok( CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'damaged', "Patron cannot reserve damaged item with AllowHoldsOnDamagedItems disabled" );
323 ok( !defined( ( CheckReserves($itemnumber) )[1] ), "Hold cannot be trapped for damaged item with AllowHoldsOnDamagedItems disabled" );
325 # Regression test for bug 9532
326 ($bibnum, $title, $bibitemnum) = create_helper_biblio('CANNOT');
327 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => $branch_1, holdingbranch => $branch_1, itype => 'CANNOT' } , $bibnum);
328 AddReserve(
329 $branch_1,
330 $borrowernumbers[0],
331 $bibnum,
336 CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'tooManyReserves',
337 "cannot request item if policy that matches on item-level item type forbids it"
339 ModItem({ itype => 'CAN' }, $item_bibnum, $itemnumber);
341 CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'OK',
342 "can request item if policy that matches on item type allows it"
345 t::lib::Mocks::mock_preference('item-level_itypes', 0);
346 ModItem({ itype => undef }, $item_bibnum, $itemnumber);
348 CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'tooManyReserves',
349 "cannot request item if policy that matches on bib-level item type forbids it (bug 9532)"
353 # Test branch item rules
355 $dbh->do('DELETE FROM issuingrules');
356 $dbh->do(
357 q{INSERT INTO issuingrules (categorycode, branchcode, itemtype, reservesallowed)
358 VALUES (?, ?, ?, ?)},
360 '*', '*', '*', 25
362 $dbh->do('DELETE FROM branch_item_rules');
363 $dbh->do('DELETE FROM default_branch_circ_rules');
364 $dbh->do('DELETE FROM default_branch_item_rules');
365 $dbh->do('DELETE FROM default_circ_rules');
366 $dbh->do(q{
367 INSERT INTO branch_item_rules (branchcode, itemtype, holdallowed, returnbranch)
368 VALUES (?, ?, ?, ?)
369 }, {}, $branch_1, 'CANNOT', 0, 'homebranch');
370 $dbh->do(q{
371 INSERT INTO branch_item_rules (branchcode, itemtype, holdallowed, returnbranch)
372 VALUES (?, ?, ?, ?)
373 }, {}, $branch_1, 'CAN', 1, 'homebranch');
374 ($bibnum, $title, $bibitemnum) = create_helper_biblio('CANNOT');
375 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem(
376 { homebranch => $branch_1, holdingbranch => $branch_1, itype => 'CANNOT' } , $bibnum);
377 is(CanItemBeReserved($borrowernumbers[0], $itemnumber), 'notReservable',
378 "CanItemBeReserved should returns 'notReservable'");
380 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem(
381 { homebranch => $branch_2, holdingbranch => $branch_1, itype => 'CAN' } , $bibnum);
382 is(CanItemBeReserved($borrowernumbers[0], $itemnumber),
383 'cannotReserveFromOtherBranches',
384 "CanItemBeReserved should returns 'cannotReserveFromOtherBranches'");
386 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem(
387 { homebranch => $branch_1, holdingbranch => $branch_1, itype => 'CAN' } , $bibnum);
388 is(CanItemBeReserved($borrowernumbers[0], $itemnumber), 'OK',
389 "CanItemBeReserved should returns 'OK'");
392 # Test CancelExpiredReserves
393 C4::Context->set_preference('ExpireReservesMaxPickUpDelay', 1);
394 C4::Context->set_preference('ReservesMaxPickUpDelay', 1);
396 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime(time);
397 $year += 1900;
398 $mon += 1;
399 $reserves = $dbh->selectall_arrayref('SELECT * FROM reserves', { Slice => {} });
400 $reserve = $reserves->[0];
401 my $calendar = C4::Calendar->new(branchcode => $reserve->{branchcode});
402 $calendar->insert_single_holiday(
403 day => $mday,
404 month => $mon,
405 year => $year,
406 title => 'Test',
407 description => 'Test',
409 $reserve_id = $reserve->{reserve_id};
410 $dbh->do("UPDATE reserves SET waitingdate = DATE_SUB( NOW(), INTERVAL 5 DAY ), found = 'W', priority = 0 WHERE reserve_id = ?", undef, $reserve_id );
411 C4::Context->set_preference('ExpireReservesOnHolidays', 0);
412 CancelExpiredReserves();
413 my $count = $dbh->selectrow_array("SELECT COUNT(*) FROM reserves WHERE reserve_id = ?", undef, $reserve_id );
414 is( $count, 1, "Waiting reserve beyond max pickup delay *not* canceled on holiday" );
415 C4::Context->set_preference('ExpireReservesOnHolidays', 1);
416 CancelExpiredReserves();
417 $count = $dbh->selectrow_array("SELECT COUNT(*) FROM reserves WHERE reserve_id = ?", undef, $reserve_id );
418 is( $count, 0, "Waiting reserve beyond max pickup delay canceled on holiday" );
420 # Test expirationdate
421 $reserve = $reserves->[1];
422 $reserve_id = $reserve->{reserve_id};
423 $dbh->do("UPDATE reserves SET expirationdate = DATE_SUB( NOW(), INTERVAL 1 DAY ) WHERE reserve_id = ?", undef, $reserve_id );
424 CancelExpiredReserves();
425 $count = $dbh->selectrow_array("SELECT COUNT(*) FROM reserves WHERE reserve_id = ?", undef, $reserve_id );
426 is( $count, 0, "Reserve with manual expiration date canceled correctly" );
428 # Bug 12632
429 t::lib::Mocks::mock_preference( 'item-level_itypes', 1 );
430 t::lib::Mocks::mock_preference( 'ReservesControlBranch', 'PatronLibrary' );
432 $dbh->do('DELETE FROM reserves');
433 $dbh->do('DELETE FROM issues');
434 $dbh->do('DELETE FROM items');
435 $dbh->do('DELETE FROM biblio');
437 ( $bibnum, $title, $bibitemnum ) = create_helper_biblio('ONLY1');
438 ( $item_bibnum, $item_bibitemnum, $itemnumber )
439 = AddItem( { homebranch => $branch_1, holdingbranch => $branch_1 }, $bibnum );
441 $dbh->do(
442 q{INSERT INTO issuingrules (categorycode, branchcode, itemtype, reservesallowed)
443 VALUES (?, ?, ?, ?)},
445 '*', '*', 'ONLY1', 1
447 is( CanItemBeReserved( $borrowernumbers[0], $itemnumber ),
448 'OK', 'Patron can reserve item with hold limit of 1, no holds placed' );
450 my $res_id = AddReserve( $branch_1, $borrowernumbers[0], $bibnum, '', 1, );
452 is( CanItemBeReserved( $borrowernumbers[0], $itemnumber ),
453 'tooManyReserves', 'Patron cannot reserve item with hold limit of 1, 1 bib level hold placed' );
456 # Helper method to set up a Biblio.
457 sub create_helper_biblio {
458 my $itemtype = shift;
459 my $bib = MARC::Record->new();
460 my $title = 'Silence in the library';
461 $bib->append_fields(
462 MARC::Field->new('100', ' ', ' ', a => 'Moffat, Steven'),
463 MARC::Field->new('245', ' ', ' ', a => $title),
464 MARC::Field->new('942', ' ', ' ', c => $itemtype),
466 return ($bibnum, $title, $bibitemnum) = AddBiblio($bib, '');