3 # Tests for SIP::Sip::MsgType
4 # Please help to extend it!
6 # This file is part of Koha.
8 # Copyright 2016 Rijksmuseum
10 # Koha is free software; you can redistribute it and/or modify it
11 # under the terms of the GNU General Public License as published by
12 # the Free Software Foundation; either version 3 of the License, or
13 # (at your option) any later version.
15 # Koha is distributed in the hope that it will be useful, but
16 # WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 # GNU General Public License for more details.
20 # You should have received a copy of the GNU General Public License
21 # along with Koha; if not, see <http://www.gnu.org/licenses>.
24 use Test::More tests => 4;
30 use t::lib::TestBuilder;
33 use Koha::AuthUtils qw(hash_password);
37 use Koha::Old::Checkouts;
41 use C4::SIP::ILS::Patron;
42 use C4::SIP::Sip qw(write_msg);
43 use C4::SIP::Sip::Constants qw(:all);
44 use C4::SIP::Sip::MsgType;
46 use constant PATRON_PW => 'do_not_ever_use_this_one';
49 subtest 'Testing Patron Status Request V2' => sub {
50 my $schema = Koha::Database->new->schema;
51 $schema->storage->txn_begin;
53 $C4::SIP::Sip::protocol_version = 2;
54 test_request_patron_status_v2();
55 $schema->storage->txn_rollback;
58 subtest 'Testing Patron Info Request V2' => sub {
59 my $schema = Koha::Database->new->schema;
60 $schema->storage->txn_begin;
62 $C4::SIP::Sip::protocol_version = 2;
63 test_request_patron_info_v2();
64 $schema->storage->txn_rollback;
67 subtest 'Checkin V2' => sub {
68 my $schema = Koha::Database->new->schema;
69 $schema->storage->txn_begin;
71 $C4::SIP::Sip::protocol_version = 2;
73 $schema->storage->txn_rollback;
76 subtest 'Lastseen response' => sub {
78 my $schema = Koha::Database->new->schema;
79 $schema->storage->txn_begin;
82 my $builder = t::lib::TestBuilder->new();
83 my $branchcode = $builder->build({ source => 'Branch' })->{branchcode};
84 my ( $response, $findpatron );
85 my $mocks = create_mocks( \$response, \$findpatron, \$branchcode );
86 my $seen_patron = $builder->build({
89 lastseen => '2001-01-01',
90 password => hash_password( PATRON_PW ),
91 branchcode => $branchcode,
94 my $cardnum = $seen_patron->{cardnumber};
95 my $sip_patron = C4::SIP::ILS::Patron->new( $cardnum );
96 $findpatron = $sip_patron;
98 my $siprequest = PATRON_INFO. 'engYYYYMMDDZZZZHHMMSS'.'Y '.
99 FID_INST_ID. $branchcode. '|'.
100 FID_PATRON_ID. $cardnum. '|'.
101 FID_PATRON_PWD. PATRON_PW. '|';
102 my $msg = C4::SIP::Sip::MsgType->new( $siprequest, 0 );
104 my $server = { ils => $mocks->{ils} };
106 t::lib::Mocks::mock_preference( 'TrackLastPatronActivity', '' );
107 $msg->handle_patron_info( $server );
109 isnt( $response, undef, 'At least we got a response.' );
110 my $respcode = substr( $response, 0, 2 );
111 is( $respcode, PATRON_INFO_RESP, 'Response code fine' );
112 $seen_patron = Koha::Patrons->find({ cardnumber => $seen_patron->{cardnumber} });
113 is( output_pref({str => $seen_patron->lastseen(), dateonly => 1}), output_pref({str => '2001-01-01', dateonly => 1}),'Last seen not updated if not tracking patrons');
115 t::lib::Mocks::mock_preference( 'TrackLastPatronActivity', '1' );
116 $msg->handle_patron_info( $server );
118 isnt( $response, undef, 'At least we got a response.' );
119 $respcode = substr( $response, 0, 2 );
120 is( $respcode, PATRON_INFO_RESP, 'Response code fine' );
121 $seen_patron = Koha::Patrons->find({ cardnumber => $seen_patron->cardnumber() });
122 is( output_pref({str => $seen_patron->lastseen(), dateonly => 1}), output_pref({dt => dt_from_string(), dateonly => 1}),'Last seen updated if tracking patrons');
123 $schema->storage->txn_rollback;
126 # Here is room for some more subtests
130 sub test_request_patron_status_v2 {
131 my $builder = t::lib::TestBuilder->new();
132 my $branchcode = $builder->build({ source => 'Branch' })->{branchcode};
133 my ( $response, $findpatron );
134 my $mocks = create_mocks( \$response, \$findpatron, \$branchcode );
136 my $patron1 = $builder->build({
137 source => 'Borrower',
139 password => hash_password( PATRON_PW ),
142 my $card1 = $patron1->{cardnumber};
143 my $sip_patron1 = C4::SIP::ILS::Patron->new( $card1 );
144 $findpatron = $sip_patron1;
146 my $siprequest = PATRON_STATUS_REQ. 'engYYYYMMDDZZZZHHMMSS'.
147 FID_INST_ID. $branchcode. '|'.
148 FID_PATRON_ID. $card1. '|'.
149 FID_PATRON_PWD. PATRON_PW. '|';
150 my $msg = C4::SIP::Sip::MsgType->new( $siprequest, 0 );
152 my $server = { ils => $mocks->{ils} };
154 $msg->handle_patron_status( $server );
156 isnt( $response, undef, 'At least we got a response.' );
157 my $respcode = substr( $response, 0, 2 );
158 is( $respcode, PATRON_STATUS_RESP, 'Response code fine' );
160 check_field( $respcode, $response, FID_INST_ID, $branchcode , 'Verified institution id' );
161 check_field( $respcode, $response, FID_PATRON_ID, $card1, 'Verified patron id' );
162 check_field( $respcode, $response, FID_PERSONAL_NAME, $patron1->{surname}, 'Verified patron name', 'contains' );
163 check_field( $respcode, $response, FID_VALID_PATRON, 'Y', 'Verified code BL' );
164 check_field( $respcode, $response, FID_VALID_PATRON_PWD, 'Y', 'Verified code CQ' );
165 check_field( $respcode, $response, FID_SCREEN_MSG, '.+', 'Verified non-empty screen message', 'regex' );
167 # Now, we pass a wrong password and verify CQ again
168 $siprequest = PATRON_STATUS_REQ. 'engYYYYMMDDZZZZHHMMSS'.
169 FID_INST_ID. $branchcode. '|'.
170 FID_PATRON_ID. $card1. '|'.
171 FID_PATRON_PWD. 'wrong_password'. '|';
172 $msg = C4::SIP::Sip::MsgType->new( $siprequest, 0 );
174 $msg->handle_patron_status( $server );
175 $respcode = substr( $response, 0, 2 );
176 check_field( $respcode, $response, FID_VALID_PATRON_PWD, 'N', 'Verified code CQ for wrong pw' );
178 # Check empty password and verify CQ again
179 $siprequest = PATRON_STATUS_REQ. 'engYYYYMMDDZZZZHHMMSS'.
180 FID_INST_ID. $branchcode. '|'.
181 FID_PATRON_ID. $card1. '|'.
183 $msg = C4::SIP::Sip::MsgType->new( $siprequest, 0 );
185 $msg->handle_patron_status( $server );
186 $respcode = substr( $response, 0, 2 );
187 check_field( $respcode, $response, FID_VALID_PATRON_PWD, 'N', 'code CQ should be N for empty AD' );
189 # Finally, we send a wrong card number and check AE, BL
190 # This is done by removing the new patron first
191 Koha::Patrons->search({ cardnumber => $card1 })->delete;
193 $siprequest = PATRON_STATUS_REQ. 'engYYYYMMDDZZZZHHMMSS'.
194 FID_INST_ID. $branchcode. '|'.
195 FID_PATRON_ID. $card1. '|'.
196 FID_PATRON_PWD. PATRON_PW. '|';
197 $msg = C4::SIP::Sip::MsgType->new( $siprequest, 0 );
199 $msg->handle_patron_status( $server );
200 $respcode = substr( $response, 0, 2 );
201 check_field( $respcode, $response, FID_VALID_PATRON, 'N', 'Verified code BL for wrong cardnumber' );
202 check_field( $respcode, $response, FID_PERSONAL_NAME, '', 'Name should be empty now' );
203 check_field( $respcode, $response, FID_SCREEN_MSG, '.+', 'But we have a screen msg', 'regex' );
206 sub test_request_patron_info_v2 {
207 my $builder = t::lib::TestBuilder->new();
208 my $branchcode = $builder->build({ source => 'Branch' })->{branchcode};
209 my ( $response, $findpatron );
210 my $mocks = create_mocks( \$response, \$findpatron, \$branchcode );
212 my $patron2 = $builder->build({
213 source => 'Borrower',
215 password => hash_password( PATRON_PW ),
218 my $card = $patron2->{cardnumber};
219 my $sip_patron2 = C4::SIP::ILS::Patron->new( $card );
220 $findpatron = $sip_patron2;
221 my $siprequest = PATRON_INFO. 'engYYYYMMDDZZZZHHMMSS'.'Y '.
222 FID_INST_ID. $branchcode. '|'.
223 FID_PATRON_ID. $card. '|'.
224 FID_PATRON_PWD. PATRON_PW. '|';
225 my $msg = C4::SIP::Sip::MsgType->new( $siprequest, 0 );
227 my $server = { ils => $mocks->{ils} };
229 $msg->handle_patron_info( $server );
230 isnt( $response, undef, 'At least we got a response.' );
231 my $respcode = substr( $response, 0, 2 );
232 is( $respcode, PATRON_INFO_RESP, 'Response code fine' );
234 check_field( $respcode, $response, FID_INST_ID, $branchcode , 'Verified institution id' );
235 check_field( $respcode, $response, FID_PATRON_ID, $card, 'Verified patron id' );
236 check_field( $respcode, $response, FID_PERSONAL_NAME, $patron2->{surname}, 'Verified patron name', 'contains' );
237 check_field( $respcode, $response, FID_VALID_PATRON, 'Y', 'Verified code BL' );
238 check_field( $respcode, $response, FID_VALID_PATRON_PWD, 'Y', 'Verified code CQ' );
239 check_field( $respcode, $response, FID_FEE_LMT, '.*', 'Checked existence of fee limit', 'regex' );
240 check_field( $respcode, $response, FID_HOME_ADDR, $patron2->{address}, 'Address in BD', 'contains' );
241 check_field( $respcode, $response, FID_EMAIL, $patron2->{email}, 'Verified email in BE' );
242 check_field( $respcode, $response, FID_HOME_PHONE, $patron2->{phone}, 'Verified home phone in BF' );
243 # No check for custom fields here (unofficial PB, PC and PI)
244 check_field( $respcode, $response, FID_SCREEN_MSG, '.+', 'We have a screen msg', 'regex' );
246 # Test customized patron name in AE with same sip request
247 # This implicitly tests C4::SIP::ILS::Patron->name
248 $server->{account}->{ae_field_template} = "X[% patron.surname %]Y";
249 $msg = C4::SIP::Sip::MsgType->new( $siprequest, 0 );
251 $msg->handle_patron_info( $server );
252 $respcode = substr( $response, 0, 2 );
253 check_field( $respcode, $response, FID_PERSONAL_NAME, 'X' . $patron2->{surname} . 'Y', 'Check customized patron name' );
256 $server->{account}->{hide_fields} = "BD,BE,BF,PB";
257 $msg->handle_patron_info( $server );
258 $respcode = substr( $response, 0, 2 );
259 check_field( $respcode, $response, FID_HOME_ADDR, undef, 'Home address successfully stripped from response' );
260 check_field( $respcode, $response, FID_EMAIL, undef, 'Email address successfully stripped from response' );
261 check_field( $respcode, $response, FID_HOME_PHONE, undef, 'Home phone successfully stripped from response' );
262 check_field( $respcode, $response, FID_PATRON_BIRTHDATE, undef, 'Date of birth successfully stripped from response' );
263 $server->{account}->{hide_fields} = "";
265 # Check empty password and verify CQ again
266 $siprequest = PATRON_INFO. 'engYYYYMMDDZZZZHHMMSS'.'Y '.
267 FID_INST_ID. $branchcode. '|'.
268 FID_PATRON_ID. $card. '|'.
270 $msg = C4::SIP::Sip::MsgType->new( $siprequest, 0 );
272 $msg->handle_patron_info( $server );
273 $respcode = substr( $response, 0, 2 );
274 check_field( $respcode, $response, FID_VALID_PATRON_PWD, 'N', 'code CQ should be N for empty AD' );
275 # Test empty password is OK if account configured to allow
276 $server->{account}->{allow_empty_passwords} = 1;
277 $msg = C4::SIP::Sip::MsgType->new( $siprequest, 0 );
279 $msg->handle_patron_info( $server );
280 $respcode = substr( $response, 0, 2 );
281 check_field( $respcode, $response, FID_VALID_PATRON_PWD, 'Y', 'code CQ should be Y if empty AD allowed' );
283 t::lib::Mocks::mock_preference( 'FailedLoginAttempts', '1' );
284 my $patron = Koha::Patrons->find({ cardnumber => $card });
285 $patron->update({ login_attempts => 0 });
286 is( $patron->account_locked, 0, "Patron account not locked already" );
287 $msg->handle_patron_info( $server );
288 $patron = Koha::Patrons->find({ cardnumber => $card });
289 is( $patron->account_locked, 0, "Patron account is not locked by patron info messages with empty password" );
291 # Finally, we send a wrong card number
292 Koha::Patrons->search({ cardnumber => $card })->delete;
294 $msg = C4::SIP::Sip::MsgType->new( $siprequest, 0 );
296 $msg->handle_patron_info( $server );
297 $respcode = substr( $response, 0, 2 );
298 check_field( $respcode, $response, FID_VALID_PATRON, 'N', 'Verified code BL for wrong cardnumber' );
299 check_field( $respcode, $response, FID_PERSONAL_NAME, '', 'Name should be empty now' );
300 check_field( $respcode, $response, FID_SCREEN_MSG, '.+', 'But we have a screen msg', 'regex' );
303 sub test_checkin_v2 {
304 my $builder = t::lib::TestBuilder->new();
305 my $branchcode = $builder->build({ source => 'Branch' })->{branchcode};
306 my ( $response, $findpatron );
307 my $mocks = create_mocks( \$response, \$findpatron, \$branchcode );
310 my $patron1 = $builder->build({
311 source => 'Borrower',
313 password => hash_password( PATRON_PW ),
316 my $card1 = $patron1->{cardnumber};
317 my $sip_patron1 = C4::SIP::ILS::Patron->new( $card1 );
318 $findpatron = $sip_patron1;
319 my $item = $builder->build({
321 value => { damaged => 0, withdrawn => 0, itemlost => 0, restricted => 0, homebranch => $branchcode, holdingbranch => $branchcode },
324 my $mockILS = $mocks->{ils};
325 my $server = { ils => $mockILS, account => {} };
326 $mockILS->mock( 'institution', sub { $branchcode; } );
327 $mockILS->mock( 'supports', sub { return; } );
328 $mockILS->mock( 'checkin', sub {
330 return C4::SIP::ILS->checkin(@_);
332 my $today = dt_from_string;
334 # Checkin invalid barcode
335 Koha::Items->search({ barcode => 'not_to_be_found' })->delete;
336 my $siprequest = CHECKIN . 'N' . 'YYYYMMDDZZZZHHMMSS' .
337 siprequestdate( $today->clone->add( days => 1) ) .
338 FID_INST_ID . $branchcode . '|'.
339 FID_ITEM_ID . 'not_to_be_found' . '|' .
340 FID_TERMINAL_PWD . 'ignored' . '|';
342 my $msg = C4::SIP::Sip::MsgType->new( $siprequest, 0 );
343 warnings_like { $msg->handle_checkin( $server ); }
344 [ qr/No item 'not_to_be_found'/, qr/no item found in object to resensitize/ ],
345 'Checkin of invalid item with two warnings';
346 my $respcode = substr( $response, 0, 2 );
347 is( $respcode, CHECKIN_RESP, 'Response code fine' );
348 is( substr($response,2,1), '0', 'OK flag is false' );
349 is( substr($response,5,1), 'Y', 'Alert flag is set' );
350 check_field( $respcode, $response, FID_SCREEN_MSG, 'Invalid Item', 'Check screen msg', 'regex' );
352 # Not checked out, toggle option checked_in_ok
353 $siprequest = CHECKIN . 'N' . 'YYYYMMDDZZZZHHMMSS' .
354 siprequestdate( $today->clone->add( days => 1) ) .
355 FID_INST_ID . $branchcode . '|'.
356 FID_ITEM_ID . $item->{barcode} . '|' .
357 FID_TERMINAL_PWD . 'ignored' . '|';
359 $msg = C4::SIP::Sip::MsgType->new( $siprequest, 0 );
360 $msg->handle_checkin( $server );
361 $respcode = substr( $response, 0, 2 );
362 is( substr($response,2,1), '0', 'OK flag is false when checking in an item that was not checked out' );
363 is( substr($response,5,1), 'Y', 'Alert flag is set' );
364 check_field( $respcode, $response, FID_SCREEN_MSG, 'not checked out', 'Check screen msg', 'regex' );
366 $server->{account}->{checked_in_ok} = 1;
368 $msg = C4::SIP::Sip::MsgType->new( $siprequest, 0 );
369 $msg->handle_checkin( $server );
370 is( substr($response,2,1), '1', 'OK flag is true now with checked_in_ok flag set when checking in an item that was not checked out' );
371 is( substr($response,5,1), 'N', 'Alert flag no longer set' );
372 check_field( $respcode, $response, FID_SCREEN_MSG, undef, 'No screen msg' );
373 $server->{account}->{checked_in_ok} = 0;
375 $server->{account}->{checked_in_ok} = 1;
376 $server->{account}->{cv_send_00_on_success} = 0;
378 $msg = C4::SIP::Sip::MsgType->new( $siprequest, 0 );
379 $msg->handle_checkin( $server );
380 $respcode = substr( $response, 0, 2 );
381 check_field( $respcode, $response, FID_ALERT_TYPE, undef, 'No FID_ALERT_TYPE (CV) field' );
382 $server->{account}->{cv_send_00_on_success} = 1;
384 $msg = C4::SIP::Sip::MsgType->new( $siprequest, 0 );
385 $msg->handle_checkin( $server );
386 $respcode = substr( $response, 0, 2 );
387 check_field( $respcode, $response, FID_ALERT_TYPE, '00', 'FID_ALERT_TYPE (CV) field is 00' );
388 $server->{account}->{checked_in_ok} = 0;
389 $server->{account}->{cv_send_00_on_success} = 0;
391 t::lib::Mocks::mock_preference( 'RecordLocalUseOnReturn', '1' );
392 $server->{account}->{checked_in_ok} = 0;
393 $server->{account}->{cv_triggers_alert} = 0;
395 $msg = C4::SIP::Sip::MsgType->new( $siprequest, 0 );
396 $msg->handle_checkin( $server );
397 $respcode = substr( $response, 0, 2 );
398 is( substr( $response, 5, 1 ), 'Y', 'Checkin without CV triggers alert flag when cv_triggers_alert is off' );
399 t::lib::Mocks::mock_preference( 'RecordLocalUseOnReturn', '0' );
400 $server->{account}->{cv_triggers_alert} = 1;
402 $msg = C4::SIP::Sip::MsgType->new( $siprequest, 0 );
403 $msg->handle_checkin( $server );
404 $respcode = substr( $response, 0, 2 );
405 is( substr( $response, 5, 1 ), 'N', 'Checkin without CV does not trigger alert flag when cv_triggers_alert is on' );
406 $server->{account}->{cv_triggers_alert} = 0;
407 t::lib::Mocks::mock_preference( 'RecordLocalUseOnReturn', '1' );
409 $server->{account}->{checked_in_ok} = 1;
410 $server->{account}->{ct_always_send} = 0;
412 $msg = C4::SIP::Sip::MsgType->new( $siprequest, 0 );
413 $msg->handle_checkin( $server );
414 $respcode = substr( $response, 0, 2 );
415 check_field( $respcode, $response, FID_DESTINATION_LOCATION, undef, 'No FID_DESTINATION_LOCATION (CT) field' );
416 $server->{account}->{ct_always_send} = 1;
418 $msg = C4::SIP::Sip::MsgType->new( $siprequest, 0 );
419 $msg->handle_checkin( $server );
420 $respcode = substr( $response, 0, 2 );
421 check_field( $respcode, $response, FID_DESTINATION_LOCATION, q{}, 'FID_DESTINATION_LOCATION (CT) field is empty but present' );
422 $server->{account}->{checked_in_ok} = 0;
423 $server->{account}->{ct_always_send} = 0;
425 # Checkin at wrong branch: issue item and switch branch, and checkin
426 my $issue = Koha::Checkout->new({ branchcode => $branchcode, borrowernumber => $patron1->{borrowernumber}, itemnumber => $item->{itemnumber} })->store;
427 $branchcode = $builder->build({ source => 'Branch' })->{branchcode};
428 t::lib::Mocks::mock_preference( 'AllowReturnToBranch', 'homebranch' );
430 $msg = C4::SIP::Sip::MsgType->new( $siprequest, 0 );
431 $msg->handle_checkin( $server );
432 is( substr($response,2,1), '0', 'OK flag is false when we check in at the wrong branch and we do not allow it' );
433 is( substr($response,5,1), 'Y', 'Alert flag is set' );
434 check_field( $respcode, $response, FID_SCREEN_MSG, 'Checkin failed', 'Check screen msg' );
435 $branchcode = $item->{homebranch}; # switch back
436 t::lib::Mocks::mock_preference( 'AllowReturnToBranch', 'anywhere' );
438 # Data corrupted: add same issue_id to old_issues
439 Koha::Old::Checkout->new({ issue_id => $issue->issue_id })->store;
441 $msg = C4::SIP::Sip::MsgType->new( $siprequest, 0 );
442 warnings_like { $msg->handle_checkin( $server ); }
443 [ qr/Duplicate entry/, qr/data corrupted/ ],
444 'DBIx error on duplicate issue_id';
445 is( substr($response,2,1), '0', 'OK flag is false when we encounter data corruption in old_issues' );
446 is( substr($response,5,1), 'Y', 'Alert flag is set' );
447 check_field( $respcode, $response, FID_SCREEN_MSG, 'Checkin failed: data problem', 'Check screen msg' );
449 # Finally checkin without problems (remove duplicate id)
450 Koha::Old::Checkouts->search({ issue_id => $issue->issue_id })->delete;
452 $msg = C4::SIP::Sip::MsgType->new( $siprequest, 0 );
453 $msg->handle_checkin( $server );
454 is( substr($response,2,1), '1', 'OK flag is true when we checkin after removing the duplicate' );
455 is( substr($response,5,1), 'N', 'Alert flag is not set' );
456 is( Koha::Checkouts->find( $issue->issue_id ), undef,
457 'Issue record is gone now' );
463 my ( $response, $findpatron, $branchcode ) = @_; # referenced variables !
465 # mock write_msg (imported from Sip.pm into Message.pm)
466 my $mockMsg = Test::MockModule->new( 'C4::SIP::Sip::MsgType' );
467 $mockMsg->mock( 'write_msg', sub { $$response = $_[1]; } ); # save response
470 my $mockILS = Test::MockObject->new;
471 $mockILS->mock( 'check_inst_id', sub {} );
472 $mockILS->mock( 'institution_id', sub { $$branchcode; } );
473 $mockILS->mock( 'find_patron', sub { $$findpatron; } );
475 return { ils => $mockILS, message => $mockMsg };
479 my ( $code, $resp, $fld, $expr, $msg, $mode ) = @_;
480 # mode: contains || equals || regex (by default: equals)
482 # strip fixed part; prefix to simplify next regex
483 $resp = '|'. substr( $resp, fixed_length( $code ) );
485 if( $resp =~ /\|$fld([^\|]*)\|/ ) {
487 } elsif( !defined($expr) ) { # field should not be found
490 } else { # test fails
491 is( 0, 1, "Code $fld not found in '$resp'?" );
495 if( !$mode || $mode eq 'equals' ) { # default
496 is( $fldval, $expr, $msg );
497 } elsif( $mode eq 'regex' ) {
498 is( $fldval =~ /$expr/, 1, $msg );
500 is( index( $fldval, $expr ) > -1, 1, $msg );
506 return $dt->ymd('').(' 'x4).$dt->hms('');
509 sub fixed_length { #length of fixed fields including response code
511 ( PATRON_STATUS_RESP ) => 37,
512 ( PATRON_INFO_RESP ) => 61,
513 ( CHECKIN_RESP ) => 24,