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
=> 12;
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 to_api_method present, return TO_JSON' );
265 $schema->storage->txn_rollback;
268 subtest
"Test update method" => sub {
271 $schema->storage->txn_begin;
273 my $branchcode = $builder->build({ source
=> 'Branch' })->{branchcode
};
274 my $library = Koha
::Libraries
->find( $branchcode );
275 $library->update({ branchname
=> 'New_Name', branchcity
=> 'AMS' });
276 is
( $library->branchname, 'New_Name', 'Changed name with update' );
277 is
( $library->branchcity, 'AMS', 'Changed city too' );
278 is
( $library->is_changed, 0, 'Change should be stored already' );
281 branchcity
=> 'NYC', not_a_column
=> 53, branchname
=> 'Name3',
283 fail
( 'It should not be possible to update an unexisting column without an error from Koha::Object/DBIx' );
285 ok
( $_->isa('Koha::Exceptions::Object'), 'Caught error when updating wrong column' );
286 $library->discard_changes; #requery after failing update
288 # Check if the columns are not updated
289 is
( $library->branchcity, 'AMS', 'First column not updated' );
290 is
( $library->branchname, 'New_Name', 'Third column not updated' );
292 $schema->storage->txn_rollback;
295 subtest
'store() tests' => sub {
299 # Using Koha::ApiKey to test Koha::Object>-store
300 # Simple object with foreign keys and unique key
302 $schema->storage->txn_begin;
304 # Create a patron to make sure its ID doesn't exist on the DB
305 my $patron = $builder->build_object({ class => 'Koha::Patrons' });
306 my $patron_id = $patron->id;
309 my $api_key = Koha
::ApiKey
->new({ patron_id
=> $patron_id, secret
=> 'a secret', description
=> 'a description' });
311 my $print_error = $schema->storage->dbh->{PrintError
};
312 $schema->storage->dbh->{PrintError
} = 0;
315 'Koha::Exceptions::Object::FKConstraint',
316 'Exception is thrown correctly';
319 "Broken FK constraint",
320 'Exception message is correct'
325 'Exception field is correct'
328 $patron = $builder->build_object({ class => 'Koha::Patrons' });
329 $api_key = $builder->build_object({ class => 'Koha::ApiKeys' });
331 my $new_api_key = Koha
::ApiKey
->new({
332 patron_id
=> $patron_id,
333 secret
=> $api_key->secret,
334 description
=> 'a description',
338 { $new_api_key->store }
339 'Koha::Exceptions::Object::DuplicateID',
340 'Exception is thrown correctly';
345 'Exception message is correct'
351 'Exception field is correct'
354 $schema->storage->dbh->{PrintError
} = $print_error;
357 $api_key->set({ secret
=> 'Manuel' });
358 my $ret = $api_key->store;
359 is
( ref($ret), 'Koha::ApiKey', 'store() returns the object on success' );
361 my $library = $builder->build_object( { class => 'Koha::Libraries' } );
362 my $patron_category = $builder->build_object(
364 class => 'Koha::Patron::Categories',
365 value
=> { category_type
=> 'P', enrolmentfee
=> 0 }
372 categorycode
=> $patron_category->categorycode,
373 branchcode
=> $library->branchcode,
374 dateofbirth
=> "", # date will be set to NULL
375 sms_provider_id
=> "", # Integer will be set to NULL
376 privacy
=> "", # privacy cannot be NULL but has a default value
380 is
( $@
, '', 'No error should be raised by ->store if empty strings are passed' );
381 is
( $patron->privacy, 1, 'Default value for privacy should be set to 1' );
382 is
( $patron->dateofbirth, undef, 'dateofbirth must have been set to undef');
383 is
( $patron->sms_provider_id, undef, 'sms_provider_id must have been set to undef');
385 my $itemtype = eval {
388 itemtype
=> 'IT4test',
395 is
( $@
, '', 'No error should be raised by ->store if empty strings are passed' );
396 is
( $itemtype->rentalcharge, undef, 'decimal DEFAULT NULL should default to null');
397 is
( $itemtype->notforloan, undef, 'int DEFAULT NULL should default to null');
398 is
( $itemtype->hideinopac, 0, 'int NOT NULL DEFAULT 0 should default to 0');
400 subtest
'Bad value tests' => sub {
404 my $patron = $builder->build_object({ class => 'Koha::Patrons' });
406 my $print_error = $schema->storage->dbh->{PrintError
};
407 $schema->storage->dbh->{PrintError
} = 0;
410 $patron->lastseen('wrong_value')->store;
412 ok
( $_->isa('Koha::Exceptions::Object::BadValue'), 'Exception thrown correctly' );
413 like
( $_->property, qr/borrowers\W?\.\W?lastseen/, 'Column should be the expected one' ); # optional \W for quote or backtic
414 is
( $_->value, 'wrong_value', 'Value should be the expected one' );
417 $schema->storage->dbh->{PrintError
} = $print_error;
420 $schema->storage->txn_rollback;
423 subtest
'unblessed_all_relateds' => sub {
426 $schema->storage->txn_begin;
428 # FIXME It's very painful to create an issue in tests!
429 my $library = $builder->build_object( { class => 'Koha::Libraries' } );
430 t
::lib
::Mocks
::mock_userenv
({ branchcode
=> $library->branchcode });
432 my $patron_category = $builder->build(
434 source
=> 'Category',
436 category_type
=> 'P',
438 BlockExpiredPatronOpacActions
=> -1, # Pick the pref value
443 firstname
=> 'firstname',
444 surname
=> 'surname',
445 categorycode
=> $patron_category->{categorycode
},
446 branchcode
=> $library->branchcode,
448 my $patron = Koha
::Patron
->new($patron_data)->store;
449 my ($biblionumber) = AddBiblio
( MARC
::Record
->new, '' );
450 my $biblio = Koha
::Biblios
->find( $biblionumber );
451 my $item = $builder->build_object(
453 class => 'Koha::Items',
455 homebranch
=> $library->branchcode,
456 holdingbranch
=> $library->branchcode,
457 biblionumber
=> $biblio->biblionumber,
464 my $issue = AddIssue
( $patron->unblessed, $item->barcode, DateTime
->now->subtract( days
=> 1 ) );
465 my $overdues = Koha
::Patrons
->find( $patron->id )->get_overdues; # Koha::Patron->get_overdue prefetches
466 my $overdue = $overdues->next->unblessed_all_relateds;
467 is
( $overdue->{issue_id
}, $issue->issue_id, 'unblessed_all_relateds has field from the original table (issues)' );
468 is
( $overdue->{title
}, $biblio->title, 'unblessed_all_relateds has field from other tables (biblio)' );
469 is
( $overdue->{homebranch
}, $item->homebranch, 'unblessed_all_relateds has field from other tables (items)' );
471 $schema->storage->txn_rollback;