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 => 17;
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 $item_class = Test::MockModule->new('Koha::Item');
266 $item_class->mock( 'to_api_mapping',
269 itemnumber => 'item_id'
274 my $hold_class = Test::MockModule->new('Koha::Hold');
275 $hold_class->mock( 'to_api_mapping',
278 reserve_id => 'hold_id'
283 my $biblio = $builder->build_sample_biblio();
284 my $item = $builder->build_sample_item({ biblionumber => $biblio->biblionumber });
285 my $hold = $builder->build_object({ class => 'Koha::Holds', value => { itemnumber => $item->itemnumber } });
287 my @embeds = ('items');
289 my $biblio_api = $biblio->to_api(\@embeds);
291 ok(exists $biblio_api->{items}, 'Items where embedded in biblio results');
292 is($biblio_api->{items}->[0]->{item_id}, $item->itemnumber, 'Item matches');
293 ok(!exists $biblio_api->{items}->[0]->{holds}, 'No holds info should be embedded yet');
295 @embeds = ('items.holds');
296 $biblio_api = $biblio->to_api(\@embeds);
298 ok(exists $biblio_api->{items}, 'Items where embedded in biblio results');
299 is($biblio_api->{items}->[0]->{item_id}, $item->itemnumber, 'Item still matches');
300 ok(exists $biblio_api->{items}->[0]->{holds}, 'Holds info should be embedded');
301 is($biblio_api->{items}->[0]->{holds}->[0]->{hold_id}, $hold->reserve_id, 'Hold matches');
303 $schema->storage->txn_rollback;
306 subtest "to_api_mapping() tests" => sub {
310 $schema->storage->txn_begin;
312 my $illrequest = $builder->build_object({ class => 'Koha::Illrequests' });
313 is_deeply( $illrequest->to_api_mapping, {}, 'If no to_api_mapping present, return empty hashref' );
315 $schema->storage->txn_rollback;
318 subtest "from_api_mapping() tests" => sub {
322 $schema->storage->txn_begin;
324 my $city = $builder->build_object({ class => 'Koha::Cities' });
326 # Lets emulate an undef
327 my $city_class = Test::MockModule->new('Koha::City');
328 $city_class->mock( 'to_api_mapping',
332 city_country => 'country',
333 city_zipcode => undef
339 $city->from_api_mapping,
342 country => 'city_country'
344 'Mapping returns correctly, undef ommited'
347 $city_class->unmock( 'to_api_mapping');
348 $city_class->mock( 'to_api_mapping',
352 city_country => 'country',
353 city_zipcode => 'postal_code'
359 $city->from_api_mapping,
362 country => 'city_country'
364 'Reverse mapping is cached'
368 $city = $builder->build_object({ class => 'Koha::Cities' });
370 $city->from_api_mapping,
373 country => 'city_country',
374 postal_code => 'city_zipcode'
376 'Fresh mapping loaded'
379 $schema->storage->txn_rollback;
382 subtest 'set_from_api() tests' => sub {
386 $schema->storage->txn_begin;
388 my $city = $builder->build_object({ class => 'Koha::Cities' });
389 my $city_unblessed = $city->unblessed;
392 country => 'Argentina',
393 postal_code => '5000'
395 $city->set_from_api($attrs);
397 is( $city->city_state, $city_unblessed->{city_state}, 'Untouched attributes are preserved' );
398 is( $city->city_name, $attrs->{name}, 'city_name updated correctly' );
399 is( $city->city_country, $attrs->{country}, 'city_country updated correctly' );
400 is( $city->city_zipcode, $attrs->{postal_code}, 'city_zipcode updated correctly' );
402 $schema->storage->txn_rollback;
405 subtest 'new_from_api() tests' => sub {
409 $schema->storage->txn_begin;
413 country => 'Argentina',
414 postal_code => '5000'
416 my $city = Koha::City->new_from_api($attrs);
418 is( ref($city), 'Koha::City', 'Object type is correct' );
419 is( $city->city_name, $attrs->{name}, 'city_name updated correctly' );
420 is( $city->city_country, $attrs->{country}, 'city_country updated correctly' );
421 is( $city->city_zipcode, $attrs->{postal_code}, 'city_zipcode updated correctly' );
423 $schema->storage->txn_rollback;
426 subtest 'attributes_from_api() tests' => sub {
430 my $patron = Koha::Patron->new();
432 use Data::Printer colored => 1;
434 my $attrs = $patron->attributes_from_api(
436 updated_on => '2019-12-27T14:53:00'
440 ok( exists $attrs->{updated_on},
441 'No translation takes place if no mapping' );
443 ref( $attrs->{updated_on} ),
445 'Given a string, a timestamp field is converted into a DateTime object'
448 $attrs = $patron->attributes_from_api(
450 last_seen => '2019-12-27T14:53:00'
454 ok( exists $attrs->{lastseen},
455 'Translation takes place because of the defined mapping' );
457 ref( $attrs->{lastseen} ),
459 'Given a string, a datetime field is converted into a DateTime object'
462 $attrs = $patron->attributes_from_api(
464 date_of_birth => '2019-12-27'
468 ok( exists $attrs->{dateofbirth},
469 'Translation takes place because of the defined mapping' );
471 ref( $attrs->{dateofbirth} ),
473 'Given a string, a date field is converted into a DateTime object'
478 $attrs = $patron->attributes_from_api(
480 date_of_birth => '20141205',
484 'Koha::Exceptions::BadParameter',
485 'Bad date throws an exception';
490 'Exception parameter is the API field name, not the DB one'
494 subtest "Test update method" => sub {
497 $schema->storage->txn_begin;
499 my $branchcode = $builder->build({ source => 'Branch' })->{branchcode};
500 my $library = Koha::Libraries->find( $branchcode );
501 $library->update({ branchname => 'New_Name', branchcity => 'AMS' });
502 is( $library->branchname, 'New_Name', 'Changed name with update' );
503 is( $library->branchcity, 'AMS', 'Changed city too' );
504 is( $library->is_changed, 0, 'Change should be stored already' );
507 branchcity => 'NYC', not_a_column => 53, branchname => 'Name3',
509 fail( 'It should not be possible to update an unexisting column without an error from Koha::Object/DBIx' );
511 ok( $_->isa('Koha::Exceptions::Object'), 'Caught error when updating wrong column' );
512 $library->discard_changes; #requery after failing update
514 # Check if the columns are not updated
515 is( $library->branchcity, 'AMS', 'First column not updated' );
516 is( $library->branchname, 'New_Name', 'Third column not updated' );
518 $schema->storage->txn_rollback;
521 subtest 'store() tests' => sub {
525 # Using Koha::ApiKey to test Koha::Object>-store
526 # Simple object with foreign keys and unique key
528 $schema->storage->txn_begin;
530 # Create a patron to make sure its ID doesn't exist on the DB
531 my $patron = $builder->build_object({ class => 'Koha::Patrons' });
532 my $patron_id = $patron->id;
535 my $api_key = Koha::ApiKey->new({ patron_id => $patron_id, secret => 'a secret', description => 'a description' });
537 my $print_error = $schema->storage->dbh->{PrintError};
538 $schema->storage->dbh->{PrintError} = 0;
541 'Koha::Exceptions::Object::FKConstraint',
542 'Exception is thrown correctly';
545 "Broken FK constraint",
546 'Exception message is correct'
551 'Exception field is correct'
554 $patron = $builder->build_object({ class => 'Koha::Patrons' });
555 $api_key = $builder->build_object({ class => 'Koha::ApiKeys' });
557 my $new_api_key = Koha::ApiKey->new({
558 patron_id => $patron_id,
559 secret => $api_key->secret,
560 description => 'a description',
564 { $new_api_key->store }
565 'Koha::Exceptions::Object::DuplicateID',
566 'Exception is thrown correctly';
571 'Exception message is correct'
577 'Exception field is correct'
580 $schema->storage->dbh->{PrintError} = $print_error;
583 $api_key->set({ secret => 'Manuel' });
584 my $ret = $api_key->store;
585 is( ref($ret), 'Koha::ApiKey', 'store() returns the object on success' );
587 my $library = $builder->build_object( { class => 'Koha::Libraries' } );
588 my $patron_category = $builder->build_object(
590 class => 'Koha::Patron::Categories',
591 value => { category_type => 'P', enrolmentfee => 0 }
598 categorycode => $patron_category->categorycode,
599 branchcode => $library->branchcode,
600 dateofbirth => "", # date will be set to NULL
601 sms_provider_id => "", # Integer will be set to NULL
602 privacy => "", # privacy cannot be NULL but has a default value
606 is( $@, '', 'No error should be raised by ->store if empty strings are passed' );
607 is( $patron->privacy, 1, 'Default value for privacy should be set to 1' );
608 is( $patron->dateofbirth, undef, 'dateofbirth must have been set to undef');
609 is( $patron->sms_provider_id, undef, 'sms_provider_id must have been set to undef');
611 my $itemtype = eval {
614 itemtype => 'IT4test',
621 is( $@, '', 'No error should be raised by ->store if empty strings are passed' );
622 is( $itemtype->rentalcharge, undef, 'decimal DEFAULT NULL should default to null');
623 is( $itemtype->notforloan, undef, 'int DEFAULT NULL should default to null');
624 is( $itemtype->hideinopac, 0, 'int NOT NULL DEFAULT 0 should default to 0');
626 subtest 'Bad value tests' => sub {
630 my $patron = $builder->build_object({ class => 'Koha::Patrons' });
632 my $print_error = $schema->storage->dbh->{PrintError};
633 $schema->storage->dbh->{PrintError} = 0;
636 $patron->lastseen('wrong_value')->store;
638 ok( $_->isa('Koha::Exceptions::Object::BadValue'), 'Exception thrown correctly' );
639 like( $_->property, qr/(borrowers\.)?lastseen/, 'Column should be the expected one' ); # The table name is not always displayed, it depends on the DBMS version
640 is( $_->value, 'wrong_value', 'Value should be the expected one' );
643 $schema->storage->dbh->{PrintError} = $print_error;
646 $schema->storage->txn_rollback;
649 subtest 'unblessed_all_relateds' => sub {
652 $schema->storage->txn_begin;
654 # FIXME It's very painful to create an issue in tests!
655 my $library = $builder->build_object( { class => 'Koha::Libraries' } );
656 t::lib::Mocks::mock_userenv({ branchcode => $library->branchcode });
658 my $patron_category = $builder->build(
660 source => 'Category',
662 category_type => 'P',
664 BlockExpiredPatronOpacActions => -1, # Pick the pref value
669 firstname => 'firstname',
670 surname => 'surname',
671 categorycode => $patron_category->{categorycode},
672 branchcode => $library->branchcode,
674 my $patron = Koha::Patron->new($patron_data)->store;
675 my ($biblionumber) = AddBiblio( MARC::Record->new, '' );
676 my $biblio = Koha::Biblios->find( $biblionumber );
677 my $item = $builder->build_object(
679 class => 'Koha::Items',
681 homebranch => $library->branchcode,
682 holdingbranch => $library->branchcode,
683 biblionumber => $biblio->biblionumber,
690 my $issue = AddIssue( $patron->unblessed, $item->barcode, DateTime->now->subtract( days => 1 ) );
691 my $overdues = Koha::Patrons->find( $patron->id )->get_overdues; # Koha::Patron->get_overdue prefetches
692 my $overdue = $overdues->next->unblessed_all_relateds;
693 is( $overdue->{issue_id}, $issue->issue_id, 'unblessed_all_relateds has field from the original table (issues)' );
694 is( $overdue->{title}, $biblio->title, 'unblessed_all_relateds has field from other tables (biblio)' );
695 is( $overdue->{homebranch}, $item->homebranch, 'unblessed_all_relateds has field from other tables (items)' );
697 $schema->storage->txn_rollback;