3 # This file is part of Koha.
5 # Koha is free software; you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
10 # Koha is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
20 use Test
::More tests
=> 9;
22 use t
::lib
::TestBuilder
;
35 use Koha
::Biblioitems
;
37 use Koha
::CirculationRules
;
39 my $schema = Koha
::Database
->new->schema;
40 my $builder = t
::lib
::TestBuilder
->new();
42 $schema->storage->txn_begin;
44 t
::lib
::Mocks
::mock_preference
( 'RESTBasicAuth', 1 );
46 my $t = Test
::Mojo
->new('Koha::REST::V1');
48 my $categorycode = $builder->build({ source
=> 'Category' })->{categorycode
};
49 my $branchcode = $builder->build({ source
=> 'Branch' })->{branchcode
};
50 my $branchcode2 = $builder->build({ source
=> 'Branch' })->{branchcode
};
51 my $itemtype = $builder->build({ source
=> 'Itemtype' })->{itemtype
};
53 # Generic password for everyone
54 my $password = 'thePassword123';
56 # User without any permissions
57 my $nopermission = $builder->build_object({
58 class => 'Koha::Patrons',
60 branchcode
=> $branchcode,
61 categorycode
=> $categorycode,
65 $nopermission->set_password( { password
=> $password, skip_validation
=> 1 } );
66 my $nopermission_userid = $nopermission->userid;
68 my $patron_1 = $builder->build_object(
70 class => 'Koha::Patrons',
72 categorycode
=> $categorycode,
73 branchcode
=> $branchcode,
74 surname
=> 'Test Surname',
75 flags
=> 80, #borrowers and reserveforothers flags
79 $patron_1->set_password( { password
=> $password, skip_validation
=> 1 } );
80 my $userid_1 = $patron_1->userid;
82 my $patron_2 = $builder->build_object(
84 class => 'Koha::Patrons',
86 categorycode
=> $categorycode,
87 branchcode
=> $branchcode,
88 surname
=> 'Test Surname 2',
89 flags
=> 16, # borrowers flag
93 $patron_2->set_password( { password
=> $password, skip_validation
=> 1 } );
94 my $userid_2 = $patron_2->userid;
96 my $patron_3 = $builder->build_object(
98 class => 'Koha::Patrons',
100 categorycode
=> $categorycode,
101 branchcode
=> $branchcode,
102 surname
=> 'Test Surname 3',
103 flags
=> 64, # reserveforothers flag
107 $patron_3->set_password( { password
=> $password, skip_validation
=> 1 } );
108 my $userid_3 = $patron_3->userid;
110 my $biblio_1 = $builder->build_sample_biblio;
111 my $item_1 = $builder->build_sample_item({ biblionumber
=> $biblio_1->biblionumber, itype
=> $itemtype });
113 my $biblio_2 = $builder->build_sample_biblio;
114 my $item_2 = $builder->build_sample_item({ biblionumber
=> $biblio_2->biblionumber, itype
=> $itemtype });
116 my $dbh = C4
::Context
->dbh;
117 $dbh->do('DELETE FROM reserves');
118 Koha
::CirculationRules
->search()->delete();
119 Koha
::CirculationRules
->set_rules(
121 categorycode
=> undef,
125 reservesallowed
=> 1,
126 holds_per_record
=> 99
131 my $reserve_id = C4
::Reserves
::AddReserve
(
133 branchcode
=> $branchcode,
134 borrowernumber
=> $patron_1->borrowernumber,
135 biblionumber
=> $biblio_1->biblionumber,
137 itemnumber
=> $item_1->itemnumber,
141 # Add another reserve to be able to change first reserve's rank
142 my $reserve_id2 = C4
::Reserves
::AddReserve
(
144 branchcode
=> $branchcode,
145 borrowernumber
=> $patron_2->borrowernumber,
146 biblionumber
=> $biblio_1->biblionumber,
148 itemnumber
=> $item_1->itemnumber,
152 my $suspended_until = DateTime
->now->add(days
=> 10)->truncate( to
=> 'day' );
153 my $expiration_date = DateTime
->now->add(days
=> 10)->truncate( to
=> 'day' );
156 patron_id
=> int($patron_1->borrowernumber),
157 biblio_id
=> int($biblio_1->biblionumber),
158 item_id
=> int($item_1->itemnumber),
159 pickup_library_id
=> $branchcode,
160 expiration_date
=> output_pref
({ dt
=> $expiration_date, dateformat
=> 'rfc3339', dateonly
=> 1 }),
165 suspended_until
=> output_pref
({ dt
=> $suspended_until, dateformat
=> 'rfc3339' }),
168 subtest
"Test endpoints without authentication" => sub {
170 $t->get_ok('/api/v1/holds')
172 $t->post_ok('/api/v1/holds')
174 $t->put_ok('/api/v1/holds/0')
176 $t->delete_ok('/api/v1/holds/0')
180 subtest
"Test endpoints without permission" => sub {
184 $t->get_ok( "//$nopermission_userid:$password@/api/v1/holds?patron_id=" . $patron_1->borrowernumber ) # no permission
187 $t->get_ok( "//$userid_3:$password@/api/v1/holds?patron_id=" . $patron_1->borrowernumber ) # no permission
190 $t->post_ok( "//$nopermission_userid:$password@/api/v1/holds" => json
=> $post_data )
193 $t->put_ok( "//$nopermission_userid:$password@/api/v1/holds/0" => json
=> $put_data )
196 $t->delete_ok( "//$nopermission_userid:$password@/api/v1/holds/0" )
200 subtest
"Test endpoints with permission" => sub {
204 $t->get_ok( "//$userid_1:$password@/api/v1/holds" )
210 $t->get_ok( "//$userid_1:$password@/api/v1/holds?priority=2" )
212 ->json_is('/0/patron_id', $patron_2->borrowernumber)
215 # While suspended_until is date-time, it's always set to midnight.
216 my $expected_suspended_until = $suspended_until->strftime('%FT00:00:00%z');
217 substr($expected_suspended_until, -2, 0, ':');
219 $t->put_ok( "//$userid_1:$password@/api/v1/holds/$reserve_id" => json
=> $put_data )
221 ->json_is( '/hold_id', $reserve_id )
222 ->json_is( '/suspended_until', $expected_suspended_until )
223 ->json_is( '/priority', 2 )
224 ->json_is( '/pickup_library_id', $branchcode );
226 # Change only pickup library, everything else should remain
227 $t->put_ok( "//$userid_1:$password@/api/v1/holds/$reserve_id" => json
=> { pickup_library_id
=> $branchcode2 } )
229 ->json_is( '/hold_id', $reserve_id )
230 ->json_is( '/suspended_until', $expected_suspended_until )
231 ->json_is( '/priority', 2 )
232 ->json_is( '/pickup_library_id', $branchcode2 );
234 # Reset suspended_until, everything else should remain
235 $t->put_ok( "//$userid_1:$password@/api/v1/holds/$reserve_id" => json
=> { suspended_until
=> undef } )
237 ->json_is( '/hold_id', $reserve_id )
238 ->json_is( '/suspended_until', undef )
239 ->json_is( '/priority', 2 )
240 ->json_is( '/pickup_library_id', $branchcode2 );
242 $t->delete_ok( "//$userid_3:$password@/api/v1/holds/$reserve_id" )
243 ->status_is(204, 'SWAGGER3.2.4')
244 ->content_is('', 'SWAGGER3.3.4');
246 $t->put_ok( "//$userid_3:$password@/api/v1/holds/$reserve_id" => json
=> $put_data )
248 ->json_has('/error');
250 $t->delete_ok( "//$userid_3:$password@/api/v1/holds/$reserve_id" )
252 ->json_has('/error');
254 $t->get_ok( "//$userid_2:$password@/api/v1/holds?patron_id=" . $patron_1->borrowernumber )
258 my $inexisting_borrowernumber = $patron_2->borrowernumber * 2;
259 $t->get_ok( "//$userid_1:$password@/api/v1/holds?patron_id=$inexisting_borrowernumber")
263 $t->delete_ok( "//$userid_3:$password@/api/v1/holds/$reserve_id2" )
264 ->status_is(204, 'SWAGGER3.2.4')
265 ->content_is('', 'SWAGGER3.3.4');
267 $t->post_ok( "//$userid_3:$password@/api/v1/holds" => json
=> $post_data )
269 ->json_has('/hold_id');
270 # Get id from response
271 $reserve_id = $t->tx->res->json->{hold_id
};
273 $t->get_ok( "//$userid_1:$password@/api/v1/holds?patron_id=" . $patron_1->borrowernumber )
275 ->json_is('/0/hold_id', $reserve_id)
276 ->json_is('/0/expiration_date', output_pref
({ dt
=> $expiration_date, dateformat
=> 'rfc3339', dateonly
=> 1 }))
277 ->json_is('/0/pickup_library_id', $branchcode);
279 $t->post_ok( "//$userid_3:$password@/api/v1/holds" => json
=> $post_data )
281 ->json_like('/error', qr
/itemAlreadyOnHold
/);
283 $post_data->{biblionumber
} = int($biblio_2->biblionumber);
284 $post_data->{itemnumber
} = int($item_2->itemnumber);
286 $t->post_ok( "//$userid_3:$password@/api/v1/holds" => json
=> $post_data )
288 ->json_like('/error', qr
/itemAlreadyOnHold
/);
290 my $to_delete_patron = $builder->build_object({ class => 'Koha::Patrons' });
291 my $deleted_patron_id = $to_delete_patron->borrowernumber;
292 $to_delete_patron->delete;
294 my $tmp_patron_id = $post_data->{patron_id
};
295 $post_data->{patron_id
} = $deleted_patron_id;
296 $t->post_ok( "//$userid_3:$password@/api/v1/holds" => json
=> $post_data )
298 ->json_is( { error
=> 'patron_id not found' } );
300 # Restore the original patron_id as it is expected by the next subtest
301 # FIXME: this tests need to be rewritten from scratch
302 $post_data->{patron_id
} = $tmp_patron_id;
305 subtest
'Reserves with itemtype' => sub {
309 patron_id
=> int($patron_1->borrowernumber),
310 biblio_id
=> int($biblio_1->biblionumber),
311 pickup_library_id
=> $branchcode,
312 item_type
=> $itemtype,
315 $t->delete_ok( "//$userid_3:$password@/api/v1/holds/$reserve_id" )
316 ->status_is(204, 'SWAGGER3.2.4')
317 ->content_is('', 'SWAGGER3.3.4');
319 $t->post_ok( "//$userid_3:$password@/api/v1/holds" => json
=> $post_data )
321 ->json_has('/hold_id');
323 $reserve_id = $t->tx->res->json->{hold_id
};
325 $t->get_ok( "//$userid_1:$password@/api/v1/holds?patron_id=" . $patron_1->borrowernumber )
327 ->json_is('/0/hold_id', $reserve_id)
328 ->json_is('/0/item_type', $itemtype);
332 subtest
'test AllowHoldDateInFuture' => sub {
336 $dbh->do('DELETE FROM reserves');
338 my $future_hold_date = DateTime
->now->add(days
=> 10)->truncate( to
=> 'day' );
341 patron_id
=> int($patron_1->borrowernumber),
342 biblio_id
=> int($biblio_1->biblionumber),
343 item_id
=> int($item_1->itemnumber),
344 pickup_library_id
=> $branchcode,
345 expiration_date
=> output_pref
({ dt
=> $expiration_date, dateformat
=> 'rfc3339', dateonly
=> 1 }),
346 hold_date
=> output_pref
({ dt
=> $future_hold_date, dateformat
=> 'rfc3339', dateonly
=> 1 }),
350 t
::lib
::Mocks
::mock_preference
( 'AllowHoldDateInFuture', 0 );
352 $t->post_ok( "//$userid_3:$password@/api/v1/holds" => json
=> $post_data )
354 ->json_has('/error');
356 t
::lib
::Mocks
::mock_preference
( 'AllowHoldDateInFuture', 1 );
358 $t->post_ok( "//$userid_3:$password@/api/v1/holds" => json
=> $post_data )
360 ->json_is('/hold_date', output_pref
({ dt
=> $future_hold_date, dateformat
=> 'rfc3339', dateonly
=> 1 }));
363 subtest
'test AllowHoldPolicyOverride' => sub {
367 $dbh->do('DELETE FROM reserves');
369 Koha
::CirculationRules
->set_rules(
379 t
::lib
::Mocks
::mock_preference
( 'AllowHoldPolicyOverride', 0 );
381 $t->post_ok( "//$userid_3:$password@/api/v1/holds" => json
=> $post_data )
383 ->json_has('/error');
385 t
::lib
::Mocks
::mock_preference
( 'AllowHoldPolicyOverride', 1 );
387 $t->post_ok( "//$userid_3:$password@/api/v1/holds" => json
=> $post_data )
391 $schema->storage->txn_rollback;
393 subtest
'suspend and resume tests' => sub {
397 $schema->storage->txn_begin;
399 my $password = 'AbcdEFG123';
401 my $patron = $builder->build_object(
402 { class => 'Koha::Patrons', value
=> { userid
=> 'tomasito', flags
=> 1 } } );
403 $patron->set_password({ password
=> $password, skip_validation
=> 1 });
404 my $userid = $patron->userid;
407 t
::lib
::Mocks
::mock_preference
( 'HoldsLog', 0 );
408 t
::lib
::Mocks
::mock_preference
( 'RESTBasicAuth', 1 );
410 my $hold = $builder->build_object(
411 { class => 'Koha::Holds',
412 value
=> { suspend
=> 0, suspend_until
=> undef, waitingdate
=> undef, found
=> undef }
416 ok
( !$hold->is_suspended, 'Hold is not suspended' );
417 $t->post_ok( "//$userid:$password@/api/v1/holds/" . $hold->id . "/suspension" )
418 ->status_is( 201, 'Hold suspension created' );
420 $hold->discard_changes; # refresh object
422 ok
( $hold->is_suspended, 'Hold is suspended' );
423 $t->json_is('/end_date', undef, 'Hold suspension has no end date');
425 my $end_date = output_pref
({
426 dt
=> dt_from_string
( undef ),
427 dateformat
=> 'rfc3339',
431 $t->post_ok( "//$userid:$password@/api/v1/holds/" . $hold->id . "/suspension" => json
=> { end_date
=> $end_date } );
433 $hold->discard_changes; # refresh object
435 ok
( $hold->is_suspended, 'Hold is suspended' );
439 dt
=> dt_from_string
( $hold->suspend_until ),
440 dateformat
=> 'rfc3339',
443 'Hold suspension has correct end date'
446 $t->delete_ok( "//$userid:$password@/api/v1/holds/" . $hold->id . "/suspension" )
447 ->status_is(204, 'SWAGGER3.2.4')
448 ->content_is('', 'SWAGGER3.3.4');
450 # Pass a an expiration date for the suspension
451 my $date = dt_from_string
()->add( days
=> 5 );
453 "//$userid:$password@/api/v1/holds/"
455 . "/suspension" => json
=> {
457 output_pref
( { dt
=> $date, dateformat
=> 'rfc3339', dateonly
=> 1 } )
459 )->status_is( 201, 'Hold suspension created' )
460 ->json_is( '/end_date',
461 output_pref
( { dt
=> $date, dateformat
=> 'rfc3339', dateonly
=> 1 } ) )
462 ->header_is( Location
=> "/api/v1/holds/" . $hold->id . "/suspension", 'The Location header is set' );
464 $t->delete_ok( "//$userid:$password@/api/v1/holds/" . $hold->id . "/suspension" )
465 ->status_is(204, 'SWAGGER3.2.4')
466 ->content_is('', 'SWAGGER3.3.4');
468 $hold->set_waiting->discard_changes;
470 $t->post_ok( "//$userid:$password@/api/v1/holds/" . $hold->id . "/suspension" )
471 ->status_is( 400, 'Cannot suspend waiting hold' )
472 ->json_is( '/error', 'Found hold cannot be suspended. Status=W' );
474 $hold->set_transfer->discard_changes;
476 $t->post_ok( "//$userid:$password@/api/v1/holds/" . $hold->id . "/suspension" )
477 ->status_is( 400, 'Cannot suspend hold on transfer' )
478 ->json_is( '/error', 'Found hold cannot be suspended. Status=T' );
480 $schema->storage->txn_rollback;
483 subtest
'PUT /holds/{hold_id}/priority tests' => sub {
487 $schema->storage->txn_begin;
489 my $password = 'AbcdEFG123';
491 my $library = $builder->build_object({ class => 'Koha::Libraries' });
492 my $patron_np = $builder->build_object(
493 { class => 'Koha::Patrons', value
=> { flags
=> 0 } } );
494 $patron_np->set_password( { password
=> $password, skip_validation
=> 1 } );
495 my $userid_np = $patron_np->userid;
497 my $patron = $builder->build_object(
498 { class => 'Koha::Patrons', value
=> { flags
=> 0 } } );
499 $patron->set_password( { password
=> $password, skip_validation
=> 1 } );
500 my $userid = $patron->userid;
503 source
=> 'UserPermission',
505 borrowernumber
=> $patron->borrowernumber,
507 code
=> 'modify_holds_priority',
513 t
::lib
::Mocks
::mock_preference
( 'HoldsLog', 0 );
514 t
::lib
::Mocks
::mock_preference
( 'RESTBasicAuth', 1 );
516 my $biblio = $builder->build_sample_biblio;
517 my $patron_1 = $builder->build_object(
519 class => 'Koha::Patrons',
520 value
=> { branchcode
=> $library->branchcode }
523 my $patron_2 = $builder->build_object(
525 class => 'Koha::Patrons',
526 value
=> { branchcode
=> $library->branchcode }
529 my $patron_3 = $builder->build_object(
531 class => 'Koha::Patrons',
532 value
=> { branchcode
=> $library->branchcode }
536 my $hold_1 = Koha
::Holds
->find(
539 branchcode
=> $library->branchcode,
540 borrowernumber
=> $patron_1->borrowernumber,
541 biblionumber
=> $biblio->biblionumber,
546 my $hold_2 = Koha
::Holds
->find(
549 branchcode
=> $library->branchcode,
550 borrowernumber
=> $patron_2->borrowernumber,
551 biblionumber
=> $biblio->biblionumber,
556 my $hold_3 = Koha
::Holds
->find(
559 branchcode
=> $library->branchcode,
560 borrowernumber
=> $patron_3->borrowernumber,
561 biblionumber
=> $biblio->biblionumber,
567 $t->put_ok( "//$userid_np:$password@/api/v1/holds/"
569 . "/priority" => json
=> 1 )->status_is(403);
571 $t->put_ok( "//$userid:$password@/api/v1/holds/"
573 . "/priority" => json
=> 1 )->status_is(200)->json_is(1);
575 is
( $hold_1->discard_changes->priority, 2, 'Priority adjusted correctly' );
576 is
( $hold_2->discard_changes->priority, 3, 'Priority adjusted correctly' );
577 is
( $hold_3->discard_changes->priority, 1, 'Priority adjusted correctly' );
579 $t->put_ok( "//$userid:$password@/api/v1/holds/"
581 . "/priority" => json
=> 3 )->status_is(200)->json_is(3);
583 is
( $hold_1->discard_changes->priority, 1, 'Priority adjusted correctly' );
584 is
( $hold_2->discard_changes->priority, 2, 'Priority adjusted correctly' );
585 is
( $hold_3->discard_changes->priority, 3, 'Priority adjusted correctly' );
587 $schema->storage->txn_rollback;
590 subtest
'add() tests (maxreserves behaviour)' => sub {
594 $schema->storage->txn_begin;
596 $dbh->do('DELETE FROM reserves');
598 Koha
::CirculationRules
->new->delete;
600 my $password = 'AbcdEFG123';
602 my $patron = $builder->build_object(
603 { class => 'Koha::Patrons', value
=> { userid
=> 'tomasito', flags
=> 1 } } );
604 $patron->set_password({ password
=> $password, skip_validation
=> 1 });
605 my $userid = $patron->userid;
607 Koha
::CirculationRules
->set_rules(
611 categorycode
=> undef,
618 Koha
::CirculationRules
->set_rules(
621 categorycode
=> $patron->categorycode,
628 my $biblio_1 = $builder->build_sample_biblio;
629 my $item_1 = $builder->build_sample_item({ biblionumber
=> $biblio_1->biblionumber });
630 my $biblio_2 = $builder->build_sample_biblio;
631 my $item_2 = $builder->build_sample_item({ biblionumber
=> $biblio_2->biblionumber });
632 my $biblio_3 = $builder->build_sample_biblio;
633 my $item_3 = $builder->build_sample_item({ biblionumber
=> $biblio_3->biblionumber });
636 t
::lib
::Mocks
::mock_preference
( 'HoldsLog', 0 );
637 t
::lib
::Mocks
::mock_preference
( 'RESTBasicAuth', 1 );
638 t
::lib
::Mocks
::mock_preference
( 'maxreserves', 2 );
639 t
::lib
::Mocks
::mock_preference
( 'AllowHoldPolicyOverride', 0 );
642 patron_id
=> $patron->borrowernumber,
643 biblio_id
=> $biblio_1->biblionumber,
644 pickup_library_id
=> $item_1->home_branch->branchcode,
645 item_type
=> $item_1->itype,
648 $t->post_ok( "//$userid:$password@/api/v1/holds" => json
=> $post_data )
652 patron_id
=> $patron->borrowernumber,
653 biblio_id
=> $biblio_2->biblionumber,
654 pickup_library_id
=> $item_2->home_branch->branchcode,
655 item_id
=> $item_2->itemnumber
658 $t->post_ok( "//$userid:$password@/api/v1/holds" => json
=> $post_data )
662 patron_id
=> $patron->borrowernumber,
663 biblio_id
=> $biblio_3->biblionumber,
664 pickup_library_id
=> $item_1->home_branch->branchcode,
665 item_id
=> $item_3->itemnumber
668 $t->post_ok( "//$userid:$password@/api/v1/holds" => json
=> $post_data )
670 ->json_is( { error
=> 'Hold cannot be placed. Reason: tooManyReserves' } );
672 $schema->storage->txn_rollback;