Bug 14310 [QA Followup] - Adapt existing code to use new methods
[koha.git] / t / db_dependent / Holds.t
blob29095d0cdf962b37ae1789343686d8a313a8f68a
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 => 60;
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 is( $reserve->{'suspend_until'}, '2012-01-01 00:00:00', "Test ToggleSuspend(), with date" );
150 AutoUnsuspendReserves();
151 $reserve = GetReserve( $reserve_id );
152 ok( !$reserve->{'suspend'}, "Test AutoUnsuspendReserves()" );
154 SuspendAll(
155 borrowernumber => $borrowernumber,
156 biblionumber => $biblionumber,
157 suspend => 1,
158 suspend_until => '2012-01-01',
160 $reserve = GetReserve( $reserve_id );
161 is( $reserve->{'suspend'}, 1, "Test SuspendAll()" );
162 is( $reserve->{'suspend_until'}, '2012-01-01 00:00:00', "Test SuspendAll(), with date" );
164 SuspendAll(
165 borrowernumber => $borrowernumber,
166 biblionumber => $biblionumber,
167 suspend => 0,
169 $reserve = GetReserve( $reserve_id );
170 is( $reserve->{'suspend'}, 0, "Test resuming with SuspendAll()" );
171 is( $reserve->{'suspend_until'}, undef, "Test resuming with SuspendAll(), should have no suspend until date" );
173 # Add a new hold for the borrower whose hold we canceled earlier, this time at the bib level
174 AddReserve(
175 $branch_1,
176 $borrowernumbers[0],
177 $biblionumber,
178 my $bibitems = q{},
179 my $priority,
180 my $resdate,
181 my $expdate,
182 my $notes = q{},
183 $title,
184 my $checkitem,
185 my $found,
187 ( $reserve ) = GetReservesFromBorrowernumber($borrowernumber);
188 my $reserveid = C4::Reserves::GetReserveId(
190 biblionumber => $biblionumber,
191 borrowernumber => $borrowernumber
194 is( $reserveid, $reserve->{reserve_id}, "Test GetReserveId" );
195 ModReserveMinusPriority( $itemnumber, $reserve->{'reserve_id'} );
196 ( $reserve ) = GetReservesFromBorrowernumber($borrowernumber);
197 ok( $reserve->{'itemnumber'} eq $itemnumber, "Test ModReserveMinusPriority()" );
200 my $reserve2 = GetReserveInfo( $reserve->{'reserve_id'} );
201 ok( $reserve->{'reserve_id'} eq $reserve2->{'reserve_id'}, "Test GetReserveInfo()" );
204 $reserves = GetReservesFromBiblionumber({ biblionumber => $biblionumber, all_dates => 1 });
205 $reserve = $reserves->[1];
206 AlterPriority( 'top', $reserve->{'reserve_id'} );
207 $reserve = GetReserve( $reserve->{'reserve_id'} );
208 is( $reserve->{'priority'}, '1', "Test AlterPriority(), move to top" );
210 AlterPriority( 'down', $reserve->{'reserve_id'} );
211 $reserve = GetReserve( $reserve->{'reserve_id'} );
212 is( $reserve->{'priority'}, '2', "Test AlterPriority(), move down" );
214 AlterPriority( 'up', $reserve->{'reserve_id'} );
215 $reserve = GetReserve( $reserve->{'reserve_id'} );
216 is( $reserve->{'priority'}, '1', "Test AlterPriority(), move up" );
218 AlterPriority( 'bottom', $reserve->{'reserve_id'} );
219 $reserve = GetReserve( $reserve->{'reserve_id'} );
220 is( $reserve->{'priority'}, '5', "Test AlterPriority(), move to bottom" );
222 # Regression test for bug 2394
224 # If IndependentBranches is ON and canreservefromotherbranches is OFF,
225 # a patron is not permittedo to request an item whose homebranch (i.e.,
226 # owner of the item) is different from the patron's own library.
227 # However, if canreservefromotherbranches is turned ON, the patron can
228 # create such hold requests.
230 # Note that canreservefromotherbranches has no effect if
231 # IndependentBranches is OFF.
233 my ($foreign_bibnum, $foreign_title, $foreign_bibitemnum) = create_helper_biblio('DUMMY');
234 my ($foreign_item_bibnum, $foreign_item_bibitemnum, $foreign_itemnumber)
235 = AddItem({ homebranch => $branch_2, holdingbranch => $branch_2 } , $foreign_bibnum);
236 $dbh->do('DELETE FROM issuingrules');
237 $dbh->do(
238 q{INSERT INTO issuingrules (categorycode, branchcode, itemtype, reservesallowed)
239 VALUES (?, ?, ?, ?)},
241 '*', '*', '*', 25
243 $dbh->do(
244 q{INSERT INTO issuingrules (categorycode, branchcode, itemtype, reservesallowed)
245 VALUES (?, ?, ?, ?)},
247 '*', '*', 'CANNOT', 0
250 # make sure some basic sysprefs are set
251 t::lib::Mocks::mock_preference('ReservesControlBranch', 'ItemHomeLibrary');
252 t::lib::Mocks::mock_preference('item-level_itypes', 1);
254 # if IndependentBranches is OFF, a $branch_1 patron can reserve an $branch_2 item
255 t::lib::Mocks::mock_preference('IndependentBranches', 0);
257 CanItemBeReserved($borrowernumbers[0], $foreign_itemnumber) eq 'OK',
258 '$branch_1 patron allowed to reserve $branch_2 item with IndependentBranches OFF (bug 2394)'
261 # if IndependentBranches is OFF, a $branch_1 patron cannot reserve an $branch_2 item
262 t::lib::Mocks::mock_preference('IndependentBranches', 1);
263 t::lib::Mocks::mock_preference('canreservefromotherbranches', 0);
265 CanItemBeReserved($borrowernumbers[0], $foreign_itemnumber) eq 'cannotReserveFromOtherBranches',
266 '$branch_1 patron NOT allowed to reserve $branch_2 item with IndependentBranches ON ... (bug 2394)'
269 # ... unless canreservefromotherbranches is ON
270 t::lib::Mocks::mock_preference('canreservefromotherbranches', 1);
272 CanItemBeReserved($borrowernumbers[0], $foreign_itemnumber) eq 'OK',
273 '... unless canreservefromotherbranches is ON (bug 2394)'
276 # Regression test for bug 11336
277 ($bibnum, $title, $bibitemnum) = create_helper_biblio('DUMMY');
278 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => $branch_1, holdingbranch => $branch_1 } , $bibnum);
279 AddReserve(
280 $branch_1,
281 $borrowernumbers[0],
282 $bibnum,
287 my $reserveid1 = C4::Reserves::GetReserveId(
289 biblionumber => $bibnum,
290 borrowernumber => $borrowernumbers[0]
294 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => $branch_1, holdingbranch => $branch_1 } , $bibnum);
295 AddReserve(
296 $branch_1,
297 $borrowernumbers[1],
298 $bibnum,
302 my $reserveid2 = C4::Reserves::GetReserveId(
304 biblionumber => $bibnum,
305 borrowernumber => $borrowernumbers[1]
309 CancelReserve({ reserve_id => $reserveid1 });
311 $reserve2 = GetReserve( $reserveid2 );
312 is( $reserve2->{priority}, 1, "After cancelreserve, the 2nd reserve becomes the first on the waiting list" );
314 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => $branch_1, holdingbranch => $branch_1 } , $bibnum);
315 AddReserve(
316 $branch_1,
317 $borrowernumbers[0],
318 $bibnum,
322 my $reserveid3 = C4::Reserves::GetReserveId(
324 biblionumber => $bibnum,
325 borrowernumber => $borrowernumbers[0]
329 my $reserve3 = GetReserve( $reserveid3 );
330 is( $reserve3->{priority}, 2, "New reserve for patron 0, the reserve has a priority = 2" );
332 ModReserve({ reserve_id => $reserveid2, rank => 'del' });
333 $reserve3 = GetReserve( $reserveid3 );
334 is( $reserve3->{priority}, 1, "After ModReserve, the 3rd reserve becomes the first on the waiting list" );
336 ModItem({ damaged => 1 }, $item_bibnum, $itemnumber);
337 C4::Context->set_preference( 'AllowHoldsOnDamagedItems', 1 );
338 ok( CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'OK', "Patron can reserve damaged item with AllowHoldsOnDamagedItems enabled" );
339 ok( defined( ( CheckReserves($itemnumber) )[1] ), "Hold can be trapped for damaged item with AllowHoldsOnDamagedItems enabled" );
340 C4::Context->set_preference( 'AllowHoldsOnDamagedItems', 0 );
341 ok( CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'damaged', "Patron cannot reserve damaged item with AllowHoldsOnDamagedItems disabled" );
342 ok( !defined( ( CheckReserves($itemnumber) )[1] ), "Hold cannot be trapped for damaged item with AllowHoldsOnDamagedItems disabled" );
344 # Regression test for bug 9532
345 ($bibnum, $title, $bibitemnum) = create_helper_biblio('CANNOT');
346 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => $branch_1, holdingbranch => $branch_1, itype => 'CANNOT' } , $bibnum);
347 AddReserve(
348 $branch_1,
349 $borrowernumbers[0],
350 $bibnum,
355 CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'tooManyReserves',
356 "cannot request item if policy that matches on item-level item type forbids it"
358 ModItem({ itype => 'CAN' }, $item_bibnum, $itemnumber);
360 CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'OK',
361 "can request item if policy that matches on item type allows it"
364 t::lib::Mocks::mock_preference('item-level_itypes', 0);
365 ModItem({ itype => undef }, $item_bibnum, $itemnumber);
367 CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'tooManyReserves',
368 "cannot request item if policy that matches on bib-level item type forbids it (bug 9532)"
372 # Test branch item rules
374 $dbh->do('DELETE FROM issuingrules');
375 $dbh->do(
376 q{INSERT INTO issuingrules (categorycode, branchcode, itemtype, reservesallowed)
377 VALUES (?, ?, ?, ?)},
379 '*', '*', '*', 25
381 $dbh->do('DELETE FROM branch_item_rules');
382 $dbh->do('DELETE FROM default_branch_circ_rules');
383 $dbh->do('DELETE FROM default_branch_item_rules');
384 $dbh->do('DELETE FROM default_circ_rules');
385 $dbh->do(q{
386 INSERT INTO branch_item_rules (branchcode, itemtype, holdallowed, returnbranch)
387 VALUES (?, ?, ?, ?)
388 }, {}, $branch_1, 'CANNOT', 0, 'homebranch');
389 $dbh->do(q{
390 INSERT INTO branch_item_rules (branchcode, itemtype, holdallowed, returnbranch)
391 VALUES (?, ?, ?, ?)
392 }, {}, $branch_1, 'CAN', 1, 'homebranch');
393 ($bibnum, $title, $bibitemnum) = create_helper_biblio('CANNOT');
394 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem(
395 { homebranch => $branch_1, holdingbranch => $branch_1, itype => 'CANNOT' } , $bibnum);
396 is(CanItemBeReserved($borrowernumbers[0], $itemnumber), 'notReservable',
397 "CanItemBeReserved should returns 'notReservable'");
399 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem(
400 { homebranch => $branch_2, holdingbranch => $branch_1, itype => 'CAN' } , $bibnum);
401 is(CanItemBeReserved($borrowernumbers[0], $itemnumber),
402 'cannotReserveFromOtherBranches',
403 "CanItemBeReserved should returns 'cannotReserveFromOtherBranches'");
405 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem(
406 { homebranch => $branch_1, holdingbranch => $branch_1, itype => 'CAN' } , $bibnum);
407 is(CanItemBeReserved($borrowernumbers[0], $itemnumber), 'OK',
408 "CanItemBeReserved should returns 'OK'");
411 # Test CancelExpiredReserves
412 C4::Context->set_preference('ExpireReservesMaxPickUpDelay', 1);
413 C4::Context->set_preference('ReservesMaxPickUpDelay', 1);
415 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime(time);
416 $year += 1900;
417 $mon += 1;
418 $reserves = $dbh->selectall_arrayref('SELECT * FROM reserves', { Slice => {} });
419 $reserve = $reserves->[0];
420 my $calendar = C4::Calendar->new(branchcode => $reserve->{branchcode});
421 $calendar->insert_single_holiday(
422 day => $mday,
423 month => $mon,
424 year => $year,
425 title => 'Test',
426 description => 'Test',
428 $reserve_id = $reserve->{reserve_id};
429 $dbh->do("UPDATE reserves SET waitingdate = DATE_SUB( NOW(), INTERVAL 5 DAY ), found = 'W', priority = 0 WHERE reserve_id = ?", undef, $reserve_id );
430 C4::Context->set_preference('ExpireReservesOnHolidays', 0);
431 CancelExpiredReserves();
432 my $count = $dbh->selectrow_array("SELECT COUNT(*) FROM reserves WHERE reserve_id = ?", undef, $reserve_id );
433 is( $count, 1, "Waiting reserve beyond max pickup delay *not* canceled on holiday" );
434 C4::Context->set_preference('ExpireReservesOnHolidays', 1);
435 CancelExpiredReserves();
436 $count = $dbh->selectrow_array("SELECT COUNT(*) FROM reserves WHERE reserve_id = ?", undef, $reserve_id );
437 is( $count, 0, "Waiting reserve beyond max pickup delay canceled on holiday" );
439 # Test expirationdate
440 $reserve = $reserves->[1];
441 $reserve_id = $reserve->{reserve_id};
442 $dbh->do("UPDATE reserves SET expirationdate = DATE_SUB( NOW(), INTERVAL 1 DAY ) WHERE reserve_id = ?", undef, $reserve_id );
443 CancelExpiredReserves();
444 $count = $dbh->selectrow_array("SELECT COUNT(*) FROM reserves WHERE reserve_id = ?", undef, $reserve_id );
445 is( $count, 0, "Reserve with manual expiration date canceled correctly" );
447 # Bug 12632
448 t::lib::Mocks::mock_preference( 'item-level_itypes', 1 );
449 t::lib::Mocks::mock_preference( 'ReservesControlBranch', 'PatronLibrary' );
451 $dbh->do('DELETE FROM reserves');
452 $dbh->do('DELETE FROM issues');
453 $dbh->do('DELETE FROM items');
454 $dbh->do('DELETE FROM biblio');
456 ( $bibnum, $title, $bibitemnum ) = create_helper_biblio('ONLY1');
457 ( $item_bibnum, $item_bibitemnum, $itemnumber )
458 = AddItem( { homebranch => $branch_1, holdingbranch => $branch_1 }, $bibnum );
460 $dbh->do(
461 q{INSERT INTO issuingrules (categorycode, branchcode, itemtype, reservesallowed)
462 VALUES (?, ?, ?, ?)},
464 '*', '*', 'ONLY1', 1
466 is( CanItemBeReserved( $borrowernumbers[0], $itemnumber ),
467 'OK', 'Patron can reserve item with hold limit of 1, no holds placed' );
469 my $res_id = AddReserve( $branch_1, $borrowernumbers[0], $bibnum, '', 1, );
471 is( CanItemBeReserved( $borrowernumbers[0], $itemnumber ),
472 'tooManyReserves', 'Patron cannot reserve item with hold limit of 1, 1 bib level hold placed' );
475 # Helper method to set up a Biblio.
476 sub create_helper_biblio {
477 my $itemtype = shift;
478 my $bib = MARC::Record->new();
479 my $title = 'Silence in the library';
480 $bib->append_fields(
481 MARC::Field->new('100', ' ', ' ', a => 'Moffat, Steven'),
482 MARC::Field->new('245', ' ', ' ', a => $title),
483 MARC::Field->new('942', ' ', ' ', c => $itemtype),
485 return ($bibnum, $title, $bibitemnum) = AddBiblio($bib, '');