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