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>.
22 use Test
::More tests
=> 10;
25 use t
::lib
::TestBuilder
;
27 use C4
::Items
qw( ModItemTransfer );
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 {
44 $schema->storage->txn_begin;
46 my $plain_password = 'tomasito';
55 my $borrower = $builder->build({
59 password
=> Koha
::AuthUtils
::hash_password
( $plain_password )
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 {
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( {
130 branchcode
=> 'T_ILSDI',
134 # Create a new category for user to belong to:
135 my $cat = $builder->build( {
136 source
=> 'Category',
138 category_type
=> 'A',
139 BlockExpiredPatronOpacActions
=> -1,
143 # Create a new attribute type:
144 my $attr_type = $builder->build( {
145 source
=> 'BorrowerAttributeType',
149 authorised_value_category
=> '',
153 my $attr_type_visible = $builder->build( {
154 source
=> 'BorrowerAttributeType',
158 authorised_value_category
=> '',
164 my $brwr = $builder->build( {
165 source
=> 'Borrower',
167 categorycode
=> $cat->{'categorycode'},
168 branchcode
=> $lib->{'branchcode'},
173 my $auth = $builder->build( {
174 source
=> 'AuthorisedValue',
176 category
=> $cat->{'categorycode'}
180 # Set the new attribute for our user:
181 my $attr_hidden = $builder->build( {
182 source
=> 'BorrowerAttribute',
184 borrowernumber
=> $brwr->{'borrowernumber'},
185 code
=> $attr_type->{'code'},
186 attribute
=> '1337 hidden',
189 my $attr_shown = $builder->build( {
190 source
=> 'BorrowerAttribute',
192 borrowernumber
=> $brwr->{'borrowernumber'},
193 code
=> $attr_type_visible->{'code'},
194 attribute
=> '1337 shown',
198 my $fine = $builder->build(
200 source
=> 'Accountline',
202 borrowernumber
=> $brwr->{borrowernumber
},
203 debit_type_code
=> 'OVERDUE',
204 amountoutstanding
=> 10
209 # Prepare and send web request for IL-SDI server:
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:
220 borrowernumber
=> $brwr->{borrowernumber
},
221 value
=> $attr_shown->{'attribute'},
222 value_description
=> $attr_shown->{'attribute'},
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"
238 is_deeply
( $reply->{'attributes'}, [ $cmp ], 'Test GetPatronInfo - show_attributes parameter' );
240 ok
( exists $reply->{is_expired
}, 'There should be the is_expired information');
243 $schema->storage->txn_rollback;
246 subtest
'LookupPatron test' => sub {
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 (
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" );
298 $schema->storage->txn_rollback;
301 subtest
'Holds test' => sub {
305 $schema->storage->txn_begin;
307 t
::lib
::Mocks
::mock_preference
( 'AllowHoldsOnDamagedItems', 0 );
309 my $patron = $builder->build({
310 source
=> 'Borrower',
313 my $biblio = $builder->build({
317 my $biblioitems = $builder->build({
318 source
=> 'Biblioitem',
320 biblionumber
=> $biblio->{biblionumber
},
324 my $item = $builder->build({
327 biblionumber
=> $biblio->{biblionumber
},
333 $query->param( 'patron_id', $patron->{borrowernumber
});
334 $query->param( 'bib_id', $biblio->{biblionumber
});
336 my $reply = C4
::ILSDI
::Services
::HoldTitle
( $query );
337 is
( $reply->{code
}, 'damaged', "Item damaged" );
339 my $item_o = Koha
::Items
->find($item->{itemnumber
});
340 $item_o->damaged(0)->store;
342 my $hold = $builder->build({
345 borrowernumber
=> $patron->{borrowernumber
},
346 biblionumber
=> $biblio->{biblionumber
},
347 itemnumber
=> $item->{itemnumber
}
351 $reply = C4
::ILSDI
::Services
::HoldTitle
( $query );
352 is
( $reply->{code
}, 'itemAlreadyOnHold', "Item already on hold" );
354 my $biblio_with_no_item = $builder->build({
359 $query->param( 'patron_id', $patron->{borrowernumber
});
360 $query->param( 'bib_id', $biblio_with_no_item->{biblionumber
});
362 $reply = C4
::ILSDI
::Services
::HoldTitle
( $query );
363 is
( $reply->{code
}, 'NoItems', 'Biblio has no item' );
365 my $biblio2 = $builder->build({
369 my $biblioitems2 = $builder->build({
370 source
=> 'Biblioitem',
372 biblionumber
=> $biblio2->{biblionumber
},
376 my $item2 = $builder->build({
379 biblionumber
=> $biblio2->{biblionumber
},
381 itype
=> $builder->build_object({ class => 'Koha::ItemTypes' })->itemtype,
385 t
::lib
::Mocks
::mock_preference
( 'ReservesControlBranch', 'PatronLibrary' );
386 Koha
::CirculationRules
->set_rule(
388 categorycode
=> $patron->{categorycode
},
389 itemtype
=> $item2->{itype
},
390 branchcode
=> $patron->{branchcode
},
391 rule_name
=> 'reservesallowed',
397 $query->param( 'patron_id', $patron->{borrowernumber
});
398 $query->param( 'bib_id', $biblio2->{biblionumber
});
399 $query->param( 'item_id', $item2->{itemnumber
});
401 $reply = C4
::ILSDI
::Services
::HoldItem
( $query );
402 is
( $reply->{code
}, 'tooManyReserves', "Too many reserves" );
404 my $biblio3 = $builder->build({
408 my $biblioitems3 = $builder->build({
409 source
=> 'Biblioitem',
411 biblionumber
=> $biblio3->{biblionumber
},
415 # Adding a holdable item to biblio 3.
416 my $item3 = $builder->build({
419 biblionumber
=> $biblio3->{biblionumber
},
421 itype
=> $builder->build_object({ class => 'Koha::ItemTypes' })->itemtype,
425 my $item4 = $builder->build({
428 biblionumber
=> $biblio3->{biblionumber
},
430 itype
=> $builder->build_object({ class => 'Koha::ItemTypes' })->itemtype,
434 Koha
::CirculationRules
->set_rule(
436 categorycode
=> $patron->{categorycode
},
437 itemtype
=> $item3->{itype
},
438 branchcode
=> $patron->{branchcode
},
439 rule_name
=> 'reservesallowed',
445 $query->param( 'patron_id', $patron->{borrowernumber
});
446 $query->param( 'bib_id', $biblio3->{biblionumber
});
447 $query->param( 'item_id', $item4->{itemnumber
});
449 $reply = C4
::ILSDI
::Services
::HoldItem
( $query );
450 is
( $reply->{code
}, 'damaged', "Item is damaged" );
452 $schema->storage->txn_rollback;
455 subtest
'Holds test for branch transfer limits' => sub {
459 $schema->storage->txn_begin;
461 # Test enforement of branch transfer limits
462 t
::lib
::Mocks
::mock_preference
( 'UseBranchTransferLimits', '1' );
463 t
::lib
::Mocks
::mock_preference
( 'BranchTransferLimitsType', 'itemtype' );
465 my $patron = $builder->build({
466 source
=> 'Borrower',
469 my $origin_branch = $builder->build(
473 pickup_location
=> 1,
477 my $pickup_branch = $builder->build(
481 pickup_location
=> 1,
486 my $biblio = $builder->build({
489 my $biblioitem = $builder->build({
490 source
=> 'Biblioitem',
492 biblionumber
=> $biblio->{biblionumber
},
495 my $item = $builder->build({
498 homebranch
=> $origin_branch->{branchcode
},
499 holdingbranch
=> $origin_branch->{branchcode
},
500 biblionumber
=> $biblio->{biblionumber
},
503 itype
=> $builder->build_object({ class => 'Koha::ItemTypes' })->itemtype,
507 Koha
::CirculationRules
->set_rule(
509 categorycode
=> undef,
512 rule_name
=> 'reservesallowed',
517 my $limit = Koha
::Item
::Transfer
::Limit
->new({
518 toBranch
=> $pickup_branch->{branchcode
},
519 fromBranch
=> $item->{holdingbranch
},
520 itemtype
=> $item->{itype
},
524 $query->param( 'pickup_location', $pickup_branch->{branchcode
} );
525 $query->param( 'patron_id', $patron->{borrowernumber
});
526 $query->param( 'bib_id', $biblio->{biblionumber
});
527 $query->param( 'item_id', $item->{itemnumber
});
529 my $reply = C4
::ILSDI
::Services
::HoldItem
( $query );
530 is
( $reply->{code
}, 'cannotBeTransferred', "Item hold, Item cannot be transferred" );
532 $reply = C4
::ILSDI
::Services
::HoldTitle
( $query );
533 is
( $reply->{code
}, 'cannotBeTransferred', "Record hold, Item cannot be transferred" );
535 t
::lib
::Mocks
::mock_preference
( 'UseBranchTransferLimits', '0' );
537 $reply = C4
::ILSDI
::Services
::HoldItem
( $query );
538 is
( $reply->{code
}, undef, "Item hold, Item can be transferred" );
539 my $hold = Koha
::Holds
->search({ itemnumber
=> $item->{itemnumber
}, borrowernumber
=> $patron->{borrowernumber
} })->next;
540 is
( $hold->branchcode, $pickup_branch->{branchcode
}, 'The library id is correctly set' );
542 Koha
::Holds
->search()->delete();
544 $reply = C4
::ILSDI
::Services
::HoldTitle
( $query );
545 is
( $reply->{code
}, undef, "Record hold, Item con be transferred" );
546 $hold = Koha
::Holds
->search({ biblionumber
=> $biblio->{biblionumber
}, borrowernumber
=> $patron->{borrowernumber
} })->next;
547 is
( $hold->branchcode, $pickup_branch->{branchcode
}, 'The library id is correctly set' );
549 $schema->storage->txn_rollback;
552 subtest
'Holds test with start_date and end_date' => sub {
556 $schema->storage->txn_begin;
558 my $pickup_library = $builder->build_object(
560 class => 'Koha::Libraries',
562 pickup_location
=> 1,
567 my $patron = $builder->build_object({
568 class => 'Koha::Patrons',
571 my $item = $builder->build_sample_item({ library
=> $pickup_library->branchcode });
573 Koha
::CirculationRules
->set_rule(
575 categorycode
=> undef,
578 rule_name
=> 'reservesallowed',
584 $query->param( 'pickup_location', $pickup_library->branchcode );
585 $query->param( 'patron_id', $patron->borrowernumber);
586 $query->param( 'bib_id', $item->biblionumber);
587 $query->param( 'item_id', $item->itemnumber);
588 $query->param( 'start_date', '2020-03-20');
589 $query->param( 'expiry_date', '2020-04-22');
591 my $reply = C4
::ILSDI
::Services
::HoldItem
( $query );
592 is
($reply->{pickup_location
}, $pickup_library->branchname, "Item hold with date parameters was placed");
593 my $hold = Koha
::Holds
->search({ biblionumber
=> $item->biblionumber})->next();
594 is
( $hold->biblionumber, $item->biblionumber, "correct biblionumber");
595 is
( $hold->reservedate, '2020-03-20', "Item hold has correct start date" );
596 is
( $hold->expirationdate, '2020-04-22', "Item hold has correct end date" );
600 $reply = C4
::ILSDI
::Services
::HoldTitle
( $query );
601 is
($reply->{pickup_location
}, $pickup_library->branchname, "Record hold with date parameters was placed");
602 $hold = Koha
::Holds
->search({ biblionumber
=> $item->biblionumber})->next();
603 is
( $hold->biblionumber, $item->biblionumber, "correct biblionumber");
604 is
( $hold->reservedate, '2020-03-20', "Record hold has correct start date" );
605 is
( $hold->expirationdate, '2020-04-22', "Record hold has correct end date" );
607 $schema->storage->txn_rollback;
610 subtest
'GetRecords' => sub {
614 $schema->storage->txn_begin;
616 t
::lib
::Mocks
::mock_preference
( 'ILS-DI', 1 );
618 my $branch1 = $builder->build({
621 my $branch2 = $builder->build({
625 my $biblio = $builder->build({
628 my $biblioitem = $builder->build({
629 source
=> 'Biblioitem',
631 biblionumber
=> $biblio->{biblionumber
},
634 my $item = $builder->build_object({
635 class => 'Koha::Items',
637 biblionumber
=> $biblio->{biblionumber
},
638 biblioitemnumber
=> $biblioitem->{biblioitemnumber
},
639 homebranch
=> $branch1->{branchcode
},
640 holdingbranch
=> $branch1->{branchcode
},
644 ModItemTransfer
($item->itemnumber, $branch1->{branchcode
}, $branch2->{branchcode
});
647 $cgi->param(service
=> 'GetRecords');
648 $cgi->param(id
=> $biblio->{biblionumber
});
650 my $reply = C4
::ILSDI
::Services
::GetRecords
($cgi);
652 my $transfer = $item->get_transfer;
654 datesent
=> $transfer->datesent,
655 frombranch
=> $transfer->frombranch,
656 tobranch
=> $transfer->tobranch,
658 is_deeply
($reply->{record
}->[0]->{items
}->{item
}->[0]->{transfer
}, $expected,
659 'GetRecords returns transfer informations');
661 $schema->storage->txn_rollback;
664 subtest
'RenewHold' => sub {
667 $schema->storage->txn_begin;
670 my $patron = $builder->build_object( { class => 'Koha::Patrons' } );
671 my $item = $builder->build_object( { class => 'Koha::Items' } );
672 $cgi->param( patron_id
=> $patron->borrowernumber );
673 $cgi->param( item_id
=> $item->itemnumber );
675 t
::lib
::Mocks
::mock_userenv
( { patron
=> $patron } ); # For AddIssue
676 my $checkout = C4
::Circulation
::AddIssue
( $patron->unblessed, $item->barcode );
679 my $reply = C4
::ILSDI
::Services
::RenewLoan
($cgi);
680 is
( exists $reply->{date_due
}, 1, 'If the item is checked out, the date_due key should exist' );
682 # The item is not checked out
684 $reply = C4
::ILSDI
::Services
::RenewLoan
($cgi);
685 is
( $reply, undef, 'If the item is not checked out, we should not explode.'); # FIXME We should return an error code instead
687 # The item does not exist
689 $reply = C4
::ILSDI
::Services
::RenewLoan
($cgi);
690 is
( $reply->{code
}, 'RecordNotFound', 'If the item does not exist, RecordNotFound should be returned');
693 $reply = C4
::ILSDI
::Services
::RenewLoan
($cgi);
694 is
( $reply->{code
}, 'PatronNotFound', 'If the patron does not exist, PatronNotFound should be returned');
696 $schema->storage->txn_rollback;
699 subtest
'GetPatronInfo paginated loans' => sub {
702 $schema->storage->txn_begin;
704 my $library = $builder->build_object({
705 class => 'Koha::Libraries',
708 my $item1 = $builder->build_sample_item({ library
=> $library->branchcode });
709 my $item2 = $builder->build_sample_item({ library
=> $library->branchcode });
710 my $item3 = $builder->build_sample_item({ library
=> $library->branchcode });
711 my $patron = $builder->build_object({
712 class => 'Koha::Patrons',
714 branchcode
=> $library->branchcode,
717 my $module = new Test
::MockModule
('C4::Context');
718 $module->mock('userenv', sub { { branch
=> $library->branchcode } });
719 my $date_due = DateTime
->now->add(weeks
=> 2);
720 my $issue1 = C4
::Circulation
::AddIssue
($patron->unblessed, $item1->barcode, $date_due);
721 my $date_due1 = Koha
::DateUtils
::dt_from_string
( $issue1->date_due );
722 my $issue2 = C4
::Circulation
::AddIssue
($patron->unblessed, $item2->barcode, $date_due);
723 my $date_due2 = Koha
::DateUtils
::dt_from_string
( $issue2->date_due );
724 my $issue3 = C4
::Circulation
::AddIssue
($patron->unblessed, $item3->barcode, $date_due);
725 my $date_due3 = Koha
::DateUtils
::dt_from_string
( $issue3->date_due );
729 $cgi->param( 'service', 'GetPatronInfo' );
730 $cgi->param( 'patron_id', $patron->borrowernumber );
731 $cgi->param( 'show_loans', '1' );
732 $cgi->param( 'loans_per_page', '2' );
733 $cgi->param( 'loans_page', '1' );
734 my $reply = C4
::ILSDI
::Services
::GetPatronInfo
($cgi);
736 is
($reply->{total_loans
}, 3, 'total_loans == 3');
737 is
(scalar @
{ $reply->{loans
}->{loan
} }, 2, 'GetPatronInfo returned only 2 loans');
738 is
($reply->{loans
}->{loan
}->[0]->{itemnumber
}, $item3->itemnumber);
739 is
($reply->{loans
}->{loan
}->[1]->{itemnumber
}, $item2->itemnumber);
741 $cgi->param( 'loans_page', '2' );
742 $reply = C4
::ILSDI
::Services
::GetPatronInfo
($cgi);
744 is
($reply->{total_loans
}, 3, 'total_loans == 3');
745 is
(scalar @
{ $reply->{loans
}->{loan
} }, 1, 'GetPatronInfo returned only 1 loan');
746 is
($reply->{loans
}->{loan
}->[0]->{itemnumber
}, $item1->itemnumber);
748 $schema->storage->txn_rollback;