Bug 26922: Regression tests
[koha.git] / t / db_dependent / ILSDI_Services.t
blob5e38a12df28e277aab130c3a5ed40003c40b2f1d
1 #!/usr/bin/perl
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>.
18 use Modern::Perl;
20 use CGI qw ( -utf8 );
22 use Test::More tests => 10;
23 use Test::MockModule;
24 use t::lib::Mocks;
25 use t::lib::TestBuilder;
27 use C4::Items qw( ModItemTransfer );
28 use C4::Circulation;
30 use Koha::AuthUtils;
32 BEGIN {
33 use_ok('C4::ILSDI::Services');
36 my $schema = Koha::Database->schema;
37 my $dbh = C4::Context->dbh;
38 my $builder = t::lib::TestBuilder->new;
40 subtest 'AuthenticatePatron test' => sub {
42 plan tests => 14;
44 $schema->storage->txn_begin;
46 my $plain_password = 'tomasito';
48 $builder->build({
49 source => 'Borrower',
50 value => {
51 cardnumber => undef,
53 });
55 my $borrower = $builder->build({
56 source => 'Borrower',
57 value => {
58 cardnumber => undef,
59 password => Koha::AuthUtils::hash_password( $plain_password )
61 });
63 my $query = CGI->new;
64 $query->param( 'username', $borrower->{userid});
65 $query->param( 'password', $plain_password);
67 my $reply = C4::ILSDI::Services::AuthenticatePatron( $query );
68 is( $reply->{id}, $borrower->{borrowernumber}, "userid and password - Patron authenticated" );
69 is( $reply->{code}, undef, "Error code undef");
71 $query->param('password','ilsdi-passworD');
72 $reply = C4::ILSDI::Services::AuthenticatePatron( $query );
73 is( $reply->{code}, 'PatronNotFound', "userid and wrong password - PatronNotFound" );
74 is( $reply->{id}, undef, "id undef");
76 $query->param( 'password', $plain_password );
77 $query->param( 'username', 'wrong-ilsdi-useriD' );
78 $reply = C4::ILSDI::Services::AuthenticatePatron( $query );
79 is( $reply->{code}, 'PatronNotFound', "non-existing userid - PatronNotFound" );
80 is( $reply->{id}, undef, "id undef");
82 $query->param( 'username', uc( $borrower->{userid} ));
83 $reply = C4::ILSDI::Services::AuthenticatePatron( $query );
84 is( $reply->{id}, $borrower->{borrowernumber}, "userid is not case sensitive - Patron authenticated" );
85 is( $reply->{code}, undef, "Error code undef");
87 $query->param( 'username', $borrower->{cardnumber} );
88 $reply = C4::ILSDI::Services::AuthenticatePatron( $query );
89 is( $reply->{id}, $borrower->{borrowernumber}, "cardnumber and password - Patron authenticated" );
90 is( $reply->{code}, undef, "Error code undef" );
92 $query->param( 'password', 'ilsdi-passworD' );
93 $reply = C4::ILSDI::Services::AuthenticatePatron( $query );
94 is( $reply->{code}, 'PatronNotFound', "cardnumber and wrong password - PatronNotFount" );
95 is( $reply->{id}, undef, "id undef" );
97 $query->param( 'username', 'randomcardnumber1234' );
98 $query->param( 'password', $plain_password );
99 $reply = C4::ILSDI::Services::AuthenticatePatron($query);
100 is( $reply->{code}, 'PatronNotFound', "non-existing cardnumer/userid - PatronNotFound" );
101 is( $reply->{id}, undef, "id undef");
103 $schema->storage->txn_rollback;
107 subtest 'GetPatronInfo/GetBorrowerAttributes test for extended patron attributes' => sub {
109 plan tests => 5;
111 $schema->storage->txn_begin;
113 $schema->resultset( 'Issue' )->delete_all;
114 $schema->resultset( 'Borrower' )->delete_all;
115 $schema->resultset( 'BorrowerAttribute' )->delete_all;
116 $schema->resultset( 'BorrowerAttributeType' )->delete_all;
117 $schema->resultset( 'Category' )->delete_all;
118 $schema->resultset( 'Item' )->delete_all; # 'Branch' deps. on this
119 $schema->resultset( 'Club' )->delete_all;
120 $schema->resultset( 'Branch' )->delete_all;
122 # Configure Koha to enable ILS-DI server and extended attributes:
123 t::lib::Mocks::mock_preference( 'ILS-DI', 1 );
124 t::lib::Mocks::mock_preference( 'ExtendedPatronAttributes', 1 );
126 # Set up a library/branch for our user to belong to:
127 my $lib = $builder->build( {
128 source => 'Branch',
129 value => {
130 branchcode => 'T_ILSDI',
132 } );
134 # Create a new category for user to belong to:
135 my $cat = $builder->build( {
136 source => 'Category',
137 value => {
138 category_type => 'A',
139 BlockExpiredPatronOpacActions => -1,
141 } );
143 # Create a new attribute type:
144 my $attr_type = $builder->build( {
145 source => 'BorrowerAttributeType',
146 value => {
147 code => 'HIDEME',
148 opac_display => 0,
149 authorised_value_category => '',
150 class => '',
152 } );
153 my $attr_type_visible = $builder->build( {
154 source => 'BorrowerAttributeType',
155 value => {
156 code => 'SHOWME',
157 opac_display => 1,
158 authorised_value_category => '',
159 class => '',
161 } );
163 # Create a new user:
164 my $brwr = $builder->build( {
165 source => 'Borrower',
166 value => {
167 categorycode => $cat->{'categorycode'},
168 branchcode => $lib->{'branchcode'},
170 } );
172 # Authorised value:
173 my $auth = $builder->build( {
174 source => 'AuthorisedValue',
175 value => {
176 category => $cat->{'categorycode'}
178 } );
180 # Set the new attribute for our user:
181 my $attr_hidden = $builder->build( {
182 source => 'BorrowerAttribute',
183 value => {
184 borrowernumber => $brwr->{'borrowernumber'},
185 code => $attr_type->{'code'},
186 attribute => '1337 hidden',
188 } );
189 my $attr_shown = $builder->build( {
190 source => 'BorrowerAttribute',
191 value => {
192 borrowernumber => $brwr->{'borrowernumber'},
193 code => $attr_type_visible->{'code'},
194 attribute => '1337 shown',
196 } );
198 my $fine = $builder->build(
200 source => 'Accountline',
201 value => {
202 borrowernumber => $brwr->{borrowernumber},
203 debit_type_code => 'OVERDUE',
204 amountoutstanding => 10
209 # Prepare and send web request for IL-SDI server:
210 my $query = CGI->new;
211 $query->param( 'service', 'GetPatronInfo' );
212 $query->param( 'patron_id', $brwr->{'borrowernumber'} );
213 $query->param( 'show_attributes', '1' );
214 $query->param( 'show_fines', '1' );
216 my $reply = C4::ILSDI::Services::GetPatronInfo( $query );
218 # Build a structure for comparison:
219 my $cmp = {
220 borrowernumber => $brwr->{borrowernumber},
221 value => $attr_shown->{'attribute'},
222 value_description => $attr_shown->{'attribute'},
223 %$attr_type_visible,
224 %$attr_shown,
227 is( $reply->{'charges'}, '10.00',
228 'The \'charges\' attribute should be correctly filled (bug 17836)' );
230 is( scalar( @{$reply->{fines}->{fine}}), 1, 'There should be only 1 account line');
232 $reply->{fines}->{fine}->[0]->{accountlines_id},
233 $fine->{accountlines_id},
234 "The accountline should be the correct one"
237 # Check results:
238 is_deeply( $reply->{'attributes'}, [ $cmp ], 'Test GetPatronInfo - show_attributes parameter' );
240 ok( exists $reply->{is_expired}, 'There should be the is_expired information');
242 # Cleanup
243 $schema->storage->txn_rollback;
246 subtest 'LookupPatron test' => sub {
248 plan tests => 9;
250 $schema->storage->txn_begin;
252 $schema->resultset( 'Issue' )->delete_all;
253 $schema->resultset( 'Borrower' )->delete_all;
254 $schema->resultset( 'BorrowerAttribute' )->delete_all;
255 $schema->resultset( 'BorrowerAttributeType' )->delete_all;
256 $schema->resultset( 'Category' )->delete_all;
257 $schema->resultset( 'Item' )->delete_all; # 'Branch' deps. on this
258 $schema->resultset( 'Branch' )->delete_all;
260 my $borrower = $builder->build({
261 source => 'Borrower',
264 my $query = CGI->new();
265 my $bad_result = C4::ILSDI::Services::LookupPatron($query);
266 is( $bad_result->{message}, 'PatronNotFound', 'No parameters' );
268 $query->delete_all();
269 $query->param( 'id', $borrower->{firstname} );
270 my $optional_result = C4::ILSDI::Services::LookupPatron($query);
272 $optional_result->{id},
273 $borrower->{borrowernumber},
274 'Valid Firstname only'
277 $query->delete_all();
278 $query->param( 'id', 'ThereIsNoWayThatThisCouldPossiblyBeValid' );
279 my $bad_optional_result = C4::ILSDI::Services::LookupPatron($query);
280 is( $bad_optional_result->{message}, 'PatronNotFound', 'Invalid ID' );
282 foreach my $id_type (
283 'cardnumber',
284 'userid',
285 'email',
286 'borrowernumber',
287 'surname',
288 'firstname'
290 $query->delete_all();
291 $query->param( 'id_type', $id_type );
292 $query->param( 'id', $borrower->{$id_type} );
293 my $result = C4::ILSDI::Services::LookupPatron($query);
294 is( $result->{'id'}, $borrower->{borrowernumber}, "Checking $id_type" );
297 # Cleanup
298 $schema->storage->txn_rollback;
301 subtest 'Holds test' => sub {
303 plan tests => 7;
305 $schema->storage->txn_begin;
307 t::lib::Mocks::mock_preference( 'AllowHoldsOnDamagedItems', 0 );
309 my $patron = $builder->build({
310 source => 'Borrower',
313 my $item = $builder->build_sample_item(
315 damaged => 1
319 my $query = CGI->new;
320 $query->param( 'patron_id', $patron->{borrowernumber});
321 $query->param( 'bib_id', $item->biblionumber);
323 my $reply = C4::ILSDI::Services::HoldTitle( $query );
324 is( $reply->{code}, 'damaged', "Item damaged" );
326 $item->damaged(0)->store;
328 my $hold = $builder->build({
329 source => 'Reserve',
330 value => {
331 borrowernumber => $patron->{borrowernumber},
332 biblionumber => $item->biblionumber,
333 itemnumber => $item->itemnumber
337 $reply = C4::ILSDI::Services::HoldTitle( $query );
338 is( $reply->{code}, 'itemAlreadyOnHold', "Item already on hold" );
340 my $biblio_with_no_item = $builder->build_sample_biblio;
342 $query = CGI->new;
343 $query->param( 'patron_id', $patron->{borrowernumber});
344 $query->param( 'bib_id', $biblio_with_no_item->biblionumber);
346 $reply = C4::ILSDI::Services::HoldTitle( $query );
347 is( $reply->{code}, 'NoItems', 'Biblio has no item' );
349 my $item2 = $builder->build_sample_item(
351 damaged => 0,
355 t::lib::Mocks::mock_preference( 'ReservesControlBranch', 'PatronLibrary' );
356 Koha::CirculationRules->set_rule(
358 categorycode => $patron->{categorycode},
359 itemtype => $item2->{itype},
360 branchcode => $patron->{branchcode},
361 rule_name => 'reservesallowed',
362 rule_value => 0,
366 $query = CGI->new;
367 $query->param( 'patron_id', $patron->{borrowernumber});
368 $query->param( 'bib_id', $item2->biblionumber);
369 $query->param( 'item_id', $item2->itemnumber);
371 $reply = C4::ILSDI::Services::HoldItem( $query );
372 is( $reply->{code}, 'tooManyReserves', "Too many reserves" );
374 my $origin_branch = $builder->build(
376 source => 'Branch',
377 value => {
378 pickup_location => 1,
383 # Adding a holdable item.
384 my $item3 = $builder->build_sample_item(
386 barcode => '123456789',
387 library => $origin_branch->{branchcode}
390 my $item4 = $builder->build_sample_item(
392 biblionumber => $item3->biblionumber,
393 damaged => 1,
394 library => $origin_branch->{branchcode}
397 Koha::CirculationRules->set_rule(
399 categorycode => $patron->{categorycode},
400 itemtype => $item3->{itype},
401 branchcode => $patron->{branchcode},
402 rule_name => 'reservesallowed',
403 rule_value => 10,
407 $query = CGI->new;
408 $query->param( 'patron_id', $patron->{borrowernumber});
409 $query->param( 'bib_id', $item4->biblionumber);
410 $query->param( 'item_id', $item4->itemnumber);
412 $reply = C4::ILSDI::Services::HoldItem( $query );
413 is( $reply->{code}, 'damaged', "Item is damaged" );
415 my $module = Test::MockModule->new('C4::Context');
416 $module->mock('userenv', sub { { patron => $patron } });
417 my $issue = C4::Circulation::AddIssue($patron, $item3->barcode);
418 t::lib::Mocks::mock_preference( 'AllowHoldsOnPatronsPossessions', '0' );
420 $query = CGI->new;
421 $query->param( 'patron_id', $patron->{borrowernumber});
422 $query->param( 'bib_id', $item3->biblionumber);
423 $query->param( 'item_id', $item3->itemnumber);
424 $query->param( 'pickup_location', $origin_branch->{branchcode});
425 $reply = C4::ILSDI::Services::HoldItem( $query );
427 is( $reply->{code}, 'alreadypossession', "Patron has issued same book" );
428 is( $reply->{pickup_location}, undef, "No reserve placed");
430 $schema->storage->txn_rollback;
433 subtest 'Holds test for branch transfer limits' => sub {
435 plan tests => 6;
437 $schema->storage->txn_begin;
439 # Test enforement of branch transfer limits
440 t::lib::Mocks::mock_preference( 'UseBranchTransferLimits', '1' );
441 t::lib::Mocks::mock_preference( 'BranchTransferLimitsType', 'itemtype' );
443 my $patron = $builder->build({
444 source => 'Borrower',
447 my $origin_branch = $builder->build(
449 source => 'Branch',
450 value => {
451 pickup_location => 1,
455 my $pickup_branch = $builder->build(
457 source => 'Branch',
458 value => {
459 pickup_location => 1,
464 my $item = $builder->build_sample_item(
466 library => $origin_branch->{branchcode},
470 Koha::CirculationRules->set_rule(
472 categorycode => undef,
473 itemtype => undef,
474 branchcode => undef,
475 rule_name => 'reservesallowed',
476 rule_value => 99,
480 my $limit = Koha::Item::Transfer::Limit->new({
481 toBranch => $pickup_branch->{branchcode},
482 fromBranch => $item->holdingbranch,
483 itemtype => $item->effective_itemtype,
484 })->store();
486 my $query = CGI->new;
487 $query->param( 'pickup_location', $pickup_branch->{branchcode} );
488 $query->param( 'patron_id', $patron->{borrowernumber});
489 $query->param( 'bib_id', $item->biblionumber);
490 $query->param( 'item_id', $item->itemnumber);
492 my $reply = C4::ILSDI::Services::HoldItem( $query );
493 is( $reply->{code}, 'cannotBeTransferred', "Item hold, Item cannot be transferred" );
495 $reply = C4::ILSDI::Services::HoldTitle( $query );
496 is( $reply->{code}, 'cannotBeTransferred', "Record hold, Item cannot be transferred" );
498 t::lib::Mocks::mock_preference( 'UseBranchTransferLimits', '0' );
500 $reply = C4::ILSDI::Services::HoldItem( $query );
501 is( $reply->{code}, undef, "Item hold, Item can be transferred" );
502 my $hold = Koha::Holds->search({ itemnumber => $item->itemnumber, borrowernumber => $patron->{borrowernumber} })->next;
503 is( $hold->branchcode, $pickup_branch->{branchcode}, 'The library id is correctly set' );
505 Koha::Holds->search()->delete();
507 $reply = C4::ILSDI::Services::HoldTitle( $query );
508 is( $reply->{code}, undef, "Record hold, Item con be transferred" );
509 $hold = Koha::Holds->search({ biblionumber => $item->biblionumber, borrowernumber => $patron->{borrowernumber} })->next;
510 is( $hold->branchcode, $pickup_branch->{branchcode}, 'The library id is correctly set' );
512 $schema->storage->txn_rollback;
515 subtest 'Holds test with start_date and end_date' => sub {
517 plan tests => 8;
519 $schema->storage->txn_begin;
521 my $pickup_library = $builder->build_object(
523 class => 'Koha::Libraries',
524 value => {
525 pickup_location => 1,
530 my $patron = $builder->build_object({
531 class => 'Koha::Patrons',
534 my $item = $builder->build_sample_item({ library => $pickup_library->branchcode });
536 Koha::CirculationRules->set_rule(
538 categorycode => undef,
539 itemtype => undef,
540 branchcode => undef,
541 rule_name => 'reservesallowed',
542 rule_value => 99,
546 my $query = CGI->new;
547 $query->param( 'pickup_location', $pickup_library->branchcode );
548 $query->param( 'patron_id', $patron->borrowernumber);
549 $query->param( 'bib_id', $item->biblionumber);
550 $query->param( 'item_id', $item->itemnumber);
551 $query->param( 'start_date', '2020-03-20');
552 $query->param( 'expiry_date', '2020-04-22');
554 my $reply = C4::ILSDI::Services::HoldItem( $query );
555 is ($reply->{pickup_location}, $pickup_library->branchname, "Item hold with date parameters was placed");
556 my $hold = Koha::Holds->search({ biblionumber => $item->biblionumber})->next();
557 is( $hold->biblionumber, $item->biblionumber, "correct biblionumber");
558 is( $hold->reservedate, '2020-03-20', "Item hold has correct start date" );
559 is( $hold->expirationdate, '2020-04-22', "Item hold has correct end date" );
561 $hold->delete();
563 $reply = C4::ILSDI::Services::HoldTitle( $query );
564 is ($reply->{pickup_location}, $pickup_library->branchname, "Record hold with date parameters was placed");
565 $hold = Koha::Holds->search({ biblionumber => $item->biblionumber})->next();
566 is( $hold->biblionumber, $item->biblionumber, "correct biblionumber");
567 is( $hold->reservedate, '2020-03-20', "Record hold has correct start date" );
568 is( $hold->expirationdate, '2020-04-22', "Record hold has correct end date" );
570 $schema->storage->txn_rollback;
573 subtest 'GetRecords' => sub {
575 plan tests => 1;
577 $schema->storage->txn_begin;
579 t::lib::Mocks::mock_preference( 'ILS-DI', 1 );
581 my $branch1 = $builder->build({
582 source => 'Branch',
584 my $branch2 = $builder->build({
585 source => 'Branch',
588 my $item = $builder->build_sample_item(
590 library => $branch1->{branchcode},
594 ModItemTransfer($item->itemnumber, $branch1->{branchcode}, $branch2->{branchcode});
596 my $cgi = CGI->new;
597 $cgi->param(service => 'GetRecords');
598 $cgi->param(id => $item->biblionumber);
600 my $reply = C4::ILSDI::Services::GetRecords($cgi);
602 my $transfer = $item->get_transfer;
603 my $expected = {
604 datesent => $transfer->datesent,
605 frombranch => $transfer->frombranch,
606 tobranch => $transfer->tobranch,
608 is_deeply($reply->{record}->[0]->{items}->{item}->[0]->{transfer}, $expected,
609 'GetRecords returns transfer informations');
611 $schema->storage->txn_rollback;
614 subtest 'RenewHold' => sub {
615 plan tests => 4;
617 $schema->storage->txn_begin;
619 my $cgi = CGI->new;
620 my $patron = $builder->build_object( { class => 'Koha::Patrons' } );
621 my $item = $builder->build_sample_item;
622 $cgi->param( patron_id => $patron->borrowernumber );
623 $cgi->param( item_id => $item->itemnumber );
625 t::lib::Mocks::mock_userenv( { patron => $patron } ); # For AddIssue
626 my $checkout = C4::Circulation::AddIssue( $patron->unblessed, $item->barcode );
628 # Everything is ok
629 my $reply = C4::ILSDI::Services::RenewLoan($cgi);
630 is( exists $reply->{date_due}, 1, 'If the item is checked out, the date_due key should exist' );
632 # The item is not checked out
633 $checkout->delete;
634 $reply = C4::ILSDI::Services::RenewLoan($cgi);
635 is( $reply, undef, 'If the item is not checked out, we should not explode.'); # FIXME We should return an error code instead
637 # The item does not exist
638 $item->delete;
639 $reply = C4::ILSDI::Services::RenewLoan($cgi);
640 is( $reply->{code}, 'RecordNotFound', 'If the item does not exist, RecordNotFound should be returned');
642 $patron->delete;
643 $reply = C4::ILSDI::Services::RenewLoan($cgi);
644 is( $reply->{code}, 'PatronNotFound', 'If the patron does not exist, PatronNotFound should be returned');
646 $schema->storage->txn_rollback;
649 subtest 'GetPatronInfo paginated loans' => sub {
650 plan tests => 7;
652 $schema->storage->txn_begin;
654 my $library = $builder->build_object({
655 class => 'Koha::Libraries',
658 my $item1 = $builder->build_sample_item({ library => $library->branchcode });
659 my $item2 = $builder->build_sample_item({ library => $library->branchcode });
660 my $item3 = $builder->build_sample_item({ library => $library->branchcode });
661 my $patron = $builder->build_object({
662 class => 'Koha::Patrons',
663 value => {
664 branchcode => $library->branchcode,
667 my $module = Test::MockModule->new('C4::Context');
668 $module->mock('userenv', sub { { branch => $library->branchcode } });
669 my $date_due = Koha::DateUtils::dt_from_string()->add(weeks => 2);
670 my $issue1 = C4::Circulation::AddIssue($patron->unblessed, $item1->barcode, $date_due);
671 my $date_due1 = Koha::DateUtils::dt_from_string( $issue1->date_due );
672 my $issue2 = C4::Circulation::AddIssue($patron->unblessed, $item2->barcode, $date_due);
673 my $date_due2 = Koha::DateUtils::dt_from_string( $issue2->date_due );
674 my $issue3 = C4::Circulation::AddIssue($patron->unblessed, $item3->barcode, $date_due);
675 my $date_due3 = Koha::DateUtils::dt_from_string( $issue3->date_due );
677 my $cgi = CGI->new;
679 $cgi->param( 'service', 'GetPatronInfo' );
680 $cgi->param( 'patron_id', $patron->borrowernumber );
681 $cgi->param( 'show_loans', '1' );
682 $cgi->param( 'loans_per_page', '2' );
683 $cgi->param( 'loans_page', '1' );
684 my $reply = C4::ILSDI::Services::GetPatronInfo($cgi);
686 is($reply->{total_loans}, 3, 'total_loans == 3');
687 is(scalar @{ $reply->{loans}->{loan} }, 2, 'GetPatronInfo returned only 2 loans');
688 is($reply->{loans}->{loan}->[0]->{itemnumber}, $item3->itemnumber);
689 is($reply->{loans}->{loan}->[1]->{itemnumber}, $item2->itemnumber);
691 $cgi->param( 'loans_page', '2' );
692 $reply = C4::ILSDI::Services::GetPatronInfo($cgi);
694 is($reply->{total_loans}, 3, 'total_loans == 3');
695 is(scalar @{ $reply->{loans}->{loan} }, 1, 'GetPatronInfo returned only 1 loan');
696 is($reply->{loans}->{loan}->[0]->{itemnumber}, $item1->itemnumber);
698 $schema->storage->txn_rollback;