Bug 26922: Regression tests
[koha.git] / t / db_dependent / Koha / Objects.t
blobafb00ee142e3a0eb38bf1ff37b5c7314ddd9568e
1 #!/usr/bin/perl
3 # Copyright 2019 Koha Development team
5 # This file is part of Koha
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
20 use Modern::Perl;
22 use Test::More tests => 24;
23 use Test::Exception;
24 use Test::MockModule;
25 use Test::Warn;
27 use Koha::Authority::Types;
28 use Koha::Cities;
29 use Koha::Biblios;
30 use Koha::Patron::Category;
31 use Koha::Patron::Categories;
32 use Koha::Patrons;
33 use Koha::Database;
34 use Koha::DateUtils qw( dt_from_string );
36 use t::lib::TestBuilder;
37 use t::lib::Mocks;
39 use Try::Tiny;
41 my $schema = Koha::Database->new->schema;
42 $schema->storage->txn_begin;
43 my $builder = t::lib::TestBuilder->new;
45 is( ref(Koha::Authority::Types->find('')), 'Koha::Authority::Type', 'Koha::Objects->find should work if the primary key is an empty string' );
47 my @columns = Koha::Patrons->columns;
48 my $borrowernumber_exists = grep { /^borrowernumber$/ } @columns;
49 is( $borrowernumber_exists, 1, 'Koha::Objects->columns should return the table columns' );
51 subtest 'find' => sub {
52 plan tests => 6;
53 my $patron = $builder->build({source => 'Borrower'});
54 my $patron_object = Koha::Patrons->find( $patron->{borrowernumber} );
55 is( $patron_object->borrowernumber, $patron->{borrowernumber}, '->find should return the correct object' );
57 my @patrons = Koha::Patrons->find( $patron->{borrowernumber} );
58 is(scalar @patrons, 1, '->find in list context returns a value');
59 is($patrons[0]->borrowernumber, $patron->{borrowernumber}, '->find in list context returns the same value as in scalar context');
61 my $patrons = {
62 foo => Koha::Patrons->find('foo'),
63 bar => 'baz',
65 is ($patrons->{foo}, undef, '->find in list context returns undef when no record is found');
67 # Test sending undef to find; should not generate a warning
68 warning_is { $patron = Koha::Patrons->find( undef ); }
69 "", "Sending undef does not trigger a DBIx warning";
70 warning_is { $patron = Koha::Patrons->find( undef, undef ); }
71 "", "Sending two undefs does not trigger a DBIx warning too";
74 subtest 'update' => sub {
75 plan tests => 2;
77 $builder->build( { source => 'City', value => { city_country => 'UK' } } );
78 $builder->build( { source => 'City', value => { city_country => 'UK' } } );
79 $builder->build( { source => 'City', value => { city_country => 'UK' } } );
80 $builder->build( { source => 'City', value => { city_country => 'France' } } );
81 $builder->build( { source => 'City', value => { city_country => 'France' } } );
82 $builder->build( { source => 'City', value => { city_country => 'Germany' } } );
83 Koha::Cities->search( { city_country => 'UK' } )->update( { city_country => 'EU' } );
84 is( Koha::Cities->search( { city_country => 'EU' } )->count, 3, 'Koha::Objects->update should have updated the 3 rows' );
85 is( Koha::Cities->search( { city_country => 'UK' } )->count, 0, 'Koha::Objects->update should have updated the 3 rows' );
88 subtest 'reset' => sub {
89 plan tests => 3;
91 my $patrons = Koha::Patrons->search;
92 my $first_borrowernumber = $patrons->next->borrowernumber;
93 my $second_borrowernumber = $patrons->next->borrowernumber;
94 is( ref( $patrons->reset ), 'Koha::Patrons', 'Koha::Objects->reset should allow chaining' );
95 is( ref( $patrons->reset->next ), 'Koha::Patron', 'Koha::Objects->reset should allow chaining' );
96 is( $patrons->reset->next->borrowernumber, $first_borrowernumber, 'Koha::Objects->reset should work as expected');
99 subtest 'delete' => sub {
100 plan tests => 2;
102 my $patron_1 = $builder->build({source => 'Borrower'});
103 my $patron_2 = $builder->build({source => 'Borrower'});
104 is( Koha::Patrons->search({ -or => { borrowernumber => [ $patron_1->{borrowernumber}, $patron_2->{borrowernumber}]}})->delete, 2, '');
105 is( Koha::Patrons->search({ -or => { borrowernumber => [ $patron_1->{borrowernumber}, $patron_2->{borrowernumber}]}})->count, 0, '');
108 subtest 'new' => sub {
109 plan tests => 2;
110 my $a_cat_code = 'A_CAT_CODE';
111 my $patron_category = Koha::Patron::Category->new( { categorycode => $a_cat_code } )->store;
112 is( Koha::Patron::Categories->find($a_cat_code)->category_type, 'A', 'Koha::Object->new should set the default value' );
113 Koha::Patron::Categories->find($a_cat_code)->delete;
114 $patron_category = Koha::Patron::Category->new( { categorycode => $a_cat_code, category_type => undef } )->store;
115 is( Koha::Patron::Categories->find($a_cat_code)->category_type, 'A', 'Koha::Object->new should set the default value even if the argument exists but is not defined' );
116 Koha::Patron::Categories->find($a_cat_code)->delete;
119 subtest 'find' => sub {
120 plan tests => 4;
122 # check find on a single PK
123 my $patron = $builder->build({ source => 'Borrower' });
124 is( Koha::Patrons->find($patron->{borrowernumber})->surname,
125 $patron->{surname}, "Checking an arbitrary patron column after find"
127 # check find with unique column
128 my $obj = Koha::Patrons->find($patron->{cardnumber}, { key => 'cardnumber' });
129 is( $obj->borrowernumber, $patron->{borrowernumber},
130 'Find with unique column and key specified' );
131 # check find with an additional where clause in the attrs hash
132 # we do not expect to find something now
133 is( Koha::Patrons->find(
134 $patron->{borrowernumber},
135 { where => { surname => { '!=', $patron->{surname} }}},
136 ), undef, 'Additional where clause in find call' );
138 is( Koha::Patrons->find(), undef, 'Find returns undef if no params passed' );
141 subtest 'search_related' => sub {
142 plan tests => 6;
143 my $builder = t::lib::TestBuilder->new;
144 my $patron_1 = $builder->build( { source => 'Borrower' } );
145 my $patron_2 = $builder->build( { source => 'Borrower' } );
146 my $libraries = Koha::Patrons->search(
148 -or => {
149 borrowernumber =>
150 [ $patron_1->{borrowernumber}, $patron_2->{borrowernumber} ]
153 )->search_related('branchcode');
154 is( ref($libraries), 'Koha::Libraries',
155 'Koha::Objects->search_related should return an instanciated Koha::Objects-based object'
157 is( $libraries->count, 2,
158 'Koha::Objects->search_related should work as expected' );
159 ok( eq_array(
160 [ $libraries->get_column('branchcode') ],
161 [ $patron_1->{branchcode}, $patron_2->{branchcode} ] ),
162 'Koha::Objects->search_related should work as expected'
165 my @libraries = Koha::Patrons->search(
167 -or => {
168 borrowernumber =>
169 [ $patron_1->{borrowernumber}, $patron_2->{borrowernumber} ]
172 )->search_related('branchcode');
174 ref( $libraries[0] ), 'Koha::Library',
175 'Koha::Objects->search_related should return a list of Koha::Object-based objects'
177 is( scalar(@libraries), 2,
178 'Koha::Objects->search_related should work as expected' );
179 ok( eq_array(
180 [ map { $_->branchcode } @libraries ],
181 [ $patron_1->{branchcode}, $patron_2->{branchcode} ] ),
182 'Koha::Objects->search_related should work as expected'
186 subtest 'single' => sub {
187 plan tests => 2;
188 my $builder = t::lib::TestBuilder->new;
189 my $patron_1 = $builder->build( { source => 'Borrower' } );
190 my $patron_2 = $builder->build( { source => 'Borrower' } );
191 my $patron = Koha::Patrons->search({}, { rows => 1 })->single;
192 is(ref($patron), 'Koha::Patron', 'Koha::Objects->single returns a single Koha::Patron object.');
193 warning_like { Koha::Patrons->search->single } qr/SQL that returns multiple rows/,
194 "Warning is presented if single is used for a result with multiple rows.";
197 subtest 'last' => sub {
198 plan tests => 3;
199 my $builder = t::lib::TestBuilder->new;
200 my $patron_1 = $builder->build( { source => 'Borrower' } );
201 my $patron_2 = $builder->build( { source => 'Borrower' } );
202 my $last_patron = Koha::Patrons->search->last;
203 is( $last_patron->borrowernumber, $patron_2->{borrowernumber}, '->last should return the last inserted patron' );
204 $last_patron = Koha::Patrons->search({ borrowernumber => $patron_1->{borrowernumber} })->last;
205 is( $last_patron->borrowernumber, $patron_1->{borrowernumber}, '->last should work even if there is only 1 result' );
206 $last_patron = Koha::Patrons->search({ surname => 'should_not_exist' })->last;
207 is( $last_patron, undef, '->last should return undef if search does not return any results' );
210 subtest 'get_column' => sub {
211 plan tests => 1;
212 my @cities = Koha::Cities->search;
213 my @city_names = map { $_->city_name } @cities;
214 is_deeply( [ Koha::Cities->search->get_column('city_name') ], \@city_names, 'Koha::Objects->get_column should be allowed' );
217 subtest 'Exceptions' => sub {
218 plan tests => 7;
220 my $patron_borrowernumber = $builder->build({ source => 'Borrower' })->{ borrowernumber };
221 my $patron = Koha::Patrons->find( $patron_borrowernumber );
223 # Koha::Object
224 try {
225 $patron->blah('blah');
226 } catch {
227 ok( $_->isa('Koha::Exceptions::Object::MethodNotCoveredByTests'),
228 'Calling a non-covered method should raise a Koha::Exceptions::Object::MethodNotCoveredByTests exception' );
229 is( $_->message, 'The method Koha::Patron->blah is not covered by tests!', 'The message raised should contain the package and the method' );
232 try {
233 $patron->set({ blah => 'blah' });
234 } catch {
235 ok( $_->isa('Koha::Exceptions::Object::PropertyNotFound'),
236 'Setting a non-existent property should raise a Koha::Exceptions::Object::PropertyNotFound exception' );
239 # Koha::Objects
240 try {
241 Koha::Patrons->search->not_covered_yet;
242 } catch {
243 ok( $_->isa('Koha::Exceptions::Object::MethodNotCoveredByTests'),
244 'Calling a non-covered method should raise a Koha::Exceptions::Object::MethodNotCoveredByTests exception' );
245 is( $_->message, 'The method Koha::Patrons->not_covered_yet is not covered by tests!', 'The message raised should contain the package and the method' );
248 try {
249 Koha::Patrons->not_covered_yet;
250 } catch {
251 ok( $_->isa('Koha::Exceptions::Object::MethodNotCoveredByTests'),
252 'Calling a non-covered method should raise a Koha::Exceptions::Object::MethodNotCoveredByTests exception' );
253 is( $_->message, 'The method Koha::Patrons->not_covered_yet is not covered by tests!', 'The message raised should contain the package and the method' );
257 $schema->storage->txn_rollback;
259 subtest '->is_paged and ->pager tests' => sub {
261 plan tests => 5;
263 $schema->storage->txn_begin;
265 # Count existing patrons
266 my $nb_patrons = Koha::Patrons->search()->count;
267 # Create 10 more patrons
268 foreach (1..10) {
269 $builder->build_object({ class => 'Koha::Patrons' });
272 # Non-paginated search
273 my $patrons = Koha::Patrons->search();
274 is( $patrons->count, $nb_patrons + 10, 'Search returns all patrons' );
275 ok( !$patrons->is_paged, 'Search is not paged' );
277 # Paginated search
278 $patrons = Koha::Patrons->search( undef, { 'page' => 1, 'rows' => 3 } );
279 is( $patrons->count, 3, 'Search returns only one page, 3 patrons' );
280 ok( $patrons->is_paged, 'Search is paged' );
281 my $pager = $patrons->pager;
282 is( ref($patrons->pager), 'DBIx::Class::ResultSet::Pager',
283 'Koha::Objects->pager returns a valid DBIx::Class object' );
285 $schema->storage->txn_rollback;
288 subtest '->search() tests' => sub {
290 plan tests => 12;
292 $schema->storage->txn_begin;
294 my $count = Koha::Patrons->search->count;
296 # Create 10 patrons
297 foreach (1..10) {
298 $builder->build_object({ class => 'Koha::Patrons' });
301 my $patrons = Koha::Patrons->search();
302 is( ref($patrons), 'Koha::Patrons', 'search in scalar context returns the Koha::Object-based type' );
303 my @patrons = Koha::Patrons->search();
304 is( scalar @patrons, $count + 10, 'search in list context returns a list of objects' );
305 my $i = 0;
306 foreach (1..10) {
307 is( ref($patrons[$i]), 'Koha::Patron', 'Objects in the list have the singular type' );
308 $i++;
311 $schema->storage->txn_rollback;
314 subtest "to_api() tests" => sub {
316 plan tests => 18;
318 $schema->storage->txn_begin;
320 my $city_1 = $builder->build_object( { class => 'Koha::Cities' } );
321 my $city_2 = $builder->build_object( { class => 'Koha::Cities' } );
323 my $cities = Koha::Cities->search(
325 cityid => [ $city_1->cityid, $city_2->cityid ]
327 { -orderby => { -desc => 'cityid' } }
330 is( $cities->count, 2, 'Count is correct' );
331 my $cities_api = $cities->to_api;
332 is( ref( $cities_api ), 'ARRAY', 'to_api returns an array' );
333 is_deeply( $cities_api->[0], $city_1->to_api, 'to_api returns the individual objects with ->to_api' );
334 is_deeply( $cities_api->[1], $city_2->to_api, 'to_api returns the individual objects with ->to_api' );
336 my $biblio_1 = $builder->build_sample_biblio();
337 my $item_1 = $builder->build_sample_item({ biblionumber => $biblio_1->biblionumber });
338 my $hold_1 = $builder->build_object(
340 class => 'Koha::Holds',
341 value => { itemnumber => $item_1->itemnumber }
345 my $biblio_2 = $builder->build_sample_biblio();
346 my $item_2 = $builder->build_sample_item({ biblionumber => $biblio_2->biblionumber });
347 my $hold_2 = $builder->build_object(
349 class => 'Koha::Holds',
350 value => { itemnumber => $item_2->itemnumber }
354 my $embed = { 'items' => {} };
356 my $i = 0;
357 my @items = ( $item_1, $item_2 );
358 my @holds = ( $hold_1, $hold_2 );
360 my $biblios_api = Koha::Biblios->search(
362 biblionumber => [ $biblio_1->biblionumber, $biblio_2->biblionumber ]
364 )->to_api( { embed => $embed } );
366 foreach my $biblio_api ( @{ $biblios_api } ) {
367 ok(exists $biblio_api->{items}, 'Items where embedded in biblio results');
368 is($biblio_api->{items}->[0]->{item_id}, $items[$i]->itemnumber, 'Item matches');
369 ok(!exists $biblio_api->{items}->[0]->{holds}, 'No holds info should be embedded yet');
371 $i++;
374 # One more level
375 $embed = {
376 'items' => {
377 children => { 'holds' => {} }
381 $i = 0;
383 $biblios_api = Koha::Biblios->search(
385 biblionumber => [ $biblio_1->biblionumber, $biblio_2->biblionumber ]
387 )->to_api( { embed => $embed } );
389 foreach my $biblio_api ( @{ $biblios_api } ) {
391 ok(exists $biblio_api->{items}, 'Items where embedded in biblio results');
392 is($biblio_api->{items}->[0]->{item_id}, $items[$i]->itemnumber, 'Item still matches');
393 ok(exists $biblio_api->{items}->[0]->{holds}, 'Holds info should be embedded');
394 is($biblio_api->{items}->[0]->{holds}->[0]->{hold_id}, $holds[$i]->reserve_id, 'Hold matches');
396 $i++;
399 $schema->storage->txn_rollback;
402 subtest "TO_JSON() tests" => sub {
404 plan tests => 4;
406 $schema->storage->txn_begin;
408 my $city_1 = $builder->build_object( { class => 'Koha::Cities' } );
409 my $city_2 = $builder->build_object( { class => 'Koha::Cities' } );
411 my $cities = Koha::Cities->search(
413 cityid => [ $city_1->cityid, $city_2->cityid ]
415 { -orderby => { -desc => 'cityid' } }
418 is( $cities->count, 2, 'Count is correct' );
419 my $cities_json = $cities->TO_JSON;
420 is( ref($cities_json), 'ARRAY', 'to_api returns an array' );
421 is_deeply( $cities_json->[0], $city_1->TO_JSON, 'TO_JSON returns the individual objects with ->TO_JSON' );
422 is_deeply( $cities_json->[1], $city_2->TO_JSON,'TO_JSON returns the individual objects with ->TO_JSON' );
424 $schema->storage->txn_rollback;
427 # Koha::Object[s] must behave the same as DBIx::Class
428 subtest 'Return same values as DBIx::Class' => sub {
429 plan tests => 2;
431 subtest 'Delete' => sub {
432 plan tests => 2;
434 $schema->storage->txn_begin;
436 subtest 'Simple Koha::Objects - Koha::Cities' => sub {
437 plan tests => 2;
439 subtest 'Koha::Object->delete' => sub {
441 plan tests => 5;
443 my ( $r_us, $e_us, $r_them, $e_them );
445 # CASE 1 - Delete an existing object
446 my $c = Koha::City->new( { city_name => 'city4test' } )->store;
447 try { $r_us = $c->delete; } catch { $e_us = $_ };
448 $c = $schema->resultset('City')->new( { city_name => 'city4test_2' } )->update_or_insert;
449 try { $r_them = $c->delete; } catch { $e_them = $_ };
450 ok( ref($r_us) && ref($r_them),
451 'Successful delete should return the object ' );
452 ok( !defined $e_us && !defined $e_them,
453 'Successful delete should not raise an exception' );
454 is( ref($r_us), 'Koha::City', 'Successful delete should return our Koha::Obect based object' );
456 # CASE 2 - Delete an object that is not in storage
457 try { $r_us = $r_us->delete; } catch { $e_us = $_ };
458 try { $r_them = $r_them->delete; } catch { $e_them = $_ };
460 defined $e_us && defined $e_them,
461 'Delete an object that is not in storage should raise an exception'
463 is( ref($e_us), 'DBIx::Class::Exception' )
464 ; # FIXME This needs adjustement, we want to throw a Koha::Exception
468 subtest 'Koha::Objects->delete' => sub {
470 plan tests => 4;
472 my ( $r_us, $e_us, $r_them, $e_them );
474 # CASE 1 - Delete existing objects
475 my $city_1 = $builder->build_object({ class => 'Koha::Cities' });
476 my $city_2 = $builder->build_object({ class => 'Koha::Cities' });
477 my $city_3 = $builder->build_object({ class => 'Koha::Cities' });
478 my $cities = Koha::Cities->search(
480 cityid => {
481 -in => [
482 $city_1->cityid,
483 $city_2->cityid,
484 $city_3->cityid,
490 try { $r_us = $cities->delete; } catch { $e_us = $_ };
492 $city_1 = $builder->build_object({ class => 'Koha::Cities' });
493 $city_2 = $builder->build_object({ class => 'Koha::Cities' });
494 $city_3 = $builder->build_object({ class => 'Koha::Cities' });
495 $cities = $schema->resultset('City')->search(
497 cityid => {
498 -in => [
499 $city_1->cityid,
500 $city_2->cityid,
501 $city_3->cityid,
507 try { $r_them = $cities->delete; } catch { $e_them = $_ };
509 ok( $r_us == 3 && $r_them == 3 );
510 ok (!defined($e_us) && !defined($e_them));
512 # CASE 2 - One of the object is not in storage
513 $city_1 = $builder->build_object({ class => 'Koha::Cities' });
514 $city_2 = $builder->build_object({ class => 'Koha::Cities' });
515 $city_3 = $builder->build_object({ class => 'Koha::Cities' });
516 $cities = Koha::Cities->search(
518 cityid => {
519 -in => [
520 $city_1->cityid,
521 $city_2->cityid,
522 $city_3->cityid,
528 $city_2->delete; # We delete one of the object
529 try { $r_us = $cities->delete; } catch { $e_us = $_ };
531 $city_1 = $builder->build_object({ class => 'Koha::Cities' });
532 $city_2 = $builder->build_object({ class => 'Koha::Cities' });
533 $city_3 = $builder->build_object({ class => 'Koha::Cities' });
534 $cities = $schema->resultset('City')->search(
536 cityid => {
537 -in => [
538 $city_1->cityid,
539 $city_2->cityid,
540 $city_3->cityid,
546 $city_2->delete; # We delete one of the object
547 try { $r_them = $cities->delete; } catch { $e_them = $_ };
549 ok( $r_us == 2 && $r_them == 2 );
550 ok (!defined($e_us) && !defined($e_them));
554 subtest 'Overwritten Koha::Objects->delete - Koha::Patrons' => sub {
556 plan tests => 2;
558 subtest 'Koha::Object->delete' => sub {
560 plan tests => 7;
562 my ( $r_us, $e_us, $r_them, $e_them );
564 # CASE 1 - Delete an existing patron
565 my $patron = $builder->build_object({ class => 'Koha::Patrons' });
566 my $patron_data = $patron->unblessed;
567 $patron->delete;
569 $patron = Koha::Patron->new( $patron_data )->store;
570 try {$r_us = $patron->delete;} catch { $e_us = $_ };
571 $patron = $schema->resultset('Borrower')->new( $patron_data )->update_or_insert;
572 try {$r_them = $patron->delete;} catch { $e_them = $_ };
573 ok( ref($r_us) && ref($r_them),
574 'Successful delete should return the patron object' );
575 ok( !defined $e_us && !defined $e_them,
576 'Successful delete should not raise an exception' );
577 is( ref($r_us), 'Koha::Patron',
578 'Successful delete should return our Koha::Obect based object' );
580 # CASE 2 - Delete a patron that is not in storage
581 try { $r_us = $r_us->delete; } catch { $e_us = $_ };
582 try { $r_them = $r_them->delete; } catch { $e_them = $_ };
584 defined $e_us && defined $e_them,
585 'Delete a patron that is not in storage should raise an exception'
587 is( ref($e_us), 'DBIx::Class::Exception' )
588 ; # FIXME This needs adjustement, we want to throw a Koha::Exception
590 # CASE 3 - Delete a patron that cannot be deleted (as a checkout)
591 $patron = Koha::Patron->new($patron_data)->store;
592 $builder->build_object(
594 class => 'Koha::Checkouts',
595 value => { borrowernumber => $patron->borrowernumber }
598 try { $r_us = $r_us->delete; } catch { $e_us = $_ };
599 $patron = $schema->resultset('Borrower')->find( $patron->borrowernumber );
600 try { $r_them = $r_them->delete; } catch { $e_them = $_ };
602 defined $e_us && defined $e_them,
603 'Delete a patron that cannot be deleted should raise an exception'
605 is( ref($e_us), 'DBIx::Class::Exception' )
606 ; # FIXME This needs adjustement, we want to throw a Koha::Exception
609 subtest 'Koha::Objects->delete' => sub {
611 plan tests => 7;
613 my ( $r_us, $e_us, $r_them, $e_them );
615 # CASE 1 - Delete existing objects
616 my $patron_1 = $builder->build_object({ class => 'Koha::Patrons' });
617 my $patron_2 = $builder->build_object({ class => 'Koha::Patrons' });
618 my $patron_3 = $builder->build_object({ class => 'Koha::Patrons' });
619 my $patrons = Koha::Patrons->search(
621 borrowernumber => {
622 -in => [
623 $patron_1->borrowernumber,
624 $patron_2->borrowernumber,
625 $patron_3->borrowernumber
631 try { $r_us = $patrons->delete; } catch { $e_us = $_ };
633 $patron_1 = $builder->build_object({ class => 'Koha::Patrons' });
634 $patron_2 = $builder->build_object({ class => 'Koha::Patrons' });
635 $patron_3 = $builder->build_object({ class => 'Koha::Patrons' });
636 $patrons = $schema->resultset('Borrower')->search(
638 borrowernumber => {
639 -in => [
640 $patron_1->borrowernumber,
641 $patron_2->borrowernumber,
642 $patron_3->borrowernumber
648 try { $r_them = $patrons->delete; } catch { $e_them = $_ };
650 ok( $r_us == 3 && $r_them == 3, '->delete should return the number of deleted patrons' );
651 ok (!defined($e_us) && !defined($e_them), '->delete should not raise exception if everything went well');
653 # CASE 2 - One of the patrons is not in storage
654 undef $_ for $r_us, $e_us, $r_them, $e_them;
655 $patron_1 = $builder->build_object({ class => 'Koha::Patrons' });
656 $patron_2 = $builder->build_object({ class => 'Koha::Patrons' });
657 $patron_3 = $builder->build_object({ class => 'Koha::Patrons' });
658 $patrons = Koha::Patrons->search(
660 borrowernumber => {
661 -in => [
662 $patron_1->borrowernumber,
663 $patron_2->borrowernumber,
664 $patron_3->borrowernumber
670 $patron_2->delete; # We delete one of the patron
671 try { $r_us = $patrons->delete; } catch { $e_us = $_ };
673 $patron_1 = $builder->build_object({ class => 'Koha::Patrons' });
674 $patron_2 = $builder->build_object({ class => 'Koha::Patrons' });
675 $patron_3 = $builder->build_object({ class => 'Koha::Patrons' });
676 $patrons = $schema->resultset('Borrower')->search(
678 borrowernumber => {
679 -in => [
680 $patron_1->borrowernumber,
681 $patron_2->borrowernumber,
682 $patron_3->borrowernumber
688 $patron_2->delete; # We delete one of the patron
689 try { $r_them = $patrons->delete; } catch { $e_them = $_ };
691 ok( $r_us == 2 && $r_them == 2, 'Delete patrons with one that was not in storage should delete the patrons' );
692 ok (!defined($e_us) && !defined($e_them), 'no exception should be raised if at least one patron was not in storage');
694 # CASE 3 - Delete a set of patrons with one that that cannot be deleted (as a checkout)
695 undef $_ for $r_us, $e_us, $r_them, $e_them;
696 $patron_1 = $builder->build_object({ class => 'Koha::Patrons' });
697 $patron_2 = $builder->build_object({ class => 'Koha::Patrons' });
698 $patron_3 = $builder->build_object({ class => 'Koha::Patrons' });
699 $patrons = Koha::Patrons->search(
701 borrowernumber => {
702 -in => [
703 $patron_1->borrowernumber,
704 $patron_2->borrowernumber,
705 $patron_3->borrowernumber
711 # Adding a checkout to patron_2
712 $builder->build_object(
714 class => 'Koha::Checkouts',
715 value => { borrowernumber => $patron_2->borrowernumber }
719 try { $r_us = $patrons->delete; } catch { $e_us = $_ };
720 my $not_deleted_us = $patron_1->in_storage + $patron_2->in_storage + $patron_3->in_storage;
722 $patron_1 = $builder->build_object({ class => 'Koha::Patrons' });
723 $patron_2 = $builder->build_object({ class => 'Koha::Patrons' });
724 $patron_3 = $builder->build_object({ class => 'Koha::Patrons' });
725 $patrons = $schema->resultset('Borrower')->search(
727 borrowernumber => {
728 -in => [
729 $patron_1->borrowernumber,
730 $patron_2->borrowernumber,
731 $patron_3->borrowernumber
737 # Adding a checkout to patron_2
738 $builder->build_object(
740 class => 'Koha::Checkouts',
741 value => { borrowernumber => $patron_2->borrowernumber }
745 try { $r_them = $patrons->delete; } catch { $e_them = $_ };
747 my $not_deleted_them = $patron_1->in_storage + $patron_2->in_storage + $patron_3->in_storage;
749 defined $e_us && defined $e_them,
750 'Delete patrons with one that cannot be deleted should raise an exception'
752 is( ref($e_us), 'DBIx::Class::Exception' )
753 ; # FIXME This needs adjustement, we want to throw a Koha::Exception
755 ok($not_deleted_us == 3 && $not_deleted_them == 3, 'If one patron cannot be deleted, none should have been deleted');
759 $schema->storage->txn_rollback;
763 subtest 'Update (set/store)' => sub {
764 plan tests => 2;
766 $schema->storage->txn_begin;
768 subtest 'Simple Koha::Objects - Koha::Cities' => sub {
769 plan tests => 2;
771 subtest 'Koha::Object->update' => sub {
773 plan tests => 5;
775 my ( $r_us, $e_us, $r_them, $e_them );
777 # CASE 1 - Update an existing object
778 my $c_us = Koha::City->new( { city_name => 'city4test' } )->store;
779 try { $r_us = $c_us->update({ city_country => 'country4test' }); } catch { $e_us = $_ };
780 my $c_them = $schema->resultset('City')->new( { city_name => 'city4test_2' } )->update_or_insert;
781 try { $r_them = $c_them->update({ city_country => 'country4test_2' }); } catch { $e_them = $_ };
782 ok( ref($r_us) && ref($r_them),
783 'Successful update should return the object ' );
784 ok( !defined $e_us && !defined $e_them,
785 'Successful update should not raise an exception' );
786 is( ref($r_us), 'Koha::City', 'Successful update should return our Koha::Obect based object' );
788 # CASE 2 - Update an object that is not in storage
789 $c_us->delete;
790 $c_them->delete;
791 try { $r_us = $c_us->update({ city_country => 'another_country' }); } catch { $e_us = $_ };
792 try { $r_them = $c_them->update({ city_country => 'another_country' }); } catch { $e_them = $_ };
794 defined $e_us && defined $e_them,
795 'Update an object that is not in storage should raise an exception'
797 is( ref($e_us), 'Koha::Exceptions::Object::NotInStorage' );
800 subtest 'Koha::Objects->update' => sub {
802 plan tests => 6;
804 my ( $r_us, $e_us, $r_them, $e_them );
806 # CASE 1 - update existing objects
807 my $city_1 = $builder->build_object({ class => 'Koha::Cities' });
808 my $city_2 = $builder->build_object({ class => 'Koha::Cities' });
809 my $city_3 = $builder->build_object({ class => 'Koha::Cities' });
810 my $cities = Koha::Cities->search(
812 cityid => {
813 -in => [
814 $city_1->cityid,
815 $city_2->cityid,
816 $city_3->cityid,
822 try { $r_us = $cities->update({ city_country => 'country4test' }); } catch { $e_us = $_ };
824 $city_1 = $builder->build_object({ class => 'Koha::Cities' });
825 $city_2 = $builder->build_object({ class => 'Koha::Cities' });
826 $city_3 = $builder->build_object({ class => 'Koha::Cities' });
827 $cities = $schema->resultset('City')->search(
829 cityid => {
830 -in => [
831 $city_1->cityid,
832 $city_2->cityid,
833 $city_3->cityid,
839 try { $r_them = $cities->update({ city_country => 'country4test' }); } catch { $e_them = $_ };
841 ok( $r_us == 3 && $r_them == 3, '->update should return the number of updated cities' );
842 ok(!defined($e_us) && !defined($e_them));
844 # CASE 2 - One of the object is not in storage
845 $city_1 = $builder->build_object({ class => 'Koha::Cities' });
846 $city_2 = $builder->build_object({ class => 'Koha::Cities' });
847 $city_3 = $builder->build_object({ class => 'Koha::Cities' });
848 $cities = Koha::Cities->search(
850 cityid => {
851 -in => [
852 $city_1->cityid,
853 $city_2->cityid,
854 $city_3->cityid,
860 $city_2->delete; # We delete one of the object
861 try { $r_us = $cities->update({ city_country => 'country4test' }); } catch { $e_us = $_ };
863 $city_1 = $builder->build_object({ class => 'Koha::Cities' });
864 $city_2 = $builder->build_object({ class => 'Koha::Cities' });
865 $city_3 = $builder->build_object({ class => 'Koha::Cities' });
866 $cities = $schema->resultset('City')->search(
868 cityid => {
869 -in => [
870 $city_1->cityid,
871 $city_2->cityid,
872 $city_3->cityid,
878 $city_2->delete; # We delete one of the object
879 try { $r_them = $cities->update({ city_country => 'country4test' }); } catch { $e_them = $_ };
881 ok( $r_us == 2 && $r_them == 2, '->update should return the number of updated cities' );
882 ok(!defined($e_us) && !defined($e_them));
884 throws_ok
885 { Koha::Cities->update({ city_country => 'Castalia' }); }
886 'Koha::Exceptions::Object::NotInstantiated',
887 'Exception thrown if not instantiated class';
889 is( "$@", 'Tried to access the \'update\' method, but Koha::Cities is not instantiated', 'Exception stringified correctly' );
894 subtest 'Overwritten Koha::Objects->store|update - Koha::Patrons' => sub {
896 plan tests => 2;
898 subtest 'Koha::Object->update' => sub {
900 plan tests => 5;
902 my ( $r_us, $e_us, $r_them, $e_them );
904 # CASE 1 - Update an existing patron
905 my $patron_us = $builder->build_object({ class => 'Koha::Patrons' });
906 try {$r_us = $patron_us->update({city => 'a_city'});} catch { $e_us = $_ };
908 my $patron_data = $builder->build_object({ class => 'Koha::Patrons' })->delete->unblessed;
909 my $patron_them = $schema->resultset('Borrower')->new( $patron_data )->update_or_insert;
910 try {$r_them = $patron_them->update({city => 'a_city'});} catch { $e_them = $_ };
911 ok( ref($r_us) && ref($r_them),
912 'Successful update should return the patron object' );
913 ok( !defined $e_us && !defined $e_them,
914 'Successful update should not raise an exception' );
915 is( ref($r_us), 'Koha::Patron',
916 'Successful update should return our Koha::Obect based object' );
918 # CASE 2 - Update a patron that is not in storage
919 $patron_us->delete;
920 $patron_them->delete;
921 try { $r_us = $patron_us->update({ city => 'another_city' }); } catch { $e_us = $_ };
922 try { $r_them = $patron_them->update({ city => 'another_city' }); } catch { $e_them = $_ };
924 defined $e_us && defined $e_them,
925 'Update a patron that is not in storage should raise an exception'
927 is( ref($e_us), 'Koha::Exceptions::Object::NotInStorage' );
931 subtest 'Koha::Objects->Update ' => sub {
933 plan tests => 6;
935 my ( $r_us, $e_us, $r_them, $e_them );
937 # CASE 1 - Update existing objects
938 my $patron_1 = $builder->build_object({ class => 'Koha::Patrons' });
939 my $patron_2 = $builder->build_object({ class => 'Koha::Patrons' });
940 my $patron_3 = $builder->build_object({ class => 'Koha::Patrons' });
941 my $patrons_us = Koha::Patrons->search(
943 borrowernumber => {
944 -in => [
945 $patron_1->borrowernumber,
946 $patron_2->borrowernumber,
947 $patron_3->borrowernumber
953 try { $r_us = $patrons_us->update({ city => 'a_city' }); } catch { $e_us = $_ };
955 $patron_1 = $builder->build_object({ class => 'Koha::Patrons' });
956 $patron_2 = $builder->build_object({ class => 'Koha::Patrons' });
957 $patron_3 = $builder->build_object({ class => 'Koha::Patrons' });
958 my $patrons_them = $schema->resultset('Borrower')->search(
960 borrowernumber => {
961 -in => [
962 $patron_1->borrowernumber,
963 $patron_2->borrowernumber,
964 $patron_3->borrowernumber
970 try { $r_them = $patrons_them->update({ city => 'a_city' }); } catch { $e_them = $_ };
972 ok( $r_us == 3 && $r_them == 3, '->update should return the number of update patrons' );
973 ok (!defined($e_us) && !defined($e_them), '->update should not raise exception if everything went well');
975 # CASE 2 - One of the patrons is not in storage
976 undef $_ for $r_us, $e_us, $r_them, $e_them;
977 $patron_1 = $builder->build_object({ class => 'Koha::Patrons' });
978 $patron_2 = $builder->build_object({ class => 'Koha::Patrons' });
979 $patron_3 = $builder->build_object({ class => 'Koha::Patrons' });
980 $patrons_us = Koha::Patrons->search(
982 borrowernumber => {
983 -in => [
984 $patron_1->borrowernumber,
985 $patron_2->borrowernumber,
986 $patron_3->borrowernumber
992 $patron_2->delete; # We delete one of the patron
993 try { $r_us = $patrons_us->update({ city => 'another_city' }); } catch { $e_us = $_ };
995 $patron_1 = $builder->build_object({ class => 'Koha::Patrons' });
996 $patron_2 = $builder->build_object({ class => 'Koha::Patrons' });
997 $patron_3 = $builder->build_object({ class => 'Koha::Patrons' });
998 $patrons_them = $schema->resultset('Borrower')->search(
1000 borrowernumber => {
1001 -in => [
1002 $patron_1->borrowernumber,
1003 $patron_2->borrowernumber,
1004 $patron_3->borrowernumber
1010 $patron_2->delete; # We delete one of the patron
1011 try { $r_them = $patrons_them->update({ city => 'another_city' }); } catch { $e_them = $_ };
1013 ok( $r_us == 2 && $r_them == 2, 'Update patrons with one that was not in storage should update the patrons' );
1014 ok (!defined($e_us) && !defined($e_them), 'no exception should be raised if at least one patron was not in storage');
1017 # Testing no_triggers
1018 t::lib::Mocks::mock_preference('uppercasesurnames', 1);
1019 $patrons_us = Koha::Patrons->search(
1021 borrowernumber => {
1022 -in => [
1023 $patron_1->borrowernumber,
1024 $patron_2->borrowernumber,
1025 $patron_3->borrowernumber
1030 $patrons_us->update({ surname => 'foo' }); # Koha::Patron->store is supposed to uppercase the surnames
1031 is( $patrons_us->search({ surname => 'FOO' })->count, 2, 'Koha::Patron->store is hit' );
1033 $patrons_us->update({ surname => 'foo' }, { no_triggers => 1 }); # The surnames won't be uppercase as we won't hit Koha::Patron->store
1034 is( $patrons_us->search({ surname => 'foo' })->count, 2, 'Koha::Patron->store is not hit');
1040 $schema->storage->txn_rollback;
1046 subtest "attributes_from_api() tests" => sub {
1048 plan tests => 1;
1050 $schema->storage->txn_begin;
1052 my $cities_rs = Koha::Cities->new;
1053 my $city = Koha::City->new;
1055 my $api_attributes = {
1056 name => 'Cordoba',
1057 postal_code => 5000
1060 is_deeply(
1061 $cities_rs->attributes_from_api($api_attributes),
1062 $city->attributes_from_api($api_attributes)
1065 $schema->storage->txn_rollback;
1069 subtest "filter_by_last_update" => sub {
1071 $schema->storage->txn_begin;
1073 my $now = dt_from_string->truncate( to => 'day' );
1074 my @borrowernumbers;
1075 # Building 6 patrons that have been created today, yesterday, ... 1 per day
1076 for my $i ( 0 .. 5 ) {
1077 push @borrowernumbers,
1078 $builder->build_object(
1080 class => 'Koha::Patrons',
1081 value => { updated_on => $now->clone->subtract( days => $i ) }
1083 )->borrowernumber;
1086 my $patrons = Koha::Patrons->search(
1087 { borrowernumber => { -in => \@borrowernumbers } } );
1089 try {
1090 $patrons->filter_by_last_update( { timestamp_column_name => 'updated_on' } )
1091 ->count;
1093 catch {
1095 $_->isa('Koha::Exceptions::MissingParameter'),
1096 'Should raise an exception if no parameter given'
1100 my $count = $patrons->filter_by_last_update(
1101 { timestamp_column_name => 'updated_on', days => 2 } )->count;
1102 is( $count, 3, '3 patrons have been updated before the last 2 days (exclusive)' );
1104 $count = $patrons->filter_by_last_update(
1105 { timestamp_column_name => 'updated_on', days => 1 } )->count;
1106 is( $count, 4, '4 patrons have been updated before yesterday (exclusive)' );
1108 $count = $patrons->filter_by_last_update(
1109 { timestamp_column_name => 'updated_on', days => 0 } )->count;
1110 is( $count, 5, '5 patrons have been updated before today (exclusive)' );
1112 $count = $patrons->filter_by_last_update(
1113 { timestamp_column_name => 'updated_on', from => $now } )->count;
1114 is( $count, 1, '1 patron has been updated "from today" (inclusive)' );
1116 $count = $patrons->filter_by_last_update(
1117 { timestamp_column_name => 'updated_on', to => $now } )->count;
1118 is( $count, 6, '6 patrons have been updated "to today" (inclusive)' );
1120 $count = $patrons->filter_by_last_update(
1122 timestamp_column_name => 'updated_on',
1123 from => $now->clone->subtract( days => 4 ),
1124 to => $now->clone->subtract( days => 2 )
1126 )->count;
1127 is( $count, 3, '3 patrons have been updated between D-4 and D-2' );
1129 t::lib::Mocks::mock_preference( 'dateformat', 'metric' );
1130 try {
1131 $count = $patrons->filter_by_last_update(
1132 { timestamp_column_name => 'updated_on', from => '1970-12-31' } )
1133 ->count;
1135 catch {
1137 $_->isa(
1138 'No exception raised, from and to parameters can take an iso formatted date'
1142 try {
1143 $count = $patrons->filter_by_last_update(
1144 { timestamp_column_name => 'updated_on', from => '31/12/1970' } )
1145 ->count;
1147 catch {
1149 $_->isa(
1150 'No exception raised, from and to parameters can take an metric formatted date (depending on dateformat syspref)'
1155 $schema->storage->txn_rollback;
1158 subtest "from_api_mapping() tests" => sub {
1160 plan tests => 1;
1162 $schema->storage->txn_begin;
1164 my $cities_rs = Koha::Cities->new;
1165 my $city = Koha::City->new;
1167 is_deeply(
1168 $cities_rs->from_api_mapping,
1169 $city->from_api_mapping
1172 $schema->storage->txn_rollback;
1175 subtest 'prefetch_whitelist() tests' => sub {
1177 plan tests => 3;
1179 $schema->storage->txn_begin;
1181 my $biblios = Koha::Biblios->new;
1183 my $prefetch_whitelist = $biblios->prefetch_whitelist;
1186 exists $prefetch_whitelist->{orders},
1187 'Relationship matching method name is listed'
1190 $prefetch_whitelist->{orders},
1191 'Koha::Acquisition::Order',
1192 'Guessed the non-standard object class correctly'
1196 $prefetch_whitelist->{items},
1197 'Koha::Item',
1198 'Guessed the standard object class correctly'
1201 $schema->storage->txn_rollback;
1204 subtest 'empty() tests' => sub {
1206 plan tests => 6;
1208 $schema->storage->txn_begin;
1210 # Add a patron, we need at least 1
1211 my $patron = $builder->build_object({ class => 'Koha::Patrons' });
1212 ok( Koha::Patrons->count > 0, 'There is at least one Koha::Patron on the resultset' );
1214 my $empty = Koha::Patrons->new->empty;
1215 is( ref($empty), 'Koha::Patrons', '->empty returns a Koha::Patrons iterator' );
1216 is( $empty->count, 0, 'The empty resultset is, well, empty :-D' );
1218 my $new_rs = $empty->search({ borrowernumber => $patron->borrowernumber });
1220 is( $new_rs->count, 0, 'Further chaining an empty resultset, returns an empty resultset' );
1222 throws_ok
1223 { Koha::Patrons->empty; }
1224 'Koha::Exceptions::Object::NotInstantiated',
1225 'Exception thrown if not instantiated class';
1227 is( "$@", 'Tried to access the \'empty\' method, but Koha::Patrons is not instantiated', 'Exception stringified correctly' );
1229 $schema->storage->txn_rollback;
1232 subtest 'delete() tests' => sub {
1234 plan tests => 2;
1236 $schema->storage->txn_begin;
1238 # Make sure no cities
1239 warnings_are { Koha::Cities->delete }[],
1240 "No warnings, no Koha::City->delete called as it doesn't exist";
1242 # Mock Koha::City
1243 my $mocked_city = Test::MockModule->new('Koha::City');
1244 $mocked_city->mock(
1245 'delete',
1246 sub {
1247 shift->_result->delete;
1248 warn "delete called!";
1252 # Add two cities
1253 $builder->build_object( { class => 'Koha::Cities' } );
1254 $builder->build_object( { class => 'Koha::Cities' } );
1256 my $cities = Koha::Cities->search;
1257 $cities->next;
1258 warnings_are { $cities->delete }
1259 [ "delete called!", "delete called!" ],
1260 "No warnings, no Koha::City->delete called as it doesn't exist";
1262 $schema->storage->txn_rollback;