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 File::Basename qw/basename/;
22 use C4::Circulation qw( AddIssue AddReturn );
25 use Koha::Illrequestattributes;
26 use Koha::Illrequest::Config;
32 use Koha::MessageAttributes;
33 use Koha::Notice::Templates;
34 use Koha::AuthorisedValueCategories;
35 use Koha::AuthorisedValues;
37 use t::lib::TestBuilder;
41 use Test::Deep qw/ cmp_deeply ignore /;
44 use Test::More tests => 14;
46 my $schema = Koha::Database->new->schema;
47 my $builder = t::lib::TestBuilder->new;
48 use_ok('Koha::Illrequest');
49 use_ok('Koha::Illrequests');
51 subtest 'Basic object tests' => sub {
55 $schema->storage->txn_begin;
57 Koha::Illrequests->search->delete;
58 my $illrq = $builder->build({ source => 'Illrequest' });
59 my $illrq_obj = Koha::Illrequests->find($illrq->{illrequest_id});
61 isa_ok($illrq_obj, 'Koha::Illrequest',
62 "Correctly create and load an illrequest object.");
63 isa_ok($illrq_obj->_config, 'Koha::Illrequest::Config',
64 "Created a config object as part of Illrequest creation.");
66 is($illrq_obj->illrequest_id, $illrq->{illrequest_id},
67 "Illrequest_id getter works.");
68 is($illrq_obj->borrowernumber, $illrq->{borrowernumber},
69 "Borrowernumber getter works.");
70 is($illrq_obj->biblio_id, $illrq->{biblio_id},
71 "Biblio_Id getter works.");
72 is($illrq_obj->branchcode, $illrq->{branchcode},
73 "Branchcode getter works.");
74 is($illrq_obj->status, $illrq->{status},
75 "Status getter works.");
76 is($illrq_obj->placed, $illrq->{placed},
77 "Placed getter works.");
78 is($illrq_obj->replied, $illrq->{replied},
79 "Replied getter works.");
80 is($illrq_obj->updated, $illrq->{updated},
81 "Updated getter works.");
82 is($illrq_obj->completed, $illrq->{completed},
83 "Completed getter works.");
84 is($illrq_obj->medium, $illrq->{medium},
85 "Medium getter works.");
86 is($illrq_obj->accessurl, $illrq->{accessurl},
87 "Accessurl getter works.");
88 is($illrq_obj->cost, $illrq->{cost},
89 "Cost getter works.");
90 is($illrq_obj->price_paid, $illrq->{price_paid},
91 "Price_paid getter works.");
92 is($illrq_obj->notesopac, $illrq->{notesopac},
93 "Notesopac getter works.");
94 is($illrq_obj->notesstaff, $illrq->{notesstaff},
95 "Notesstaff getter works.");
96 is($illrq_obj->orderid, $illrq->{orderid},
97 "Orderid getter works.");
98 is($illrq_obj->backend, $illrq->{backend},
99 "Backend getter works.");
101 is($illrq_obj->get_type, undef,
102 'get_type() returns undef if no type is set');
104 source => 'Illrequestattribute',
106 illrequest_id => $illrq_obj->illrequest_id,
111 is($illrq_obj->get_type, 'book',
112 'get_type() returns correct type if set');
114 isnt($illrq_obj->status, 'COMP',
115 "ILL is not currently marked complete.");
116 $illrq_obj->mark_completed;
117 is($illrq_obj->status, 'COMP',
118 "ILL is now marked complete.");
122 is(Koha::Illrequests->search->count, 0,
123 "No illrequest found after delete.");
125 $schema->storage->txn_rollback;
128 subtest 'Working with related objects' => sub {
132 $schema->storage->txn_begin;
134 Koha::Illrequests->search->delete;
136 my $patron = $builder->build({ source => 'Borrower' });
137 my $illrq = $builder->build({
138 source => 'Illrequest',
139 value => { borrowernumber => $patron->{borrowernumber} }
141 my $illrq_obj = Koha::Illrequests->find($illrq->{illrequest_id});
143 isa_ok($illrq_obj->patron, 'Koha::Patron',
144 "OK accessing related patron.");
147 source => 'Illrequestattribute',
148 value => { illrequest_id => $illrq_obj->illrequest_id, type => 'X' }
151 source => 'Illrequestattribute',
152 value => { illrequest_id => $illrq_obj->illrequest_id, type => 'Y' }
155 source => 'Illrequestattribute',
156 value => { illrequest_id => $illrq_obj->illrequest_id, type => 'Z' }
159 is($illrq_obj->illrequestattributes->count, Koha::Illrequestattributes->search->count,
160 "Fetching expected number of Illrequestattributes for our request.");
162 my $illrq1 = $builder->build({ source => 'Illrequest' });
164 source => 'Illrequestattribute',
165 value => { illrequest_id => $illrq1->{illrequest_id}, type => 'X' }
168 is($illrq_obj->illrequestattributes->count + 1, Koha::Illrequestattributes->search->count,
169 "Fetching expected number of Illrequestattributes for our request.");
171 is($illrq_obj->biblio, undef, "->biblio returns undef if no biblio");
172 my $biblio = $builder->build_object({ class => 'Koha::Biblios' });
173 my $req_bib = $builder->build_object({
174 class => 'Koha::Illrequests',
176 biblio_id => $biblio->biblionumber
179 isa_ok($req_bib->biblio, 'Koha::Biblio', "OK accessing related biblio");
182 is(Koha::Illrequestattributes->search->count, 1,
183 "Correct number of illrequestattributes after delete.");
185 isa_ok(Koha::Patrons->find($patron->{borrowernumber}), 'Koha::Patron',
186 "Borrower was not deleted after illrq delete.");
188 $schema->storage->txn_rollback;
191 subtest 'Status Graph tests' => sub {
195 $schema->storage->txn_begin;
197 my $illrq = $builder->build({source => 'Illrequest'});
198 my $illrq_obj = Koha::Illrequests->find($illrq->{illrequest_id});
200 # _core_status_graph tests: it's just a constant, so here we just make
201 # sure it returns a hashref.
202 is(ref $illrq_obj->_core_status_graph, "HASH",
203 "_core_status_graph returns a hash.");
205 # _status_graph_union: let's try different merge operations.
208 $illrq_obj->_status_graph_union($illrq_obj->_core_status_graph, {}),
209 $illrq_obj->_core_status_graph,
210 "core_status_graph + null = core_status_graph"
215 $illrq_obj->_status_graph_union({}, $illrq_obj->_core_status_graph),
216 $illrq_obj->_core_status_graph,
217 "null + core_status_graph = core_status_graph"
220 # Correct merge behaviour
222 $illrq_obj->_status_graph_union({
230 prev_actions => [ 'REQ' ],
232 next_actions => [ 'REQ' ],
237 prev_actions => [ 'QER' ],
239 next_actions => [ 'QER' ],
242 prev_actions => [ 'REQ' ],
244 next_actions => [ 'REQ' ],
247 "REQ atom + linking QER = cyclical status graph"
250 # Create a new node, with no prev_actions and no next_actions. This should
251 # protect us against regressions related to bug 22280.
259 # Add the new node to the core_status_grpah
260 my $new_graph = $illrq_obj->_status_graph_union( $new_node, $illrq_obj->_core_status_graph);
261 # Compare the updated graph to the expected graph
262 # The structure we compare against here is just a copy of the structure found
263 # in Koha::Illrequest::_core_status_graph() + the new node we created above
264 cmp_deeply( $new_graph,
272 prev_actions => [ ], # Actions containing buttons
273 # leading to this status
274 id => 'NEW', # ID of this status
275 name => 'New request', # UI name of this status
276 ui_method_name => 'New request', # UI name of method leading
278 method => 'create', # method to this status
279 next_actions => [ 'REQ', 'GENREQ', 'KILL' ], # buttons to add to all
280 # requests with this status
281 ui_method_icon => 'fa-plus', # UI Style class
284 prev_actions => [ 'NEW', 'REQREV', 'QUEUED', 'CANCREQ' ],
287 ui_method_name => 'Confirm request',
289 next_actions => [ 'REQREV', 'COMP', 'CHK' ],
290 ui_method_icon => 'fa-check',
293 prev_actions => [ 'NEW', 'REQREV' ],
295 name => 'Requested from partners',
296 ui_method_name => 'Place request with partners',
297 method => 'generic_confirm',
298 next_actions => [ 'COMP', 'CHK' ],
299 ui_method_icon => 'fa-send-o',
302 prev_actions => [ 'REQ' ],
304 name => 'Request reverted',
305 ui_method_name => 'Revert Request',
307 next_actions => [ 'REQ', 'GENREQ', 'KILL' ],
308 ui_method_icon => 'fa-times',
313 name => 'Queued request',
316 next_actions => [ 'REQ', 'KILL' ],
320 prev_actions => [ 'NEW' ],
322 name => 'Cancellation requested',
325 next_actions => [ 'KILL', 'REQ' ],
329 prev_actions => [ 'REQ' ],
332 ui_method_name => 'Mark completed',
333 method => 'mark_completed',
334 next_actions => [ 'CHK' ],
335 ui_method_icon => 'fa-check',
338 prev_actions => [ 'QUEUED', 'REQREV', 'NEW', 'CANCREQ' ],
341 ui_method_name => 'Delete request',
344 ui_method_icon => 'fa-trash',
347 prev_actions => [ 'REQ', 'GENREQ', 'COMP' ],
349 name => 'Checked out',
350 ui_method_name => 'Check out',
351 needs_prefs => [ 'CirculateILL' ],
352 needs_perms => [ 'user_circulate_circulate_remaining_permissions' ],
353 needs_all => ignore(),
354 method => 'check_out',
356 ui_method_icon => 'fa-upload',
359 prev_actions => [ 'CHK' ],
361 name => 'Returned to library',
362 ui_method_name => 'Check in',
363 method => 'check_in',
364 next_actions => [ 'COMP' ],
365 ui_method_icon => 'fa-download',
368 "new node + core_status_graph = bigger status graph"
369 ) || diag explain $new_graph;
371 # Create a duplicate node
374 prev_actions => [ 'NEW', 'REQREV', 'QUEUED', 'CANCREQ' ],
377 ui_method_name => 'Confirm request dupe',
379 next_actions => [ 'REQREV', 'COMP', 'CHK' ],
380 ui_method_icon => 'fa-check',
383 # Add the dupe node to the core_status_grpah
384 my $dupe_graph = $illrq_obj->_status_graph_union( $illrq_obj->_core_status_graph, $dupe_node);
385 # Compare the updated graph to the expected graph
386 # The structure we compare against here is just a copy of the structure found
387 # in Koha::Illrequest::_core_status_graph() + the new node we created above
388 cmp_deeply( $dupe_graph,
391 prev_actions => [ ], # Actions containing buttons
392 # leading to this status
393 id => 'NEW', # ID of this status
394 name => 'New request', # UI name of this status
395 ui_method_name => 'New request', # UI name of method leading
397 method => 'create', # method to this status
398 next_actions => [ 'REQ', 'GENREQ', 'KILL' ], # buttons to add to all
399 # requests with this status
400 ui_method_icon => 'fa-plus', # UI Style class
403 prev_actions => [ 'NEW', 'REQREV', 'QUEUED', 'CANCREQ' ],
406 ui_method_name => 'Confirm request dupe',
408 next_actions => [ 'REQREV', 'COMP', 'CHK' ],
409 ui_method_icon => 'fa-check',
412 prev_actions => [ 'NEW', 'REQREV' ],
414 name => 'Requested from partners',
415 ui_method_name => 'Place request with partners',
416 method => 'generic_confirm',
417 next_actions => [ 'COMP', 'CHK' ],
418 ui_method_icon => 'fa-send-o',
421 prev_actions => [ 'REQ' ],
423 name => 'Request reverted',
424 ui_method_name => 'Revert Request',
426 next_actions => [ 'REQ', 'GENREQ', 'KILL' ],
427 ui_method_icon => 'fa-times',
432 name => 'Queued request',
435 next_actions => [ 'REQ', 'KILL' ],
439 prev_actions => [ 'NEW' ],
441 name => 'Cancellation requested',
444 next_actions => [ 'KILL', 'REQ' ],
448 prev_actions => [ 'REQ' ],
451 ui_method_name => 'Mark completed',
452 method => 'mark_completed',
453 next_actions => [ 'CHK' ],
454 ui_method_icon => 'fa-check',
457 prev_actions => [ 'QUEUED', 'REQREV', 'NEW', 'CANCREQ' ],
460 ui_method_name => 'Delete request',
463 ui_method_icon => 'fa-trash',
466 prev_actions => [ 'REQ', 'GENREQ', 'COMP' ],
468 name => 'Checked out',
469 ui_method_name => 'Check out',
470 needs_prefs => [ 'CirculateILL' ],
471 needs_perms => [ 'user_circulate_circulate_remaining_permissions' ],
472 needs_all => ignore(),
473 method => 'check_out',
475 ui_method_icon => 'fa-upload',
478 prev_actions => [ 'CHK' ],
480 name => 'Returned to library',
481 ui_method_name => 'Check in',
482 method => 'check_in',
483 next_actions => [ 'COMP' ],
484 ui_method_icon => 'fa-download',
487 "new node + core_status_graph = bigger status graph"
488 ) || diag explain $dupe_graph;
490 $schema->storage->txn_rollback;
493 subtest 'Backend testing (mocks)' => sub {
497 $schema->storage->txn_begin;
499 # testing load_backend & available_backends requires that we have at least
500 # the Dummy plugin installed. load_backend & available_backends don't
501 # currently have tests as a result.
503 t::lib::Mocks->mock_config('interlibrary_loans', { backend_dir => 'a_dir' } );
504 my $backend = Test::MockObject->new;
505 $backend->set_isa('Koha::Illbackends::Mock');
506 $backend->set_always('name', 'Mock');
508 my $patron = $builder->build({ source => 'Borrower' });
509 my $illrq = $builder->build_object({
510 class => 'Koha::Illrequests',
513 $illrq->_backend($backend);
515 isa_ok($illrq->_backend, 'Koha::Illbackends::Mock',
516 "OK accessing mocked backend.");
518 # _backend_capability tests:
519 # We need to test whether this optional feature of a mocked backend
520 # behaves as expected.
521 # 3 scenarios: feature not implemented, feature implemented, but requested
522 # capability is not provided by backend, & feature is implemented &
523 # capability exists. This method can be used to implement custom backend
524 # functionality, such as unmediated in the BLDSS backend (also see
526 $backend->set_always('capabilities', undef);
527 is($illrq->_backend_capability('Test'), 0,
528 "0 returned on Mock not implementing capabilities.");
530 $backend->set_always('capabilities', 0);
531 is($illrq->_backend_capability('Test'), 0,
532 "0 returned on Mock not implementing Test capability.");
534 $backend->set_always('capabilities', sub { return 'bar'; } );
535 is($illrq->_backend_capability('Test'), 'bar',
536 "'bar' returned on Mock implementing Test capability.");
538 # metadata test: we need to be sure that we return the arbitrary values
543 my ( $self, $rq ) = @_;
545 ID => $rq->illrequest_id,
546 Title => $rq->patron->borrowernumber
554 ID => $illrq->illrequest_id,
555 Title => $illrq->patron->borrowernumber
562 # No backend graph extension
563 $backend->set_always('status_graph', {});
564 is_deeply($illrq->capabilities('COMP'),
566 prev_actions => [ 'REQ' ],
569 ui_method_name => 'Mark completed',
570 method => 'mark_completed',
571 next_actions => [ 'CHK' ],
572 ui_method_icon => 'fa-check',
574 "Dummy status graph for COMP.");
575 is($illrq->capabilities('UNKNOWN'), undef,
576 "Dummy status graph for UNKNOWN.");
577 is_deeply($illrq->capabilities(),
578 $illrq->_core_status_graph,
579 "Dummy full status graph.");
580 # Simple backend graph extension
581 $backend->set_always('status_graph',
584 prev_actions => [ 'REQ' ],
586 next_actions => [ 'REQ' ],
589 is_deeply($illrq->capabilities('QER'),
591 prev_actions => [ 'REQ' ],
593 next_actions => [ 'REQ' ],
595 "Simple status graph for QER.");
596 is($illrq->capabilities('UNKNOWN'), undef,
597 "Simple status graph for UNKNOWN.");
598 is_deeply($illrq->capabilities(),
599 $illrq->_status_graph_union(
600 $illrq->_core_status_graph,
603 prev_actions => [ 'REQ' ],
605 next_actions => [ 'REQ' ],
609 "Simple full status graph.");
613 # No backend graph extension
614 $backend->set_always('status_graph', {});
615 is($illrq->custom_capability('unknown', {}), 0,
616 "Unknown candidate.");
618 # Simple backend graph extension
619 $backend->set_always('status_graph',
622 prev_actions => [ 'REQ' ],
624 method => 'identity',
625 next_actions => [ 'REQ' ],
628 $backend->mock('identity',
629 sub { my ( $self, $params ) = @_; return $params->{other}; });
630 is($illrq->custom_capability('identity', { test => 1, method => 'blah' })->{test}, 1,
631 "Resolve identity custom_capability");
633 $schema->storage->txn_rollback;
637 subtest 'Backend core methods' => sub {
641 $schema->storage->txn_begin;
643 # Build infrastructure
644 my $backend = Test::MockObject->new;
645 $backend->set_isa('Koha::Illbackends::Mock');
646 $backend->set_always('name', 'Mock');
647 $backend->mock('capabilities', sub { return 'Mock'; });
649 my $config = Test::MockObject->new;
650 $config->set_always('backend_dir', "/tmp");
651 $config->set_always('getLimitRules',
652 { default => { count => 0, method => 'active' } });
654 my $illrq = $builder->build_object({
655 class => 'Koha::Illrequests',
656 value => { backend => undef }
658 $illrq->_config($config);
660 # Test error conditions (no backend)
661 throws_ok { $illrq->load_backend; }
662 'Koha::Exceptions::Ill::InvalidBackendId',
663 'Exception raised correctly';
665 throws_ok { $illrq->load_backend(''); }
666 'Koha::Exceptions::Ill::InvalidBackendId',
667 'Exception raised correctly';
669 # Now load the mocked backend
670 $illrq->_backend($backend);
673 is_deeply($illrq->expandTemplate({ test => 1, method => "bar" }),
677 template => "/tmp/Mock/intra-includes/bar.inc",
678 opac_template => "/tmp/Mock/opac-includes/bar.inc",
683 # we are testing simple cases.
684 $backend->set_series('create',
685 { stage => 'bar', method => 'create' },
686 { stage => 'commit', method => 'create' },
687 { stage => 'commit', method => 'create' },
688 { stage => 'commit', method => 'create' },
689 { stage => 'commit', method => 'create' });
691 is_deeply($illrq->backend_create({test => 1}),
693 stage => 'bar', method => 'create',
694 template => "/tmp/Mock/intra-includes/create.inc",
695 opac_template => "/tmp/Mock/opac-includes/create.inc",
697 "Backend create: arbitrary stage.");
699 is_deeply($illrq->backend_create({test => 1}),
701 stage => 'commit', method => 'create', permitted => 0,
702 template => "/tmp/Mock/intra-includes/create.inc",
703 opac_template => "/tmp/Mock/opac-includes/create.inc",
705 "Backend create: arbitrary stage, not permitted.");
706 is($illrq->status, "QUEUED", "Backend create: queued if restricted.");
707 $config->set_always('getLimitRules', {});
708 $illrq->status('NEW');
709 is_deeply($illrq->backend_create({test => 1}),
711 stage => 'commit', method => 'create', permitted => 1,
712 template => "/tmp/Mock/intra-includes/create.inc",
713 opac_template => "/tmp/Mock/opac-includes/create.inc",
715 "Backend create: arbitrary stage, permitted.");
716 is($illrq->status, "NEW", "Backend create: not-queued.");
718 # Test that enabling the unmediated workflow causes the backend's
719 # 'unmediated_ill' method to be called
720 t::lib::Mocks::mock_preference('ILLModuleUnmediated', '1');
724 my ($self, $name) = @_;
725 if ($name eq 'unmediated_ill') {
727 return { unmediated_ill => 1 };
732 $illrq->status('NEW');
734 $illrq->backend_create({test => 1}),
736 'opac_template' => '/tmp/Mock/opac-includes/.inc',
737 'template' => '/tmp/Mock/intra-includes/.inc',
738 'unmediated_ill' => 1
740 "Backend create: commit stage, permitted, ILLModuleUnmediated enabled."
743 # Test that disabling the unmediated workflow causes the backend's
744 # 'unmediated_ill' method to be NOT called
745 t::lib::Mocks::mock_preference('ILLModuleUnmediated', '0');
746 $illrq->status('NEW');
748 $illrq->backend_create({test => 1}),
750 stage => 'commit', method => 'create', permitted => 1,
751 template => "/tmp/Mock/intra-includes/create.inc",
752 opac_template => "/tmp/Mock/opac-includes/create.inc",
754 "Backend create: commit stage, permitted, ILLModuleUnmediated disabled."
758 $backend->set_series('renew', { stage => 'bar', method => 'renew' });
759 is_deeply($illrq->backend_renew({test => 1}),
761 stage => 'bar', method => 'renew',
762 template => "/tmp/Mock/intra-includes/renew.inc",
763 opac_template => "/tmp/Mock/opac-includes/renew.inc",
765 "Backend renew: arbitrary stage.");
768 $backend->set_series('cancel', { stage => 'bar', method => 'cancel' });
769 is_deeply($illrq->backend_cancel({test => 1}),
771 stage => 'bar', method => 'cancel',
772 template => "/tmp/Mock/intra-includes/cancel.inc",
773 opac_template => "/tmp/Mock/opac-includes/cancel.inc",
775 "Backend cancel: arbitrary stage.");
777 # backend_update_status
778 $backend->set_series('update_status', { stage => 'bar', method => 'update_status' });
779 is_deeply($illrq->backend_update_status({test => 1}),
781 stage => 'bar', method => 'update_status',
782 template => "/tmp/Mock/intra-includes/update_status.inc",
783 opac_template => "/tmp/Mock/opac-includes/update_status.inc",
785 "Backend update_status: arbitrary stage.");
788 $backend->set_series('confirm', { stage => 'bar', method => 'confirm' });
789 is_deeply($illrq->backend_confirm({test => 1}),
791 stage => 'bar', method => 'confirm',
792 template => "/tmp/Mock/intra-includes/confirm.inc",
793 opac_template => "/tmp/Mock/opac-includes/confirm.inc",
795 "Backend confirm: arbitrary stage.");
797 $config->set_always('partner_code', "ILLTSTLIB");
798 $backend->set_always('metadata', { Test => "Foobar" });
799 my $illbrn = $builder->build({
801 value => { branchemail => "", branchreplyto => "" }
803 my $partner1 = $builder->build({
804 source => 'Borrower',
805 value => { categorycode => "ILLTSTLIB" },
807 my $partner2 = $builder->build({
808 source => 'Borrower',
809 value => { categorycode => "ILLTSTLIB" },
811 my $gen_conf = $illrq->generic_confirm({
812 current_branchcode => $illbrn->{branchcode}
814 isnt(index($gen_conf->{value}->{draft}->{body}, $backend->metadata->{Test}), -1,
815 "Generic confirm: draft contains metadata."
817 is($gen_conf->{value}->{partners}->next->borrowernumber, $partner1->{borrowernumber},
818 "Generic cofnirm: partner 1 is correct."
820 is($gen_conf->{value}->{partners}->next->borrowernumber, $partner2->{borrowernumber},
821 "Generic confirm: partner 2 is correct."
824 dies_ok { $illrq->generic_confirm({
825 current_branchcode => $illbrn->{branchcode},
828 "Generic confirm: missing to dies OK.";
830 $schema->storage->txn_rollback;
834 subtest 'Helpers' => sub {
838 $schema->storage->txn_begin;
840 # Build infrastructure
841 my $backend = Test::MockObject->new;
842 $backend->set_isa('Koha::Illbackends::Mock');
843 $backend->set_always('name', 'Mock');
847 my ( $self, $rq ) = @_;
855 my $config = Test::MockObject->new;
856 $config->set_always('backend_dir', "/tmp");
858 my $patron = $builder->build({
859 source => 'Borrower',
860 value => { categorycode => "A" }
862 # Create a mocked branch with no email addressed defined
863 my $illbrn = $builder->build({
868 branchillemail => "",
872 my $illrq = $builder->build({
873 source => 'Illrequest',
874 value => { branchcode => "HDE", borrowernumber => $patron->{borrowernumber} }
876 my $illrq_obj = Koha::Illrequests->find($illrq->{illrequest_id});
877 $illrq_obj->_config($config);
878 $illrq_obj->_backend($backend);
881 $config->set_series('getPrefixes',
882 { HDE => "TEST", TSL => "BAR", default => "DEFAULT" },
883 { A => "ATEST", C => "CBAR", default => "DEFAULT" });
884 is($illrq_obj->getPrefix({ brw_cat => "UNKNOWN", branch => "HDE" }), "TEST",
885 "getPrefix: branch");
886 $config->set_series('getPrefixes',
887 { HDE => "TEST", TSL => "BAR", default => "DEFAULT" },
888 { A => "ATEST", C => "CBAR", default => "DEFAULT" });
889 is($illrq_obj->getPrefix({ branch => "UNKNOWN" }), "",
890 "getPrefix: default");
891 $config->set_always('getPrefixes', {});
892 is($illrq_obj->getPrefix({ branch => "UNKNOWN" }), "",
893 "getPrefix: the empty prefix");
896 $config->set_series('getPrefixes',
897 { HDE => "TEST", TSL => "BAR", default => "DEFAULT" },
898 { AB => "ATEST", CD => "CBAR", default => "DEFAULT" });
899 is($illrq_obj->id_prefix, "TEST-", "id_prefix: branch");
900 $config->set_series('getPrefixes',
901 { HDET => "TEST", TSLT => "BAR", default => "DEFAULT" },
902 { AB => "ATEST", CD => "CBAR", default => "DEFAULT" });
903 is($illrq_obj->id_prefix, "", "id_prefix: default");
905 # requires_moderation
906 $illrq_obj->status('NEW')->store;
907 is($illrq_obj->requires_moderation, undef, "requires_moderation: No.");
908 $illrq_obj->status('CANCREQ')->store;
909 is($illrq_obj->requires_moderation, 'CANCREQ', "requires_moderation: Yes.");
912 my $attr = Koha::MessageAttributes->find({ message_name => 'Ill_ready' });
913 C4::Members::Messaging::SetMessagingPreference({
914 borrowernumber => $patron->{borrowernumber},
915 message_attribute_id => $attr->message_attribute_id,
916 message_transport_types => ['email']
918 my $return_patron = $illrq_obj->send_patron_notice('ILL_PICKUP_READY');
919 my $notice = $schema->resultset('MessageQueue')->search({
920 letter_code => 'ILL_PICKUP_READY',
921 message_transport_type => 'email',
922 borrowernumber => $illrq_obj->borrowernumber
923 })->next()->letter_code;
926 { result => { success => ['email'], fail => [] } },
927 "Correct return when notice created"
929 is($notice, 'ILL_PICKUP_READY' ,"Notice is correctly created");
931 my $return_patron_fail = $illrq_obj->send_patron_notice();
934 { error => 'notice_no_type' },
935 "Correct error when missing type"
939 # Specify that no staff notices should be send
940 t::lib::Mocks::mock_preference('ILLSendStaffNotices', '');
941 my $return_staff_cancel_fail =
942 $illrq_obj->send_staff_notice('ILL_REQUEST_CANCEL');
944 $return_staff_cancel_fail,
945 { error => 'notice_not_enabled' },
946 "Does not send notices that are not enabled"
948 my $queue = $schema->resultset('MessageQueue')->search({
949 letter_code => 'ILL_REQUEST_CANCEL'
951 is($queue->count, 0, "Notice is not queued");
953 # Specify that the cancel notice can be sent
954 t::lib::Mocks::mock_preference('ILLSendStaffNotices', 'ILL_REQUEST_CANCEL');
955 my $return_staff_cancel = $illrq_obj->send_staff_notice(
959 $return_staff_cancel,
960 { success => 'notice_queued' },
961 "Correct return when staff notice created"
963 $queue = $schema->resultset('MessageQueue')->search({
964 letter_code => 'ILL_REQUEST_CANCEL'
966 is($queue->count, 1, "Notice queued as expected");
968 my $return_staff_fail = $illrq_obj->send_staff_notice();
971 { error => 'notice_no_type' },
972 "Correct error when missing type"
974 $queue = $schema->resultset('MessageQueue')->search({
975 letter_code => 'ILL_REQUEST_CANCEL'
977 is($queue->count, 1, "Notice is not queued");
980 my $not = $illrq_obj->get_notice({
981 notice_code => 'ILL_REQUEST_CANCEL',
985 # We test the properties of the hashref separately because the random
986 # hash ordering of the metadata means we can't test the entire thing
989 $not->{module} eq 'ill',
990 'Correct module return from get_notice'
993 $not->{name} eq 'ILL request cancelled',
994 'Correct name return from get_notice'
997 $not->{message_transport_type} eq 'email',
998 'Correct message_transport_type return from get_notice'
1001 $not->{title} eq 'Interlibrary loan request cancelled',
1002 'Correct title return from get_notice'
1004 $not->{content} =~ s/\s//g;
1007 $not->{content},"Thepatronforinterlibraryloansrequest" . $illrq_obj->id . ",withthefollowingdetails,hasrequestedcancellationofthisILLrequest:-author:myauthor-title:mytitle",
1008 'Correct content returned from get_notice with metadata correctly ordered'
1011 $schema->storage->txn_rollback;
1015 subtest 'Censorship' => sub {
1019 $schema->storage->txn_begin;
1021 # Build infrastructure
1022 my $backend = Test::MockObject->new;
1023 $backend->set_isa('Koha::Illbackends::Mock');
1024 $backend->set_always('name', 'Mock');
1026 my $config = Test::MockObject->new;
1027 $config->set_always('backend_dir', "/tmp");
1029 my $illrq = $builder->build({source => 'Illrequest'});
1030 my $illrq_obj = Koha::Illrequests->find($illrq->{illrequest_id});
1031 $illrq_obj->_config($config);
1032 $illrq_obj->_backend($backend);
1034 $config->set_always('censorship', { censor_notes_staff => 1, censor_reply_date => 0 });
1036 my $censor_out = $illrq_obj->_censor({ foo => 'bar', baz => 564 });
1037 is_deeply($censor_out, { foo => 'bar', baz => 564, display_reply_date => 1 },
1038 "_censor: not OPAC, reply_date = 1");
1040 $censor_out = $illrq_obj->_censor({ foo => 'bar', baz => 564, opac => 1 });
1041 is_deeply($censor_out, {
1042 foo => 'bar', baz => 564, censor_notes_staff => 1,
1043 display_reply_date => 1, opac => 1
1044 }, "_censor: notes_staff = 0, reply_date = 0");
1046 $schema->storage->txn_rollback;
1049 subtest 'Checking out' => sub {
1053 $schema->storage->txn_begin;
1055 my $itemtype = $builder->build_object({
1056 class => 'Koha::ItemTypes',
1061 my $library = $builder->build_object({ class => 'Koha::Libraries' });
1062 my $biblio = $builder->build_sample_biblio();
1063 my $patron = $builder->build_object({
1064 class => 'Koha::Patrons',
1065 value => { category_type => 'x' }
1067 my $request = $builder->build_object({
1068 class => 'Koha::Illrequests',
1070 borrowernumber => $patron->borrowernumber,
1071 biblio_id => $biblio->biblionumber
1075 # First test that calling check_out without a stage param returns
1076 # what's required to build the form
1077 my $no_stage = $request->check_out();
1078 is($no_stage->{method}, 'check_out');
1079 is($no_stage->{stage}, 'form');
1080 isa_ok($no_stage->{value}, 'HASH');
1081 isa_ok($no_stage->{value}->{itemtypes}, 'Koha::ItemTypes');
1082 isa_ok($no_stage->{value}->{libraries}, 'Koha::Libraries');
1083 isa_ok($no_stage->{value}->{statistical}, 'Koha::Patrons');
1084 isa_ok($no_stage->{value}->{biblio}, 'Koha::Biblio');
1086 # Now test that form validation works when we supply a 'form' stage
1089 my $form_stage_missing_params = $request->check_out({
1092 is_deeply($form_stage_missing_params->{value}->{errors}, {
1095 # inhouse passed but not a valid patron
1096 my $form_stage_bad_patron = $request->check_out({
1098 item_type => $itemtype->itemtype,
1099 inhouse => 'I_DONT_EXIST'
1101 is_deeply($form_stage_bad_patron->{value}->{errors}, {
1104 # Too many items attached to biblio
1105 my $item1 = $builder->build_sample_item({ biblionumber => $biblio->biblionumber });
1106 my $item2 = $builder->build_sample_item({ biblionumber => $biblio->biblionumber });
1107 my $form_stage_two_items = $request->check_out({
1109 item_type => $itemtype->itemtype,
1111 is_deeply($form_stage_two_items->{value}->{errors}, {
1115 # Delete the items we created, so we can test that we can create one
1119 # We need to mock the user environment for AddIssue
1120 t::lib::Mocks::mock_userenv({ branchcode => $library->branchcode });
1123 # First we pass bad parameters to the item creation to test we're
1124 # catching the failure of item creation
1125 my $form_stage_bad_branchcode;
1127 $form_stage_bad_branchcode = $request->check_out({
1129 item_type => $itemtype->itemtype,
1132 } qr/DBD::mysql::st execute failed: Cannot add or update a child row: a foreign key constraint fails/,
1133 "Item creation fails on bad parameters";
1135 is_deeply($form_stage_bad_branchcode->{value}->{errors}, {
1137 },"We get expected failure of item creation");
1139 # Now create a proper item
1140 my $form_stage_good_branchcode = $request->check_out({
1142 item_type => $itemtype->itemtype,
1143 branchcode => $library->branchcode
1145 # By default, this item should not be loanable, so check that we're
1146 # informed of that fact
1148 $form_stage_good_branchcode->{value}->{check_out_errors},
1152 itemtype_notforloan => $itemtype->itemtype
1155 "We get expected error on notforloan of item"
1157 # Delete the item that was created
1158 $biblio->items->delete;
1159 # Now create an itemtype that is loanable
1160 my $itemtype_loanable = $builder->build_object({
1161 class => 'Koha::ItemTypes',
1166 # We need to mock the user environment for AddIssue
1167 t::lib::Mocks::mock_userenv({ branchcode => $library->branchcode });
1168 my $form_stage_loanable = $request->check_out({
1170 item_type => $itemtype_loanable->itemtype,
1171 branchcode => $library->branchcode
1173 is($form_stage_loanable->{stage}, 'done_check_out');
1174 isa_ok($patron->checkouts, 'Koha::Checkouts');
1175 is($patron->checkouts->count, 1);
1176 is($request->status, 'CHK');
1178 $schema->storage->txn_rollback;
1181 subtest 'Checking out with custom due date' => sub {
1183 $schema->storage->txn_begin;
1185 my $library = $builder->build_object({ class => 'Koha::Libraries' });
1186 my $patron = $builder->build_object({
1187 class => 'Koha::Patrons',
1188 value => { category_type => 'x' }
1190 my $biblio = $builder->build_sample_biblio();
1191 my $itemtype_loanable = $builder->build_object({
1192 class => 'Koha::ItemTypes',
1197 my $request = $builder->build_object({
1198 class => 'Koha::Illrequests',
1200 borrowernumber => $patron->borrowernumber,
1201 biblio_id => $biblio->biblionumber
1205 t::lib::Mocks::mock_userenv({ branchcode => $library->branchcode });
1206 my $duedate = '2099-05-21 00:00:00';
1207 my $form_stage_loanable = $request->check_out({
1209 item_type => $itemtype_loanable->itemtype,
1210 branchcode => $library->branchcode,
1213 is($patron->checkouts->next->date_due, $duedate, "Custom due date was used");
1215 $schema->storage->txn_rollback;
1218 subtest 'Checking Limits' => sub {
1222 $schema->storage->txn_begin;
1224 # Build infrastructure
1225 my $backend = Test::MockObject->new;
1226 $backend->set_isa('Koha::Illbackends::Mock');
1227 $backend->set_always('name', 'Mock');
1229 my $config = Test::MockObject->new;
1230 $config->set_always('backend_dir', "/tmp");
1232 my $illrq = $builder->build({source => 'Illrequest'});
1233 my $illrq_obj = Koha::Illrequests->find($illrq->{illrequest_id});
1234 $illrq_obj->_config($config);
1235 $illrq_obj->_backend($backend);
1238 $config->set_series('getLimitRules',
1239 { CPL => { count => 1, method => 'test' } },
1240 { default => { count => 0, method => 'active' } });
1241 is_deeply($illrq_obj->getLimits({ type => 'branch', value => "CPL" }),
1242 { count => 1, method => 'test' },
1243 "getLimits: by value.");
1244 is_deeply($illrq_obj->getLimits({ type => 'branch' }),
1245 { count => 0, method => 'active' },
1246 "getLimits: by default.");
1247 is_deeply($illrq_obj->getLimits({ type => 'branch', value => "CPL" }),
1248 { count => -1, method => 'active' },
1249 "getLimits: by hard-coded.");
1252 is($illrq_obj->_limit_counter('annual', { branchcode => $illrq_obj->branchcode }),
1253 1, "_limit_counter: Initial branch annual count.");
1254 is($illrq_obj->_limit_counter('active', { branchcode => $illrq_obj->branchcode }),
1255 1, "_limit_counter: Initial branch active count.");
1256 is($illrq_obj->_limit_counter('annual', { borrowernumber => $illrq_obj->borrowernumber }),
1257 1, "_limit_counter: Initial patron annual count.");
1258 is($illrq_obj->_limit_counter('active', { borrowernumber => $illrq_obj->borrowernumber }),
1259 1, "_limit_counter: Initial patron active count.");
1261 source => 'Illrequest',
1263 branchcode => $illrq_obj->branchcode,
1264 borrowernumber => $illrq_obj->borrowernumber,
1267 is($illrq_obj->_limit_counter('annual', { branchcode => $illrq_obj->branchcode }),
1268 2, "_limit_counter: Add a qualifying request for branch annual count.");
1269 is($illrq_obj->_limit_counter('active', { branchcode => $illrq_obj->branchcode }),
1270 2, "_limit_counter: Add a qualifying request for branch active count.");
1271 is($illrq_obj->_limit_counter('annual', { borrowernumber => $illrq_obj->borrowernumber }),
1272 2, "_limit_counter: Add a qualifying request for patron annual count.");
1273 is($illrq_obj->_limit_counter('active', { borrowernumber => $illrq_obj->borrowernumber }),
1274 2, "_limit_counter: Add a qualifying request for patron active count.");
1276 source => 'Illrequest',
1278 branchcode => $illrq_obj->branchcode,
1279 borrowernumber => $illrq_obj->borrowernumber,
1280 placed => "2005-05-31",
1283 is($illrq_obj->_limit_counter('annual', { branchcode => $illrq_obj->branchcode }),
1284 2, "_limit_counter: Add an out-of-date branch request.");
1285 is($illrq_obj->_limit_counter('active', { branchcode => $illrq_obj->branchcode }),
1286 3, "_limit_counter: Add a qualifying request for branch active count.");
1287 is($illrq_obj->_limit_counter('annual', { borrowernumber => $illrq_obj->borrowernumber }),
1288 2, "_limit_counter: Add an out-of-date patron request.");
1289 is($illrq_obj->_limit_counter('active', { borrowernumber => $illrq_obj->borrowernumber }),
1290 3, "_limit_counter: Add a qualifying request for patron active count.");
1292 source => 'Illrequest',
1294 branchcode => $illrq_obj->branchcode,
1295 borrowernumber => $illrq_obj->borrowernumber,
1299 is($illrq_obj->_limit_counter('annual', { branchcode => $illrq_obj->branchcode }),
1300 3, "_limit_counter: Add a qualifying request for branch annual count.");
1301 is($illrq_obj->_limit_counter('active', { branchcode => $illrq_obj->branchcode }),
1302 3, "_limit_counter: Add a completed request for branch active count.");
1303 is($illrq_obj->_limit_counter('annual', { borrowernumber => $illrq_obj->borrowernumber }),
1304 3, "_limit_counter: Add a qualifying request for patron annual count.");
1305 is($illrq_obj->_limit_counter('active', { borrowernumber => $illrq_obj->borrowernumber }),
1306 3, "_limit_counter: Add a completed request for patron active count.");
1310 # We've tested _limit_counter, so all we need to test here is whether the
1311 # current counts of 3 for each work as they should against different
1312 # configuration declarations.
1315 $config->set_always('getLimitRules', undef);
1316 is($illrq_obj->check_limits({patron => $illrq_obj->patron,
1317 librarycode => $illrq_obj->branchcode}),
1318 1, "check_limits: no configuration => no limits.");
1321 $config->set_always('getLimitRules',
1322 { $illrq_obj->branchcode => { count => 1, method => 'active' } });
1323 is($illrq_obj->check_limits({patron => $illrq_obj->patron,
1324 librarycode => $illrq_obj->branchcode}),
1325 0, "check_limits: branch active limit exceeded.");
1326 $config->set_always('getLimitRules',
1327 { $illrq_obj->branchcode => { count => 1, method => 'annual' } });
1328 is($illrq_obj->check_limits({patron => $illrq_obj->patron,
1329 librarycode => $illrq_obj->branchcode}),
1330 0, "check_limits: branch annual limit exceeded.");
1331 $config->set_always('getLimitRules',
1332 { $illrq_obj->branchcode => { count => 4, method => 'active' } });
1333 is($illrq_obj->check_limits({patron => $illrq_obj->patron,
1334 librarycode => $illrq_obj->branchcode}),
1335 1, "check_limits: branch active limit OK.");
1336 $config->set_always('getLimitRules',
1337 { $illrq_obj->branchcode => { count => 4, method => 'annual' } });
1338 is($illrq_obj->check_limits({patron => $illrq_obj->patron,
1339 librarycode => $illrq_obj->branchcode}),
1340 1, "check_limits: branch annual limit OK.");
1343 $config->set_always('getLimitRules',
1344 { $illrq_obj->patron->categorycode => { count => 1, method => 'active' } });
1345 is($illrq_obj->check_limits({patron => $illrq_obj->patron,
1346 librarycode => $illrq_obj->branchcode}),
1347 0, "check_limits: patron category active limit exceeded.");
1348 $config->set_always('getLimitRules',
1349 { $illrq_obj->patron->categorycode => { count => 1, method => 'annual' } });
1350 is($illrq_obj->check_limits({patron => $illrq_obj->patron,
1351 librarycode => $illrq_obj->branchcode}),
1352 0, "check_limits: patron category annual limit exceeded.");
1353 $config->set_always('getLimitRules',
1354 { $illrq_obj->patron->categorycode => { count => 4, method => 'active' } });
1355 is($illrq_obj->check_limits({patron => $illrq_obj->patron,
1356 librarycode => $illrq_obj->branchcode}),
1357 1, "check_limits: patron category active limit OK.");
1358 $config->set_always('getLimitRules',
1359 { $illrq_obj->patron->categorycode => { count => 4, method => 'annual' } });
1360 is($illrq_obj->check_limits({patron => $illrq_obj->patron,
1361 librarycode => $illrq_obj->branchcode}),
1362 1, "check_limits: patron category annual limit OK.");
1364 # One rule cancels the other
1365 $config->set_series('getLimitRules',
1366 # Branch rules allow request
1367 { $illrq_obj->branchcode => { count => 4, method => 'active' } },
1368 # Patron rule forbids it
1369 { $illrq_obj->patron->categorycode => { count => 1, method => 'annual' } });
1370 is($illrq_obj->check_limits({patron => $illrq_obj->patron,
1371 librarycode => $illrq_obj->branchcode}),
1372 0, "check_limits: patron category veto overrides branch OK.");
1373 $config->set_series('getLimitRules',
1374 # Branch rules allow request
1375 { $illrq_obj->branchcode => { count => 1, method => 'active' } },
1376 # Patron rule forbids it
1377 { $illrq_obj->patron->categorycode => { count => 4, method => 'annual' } });
1378 is($illrq_obj->check_limits({patron => $illrq_obj->patron,
1379 librarycode => $illrq_obj->branchcode}),
1380 0, "check_limits: branch veto overrides patron category OK.");
1382 $schema->storage->txn_rollback;
1385 subtest 'Custom statuses' => sub {
1389 $schema->storage->txn_begin;
1391 my $cat = Koha::AuthorisedValueCategories->search(
1393 category_name => 'ILLSTATUS'
1397 if ($cat->count == 0) {
1398 $cat = $builder->build_object(
1400 class => 'Koha::AuthorisedValueCategory',
1402 category_name => 'ILLSTATUS'
1408 my $av = $builder->build_object(
1410 class => 'Koha::AuthorisedValues',
1412 category => 'ILLSTATUS'
1417 is($av->category, 'ILLSTATUS',
1418 "Successfully created authorised value for custom status");
1420 my $ill_req = $builder->build_object(
1422 class => 'Koha::Illrequests',
1424 status_alias => $av->authorised_value
1428 isa_ok($ill_req->statusalias, 'Koha::AuthorisedValue',
1429 "statusalias correctly returning Koha::AuthorisedValue object");
1431 $ill_req->status("COMP");
1432 is($ill_req->statusalias, undef,
1433 "Koha::Illrequest->status overloading resetting status_alias");
1435 $schema->storage->txn_rollback;
1438 subtest 'Checking in hook' => sub {
1442 $schema->storage->txn_begin;
1444 # Build infrastructure
1445 my $backend = Test::MockObject->new;
1446 $backend->set_isa('Koha::Illbackends::Mock');
1447 $backend->set_always('name', 'Mock');
1449 my $config = Test::MockObject->new;
1450 $config->set_always('backend_dir', "/tmp");
1452 my $item = $builder->build_sample_item();
1453 my $patron = $builder->build_object({ class => 'Koha::Patrons' });
1455 t::lib::Mocks::mock_userenv(
1458 branchcode => $patron->branchcode
1462 my $illrq = $builder->build_object(
1464 class => 'Koha::Illrequests',
1466 biblio_id => $item->biblio->biblionumber,
1472 $illrq->_config($config);
1473 $illrq->_backend($backend);
1475 t::lib::Mocks::mock_preference('CirculateILL', 1);
1478 AddIssue( $patron->unblessed, $item->barcode );
1479 # Make the item withdrawn so checking-in is rejected
1480 t::lib::Mocks::mock_preference('BlockReturnOfWithdrawnItems', 1);
1481 $item->set({ withdrawn => 1 })->store;
1482 AddReturn( $item->barcode, $patron->branchcode );
1484 $illrq->discard_changes;
1485 isnt( $illrq->status, 'RET' );
1487 # allow the check-in
1488 $item->set({ withdrawn => 0 })->store;
1489 AddReturn( $item->barcode, $patron->branchcode );
1491 $illrq->discard_changes;
1492 is( $illrq->status, 'RET' );
1494 $schema->storage->txn_rollback;