3 # This file is part of Koha.
5 # Koha is free software; you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
10 # Koha is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
20 use Test::More tests => 18;
26 use C4::Circulation; # AddIssue
27 use C4::Biblio; # AddBiblio
30 use Koha::DateUtils qw( dt_from_string );
35 use Scalar::Util qw( isvstring );
38 use t::lib::TestBuilder;
42 use_ok('Koha::Object');
43 use_ok('Koha::Patron');
46 my $schema = Koha::Database->new->schema;
47 my $builder = t::lib::TestBuilder->new();
49 subtest 'is_changed / make_column_dirty' => sub {
52 $schema->storage->txn_begin;
54 my $categorycode = $builder->build({ source => 'Category' })->{categorycode};
55 my $branchcode = $builder->build({ source => 'Branch' })->{branchcode};
57 my $object = Koha::Patron->new();
58 $object->categorycode( $categorycode );
59 $object->branchcode( $branchcode );
60 $object->surname("Test Surname");
62 is( $object->is_changed(), 0, "Object is unchanged" );
63 $object->surname("Test Surname");
64 is( $object->is_changed(), 0, "Object is still unchanged" );
65 $object->surname("Test Surname 2");
66 is( $object->is_changed(), 1, "Object is changed" );
69 is( $object->is_changed(), 0, "Object no longer marked as changed after being stored" );
71 $object->set({ firstname => 'Test Firstname' });
72 is( $object->is_changed(), 1, "Object is changed after Set" );
74 is( $object->is_changed(), 0, "Object no longer marked as changed after being stored" );
76 # Test make_column_dirty
77 is( $object->make_column_dirty('firstname'), '', 'make_column_dirty returns empty string on success' );
78 is( $object->make_column_dirty('firstname'), 1, 'make_column_dirty returns 1 if already dirty' );
79 is( $object->is_changed, 1, "Object is changed after make dirty" );
81 is( $object->is_changed, 0, "Store clears dirty mark" );
82 $object->make_column_dirty('firstname');
83 $object->discard_changes;
84 is( $object->is_changed, 0, "Discard clears dirty mark too" );
86 $schema->storage->txn_rollback;
89 subtest 'in_storage' => sub {
92 $schema->storage->txn_begin;
94 my $categorycode = $builder->build({ source => 'Category' })->{categorycode};
95 my $branchcode = $builder->build({ source => 'Branch' })->{branchcode};
97 my $object = Koha::Patron->new();
98 is( $object->in_storage, 0, "Object is not in storage" );
99 $object->categorycode( $categorycode );
100 $object->branchcode( $branchcode );
101 $object->surname("Test Surname");
103 is( $object->in_storage, 1, "Object is now stored" );
104 $object->surname("another surname");
105 is( $object->in_storage, 1 );
107 my $borrowernumber = $object->borrowernumber;
108 my $patron = $schema->resultset('Borrower')->find( $borrowernumber );
109 is( $patron->surname(), "Test Surname", "Object found in database" );
112 $patron = $schema->resultset('Borrower')->find( $borrowernumber );
113 ok( ! $patron, "Object no longer found in database" );
114 is( $object->in_storage, 0, "Object is not in storage" );
116 $schema->storage->txn_rollback;
119 subtest 'id' => sub {
122 $schema->storage->txn_begin;
124 my $categorycode = $builder->build({ source => 'Category' })->{categorycode};
125 my $branchcode = $builder->build({ source => 'Branch' })->{branchcode};
127 my $patron = Koha::Patron->new({categorycode => $categorycode, branchcode => $branchcode })->store;
128 is( $patron->id, $patron->borrowernumber );
130 $schema->storage->txn_rollback;
133 subtest 'get_column' => sub {
136 $schema->storage->txn_begin;
138 my $categorycode = $builder->build({ source => 'Category' })->{categorycode};
139 my $branchcode = $builder->build({ source => 'Branch' })->{branchcode};
141 my $patron = Koha::Patron->new({categorycode => $categorycode, branchcode => $branchcode })->store;
142 is( $patron->get_column('borrowernumber'), $patron->borrowernumber, 'get_column should retrieve the correct value' );
144 $schema->storage->txn_rollback;
147 subtest 'discard_changes' => sub {
150 $schema->storage->txn_begin;
152 my $patron = $builder->build( { source => 'Borrower' } );
153 $patron = Koha::Patrons->find( $patron->{borrowernumber} );
154 $patron->dateexpiry(dt_from_string);
155 $patron->discard_changes;
157 dt_from_string( $patron->dateexpiry ),
158 dt_from_string->truncate( to => 'day' ),
159 'discard_changes should refresh the object'
162 $schema->storage->txn_rollback;
165 subtest 'TO_JSON tests' => sub {
169 $schema->storage->txn_begin;
171 my $dt = dt_from_string();
172 my $borrowernumber = $builder->build(
173 { source => 'Borrower',
174 value => { lost => 1,
175 sms_provider_id => undef,
178 lastseen => $dt, } })->{borrowernumber};
180 my $patron = Koha::Patrons->find($borrowernumber);
181 my $lost = $patron->TO_JSON()->{lost};
182 my $gonenoaddress = $patron->TO_JSON->{gonenoaddress};
183 my $updated_on = $patron->TO_JSON->{updated_on};
184 my $lastseen = $patron->TO_JSON->{lastseen};
186 ok( $lost->isa('JSON::PP::Boolean'), 'Boolean attribute type is correct' );
187 is( $lost, 1, 'Boolean attribute value is correct (true)' );
189 ok( $gonenoaddress->isa('JSON::PP::Boolean'), 'Boolean attribute type is correct' );
190 is( $gonenoaddress, 0, 'Boolean attribute value is correct (false)' );
192 is( $patron->TO_JSON->{sms_provider_id}, undef, 'Undef values should not be casted to 0' );
194 ok( !isvstring($patron->borrowernumber), 'Integer values are not coded as strings' );
196 my $rfc3999_regex = qr/
208 (([Zz])|([\+|\-]([01][0-9]|2[0-3]):[0-5][0-9]))
210 like( $updated_on, $rfc3999_regex, "Date-time $updated_on formatted correctly");
211 like( $lastseen, $rfc3999_regex, "Date-time $updated_on formatted correctly");
213 $schema->storage->txn_rollback;
216 subtest "to_api() tests" => sub {
220 $schema->storage->txn_begin;
222 my $city = $builder->build_object({ class => 'Koha::Cities' });
225 # cityid => 'city_id',
226 # city_country => 'country',
227 # city_name => 'name',
228 # city_state => 'state',
229 # city_zipcode => 'postal_code'
231 my $api_city = $city->to_api;
233 is( $api_city->{city_id}, $city->cityid, 'Attribute translated correctly' );
234 is( $api_city->{country}, $city->city_country, 'Attribute translated correctly' );
235 is( $api_city->{name}, $city->city_name, 'Attribute translated correctly' );
236 is( $api_city->{state}, $city->city_state, 'Attribute translated correctly' );
237 is( $api_city->{postal_code}, $city->city_zipcode, 'Attribute translated correctly' );
239 # Lets emulate an undef
240 my $city_class = Test::MockModule->new('Koha::City');
241 $city_class->mock( 'to_api_mapping',
245 city_country => 'country',
247 city_state => 'state',
248 city_zipcode => undef
253 $api_city = $city->to_api;
255 is( $api_city->{city_id}, $city->cityid, 'Attribute translated correctly' );
256 is( $api_city->{country}, $city->city_country, 'Attribute translated correctly' );
257 is( $api_city->{name}, $city->city_name, 'Attribute translated correctly' );
258 is( $api_city->{state}, $city->city_state, 'Attribute translated correctly' );
259 ok( !exists $api_city->{postal_code}, 'Attribute removed' );
261 # Pick a class that won't have a mapping for the API
262 my $illrequest = $builder->build_object({ class => 'Koha::Illrequests' });
263 is_deeply( $illrequest->to_api, $illrequest->TO_JSON, 'If no overloaded to_api_mapping method, return TO_JSON' );
265 my $biblio = $builder->build_sample_biblio();
266 my $item = $builder->build_sample_item({ biblionumber => $biblio->biblionumber });
267 my $hold = $builder->build_object({ class => 'Koha::Holds', value => { itemnumber => $item->itemnumber } });
269 my $embeds = { 'items' => {} };
271 my $biblio_api = $biblio->to_api({ embed => $embeds });
273 ok(exists $biblio_api->{items}, 'Items where embedded in biblio results');
274 is($biblio_api->{items}->[0]->{item_id}, $item->itemnumber, 'Item matches');
275 ok(!exists $biblio_api->{items}->[0]->{holds}, 'No holds info should be embedded yet');
287 $biblio_api = $biblio->to_api({ embed => $embeds });
289 ok(exists $biblio_api->{items}, 'Items where embedded in biblio results');
290 is($biblio_api->{items}->[0]->{item_id}, $item->itemnumber, 'Item still matches');
291 ok(exists $biblio_api->{items}->[0]->{holds}, 'Holds info should be embedded');
292 is($biblio_api->{items}->[0]->{holds}->[0]->{hold_id}, $hold->reserve_id, 'Hold matches');
293 is_deeply($biblio_api->{biblioitem}, $biblio->biblioitem->to_api, 'More than one root');
295 my $hold_api = $hold->to_api(
297 embed => { 'item' => {} }
301 is( ref($hold_api->{item}), 'HASH', 'Single nested object works correctly' );
302 is( $hold_api->{item}->{item_id}, $item->itemnumber, 'Object embedded correctly' );
304 # biblio with no items
305 my $new_biblio = $builder->build_sample_biblio;
306 my $new_biblio_api = $new_biblio->to_api({ embed => $embeds });
308 is_deeply( $new_biblio_api->{items}, [], 'Empty list if no items' );
310 my $biblio_class = Test::MockModule->new('Koha::Biblio');
311 $biblio_class->mock( 'undef_result', sub { return; } );
313 $new_biblio_api = $new_biblio->to_api({ embed => ( { 'undef_result' => {} } ) });
314 ok( exists $new_biblio_api->{undef_result}, 'If a method returns undef, then the attribute is defined' );
315 is( $new_biblio_api->{undef_result}, undef, 'If a method returns undef, then the attribute is undef' );
317 $biblio_class->mock( 'items',
318 sub { return [ bless { itemnumber => 1 }, 'Somethings' ]; } );
321 $new_biblio_api = $new_biblio->to_api(
322 { embed => { 'items' => { children => { asd => {} } } } } );
324 'Koha::Exceptions::Exception',
325 "An exception is thrown if a blessed object to embed doesn't implement to_api";
329 "Asked to embed items but its return value doesn't implement to_api",
330 "Exception message correct"
333 $schema->storage->txn_rollback;
336 subtest "to_api_mapping() tests" => sub {
340 $schema->storage->txn_begin;
342 my $illrequest = $builder->build_object({ class => 'Koha::Illrequests' });
343 is_deeply( $illrequest->to_api_mapping, {}, 'If no to_api_mapping present, return empty hashref' );
345 $schema->storage->txn_rollback;
348 subtest "from_api_mapping() tests" => sub {
352 $schema->storage->txn_begin;
354 my $city = $builder->build_object({ class => 'Koha::Cities' });
356 # Lets emulate an undef
357 my $city_class = Test::MockModule->new('Koha::City');
358 $city_class->mock( 'to_api_mapping',
362 city_country => 'country',
363 city_zipcode => undef
369 $city->from_api_mapping,
372 country => 'city_country'
374 'Mapping returns correctly, undef ommited'
377 $city_class->unmock( 'to_api_mapping');
378 $city_class->mock( 'to_api_mapping',
382 city_country => 'country',
383 city_zipcode => 'postal_code'
389 $city->from_api_mapping,
392 country => 'city_country'
394 'Reverse mapping is cached'
398 $city = $builder->build_object({ class => 'Koha::Cities' });
400 $city->from_api_mapping,
403 country => 'city_country',
404 postal_code => 'city_zipcode'
406 'Fresh mapping loaded'
409 $schema->storage->txn_rollback;
412 subtest 'set_from_api() tests' => sub {
416 $schema->storage->txn_begin;
418 my $city = $builder->build_object({ class => 'Koha::Cities' });
419 my $city_unblessed = $city->unblessed;
422 country => 'Argentina',
423 postal_code => '5000'
425 $city->set_from_api($attrs);
427 is( $city->city_state, $city_unblessed->{city_state}, 'Untouched attributes are preserved' );
428 is( $city->city_name, $attrs->{name}, 'city_name updated correctly' );
429 is( $city->city_country, $attrs->{country}, 'city_country updated correctly' );
430 is( $city->city_zipcode, $attrs->{postal_code}, 'city_zipcode updated correctly' );
432 $schema->storage->txn_rollback;
435 subtest 'new_from_api() tests' => sub {
439 $schema->storage->txn_begin;
443 country => 'Argentina',
444 postal_code => '5000'
446 my $city = Koha::City->new_from_api($attrs);
448 is( ref($city), 'Koha::City', 'Object type is correct' );
449 is( $city->city_name, $attrs->{name}, 'city_name updated correctly' );
450 is( $city->city_country, $attrs->{country}, 'city_country updated correctly' );
451 is( $city->city_zipcode, $attrs->{postal_code}, 'city_zipcode updated correctly' );
453 $schema->storage->txn_rollback;
456 subtest 'attributes_from_api() tests' => sub {
460 my $patron = Koha::Patron->new();
462 my $attrs = $patron->attributes_from_api(
464 updated_on => '2019-12-27T14:53:00',
468 ok( exists $attrs->{updated_on},
469 'No translation takes place if no mapping' );
471 ref( $attrs->{updated_on} ),
473 'Given a string, a timestamp field is converted into a DateTime object'
476 $attrs = $patron->attributes_from_api(
478 last_seen => '2019-12-27T14:53:00'
482 ok( exists $attrs->{lastseen},
483 'Translation takes place because of the defined mapping' );
485 ref( $attrs->{lastseen} ),
487 'Given a string, a datetime field is converted into a DateTime object'
490 $attrs = $patron->attributes_from_api(
492 date_of_birth => '2019-12-27'
496 ok( exists $attrs->{dateofbirth},
497 'Translation takes place because of the defined mapping' );
499 ref( $attrs->{dateofbirth} ),
501 'Given a string, a date field is converted into a DateTime object'
506 $attrs = $patron->attributes_from_api(
508 date_of_birth => '20141205',
512 'Koha::Exceptions::BadParameter',
513 'Bad date throws an exception';
518 'Exception parameter is the API field name, not the DB one'
522 $attrs = $patron->attributes_from_api(
524 incorrect_address => Mojo::JSON->true,
525 patron_card_lost => Mojo::JSON->false,
529 ok( exists $attrs->{gonenoaddress}, 'Attribute gets translated' );
530 is( $attrs->{gonenoaddress}, 1, 'Boolean correctly translated to integer (true => 1)' );
531 ok( exists $attrs->{lost}, 'Attribute gets translated' );
532 is( $attrs->{lost}, 0, 'Boolean correctly translated to integer (false => 0)' );
535 subtest "Test update method" => sub {
538 $schema->storage->txn_begin;
540 my $branchcode = $builder->build({ source => 'Branch' })->{branchcode};
541 my $library = Koha::Libraries->find( $branchcode );
542 $library->update({ branchname => 'New_Name', branchcity => 'AMS' });
543 is( $library->branchname, 'New_Name', 'Changed name with update' );
544 is( $library->branchcity, 'AMS', 'Changed city too' );
545 is( $library->is_changed, 0, 'Change should be stored already' );
548 branchcity => 'NYC', not_a_column => 53, branchname => 'Name3',
550 fail( 'It should not be possible to update an unexisting column without an error from Koha::Object/DBIx' );
552 ok( $_->isa('Koha::Exceptions::Object'), 'Caught error when updating wrong column' );
553 $library->discard_changes; #requery after failing update
555 # Check if the columns are not updated
556 is( $library->branchcity, 'AMS', 'First column not updated' );
557 is( $library->branchname, 'New_Name', 'Third column not updated' );
559 $schema->storage->txn_rollback;
562 subtest 'store() tests' => sub {
566 # Using Koha::ApiKey to test Koha::Object>-store
567 # Simple object with foreign keys and unique key
569 $schema->storage->txn_begin;
571 # Create a patron to make sure its ID doesn't exist on the DB
572 my $patron = $builder->build_object({ class => 'Koha::Patrons' });
573 my $patron_id = $patron->id;
576 my $api_key = Koha::ApiKey->new({ patron_id => $patron_id, secret => 'a secret', description => 'a description' });
578 my $print_error = $schema->storage->dbh->{PrintError};
579 $schema->storage->dbh->{PrintError} = 0;
582 'Koha::Exceptions::Object::FKConstraint',
583 'Exception is thrown correctly';
586 "Broken FK constraint",
587 'Exception message is correct'
592 'Exception field is correct'
595 $patron = $builder->build_object({ class => 'Koha::Patrons' });
596 $api_key = $builder->build_object({ class => 'Koha::ApiKeys' });
598 my $new_api_key = Koha::ApiKey->new({
599 patron_id => $patron_id,
600 secret => $api_key->secret,
601 description => 'a description',
605 { $new_api_key->store }
606 'Koha::Exceptions::Object::DuplicateID',
607 'Exception is thrown correctly';
612 'Exception message is correct'
617 qr/(api_keys\.)?secret/,
618 'Exception field is correct (note that MySQL 8 is displaying the tablename)'
621 $schema->storage->dbh->{PrintError} = $print_error;
624 $api_key->set({ secret => 'Manuel' });
625 my $ret = $api_key->store;
626 is( ref($ret), 'Koha::ApiKey', 'store() returns the object on success' );
628 my $library = $builder->build_object( { class => 'Koha::Libraries' } );
629 my $patron_category = $builder->build_object(
631 class => 'Koha::Patron::Categories',
632 value => { category_type => 'P', enrolmentfee => 0 }
639 categorycode => $patron_category->categorycode,
640 branchcode => $library->branchcode,
641 dateofbirth => "", # date will be set to NULL
642 sms_provider_id => "", # Integer will be set to NULL
643 privacy => "", # privacy cannot be NULL but has a default value
647 is( $@, '', 'No error should be raised by ->store if empty strings are passed' );
648 is( $patron->privacy, 1, 'Default value for privacy should be set to 1' );
649 is( $patron->dateofbirth, undef, 'dateofbirth must have been set to undef');
650 is( $patron->sms_provider_id, undef, 'sms_provider_id must have been set to undef');
652 my $itemtype = eval {
655 itemtype => 'IT4test',
662 is( $@, '', 'No error should be raised by ->store if empty strings are passed' );
663 is( $itemtype->rentalcharge, undef, 'decimal DEFAULT NULL should default to null');
664 is( $itemtype->notforloan, undef, 'int DEFAULT NULL should default to null');
665 is( $itemtype->hideinopac, 0, 'int NOT NULL DEFAULT 0 should default to 0');
667 subtest 'Bad value tests' => sub {
671 my $patron = $builder->build_object({ class => 'Koha::Patrons' });
673 my $print_error = $schema->storage->dbh->{PrintError};
674 $schema->storage->dbh->{PrintError} = 0;
677 $patron->lastseen('wrong_value')->store;
679 ok( $_->isa('Koha::Exceptions::Object::BadValue'), 'Exception thrown correctly' );
680 like( $_->property, qr/(borrowers\.)?lastseen/, 'Column should be the expected one' ); # The table name is not always displayed, it depends on the DBMS version
681 is( $_->value, 'wrong_value', 'Value should be the expected one' );
684 $schema->storage->dbh->{PrintError} = $print_error;
687 $schema->storage->txn_rollback;
690 subtest 'unblessed_all_relateds' => sub {
693 $schema->storage->txn_begin;
695 # FIXME It's very painful to create an issue in tests!
696 my $library = $builder->build_object( { class => 'Koha::Libraries' } );
697 t::lib::Mocks::mock_userenv({ branchcode => $library->branchcode });
699 my $patron_category = $builder->build(
701 source => 'Category',
703 category_type => 'P',
705 BlockExpiredPatronOpacActions => -1, # Pick the pref value
710 firstname => 'firstname',
711 surname => 'surname',
712 categorycode => $patron_category->{categorycode},
713 branchcode => $library->branchcode,
715 my $patron = Koha::Patron->new($patron_data)->store;
716 my ($biblionumber) = AddBiblio( MARC::Record->new, '' );
717 my $biblio = Koha::Biblios->find( $biblionumber );
718 my $item = $builder->build_object(
720 class => 'Koha::Items',
722 homebranch => $library->branchcode,
723 holdingbranch => $library->branchcode,
724 biblionumber => $biblio->biblionumber,
731 my $issue = AddIssue( $patron->unblessed, $item->barcode, DateTime->now->subtract( days => 1 ) );
732 my $overdues = Koha::Patrons->find( $patron->id )->get_overdues; # Koha::Patron->get_overdue prefetches
733 my $overdue = $overdues->next->unblessed_all_relateds;
734 is( $overdue->{issue_id}, $issue->issue_id, 'unblessed_all_relateds has field from the original table (issues)' );
735 is( $overdue->{title}, $biblio->title, 'unblessed_all_relateds has field from other tables (biblio)' );
736 is( $overdue->{homebranch}, $item->homebranch, 'unblessed_all_relateds has field from other tables (items)' );
738 $schema->storage->txn_rollback;
741 subtest 'get_from_storage' => sub {
744 $schema->storage->txn_begin;
746 my $biblio = $builder->build_sample_biblio;
748 my $old_title = $biblio->title;
749 my $new_title = 'new_title';
750 Koha::Biblios->find( $biblio->biblionumber )->title($new_title)->store;
752 is( $biblio->title, $old_title, 'current $biblio should not be modified' );
753 is( $biblio->get_from_storage->title,
754 $new_title, 'get_from_storage should return an updated object' );
756 Koha::Biblios->find( $biblio->biblionumber )->delete;
757 is( ref($biblio), 'Koha::Biblio', 'current $biblio should not be deleted' );
758 is( $biblio->get_from_storage, undef,
759 'get_from_storage should return undef if the object has been deleted' );
761 $schema->storage->txn_rollback;