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