Bug 13851: (QA followup) 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 => 49;
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
41 # Setup Test------------------------
42 # Create a biblio instance for testing
43 my ($bibnum, $title, $bibitemnum) = create_helper_biblio('DUMMY');
44
45 # Create item instance for testing.
46 my ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => 'CPL', holdingbranch => 'CPL' } , $bibnum);
47
48 # Create some borrowers
49 my @borrowernumbers;
50 foreach (1..$borrowers_count) {
51     my $borrowernumber = AddMember(
52         firstname =>  'my firstname',
53         surname => 'my surname ' . $_,
54         categorycode => 'S',
55         branchcode => 'CPL',
56     );
57     push @borrowernumbers, $borrowernumber;
58 }
59
60 my $biblionumber   = $bibnum;
61
62 my @branches = GetBranchesLoop();
63 my $branch = $branches[0][0]{value};
64
65 # Create five item level holds
66 foreach my $borrowernumber ( @borrowernumbers ) {
67     AddReserve(
68         $branch,
69         $borrowernumber,
70         $biblionumber,
71         my $constraint = 'a',
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 $constraint = 'a',
152     my $bibitems = q{},
153     my $priority,
154     my $resdate,
155     my $expdate,
156     my $notes = q{},
157     $title,
158     my $checkitem,
159     my $found,
160 );
161 ( $reserve ) = GetReservesFromBorrowernumber($borrowernumber);
162 my $reserveid = C4::Reserves::GetReserveId(
163     {
164         biblionumber => $biblionumber,
165         borrowernumber => $borrowernumber
166     }
167 );
168 is( $reserveid, $reserve->{reserve_id}, "Test GetReserveId" );
169 ModReserveMinusPriority( $itemnumber, $reserve->{'reserve_id'} );
170 ( $reserve ) = GetReservesFromBorrowernumber($borrowernumber);
171 ok( $reserve->{'itemnumber'} eq $itemnumber, "Test ModReserveMinusPriority()" );
172
173
174 my $reserve2 = GetReserveInfo( $reserve->{'reserve_id'} );
175 ok( $reserve->{'reserve_id'} eq $reserve2->{'reserve_id'}, "Test GetReserveInfo()" );
176
177
178 $reserves = GetReservesFromBiblionumber({ biblionumber => $biblionumber, all_dates => 1 });
179 $reserve = $reserves->[1];
180 AlterPriority( 'top', $reserve->{'reserve_id'} );
181 $reserve = GetReserve( $reserve->{'reserve_id'} );
182 ok( $reserve->{'priority'} eq '1', "Test AlterPriority(), move to top" );
183
184 AlterPriority( 'down', $reserve->{'reserve_id'} );
185 $reserve = GetReserve( $reserve->{'reserve_id'} );
186 ok( $reserve->{'priority'} eq '2', "Test AlterPriority(), move down" );
187
188 AlterPriority( 'up', $reserve->{'reserve_id'} );
189 $reserve = GetReserve( $reserve->{'reserve_id'} );
190 ok( $reserve->{'priority'} eq '1', "Test AlterPriority(), move up" );
191
192 AlterPriority( 'bottom', $reserve->{'reserve_id'} );
193 $reserve = GetReserve( $reserve->{'reserve_id'} );
194 ok( $reserve->{'priority'} eq '5', "Test AlterPriority(), move to bottom" );
195
196 # Regression test for bug 2394
197 #
198 # If IndependentBranches is ON and canreservefromotherbranches is OFF,
199 # a patron is not permittedo to request an item whose homebranch (i.e.,
200 # owner of the item) is different from the patron's own library.
201 # However, if canreservefromotherbranches is turned ON, the patron can
202 # create such hold requests.
203 #
204 # Note that canreservefromotherbranches has no effect if
205 # IndependentBranches is OFF.
206
207 my ($foreign_bibnum, $foreign_title, $foreign_bibitemnum) = create_helper_biblio('DUMMY');
208 my ($foreign_item_bibnum, $foreign_item_bibitemnum, $foreign_itemnumber)
209   = AddItem({ homebranch => 'MPL', holdingbranch => 'MPL' } , $foreign_bibnum);
210 $dbh->do('DELETE FROM issuingrules');
211 $dbh->do(
212     q{INSERT INTO issuingrules (categorycode, branchcode, itemtype, reservesallowed)
213       VALUES (?, ?, ?, ?)}, 
214     {},
215     '*', '*', '*', 25
216 );
217 $dbh->do(
218     q{INSERT INTO issuingrules (categorycode, branchcode, itemtype, reservesallowed)
219       VALUES (?, ?, ?, ?)}, 
220     {},
221     '*', '*', 'CANNOT', 0 
222 );
223
224 # make sure some basic sysprefs are set
225 t::lib::Mocks::mock_preference('ReservesControlBranch', 'homebranch');
226 t::lib::Mocks::mock_preference('item-level_itypes', 1);
227
228 # if IndependentBranches is OFF, a CPL patron can reserve an MPL item
229 t::lib::Mocks::mock_preference('IndependentBranches', 0);
230 ok(
231     CanItemBeReserved($borrowernumbers[0], $foreign_itemnumber) eq 'OK',
232     'CPL patron allowed to reserve MPL item with IndependentBranches OFF (bug 2394)'
233 );
234
235 # if IndependentBranches is OFF, a CPL patron cannot reserve an MPL item
236 t::lib::Mocks::mock_preference('IndependentBranches', 1);
237 t::lib::Mocks::mock_preference('canreservefromotherbranches', 0);
238 ok(
239     CanItemBeReserved($borrowernumbers[0], $foreign_itemnumber) eq 'cannotReserveFromOtherBranches',
240     'CPL patron NOT allowed to reserve MPL item with IndependentBranches ON ... (bug 2394)'
241 );
242
243 # ... unless canreservefromotherbranches is ON
244 t::lib::Mocks::mock_preference('canreservefromotherbranches', 1);
245 ok(
246     CanItemBeReserved($borrowernumbers[0], $foreign_itemnumber) eq 'OK',
247     '... unless canreservefromotherbranches is ON (bug 2394)'
248 );
249
250 # Regression test for bug 11336
251 ($bibnum, $title, $bibitemnum) = create_helper_biblio('DUMMY');
252 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => 'CPL', holdingbranch => 'CPL' } , $bibnum);
253 AddReserve(
254     $branch,
255     $borrowernumbers[0],
256     $bibnum,
257     'a',
258     '',
259     1,
260 );
261
262 my $reserveid1 = C4::Reserves::GetReserveId(
263     {
264         biblionumber => $bibnum,
265         borrowernumber => $borrowernumbers[0]
266     }
267 );
268
269 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => 'CPL', holdingbranch => 'CPL' } , $bibnum);
270 AddReserve(
271     $branch,
272     $borrowernumbers[1],
273     $bibnum,
274     'a',
275     '',
276     2,
277 );
278 my $reserveid2 = C4::Reserves::GetReserveId(
279     {
280         biblionumber => $bibnum,
281         borrowernumber => $borrowernumbers[1]
282     }
283 );
284
285 CancelReserve({ reserve_id => $reserveid1 });
286
287 $reserve2 = GetReserve( $reserveid2 );
288 is( $reserve2->{priority}, 1, "After cancelreserve, the 2nd reserve becomes the first on the waiting list" );
289
290 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => 'CPL', holdingbranch => 'CPL' } , $bibnum);
291 AddReserve(
292     $branch,
293     $borrowernumbers[0],
294     $bibnum,
295     'a',
296     '',
297     2,
298 );
299 my $reserveid3 = C4::Reserves::GetReserveId(
300     {
301         biblionumber => $bibnum,
302         borrowernumber => $borrowernumbers[0]
303     }
304 );
305
306 my $reserve3 = GetReserve( $reserveid3 );
307 is( $reserve3->{priority}, 2, "New reserve for patron 0, the reserve has a priority = 2" );
308
309 ModReserve({ reserve_id => $reserveid2, rank => 'del' });
310 $reserve3 = GetReserve( $reserveid3 );
311 is( $reserve3->{priority}, 1, "After ModReserve, the 3rd reserve becomes the first on the waiting list" );
312
313 ModItem({ damaged => 1 }, $item_bibnum, $itemnumber);
314 C4::Context->set_preference( 'AllowHoldsOnDamagedItems', 1 );
315 ok( CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'OK', "Patron can reserve damaged item with AllowHoldsOnDamagedItems enabled" );
316 ok( defined( ( CheckReserves($itemnumber) )[1] ), "Hold can be trapped for damaged item with AllowHoldsOnDamagedItems enabled" );
317 C4::Context->set_preference( 'AllowHoldsOnDamagedItems', 0 );
318 ok( CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'damaged', "Patron cannot reserve damaged item with AllowHoldsOnDamagedItems disabled" );
319 ok( !defined( ( CheckReserves($itemnumber) )[1] ), "Hold cannot be trapped for damaged item with AllowHoldsOnDamagedItems disabled" );
320
321 # Regression test for bug 9532
322 ($bibnum, $title, $bibitemnum) = create_helper_biblio('CANNOT');
323 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem({ homebranch => 'CPL', holdingbranch => 'CPL', itype => 'CANNOT' } , $bibnum);
324 AddReserve(
325     $branch,
326     $borrowernumbers[0],
327     $bibnum,
328     'a',
329     '',
330     1,
331 );
332 ok(
333     CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'tooManyReserves',
334     "cannot request item if policy that matches on item-level item type forbids it"
335 );
336 ModItem({ itype => 'CAN' }, $item_bibnum, $itemnumber);
337 ok(
338     CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'OK',
339     "can request item if policy that matches on item type allows it"
340 );
341
342 t::lib::Mocks::mock_preference('item-level_itypes', 0);
343 ModItem({ itype => undef }, $item_bibnum, $itemnumber);
344 ok(
345     CanItemBeReserved( $borrowernumbers[0], $itemnumber) eq 'tooManyReserves',
346     "cannot request item if policy that matches on bib-level item type forbids it (bug 9532)"
347 );
348
349
350 # Test branch item rules
351
352 $dbh->do('DELETE FROM issuingrules');
353 $dbh->do(
354     q{INSERT INTO issuingrules (categorycode, branchcode, itemtype, reservesallowed)
355       VALUES (?, ?, ?, ?)},
356     {},
357     '*', '*', '*', 25
358 );
359 $dbh->do('DELETE FROM branch_item_rules');
360 $dbh->do('DELETE FROM default_branch_circ_rules');
361 $dbh->do('DELETE FROM default_branch_item_rules');
362 $dbh->do('DELETE FROM default_circ_rules');
363 $dbh->do(q{
364     INSERT INTO branch_item_rules (branchcode, itemtype, holdallowed, returnbranch)
365     VALUES (?, ?, ?, ?)
366 }, {}, 'CPL', 'CANNOT', 0, 'homebranch');
367 $dbh->do(q{
368     INSERT INTO branch_item_rules (branchcode, itemtype, holdallowed, returnbranch)
369     VALUES (?, ?, ?, ?)
370 }, {}, 'CPL', 'CAN', 1, 'homebranch');
371 ($bibnum, $title, $bibitemnum) = create_helper_biblio('CANNOT');
372 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem(
373     { homebranch => 'CPL', holdingbranch => 'CPL', itype => 'CANNOT' } , $bibnum);
374 is(CanItemBeReserved($borrowernumbers[0], $itemnumber), 'notReservable',
375     "CanItemBeReserved should returns 'notReservable'");
376
377 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem(
378     { homebranch => 'MPL', holdingbranch => 'CPL', itype => 'CAN' } , $bibnum);
379 is(CanItemBeReserved($borrowernumbers[0], $itemnumber),
380     'cannotReserveFromOtherBranches',
381     "CanItemBeReserved should returns 'cannotReserveFromOtherBranches'");
382
383 ($item_bibnum, $item_bibitemnum, $itemnumber) = AddItem(
384     { homebranch => 'CPL', holdingbranch => 'CPL', itype => 'CAN' } , $bibnum);
385 is(CanItemBeReserved($borrowernumbers[0], $itemnumber), 'OK',
386     "CanItemBeReserved should returns 'OK'");
387
388
389 # Test CancelExpiredReserves
390 C4::Context->set_preference('ExpireReservesMaxPickUpDelay', 1);
391 C4::Context->set_preference('ReservesMaxPickUpDelay', 1);
392
393 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime(time);
394 $year += 1900;
395 $mon += 1;
396 $reserves = $dbh->selectall_arrayref('SELECT * FROM reserves', { Slice => {} });
397 $reserve = $reserves->[0];
398 my $calendar = C4::Calendar->new(branchcode => $reserve->{branchcode});
399 $calendar->insert_single_holiday(
400     day         => $mday,
401     month       => $mon,
402     year        => $year,
403     title       => 'Test',
404     description => 'Test',
405 );
406 $reserve_id = $reserve->{reserve_id};
407 $dbh->do("UPDATE reserves SET waitingdate = DATE_SUB( NOW(), INTERVAL 5 DAY ), found = 'W', priority = 0 WHERE reserve_id = ?", undef, $reserve_id );
408 C4::Context->set_preference('ExpireReservesOnHolidays', 0);
409 CancelExpiredReserves();
410 my $count = $dbh->selectrow_array("SELECT COUNT(*) FROM reserves WHERE reserve_id = ?", undef, $reserve_id );
411 is( $count, 1, "Waiting reserve beyond max pickup delay *not* canceled on holiday" );
412 C4::Context->set_preference('ExpireReservesOnHolidays', 1);
413 CancelExpiredReserves();
414 $count = $dbh->selectrow_array("SELECT COUNT(*) FROM reserves WHERE reserve_id = ?", undef, $reserve_id );
415 is( $count, 0, "Waiting reserve beyond max pickup delay canceled on holiday" );
416
417 # Test expirationdate
418 $reserve = $reserves->[1];
419 $reserve_id = $reserve->{reserve_id};
420 $dbh->do("UPDATE reserves SET expirationdate = DATE_SUB( NOW(), INTERVAL 1 DAY ) WHERE reserve_id = ?", undef, $reserve_id );
421 CancelExpiredReserves();
422 $count = $dbh->selectrow_array("SELECT COUNT(*) FROM reserves WHERE reserve_id = ?", undef, $reserve_id );
423 is( $count, 0, "Reserve with manual expiration date canceled correctly" );
424
425 # Helper method to set up a Biblio.
426 sub create_helper_biblio {
427     my $itemtype = shift;
428     my $bib = MARC::Record->new();
429     my $title = 'Silence in the library';
430     $bib->append_fields(
431         MARC::Field->new('100', ' ', ' ', a => 'Moffat, Steven'),
432         MARC::Field->new('245', ' ', ' ', a => $title),
433         MARC::Field->new('942', ' ', ' ', c => $itemtype),
434     );
435     return ($bibnum, $title, $bibitemnum) = AddBiblio($bib, '');
436 }