Bug 26892: Remove warnings from Koha/Patrons.t
[koha.git] / t / db_dependent / Koha / Patrons.t
1 #!/usr/bin/perl
2
3 # Copyright 2015 Koha Development team
4 #
5 # This file is part of Koha
6 #
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.
11 #
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.
16 #
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>.
19
20 use Modern::Perl;
21
22 use Test::More tests => 41;
23 use Test::Warn;
24 use Test::Exception;
25 use Test::MockModule;
26 use Time::Fake;
27 use DateTime;
28 use JSON;
29 use Data::Dumper;
30 use utf8;
31
32 use C4::Circulation;
33 use C4::Biblio;
34 use C4::Auth qw(checkpw_hash);
35
36 use Koha::ActionLogs;
37 use Koha::Holds;
38 use Koha::Old::Holds;
39 use Koha::Patrons;
40 use Koha::Old::Patrons;
41 use Koha::Patron::Attribute::Types;
42 use Koha::Patron::Categories;
43 use Koha::Patron::Relationship;
44 use Koha::Database;
45 use Koha::DateUtils;
46 use Koha::Virtualshelves;
47
48 use t::lib::TestBuilder;
49 use t::lib::Mocks;
50
51 my $schema = Koha::Database->new->schema;
52 $schema->storage->txn_begin;
53
54 my $builder       = t::lib::TestBuilder->new;
55 my $library = $builder->build({source => 'Branch' });
56 my $category = $builder->build({source => 'Category' });
57 my $nb_of_patrons = Koha::Patrons->search->count;
58 my $new_patron_1  = Koha::Patron->new(
59     {   cardnumber => 'test_cn_1',
60         branchcode => $library->{branchcode},
61         categorycode => $category->{categorycode},
62         surname => 'surname for patron1',
63         firstname => 'firstname for patron1',
64         userid => 'a_nonexistent_userid_1',
65         flags => 1, # Is superlibrarian
66     }
67 )->store;
68 my $new_patron_2  = Koha::Patron->new(
69     {   cardnumber => 'test_cn_2',
70         branchcode => $library->{branchcode},
71         categorycode => $category->{categorycode},
72         surname => 'surname for patron2',
73         firstname => 'firstname for patron2',
74         userid => 'a_nonexistent_userid_2',
75     }
76 )->store;
77
78 t::lib::Mocks::mock_userenv({ patron => $new_patron_1 });
79
80 is( Koha::Patrons->search->count, $nb_of_patrons + 2, 'The 2 patrons should have been added' );
81
82 my $retrieved_patron_1 = Koha::Patrons->find( $new_patron_1->borrowernumber );
83 is( $retrieved_patron_1->cardnumber, $new_patron_1->cardnumber, 'Find a patron by borrowernumber should return the correct patron' );
84
85 subtest 'library' => sub {
86     plan tests => 2;
87     is( $retrieved_patron_1->library->branchcode, $library->{branchcode}, 'Koha::Patron->library should return the correct library' );
88     is( ref($retrieved_patron_1->library), 'Koha::Library', 'Koha::Patron->library should return a Koha::Library object' );
89 };
90
91 subtest 'sms_provider' => sub {
92     plan tests => 3;
93     my $sms_provider = $builder->build({source => 'SmsProvider' });
94     is( $retrieved_patron_1->sms_provider, undef, '->sms_provider should return undef if none defined' );
95     $retrieved_patron_1->sms_provider_id( $sms_provider->{id} )->store;
96     is_deeply( $retrieved_patron_1->sms_provider->unblessed, $sms_provider, 'Koha::Patron->sms_provider returns the correct SMS provider' );
97     is( ref($retrieved_patron_1->sms_provider), 'Koha::SMS::Provider', 'Koha::Patron->sms_provider should return a Koha::SMS::Provider object' );
98 };
99
100 subtest 'guarantees' => sub {
101     plan tests => 13;
102
103     t::lib::Mocks::mock_preference( 'borrowerRelationship', 'test|test2' );
104
105     my $guarantees = $new_patron_1->guarantee_relationships;
106     is( ref($guarantees), 'Koha::Patron::Relationships', 'Koha::Patron->guarantees should return a Koha::Patrons result set in a scalar context' );
107     is( $guarantees->count, 0, 'new_patron_1 should have 0 guarantee relationships' );
108     my @guarantees = $new_patron_1->guarantee_relationships;
109     is( ref(\@guarantees), 'ARRAY', 'Koha::Patron->guarantee_relationships should return an array in a list context' );
110     is( scalar(@guarantees), 0, 'new_patron_1 should have 0 guarantee' );
111
112     my $guarantee_1 = $builder->build({ source => 'Borrower' });
113     my $relationship_1 = Koha::Patron::Relationship->new( { guarantor_id => $new_patron_1->id, guarantee_id => $guarantee_1->{borrowernumber}, relationship => 'test' } )->store();
114     my $guarantee_2 = $builder->build({ source => 'Borrower' });
115     my $relationship_2 = Koha::Patron::Relationship->new( { guarantor_id => $new_patron_1->id, guarantee_id => $guarantee_2->{borrowernumber}, relationship => 'test' } )->store();
116
117     $guarantees = $new_patron_1->guarantee_relationships;
118     is( ref($guarantees), 'Koha::Patron::Relationships', 'Koha::Patron->guarantee_relationships should return a Koha::Patrons result set in a scalar context' );
119     is( $guarantees->count, 2, 'new_patron_1 should have 2 guarantees' );
120     @guarantees = $new_patron_1->guarantee_relationships;
121     is( ref(\@guarantees), 'ARRAY', 'Koha::Patron->guarantee_relationships should return an array in a list context' );
122     is( scalar(@guarantees), 2, 'new_patron_1 should have 2 guarantees' );
123     $_->delete for @guarantees;
124
125     #Test return order of guarantees BZ 18635
126     my $categorycode = $builder->build({ source => 'Category' })->{categorycode};
127     my $branchcode = $builder->build({ source => 'Branch' })->{branchcode};
128
129     my $guarantor = $builder->build_object( { class => 'Koha::Patrons' } );
130
131     my $order_guarantee1 = $builder->build_object(
132         {
133             class => 'Koha::Patrons',
134             value => {
135                 surname     => 'Zebra',
136             }
137         }
138     )->borrowernumber;
139     $builder->build_object(
140         {
141             class => 'Koha::Patron::Relationships',
142             value => {
143                 guarantor_id  => $guarantor->id,
144                 guarantee_id => $order_guarantee1,
145                 relationship => 'test',
146             }
147         }
148     );
149
150     my $order_guarantee2 = $builder->build_object(
151         {
152             class => 'Koha::Patrons',
153             value => {
154                 surname     => 'Yak',
155             }
156         }
157     )->borrowernumber;
158     $builder->build_object(
159         {
160             class => 'Koha::Patron::Relationships',
161             value => {
162                 guarantor_id  => $guarantor->id,
163                 guarantee_id => $order_guarantee2,
164                 relationship => 'test',
165             }
166         }
167     );
168
169     my $order_guarantee3 = $builder->build_object(
170         {
171             class => 'Koha::Patrons',
172             value => {
173                 surname     => 'Xerus',
174                 firstname   => 'Walrus',
175             }
176         }
177     )->borrowernumber;
178     $builder->build_object(
179         {
180             class => 'Koha::Patron::Relationships',
181             value => {
182                 guarantor_id  => $guarantor->id,
183                 guarantee_id => $order_guarantee3,
184                 relationship => 'test',
185             }
186         }
187     );
188
189     my $order_guarantee4 = $builder->build_object(
190         {
191             class => 'Koha::Patrons',
192             value => {
193                 surname     => 'Xerus',
194                 firstname   => 'Vulture',
195                 guarantorid => $guarantor->borrowernumber
196             }
197         }
198     )->borrowernumber;
199     $builder->build_object(
200         {
201             class => 'Koha::Patron::Relationships',
202             value => {
203                 guarantor_id  => $guarantor->id,
204                 guarantee_id => $order_guarantee4,
205                 relationship => 'test',
206             }
207         }
208     );
209
210     my $order_guarantee5 = $builder->build_object(
211         {
212             class => 'Koha::Patrons',
213             value => {
214                 surname     => 'Xerus',
215                 firstname   => 'Unicorn',
216                 guarantorid => $guarantor->borrowernumber
217             }
218         }
219     )->borrowernumber;
220     my $r = $builder->build_object(
221         {
222             class => 'Koha::Patron::Relationships',
223             value => {
224                 guarantor_id  => $guarantor->id,
225                 guarantee_id => $order_guarantee5,
226                 relationship => 'test',
227             }
228         }
229     );
230
231     $guarantees = $guarantor->guarantee_relationships->guarantees;
232
233     is( $guarantees->next()->borrowernumber, $order_guarantee5, "Return first guarantor alphabetically" );
234     is( $guarantees->next()->borrowernumber, $order_guarantee4, "Return second guarantor alphabetically" );
235     is( $guarantees->next()->borrowernumber, $order_guarantee3, "Return third guarantor alphabetically" );
236     is( $guarantees->next()->borrowernumber, $order_guarantee2, "Return fourth guarantor alphabetically" );
237     is( $guarantees->next()->borrowernumber, $order_guarantee1, "Return fifth guarantor alphabetically" );
238 };
239
240 subtest 'category' => sub {
241     plan tests => 2;
242     my $patron_category = $new_patron_1->category;
243     is( ref( $patron_category), 'Koha::Patron::Category', );
244     is( $patron_category->categorycode, $category->{categorycode}, );
245 };
246
247 subtest 'siblings' => sub {
248     plan tests => 7;
249     my $siblings = $new_patron_1->siblings;
250     is( $siblings, undef, 'Koha::Patron->siblings should not crashed if the patron has no guarantor' );
251     my $guarantee_1 = $builder->build( { source => 'Borrower' } );
252     my $relationship_1 = Koha::Patron::Relationship->new( { guarantor_id => $new_patron_1->borrowernumber, guarantee_id => $guarantee_1->{borrowernumber}, relationship => 'test' } )->store();
253     my $retrieved_guarantee_1 = Koha::Patrons->find($guarantee_1);
254     $siblings = $retrieved_guarantee_1->siblings;
255     is( ref($siblings), 'Koha::Patrons', 'Koha::Patron->siblings should return a Koha::Patrons result set in a scalar context' );
256     my @siblings = $retrieved_guarantee_1->siblings;
257     is( ref( \@siblings ), 'ARRAY', 'Koha::Patron->siblings should return an array in a list context' );
258     is( $siblings->count,  0,       'guarantee_1 should not have siblings yet' );
259     my $guarantee_2 = $builder->build( { source => 'Borrower' } );
260     my $relationship_2 = Koha::Patron::Relationship->new( { guarantor_id => $new_patron_1->borrowernumber, guarantee_id => $guarantee_2->{borrowernumber}, relationship => 'test' } )->store();
261     my $guarantee_3 = $builder->build( { source => 'Borrower' } );
262     my $relationship_3 = Koha::Patron::Relationship->new( { guarantor_id => $new_patron_1->borrowernumber, guarantee_id => $guarantee_3->{borrowernumber}, relationship => 'test' } )->store();
263     $siblings = $retrieved_guarantee_1->siblings;
264     is( $siblings->count,               2,                               'guarantee_1 should have 2 siblings' );
265     is( $guarantee_2->{borrowernumber}, $siblings->next->borrowernumber, 'guarantee_2 should exist in the guarantees' );
266     is( $guarantee_3->{borrowernumber}, $siblings->next->borrowernumber, 'guarantee_3 should exist in the guarantees' );
267     $_->delete for $retrieved_guarantee_1->siblings;
268     $retrieved_guarantee_1->delete;
269 };
270
271 subtest 'has_overdues' => sub {
272     plan tests => 3;
273
274     my $item_1 = $builder->build_sample_item;
275     my $retrieved_patron = Koha::Patrons->find( $new_patron_1->borrowernumber );
276     is( $retrieved_patron->has_overdues, 0, );
277
278     my $tomorrow = DateTime->today( time_zone => C4::Context->tz() )->add( days => 1 );
279     my $issue = Koha::Checkout->new({ borrowernumber => $new_patron_1->id, itemnumber => $item_1->itemnumber, date_due => $tomorrow, branchcode => $library->{branchcode} })->store();
280     is( $retrieved_patron->has_overdues, 0, );
281     $issue->delete();
282     my $yesterday = DateTime->today(time_zone => C4::Context->tz())->add( days => -1 );
283     $issue = Koha::Checkout->new({ borrowernumber => $new_patron_1->id, itemnumber => $item_1->itemnumber, date_due => $yesterday, branchcode => $library->{branchcode} })->store();
284     $retrieved_patron = Koha::Patrons->find( $new_patron_1->borrowernumber );
285     is( $retrieved_patron->has_overdues, 1, );
286     $issue->delete();
287 };
288
289 subtest 'is_expired' => sub {
290     plan tests => 4;
291     my $patron = $builder->build({ source => 'Borrower' });
292     $patron = Koha::Patrons->find( $patron->{borrowernumber} );
293     $patron->dateexpiry( undef )->store->discard_changes;
294     is( $patron->is_expired, 0, 'Patron should not be considered expired if dateexpiry is not set');
295     $patron->dateexpiry( dt_from_string )->store->discard_changes;
296     is( $patron->is_expired, 0, 'Patron should not be considered expired if dateexpiry is today');
297     $patron->dateexpiry( dt_from_string->add( days => 1 ) )->store->discard_changes;
298     is( $patron->is_expired, 0, 'Patron should not be considered expired if dateexpiry is tomorrow');
299     $patron->dateexpiry( dt_from_string->add( days => -1 ) )->store->discard_changes;
300     is( $patron->is_expired, 1, 'Patron should be considered expired if dateexpiry is yesterday');
301
302     $patron->delete;
303 };
304
305 subtest 'is_going_to_expire' => sub {
306     plan tests => 9;
307
308     my $today = dt_from_string(undef, undef, 'floating');
309     my $patron = $builder->build({ source => 'Borrower' });
310     $patron = Koha::Patrons->find( $patron->{borrowernumber} );
311     $patron->dateexpiry( undef )->store->discard_changes;
312     is( $patron->is_going_to_expire, 0, 'Patron should not be considered going to expire if dateexpiry is not set');
313
314     t::lib::Mocks::mock_preference('NotifyBorrowerDeparture', 0);
315     $patron->dateexpiry( $today )->store->discard_changes;
316     is( $patron->is_going_to_expire, 0, 'Patron should not be considered going to expire if dateexpiry is today');
317
318     $patron->dateexpiry( $today )->store->discard_changes;
319     is( $patron->is_going_to_expire, 0, 'Patron should not be considered going to expire if dateexpiry is today and pref is 0');
320
321     t::lib::Mocks::mock_preference('NotifyBorrowerDeparture', 10);
322     $patron->dateexpiry( $today->clone->add( days => 11 ) )->store->discard_changes;
323     is( $patron->is_going_to_expire, 0, 'Patron should not be considered going to expire if dateexpiry is 11 days ahead and pref is 10');
324
325     t::lib::Mocks::mock_preference('NotifyBorrowerDeparture', 0);
326     $patron->dateexpiry( $today->clone->add( days => 10 ) )->store->discard_changes;
327     is( $patron->is_going_to_expire, 0, 'Patron should not be considered going to expire if dateexpiry is 10 days ahead and pref is 0');
328
329     t::lib::Mocks::mock_preference('NotifyBorrowerDeparture', 10);
330     $patron->dateexpiry( $today->clone->add( days => 10 ) )->store->discard_changes;
331     is( $patron->is_going_to_expire, 0, 'Patron should not be considered going to expire if dateexpiry is 10 days ahead and pref is 10');
332     $patron->delete;
333
334     t::lib::Mocks::mock_preference('NotifyBorrowerDeparture', 10);
335     $patron->dateexpiry( $today->clone->add( days => 20 ) )->store->discard_changes;
336     is( $patron->is_going_to_expire, 0, 'Patron should not be considered going to expire if dateexpiry is 20 days ahead and pref is 10');
337
338     t::lib::Mocks::mock_preference('NotifyBorrowerDeparture', 20);
339     $patron->dateexpiry( $today->clone->add( days => 10 ) )->store->discard_changes;
340     is( $patron->is_going_to_expire, 1, 'Patron should be considered going to expire if dateexpiry is 10 days ahead and pref is 20');
341
342     { # Testing invalid is going to expiry date
343         t::lib::Mocks::mock_preference('NotifyBorrowerDeparture', 30);
344         # mock_config does not work here, because of tz vs timezone subroutines
345         my $context = Test::MockModule->new('C4::Context');
346         $context->mock( 'tz', sub {
347             'America/Sao_Paulo';
348         });
349         $patron->dateexpiry(DateTime->new( year => 2019, month => 12, day => 3 ))->store;
350         eval { $patron->is_going_to_expire };
351         is( $@, '', 'On invalid "is going to expire" date, the method should not crash with "Invalid local time for date in time zone"');
352         $context->unmock('tz');
353     };
354
355     $patron->delete;
356 };
357
358
359 subtest 'renew_account' => sub {
360     plan tests => 48;
361
362     for my $date ( '2016-03-31', '2016-11-30', '2019-01-31', dt_from_string() ) {
363         my $dt = dt_from_string( $date, 'iso' );
364         Time::Fake->offset( $dt->epoch );
365         my $a_month_ago                = $dt->clone->subtract( months => 1, end_of_month => 'limit' )->truncate( to => 'day' );
366         my $a_year_later               = $dt->clone->add( months => 12, end_of_month => 'limit' )->truncate( to => 'day' );
367         my $a_year_later_minus_a_month = $a_month_ago->clone->add( months => 12, end_of_month => 'limit' )->truncate( to => 'day' );
368         my $a_month_later              = $dt->clone->add( months => 1 , end_of_month => 'limit' )->truncate( to => 'day' );
369         my $a_year_later_plus_a_month  = $a_month_later->clone->add( months => 12, end_of_month => 'limit' )->truncate( to => 'day' );
370         my $patron_category = $builder->build(
371             {   source => 'Category',
372                 value  => {
373                     enrolmentperiod     => 12,
374                     enrolmentperioddate => undef,
375                 }
376             }
377         );
378         my $patron = $builder->build(
379             {   source => 'Borrower',
380                 value  => {
381                     dateexpiry   => $a_month_ago,
382                     categorycode => $patron_category->{categorycode},
383                     date_renewed => undef, # Force builder to not populate the column for new patron
384                 }
385             }
386         );
387         my $patron_2 = $builder->build(
388             {  source => 'Borrower',
389                value  => {
390                    dateexpiry => $a_month_ago,
391                    categorycode => $patron_category->{categorycode},
392                 }
393             }
394         );
395         my $patron_3 = $builder->build(
396             {  source => 'Borrower',
397                value  => {
398                    dateexpiry => $a_month_later,
399                    categorycode => $patron_category->{categorycode},
400                }
401             }
402         );
403         my $retrieved_patron = Koha::Patrons->find( $patron->{borrowernumber} );
404         my $retrieved_patron_2 = Koha::Patrons->find( $patron_2->{borrowernumber} );
405         my $retrieved_patron_3 = Koha::Patrons->find( $patron_3->{borrowernumber} );
406
407         is( $retrieved_patron->date_renewed, undef, "Date renewed is not set for patrons that have never been renewed" );
408
409         t::lib::Mocks::mock_preference( 'BorrowerRenewalPeriodBase', 'dateexpiry' );
410         t::lib::Mocks::mock_preference( 'BorrowersLog',              1 );
411         my $expiry_date = $retrieved_patron->renew_account;
412         is( $expiry_date, $a_year_later_minus_a_month, "$a_month_ago + 12 months must be $a_year_later_minus_a_month" );
413         my $retrieved_expiry_date = Koha::Patrons->find( $patron->{borrowernumber} )->dateexpiry;
414         is( dt_from_string($retrieved_expiry_date), $a_year_later_minus_a_month, "$a_month_ago + 12 months must be $a_year_later_minus_a_month" );
415         my $number_of_logs = $schema->resultset('ActionLog')->search( { module => 'MEMBERS', action => 'RENEW', object => $retrieved_patron->borrowernumber } )->count;
416         is( $number_of_logs, 1, 'With BorrowerLogs, Koha::Patron->renew_account should have logged' );
417
418         t::lib::Mocks::mock_preference( 'BorrowerRenewalPeriodBase', 'now' );
419         t::lib::Mocks::mock_preference( 'BorrowersLog',              0 );
420         $expiry_date = $retrieved_patron->renew_account;
421         is( $expiry_date, $a_year_later, "today + 12 months must be $a_year_later" );
422         $retrieved_patron = Koha::Patrons->find( $patron->{borrowernumber} );
423         is( $retrieved_patron->date_renewed, output_pref({ dt => $dt, dateformat => 'iso', dateonly => 1 }), "Date renewed is set when calling renew_account" );
424         $retrieved_expiry_date = $retrieved_patron->dateexpiry;
425         is( dt_from_string($retrieved_expiry_date), $a_year_later, "today + 12 months must be $a_year_later" );
426         $number_of_logs = $schema->resultset('ActionLog')->search( { module => 'MEMBERS', action => 'RENEW', object => $retrieved_patron->borrowernumber } )->count;
427         is( $number_of_logs, 1, 'Without BorrowerLogs, Koha::Patron->renew_account should not have logged' );
428
429         t::lib::Mocks::mock_preference( 'BorrowerRenewalPeriodBase', 'combination' );
430         $expiry_date = $retrieved_patron_2->renew_account;
431         is( $expiry_date, $a_year_later, "today + 12 months must be $a_year_later" );
432         $retrieved_expiry_date = Koha::Patrons->find( $patron_2->{borrowernumber} )->dateexpiry;
433         is( dt_from_string($retrieved_expiry_date), $a_year_later, "today + 12 months must be $a_year_later" );
434
435         $expiry_date = $retrieved_patron_3->renew_account;
436         is( $expiry_date, $a_year_later_plus_a_month, "$a_month_later + 12 months must be $a_year_later_plus_a_month" );
437         $retrieved_expiry_date = Koha::Patrons->find( $patron_3->{borrowernumber} )->dateexpiry;
438         is( dt_from_string($retrieved_expiry_date), $a_year_later_plus_a_month, "$a_month_later + 12 months must be $a_year_later_plus_a_month" );
439
440         $retrieved_patron->delete;
441         $retrieved_patron_2->delete;
442         $retrieved_patron_3->delete;
443     }
444     Time::Fake->reset;
445 };
446
447 subtest "move_to_deleted" => sub {
448     plan tests => 5;
449     my $originally_updated_on = '2016-01-01 12:12:12';
450     my $patron = $builder->build( { source => 'Borrower',value => { updated_on => $originally_updated_on } } );
451     my $retrieved_patron = Koha::Patrons->find( $patron->{borrowernumber} );
452     is( ref( $retrieved_patron->move_to_deleted ), 'Koha::Schema::Result::Deletedborrower', 'Koha::Patron->move_to_deleted should return the Deleted patron' )
453       ;    # FIXME This should be Koha::Deleted::Patron
454     my $deleted_patron = $schema->resultset('Deletedborrower')
455         ->search( { borrowernumber => $patron->{borrowernumber} }, { result_class => 'DBIx::Class::ResultClass::HashRefInflator' } )
456         ->next;
457     ok( $retrieved_patron->updated_on, 'updated_on should be set for borrowers table' );
458     ok( $deleted_patron->{updated_on}, 'updated_on should be set for deleted_borrowers table' );
459     isnt( $deleted_patron->{updated_on}, $retrieved_patron->updated_on, 'Koha::Patron->move_to_deleted should have correctly updated the updated_on column');
460     $deleted_patron->{updated_on} = $originally_updated_on; #reset for simplicity in comparing all other fields
461     is_deeply( $deleted_patron, $patron, 'Koha::Patron->move_to_deleted should have correctly moved the patron to the deleted table' );
462     $retrieved_patron->delete( $patron->{borrowernumber} );    # Cleanup
463 };
464
465 subtest "delete" => sub {
466     plan tests => 7;
467     t::lib::Mocks::mock_preference( 'BorrowersLog', 1 );
468     my $patron           = $builder->build( { source => 'Borrower' } );
469     my $retrieved_patron = Koha::Patrons->find( $patron->{borrowernumber} );
470     my $hold             = $builder->build(
471         {   source => 'Reserve',
472             value  => { borrowernumber => $patron->{borrowernumber} }
473         }
474     );
475     my $list = $builder->build(
476         {   source => 'Virtualshelve',
477             value  => { owner => $patron->{borrowernumber} }
478         }
479     );
480     my $modification = $builder->build_object({ class => 'Koha::Patron::Modifications', value => { borrowernumber => $patron->{borrowernumber} } });
481
482     my $deleted = $retrieved_patron->delete;
483     is( ref($deleted), 'Koha::Patron', 'Koha::Patron->delete should return the deleted patron object if the patron has been correctly deleted' );
484
485     is( Koha::Patrons->find( $patron->{borrowernumber} ), undef, 'Koha::Patron->delete should have deleted the patron' );
486
487     is (Koha::Old::Holds->search( { reserve_id => $hold->{ reserve_id } } )->count, 1, q|Koha::Patron->delete should have cancelled patron's holds| );
488
489     is( Koha::Holds->search( { borrowernumber => $patron->{borrowernumber} } )->count, 0, q|Koha::Patron->delete should have cancelled patron's holds 2| );
490
491     is( Koha::Virtualshelves->search( { owner => $patron->{borrowernumber} } )->count, 0, q|Koha::Patron->delete should have deleted patron's lists| );
492
493     is( Koha::Patron::Modifications->search( { borrowernumber => $patron->{borrowernumber} } )->count, 0, q|Koha::Patron->delete should have deleted patron's modifications| );
494
495     my $number_of_logs = $schema->resultset('ActionLog')->search( { module => 'MEMBERS', action => 'DELETE', object => $retrieved_patron->borrowernumber } )->count;
496     is( $number_of_logs, 1, 'With BorrowerLogs, Koha::Patron->delete should have logged' );
497 };
498
499 subtest 'Koha::Patrons->delete' => sub {
500     plan tests => 3;
501
502     my $patron1 = $builder->build_object({ class => 'Koha::Patrons' });
503     my $patron2 = $builder->build_object({ class => 'Koha::Patrons' });
504     my $id1 = $patron1->borrowernumber;
505     my $set = Koha::Patrons->search({ borrowernumber => { -in => [$patron1->borrowernumber, $patron2->borrowernumber]}});
506     is( $set->count, 2, 'Two patrons found as expected' );
507     is( $set->delete({ move => 1 }), 2, 'Two patrons deleted' );
508     my $deleted_patrons = Koha::Old::Patrons->search({ borrowernumber => { -in => [$patron1->borrowernumber, $patron2->borrowernumber]}});
509     is( $deleted_patrons->count, 2, 'Patrons moved to deletedborrowers' );
510
511     # See other tests in t/db_dependent/Koha/Objects.t
512 };
513
514 subtest 'add_enrolment_fee_if_needed' => sub {
515     plan tests => 4;
516
517     my $enrolmentfees = { K  => 5, J => 10, YA => 20 };
518     foreach( keys %{$enrolmentfees} ) {
519         ( Koha::Patron::Categories->find( $_ ) // $builder->build_object({ class => 'Koha::Patron::Categories', value => { categorycode => $_ } }) )->enrolmentfee( $enrolmentfees->{$_} )->store;
520     }
521     my $enrolmentfee_K  = $enrolmentfees->{K};
522     my $enrolmentfee_J  = $enrolmentfees->{J};
523     my $enrolmentfee_YA = $enrolmentfees->{YA};
524
525     my %borrower_data = (
526         firstname    => 'my firstname',
527         surname      => 'my surname',
528         categorycode => 'K',
529         branchcode   => $library->{branchcode},
530     );
531
532     my $borrowernumber = Koha::Patron->new(\%borrower_data)->store->borrowernumber;
533     $borrower_data{borrowernumber} = $borrowernumber;
534
535     my $patron = Koha::Patrons->find( $borrowernumber );
536     my $total = $patron->account->balance;
537     is( int($total), int($enrolmentfee_K), "New kid pay $enrolmentfee_K" );
538
539     t::lib::Mocks::mock_preference( 'FeeOnChangePatronCategory', 0 );
540     $borrower_data{categorycode} = 'J';
541     $patron->set(\%borrower_data)->store;
542     $total = $patron->account->balance;
543     is( int($total), int($enrolmentfee_K), "Kid growing and become a juvenile, but shouldn't pay for the upgrade " );
544
545     $borrower_data{categorycode} = 'K';
546     $patron->set(\%borrower_data)->store;
547     t::lib::Mocks::mock_preference( 'FeeOnChangePatronCategory', 1 );
548
549     $borrower_data{categorycode} = 'J';
550     $patron->set(\%borrower_data)->store;
551     $total = $patron->account->balance;
552     is( int($total), int($enrolmentfee_K + $enrolmentfee_J), "Kid growing and become a juvenile, they should pay " . ( $enrolmentfee_K + $enrolmentfee_J ) );
553
554     # Check with calling directly Koha::Patron->get_enrolment_fee_if_needed
555     $patron->categorycode('YA')->store;
556     $total = $patron->account->balance;
557     is( int($total),
558         int($enrolmentfee_K + $enrolmentfee_J + $enrolmentfee_YA),
559         "Juvenile growing and become an young adult, they should pay " . ( $enrolmentfee_K + $enrolmentfee_J + $enrolmentfee_YA )
560     );
561
562     $patron->delete;
563 };
564
565 subtest 'checkouts + pending_checkouts + get_overdues + old_checkouts' => sub {
566     plan tests => 17;
567
568     my $library = $builder->build( { source => 'Branch' } );
569     my $biblionumber_1 = $builder->build_sample_biblio->biblionumber;
570     my $item_1 = $builder->build_sample_item(
571         {
572             library      => $library->{branchcode},
573             biblionumber => $biblionumber_1,
574         }
575     );
576     my $item_2 = $builder->build_sample_item(
577         {
578             library      => $library->{branchcode},
579             biblionumber => $biblionumber_1,
580         }
581     );
582     my $biblionumber_2 = $builder->build_sample_biblio->biblionumber;
583     my $item_3 = $builder->build_sample_item(
584         {
585             library      => $library->{branchcode},
586             biblionumber => $biblionumber_2,
587         }
588     );
589     my $patron = $builder->build(
590         {
591             source => 'Borrower',
592             value  => { branchcode => $library->{branchcode} }
593         }
594     );
595
596     $patron = Koha::Patrons->find( $patron->{borrowernumber} );
597     my $checkouts = $patron->checkouts;
598     is( $checkouts->count, 0, 'checkouts should not return any issues for that patron' );
599     is( ref($checkouts), 'Koha::Checkouts', 'checkouts should return a Koha::Checkouts object' );
600     my $pending_checkouts = $patron->pending_checkouts;
601     is( $pending_checkouts->count, 0, 'pending_checkouts should not return any issues for that patron' );
602     is( ref($pending_checkouts), 'Koha::Checkouts', 'pending_checkouts should return a Koha::Checkouts object' );
603     my $old_checkouts = $patron->old_checkouts;
604     is( $old_checkouts->count, 0, 'old_checkouts should not return any issues for that patron' );
605     is( ref($old_checkouts), 'Koha::Old::Checkouts', 'old_checkouts should return a Koha::Old::Checkouts object' );
606
607     # Not sure how this is useful, but AddIssue pass this variable to different other subroutines
608     $patron = Koha::Patrons->find( $patron->borrowernumber )->unblessed;
609
610     t::lib::Mocks::mock_userenv({ branchcode => $library->{branchcode} });
611
612     AddIssue( $patron, $item_1->barcode, DateTime->now->subtract( days => 1 ) );
613     AddIssue( $patron, $item_2->barcode, DateTime->now->subtract( days => 5 ) );
614     AddIssue( $patron, $item_3->barcode );
615
616     $patron = Koha::Patrons->find( $patron->{borrowernumber} );
617     $checkouts = $patron->checkouts;
618     is( $checkouts->count, 3, 'checkouts should return 3 issues for that patron' );
619     is( ref($checkouts), 'Koha::Checkouts', 'checkouts should return a Koha::Checkouts object' );
620     $pending_checkouts = $patron->pending_checkouts;
621     is( $pending_checkouts->count, 3, 'pending_checkouts should return 3 issues for that patron' );
622     is( ref($pending_checkouts), 'Koha::Checkouts', 'pending_checkouts should return a Koha::Checkouts object' );
623
624     my $first_checkout = $pending_checkouts->next;
625     is( $first_checkout->unblessed_all_relateds->{biblionumber}, $item_3->biblionumber, 'pending_checkouts should prefetch values from other tables (here biblio)' );
626
627     my $overdues = $patron->get_overdues;
628     is( $overdues->count, 2, 'Patron should have 2 overdues');
629     is( ref($overdues), 'Koha::Checkouts', 'Koha::Patron->get_overdues should return Koha::Checkouts' );
630     is( $overdues->next->itemnumber, $item_1->itemnumber, 'The issue should be returned in the same order as they have been done, first is correct' );
631     is( $overdues->next->itemnumber, $item_2->itemnumber, 'The issue should be returned in the same order as they have been done, second is correct' );
632
633
634     C4::Circulation::AddReturn( $item_1->barcode );
635     C4::Circulation::AddReturn( $item_2->barcode );
636     $old_checkouts = $patron->old_checkouts;
637     is( $old_checkouts->count, 2, 'old_checkouts should return 2 old checkouts that patron' );
638     is( ref($old_checkouts), 'Koha::Old::Checkouts', 'old_checkouts should return a Koha::Old::Checkouts object' );
639
640     # Clean stuffs
641     Koha::Checkouts->search( { borrowernumber => $patron->borrowernumber } )->delete;
642     $patron->delete;
643 };
644
645 subtest 'get_routing_lists' => sub {
646     plan tests => 5;
647
648     my $biblio = Koha::Biblio->new()->store();
649     my $subscription = Koha::Subscription->new({
650         biblionumber => $biblio->biblionumber,
651         }
652     )->store;
653
654     my $patron = $builder->build( { source => 'Borrower' } );
655     $patron = Koha::Patrons->find( $patron->{borrowernumber} );
656
657     is( $patron->get_routing_lists->count, 0, 'Retrieves correct number of routing lists: 0' );
658
659     my $routinglist_count = Koha::Subscription::Routinglists->count;
660     my $routinglist = Koha::Subscription::Routinglist->new({
661         borrowernumber   => $patron->borrowernumber,
662         ranking          => 5,
663         subscriptionid   => $subscription->subscriptionid
664     })->store;
665
666     is ($patron->get_routing_lists->count, 1, "Retrieves correct number of routing lists: 1");
667
668     my $routinglists = $patron->get_routing_lists;
669     is ($routinglists->next->ranking, 5, "Retrieves ranking: 5");
670     is( ref($routinglists),   'Koha::Subscription::Routinglists', 'get_routing_lists returns Koha::Subscription::Routinglists' );
671
672     my $subscription2 = Koha::Subscription->new({
673         biblionumber => $biblio->biblionumber,
674         }
675     )->store;
676     my $routinglist2 = Koha::Subscription::Routinglist->new({
677         borrowernumber   => $patron->borrowernumber,
678         ranking          => 1,
679         subscriptionid   => $subscription2->subscriptionid
680     })->store;
681
682     is ($patron->get_routing_lists->count, 2, "Retrieves correct number of routing lists: 2");
683
684     $patron->delete; # Clean up for later tests
685
686 };
687
688 subtest 'get_age' => sub {
689     plan tests => 31;
690
691     my $patron = $builder->build( { source => 'Borrower' } );
692     $patron = Koha::Patrons->find( $patron->{borrowernumber} );
693
694     my @dates = (
695         {
696             today            => '2020-02-28',
697             has_12           => { date => '2007-08-27', expected_age => 12 },
698             almost_18        => { date => '2002-03-01', expected_age => 17 },
699             has_18_today     => { date => '2002-02-28', expected_age => 18 },
700             had_18_yesterday => { date => '2002-02-27', expected_age => 18 },
701             almost_16        => { date => '2004-02-29', expected_age => 15 },
702             has_16_today     => { date => '2004-02-28', expected_age => 16 },
703             had_16_yesterday => { date => '2004-02-27', expected_age => 16 },
704             new_born         => { date => '2020-01-27', expected_age => 0 },
705         },
706         {
707             today            => '2020-02-29',
708             has_12           => { date => '2007-08-27', expected_age => 12 },
709             almost_18        => { date => '2002-03-01', expected_age => 17 },
710             has_18_today     => { date => '2002-02-28', expected_age => 18 },
711             had_18_yesterday => { date => '2002-02-27', expected_age => 18 },
712             almost_16        => { date => '2004-03-01', expected_age => 15 },
713             has_16_today     => { date => '2004-02-29', expected_age => 16 },
714             had_16_yesterday => { date => '2004-02-28', expected_age => 16 },
715             new_born         => { date => '2020-01-27', expected_age => 0 },
716         },
717         {
718             today            => '2020-03-01',
719             has_12           => { date => '2007-08-27', expected_age => 12 },
720             almost_18        => { date => '2002-03-02', expected_age => 17 },
721             has_18_today     => { date => '2002-03-01', expected_age => 18 },
722             had_18_yesterday => { date => '2002-02-28', expected_age => 18 },
723             almost_16        => { date => '2004-03-02', expected_age => 15 },
724             has_16_today     => { date => '2004-03-01', expected_age => 16 },
725             had_16_yesterday => { date => '2004-02-29', expected_age => 16 },
726         },
727         {
728             today            => '2019-01-31',
729             has_12           => { date => '2006-08-27', expected_age => 12 },
730             almost_18        => { date => '2001-02-01', expected_age => 17 },
731             has_18_today     => { date => '2001-01-31', expected_age => 18 },
732             had_18_yesterday => { date => '2001-01-30', expected_age => 18 },
733             almost_16        => { date => '2003-02-01', expected_age => 15 },
734             has_16_today     => { date => '2003-01-31', expected_age => 16 },
735             had_16_yesterday => { date => '2003-01-30', expected_age => 16 },
736         },
737     );
738
739     $patron->dateofbirth( undef );
740     is( $patron->get_age, undef, 'get_age should return undef if no dateofbirth is defined' );
741
742     for my $date ( @dates ) {
743
744         my $dt = dt_from_string($date->{today});
745
746         Time::Fake->offset( $dt->epoch );
747
748         for my $k ( keys %$date ) {
749             next if $k eq 'today';
750
751             my $dob = $date->{$k};
752             $patron->dateofbirth( dt_from_string( $dob->{date}, 'iso' ) );
753             is(
754                 $patron->get_age,
755                 $dob->{expected_age},
756                 sprintf(
757                     "Today=%s, dob=%s, should be %d",
758                     $date->{today}, $dob->{date}, $dob->{expected_age}
759                 )
760             );
761         }
762
763         Time::Fake->reset;
764
765     }
766
767     $patron->delete;
768 };
769
770 subtest 'is_valid_age' => sub {
771     plan tests => 10;
772
773     my $dt = dt_from_string('2020-02-28');
774
775     Time::Fake->offset( $dt->epoch );
776
777     my $category = $builder->build({
778         source => 'Category',
779         value => {
780             categorycode        => 'AGE_5_10',
781             dateofbirthrequired => 5,
782             upperagelimit       => 10
783         }
784     });
785     $category = Koha::Patron::Categories->find( $category->{categorycode} );
786
787     my $patron = $builder->build({
788         source => 'Borrower',
789         value => {
790             categorycode        => 'AGE_5_10'
791         }
792     });
793     $patron = Koha::Patrons->find( $patron->{borrowernumber} );
794
795
796     $patron->dateofbirth( undef );
797     is( $patron->is_valid_age, 1, 'Patron with no dateofbirth is always valid for any category');
798
799     my @dates = (
800         {
801             today => '2020-02-28',
802             add_m12_m6_m1 =>
803               { date => '2007-08-27', expected_age => 12, valid => 0 },
804             add_m3_m6_m1 =>
805               { date => '2016-08-27', expected_age => 3, valid => 0 },
806             add_m7_m6_m1 =>
807               { date => '2015-02-28', expected_age => 7, valid => 1 },
808             add_m5_0_0 =>
809               { date => '2015-02-28', expected_age => 5, valid => 1 },
810             add_m5_0_p1 =>
811               { date => '2015-03-01', expected_age => 5, valid => 0 },
812             add_m5_0_m1 =>
813               { date => '2015-02-27', expected_age => 5, valid => 1 },
814             add_m11_0_0 =>
815               { date => '2009-02-28', expected_age => 11, valid => 0 },
816             add_m11_0_p1 =>
817               { date => '2009-03-01', expected_age => 11, valid => 1 },
818             add_m11_0_m1 =>
819               { date => '2009-02-27', expected_age => 11, valid => 0 },
820         },
821     );
822
823     for my $date ( @dates ) {
824
825         my $dt = dt_from_string($date->{today});
826
827         Time::Fake->offset( $dt->epoch );
828
829         for my $k ( keys %$date ) {
830             next if $k eq 'today';
831
832             my $dob = $date->{$k};
833             $patron->dateofbirth( dt_from_string( $dob->{date}, 'iso' ) );
834             is(
835                 $patron->is_valid_age,
836                 $dob->{valid},
837                 sprintf(
838                     "Today=%s, dob=%s, is %s, should be valid=%s",
839                     $date->{today}, $dob->{date}, $dob->{expected_age}, $dob->{valid}
840                 )
841             );
842         }
843
844         Time::Fake->reset;
845
846     }
847
848     $patron->delete;
849     $category->delete;
850 };
851
852 subtest 'account' => sub {
853     plan tests => 1;
854
855     my $patron = $builder->build({source => 'Borrower'});
856
857     $patron = Koha::Patrons->find( $patron->{borrowernumber} );
858     my $account = $patron->account;
859     is( ref($account),   'Koha::Account', 'account should return a Koha::Account object' );
860
861     $patron->delete;
862 };
863
864 subtest 'search_upcoming_membership_expires' => sub {
865     plan tests => 9;
866
867     my $expiry_days = 15;
868     t::lib::Mocks::mock_preference( 'MembershipExpiryDaysNotice', $expiry_days );
869     my $nb_of_days_before = 1;
870     my $nb_of_days_after = 2;
871
872     my $builder = t::lib::TestBuilder->new();
873
874     my $library = $builder->build({ source => 'Branch' });
875
876     # before we add borrowers to this branch, add the expires we have now
877     # note that this pertains to the current mocked setting of the pref
878     # for this reason we add the new branchcode to most of the tests
879     my $nb_of_expires = Koha::Patrons->search_upcoming_membership_expires->count;
880
881     my $patron_1 = $builder->build({
882         source => 'Borrower',
883         value  => {
884             branchcode              => $library->{branchcode},
885             dateexpiry              => dt_from_string->add( days => $expiry_days )
886         },
887     });
888
889     my $patron_2 = $builder->build({
890         source => 'Borrower',
891         value  => {
892             branchcode              => $library->{branchcode},
893             dateexpiry              => dt_from_string->add( days => $expiry_days - $nb_of_days_before )
894         },
895     });
896
897     my $patron_3 = $builder->build({
898         source => 'Borrower',
899         value  => {
900             branchcode              => $library->{branchcode},
901             dateexpiry              => dt_from_string->add( days => $expiry_days + $nb_of_days_after )
902         },
903     });
904
905     # Test without extra parameters
906     my $upcoming_mem_expires = Koha::Patrons->search_upcoming_membership_expires();
907     is( $upcoming_mem_expires->count, $nb_of_expires + 1, 'Get upcoming membership expires should return one new borrower.' );
908
909     # Test with branch
910     $upcoming_mem_expires = Koha::Patrons->search_upcoming_membership_expires({ 'me.branchcode' => $library->{branchcode} });
911     is( $upcoming_mem_expires->count, 1, 'Test with branch parameter' );
912     my $expired = $upcoming_mem_expires->next;
913     is( $expired->surname, $patron_1->{surname}, 'Get upcoming membership expires should return the correct patron.' );
914     is( $expired->library->branchemail, $library->{branchemail}, 'Get upcoming membership expires should return the correct patron.' );
915     is( $expired->branchcode, $patron_1->{branchcode}, 'Get upcoming membership expires should return the correct patron.' );
916
917     t::lib::Mocks::mock_preference( 'MembershipExpiryDaysNotice', 0 );
918     $upcoming_mem_expires = Koha::Patrons->search_upcoming_membership_expires({ 'me.branchcode' => $library->{branchcode} });
919     is( $upcoming_mem_expires->count, 0, 'Get upcoming membership expires with MembershipExpiryDaysNotice==0 should not return new records.' );
920
921     # Test MembershipExpiryDaysNotice == undef
922     t::lib::Mocks::mock_preference( 'MembershipExpiryDaysNotice', undef );
923     $upcoming_mem_expires = Koha::Patrons->search_upcoming_membership_expires({ 'me.branchcode' => $library->{branchcode} });
924     is( $upcoming_mem_expires->count, 0, 'Get upcoming membership expires without MembershipExpiryDaysNotice should not return new records.' );
925
926     # Test the before parameter
927     t::lib::Mocks::mock_preference( 'MembershipExpiryDaysNotice', 15 );
928     $upcoming_mem_expires = Koha::Patrons->search_upcoming_membership_expires({ 'me.branchcode' => $library->{branchcode}, before => $nb_of_days_before });
929     is( $upcoming_mem_expires->count, 2, 'Expect two results for before');
930     # Test after parameter also
931     $upcoming_mem_expires = Koha::Patrons->search_upcoming_membership_expires({ 'me.branchcode' => $library->{branchcode}, before => $nb_of_days_before, after => $nb_of_days_after });
932     is( $upcoming_mem_expires->count, 3, 'Expect three results when adding after' );
933     Koha::Patrons->search({ borrowernumber => { in => [ $patron_1->{borrowernumber}, $patron_2->{borrowernumber}, $patron_3->{borrowernumber} ] } })->delete;
934 };
935
936 subtest 'holds and old_holds' => sub {
937     plan tests => 6;
938
939     my $library = $builder->build( { source => 'Branch' } );
940     my $biblionumber_1 = $builder->build_sample_biblio->biblionumber;
941     my $item_1 = $builder->build_sample_item(
942         {
943             library      => $library->{branchcode},
944             biblionumber => $biblionumber_1,
945         }
946     );
947     my $item_2 = $builder->build_sample_item(
948         {
949             library      => $library->{branchcode},
950             biblionumber => $biblionumber_1,
951         }
952     );
953     my $biblionumber_2 = $builder->build_sample_biblio->biblionumber;
954     my $item_3 = $builder->build_sample_item(
955         {
956             library      => $library->{branchcode},
957             biblionumber => $biblionumber_2,
958         }
959     );
960
961     my $patron = $builder->build(
962         {
963             source => 'Borrower',
964             value  => { branchcode => $library->{branchcode} }
965         }
966     );
967
968     $patron = Koha::Patrons->find( $patron->{borrowernumber} );
969     my $holds = $patron->holds;
970     is( ref($holds), 'Koha::Holds',
971         'Koha::Patron->holds should return a Koha::Holds objects' );
972     is( $holds->count, 0, 'There should not be holds placed by this patron yet' );
973
974     C4::Reserves::AddReserve(
975         {
976             branchcode     => $library->{branchcode},
977             borrowernumber => $patron->borrowernumber,
978             biblionumber   => $biblionumber_1
979         }
980     );
981     # In the future
982     C4::Reserves::AddReserve(
983         {
984             branchcode      => $library->{branchcode},
985             borrowernumber  => $patron->borrowernumber,
986             biblionumber    => $biblionumber_2,
987             expiration_date => dt_from_string->add( days => 2 )
988         }
989     );
990
991     $holds = $patron->holds;
992     is( $holds->count, 2, 'There should be 2 holds placed by this patron' );
993
994     my $old_holds = $patron->old_holds;
995     is( ref($old_holds), 'Koha::Old::Holds',
996         'Koha::Patron->old_holds should return a Koha::Old::Holds objects' );
997     is( $old_holds->count, 0, 'There should not be any old holds yet');
998
999     my $hold = $holds->next;
1000     $hold->cancel;
1001
1002     $old_holds = $patron->old_holds;
1003     is( $old_holds->count, 1, 'There should  be 1 old (cancelled) hold');
1004
1005     $old_holds->delete;
1006     $holds->delete;
1007     $patron->delete;
1008 };
1009
1010 subtest 'notice_email_address' => sub {
1011     plan tests => 2;
1012
1013     my $patron = $builder->build_object({ class => 'Koha::Patrons' });
1014
1015     t::lib::Mocks::mock_preference( 'AutoEmailPrimaryAddress', 'OFF' );
1016     is ($patron->notice_email_address, $patron->email, "Koha::Patron->notice_email_address returns correct value when AutoEmailPrimaryAddress is off");
1017
1018     t::lib::Mocks::mock_preference( 'AutoEmailPrimaryAddress', 'emailpro' );
1019     is ($patron->notice_email_address, $patron->emailpro, "Koha::Patron->notice_email_address returns correct value when AutoEmailPrimaryAddress is emailpro");
1020
1021     $patron->delete;
1022 };
1023
1024 subtest 'search_patrons_to_anonymise & anonymise_issue_history' => sub {
1025     plan tests => 4;
1026
1027     # TODO create a subroutine in t::lib::Mocks
1028     my $branch = $builder->build({ source => 'Branch' });
1029     my $userenv_patron = $builder->build_object({
1030         class  => 'Koha::Patrons',
1031         value  => { branchcode => $branch->{branchcode}, flags => 0 },
1032     });
1033     t::lib::Mocks::mock_userenv({ patron => $userenv_patron });
1034
1035     my $anonymous = $builder->build( { source => 'Borrower', }, );
1036
1037     t::lib::Mocks::mock_preference( 'AnonymousPatron', $anonymous->{borrowernumber} );
1038
1039     subtest 'patron privacy is 1 (default)' => sub {
1040         plan tests => 9;
1041
1042         t::lib::Mocks::mock_preference('IndependentBranches', 0);
1043         my $patron = $builder->build(
1044             {   source => 'Borrower',
1045                 value  => { privacy => 1, }
1046             }
1047         );
1048         my $item_1 = $builder->build_sample_item;
1049         my $issue_1 = $builder->build(
1050             {   source => 'Issue',
1051                 value  => {
1052                     borrowernumber => $patron->{borrowernumber},
1053                     itemnumber     => $item_1->itemnumber,
1054                 },
1055             }
1056         );
1057         my $item_2 = $builder->build_sample_item;
1058         my $issue_2 = $builder->build(
1059             {   source => 'Issue',
1060                 value  => {
1061                     borrowernumber => $patron->{borrowernumber},
1062                     itemnumber     => $item_2->itemnumber,
1063                 },
1064             }
1065         );
1066
1067         my ( $returned_1, undef, undef ) = C4::Circulation::AddReturn( $item_1->barcode, undef, undef, dt_from_string('2010-10-10') );
1068         my ( $returned_2, undef, undef ) = C4::Circulation::AddReturn( $item_2->barcode, undef, undef, dt_from_string('2011-11-11') );
1069         is( $returned_1 && $returned_2, 1, 'The items should have been returned' );
1070
1071         my $patrons_to_anonymise = Koha::Patrons->search_patrons_to_anonymise( { before => '2010-10-11' } )->search( { 'me.borrowernumber' => $patron->{borrowernumber} } );
1072         is( ref($patrons_to_anonymise), 'Koha::Patrons', 'search_patrons_to_anonymise should return Koha::Patrons' );
1073
1074         my $rows_affected = Koha::Patrons->search_patrons_to_anonymise( { before => '2011-11-12' } )->anonymise_issue_history( { before => '2010-10-11' } );
1075         ok( $rows_affected > 0, 'AnonymiseIssueHistory should affect at least 1 row' );
1076
1077         $patrons_to_anonymise = Koha::Patrons->search_patrons_to_anonymise( { before => '2010-10-11' } );
1078         is( $patrons_to_anonymise->count, 0, 'search_patrons_to_anonymise should return 0 after anonymisation is done' );
1079
1080         my $dbh = C4::Context->dbh;
1081         my $sth = $dbh->prepare(q|SELECT borrowernumber FROM old_issues where itemnumber = ?|);
1082         $sth->execute($item_1->itemnumber);
1083         my ($borrowernumber_used_to_anonymised) = $sth->fetchrow_array;
1084         is( $borrowernumber_used_to_anonymised, $anonymous->{borrowernumber}, 'With privacy=1, the issue should have been anonymised' );
1085         $sth->execute($item_2->itemnumber);
1086         ($borrowernumber_used_to_anonymised) = $sth->fetchrow_array;
1087         is( $borrowernumber_used_to_anonymised, $patron->{borrowernumber}, 'The issue should not have been anonymised, the returned date is later' );
1088
1089         $rows_affected = Koha::Patrons->search_patrons_to_anonymise( { before => '2011-11-12' } )->anonymise_issue_history;
1090         $sth->execute($item_2->itemnumber);
1091         ($borrowernumber_used_to_anonymised) = $sth->fetchrow_array;
1092         is( $borrowernumber_used_to_anonymised, $anonymous->{borrowernumber}, 'The issue should have been anonymised, the returned date is before' );
1093
1094         my $sth_reset = $dbh->prepare(q|UPDATE old_issues SET borrowernumber = ? WHERE itemnumber = ?|);
1095         $sth_reset->execute( $patron->{borrowernumber}, $item_1->itemnumber );
1096         $sth_reset->execute( $patron->{borrowernumber}, $item_2->itemnumber );
1097         $rows_affected = Koha::Patrons->search_patrons_to_anonymise->anonymise_issue_history;
1098         $sth->execute($item_1->itemnumber);
1099         ($borrowernumber_used_to_anonymised) = $sth->fetchrow_array;
1100         is( $borrowernumber_used_to_anonymised, $anonymous->{borrowernumber}, 'The issue 1 should have been anonymised, before parameter was not passed' );
1101         $sth->execute($item_2->itemnumber);
1102         ($borrowernumber_used_to_anonymised) = $sth->fetchrow_array;
1103         is( $borrowernumber_used_to_anonymised, $anonymous->{borrowernumber}, 'The issue 2 should have been anonymised, before parameter was not passed' );
1104
1105         Koha::Patrons->find( $patron->{borrowernumber})->delete;
1106     };
1107
1108     subtest 'patron privacy is 0 (forever)' => sub {
1109         plan tests => 2;
1110
1111         t::lib::Mocks::mock_preference('IndependentBranches', 0);
1112         my $patron = $builder->build(
1113             {   source => 'Borrower',
1114                 value  => { privacy => 0, }
1115             }
1116         );
1117         my $item = $builder->build_sample_item;
1118         my $issue = $builder->build(
1119             {   source => 'Issue',
1120                 value  => {
1121                     borrowernumber => $patron->{borrowernumber},
1122                     itemnumber     => $item->itemnumber,
1123                 },
1124             }
1125         );
1126
1127         my ( $returned, undef, undef ) = C4::Circulation::AddReturn( $item->barcode, undef, undef, dt_from_string('2010-10-10') );
1128         is( $returned, 1, 'The item should have been returned' );
1129
1130         my $dbh = C4::Context->dbh;
1131         my ($borrowernumber_used_to_anonymised) = $dbh->selectrow_array(q|
1132             SELECT borrowernumber FROM old_issues where itemnumber = ?
1133         |, undef, $item->itemnumber);
1134         is( $borrowernumber_used_to_anonymised, $patron->{borrowernumber}, 'With privacy=0, the issue should not be anonymised' );
1135         Koha::Patrons->find( $patron->{borrowernumber})->delete;
1136     };
1137
1138     t::lib::Mocks::mock_preference( 'AnonymousPatron', '' );
1139
1140     subtest 'AnonymousPatron is not defined' => sub {
1141         plan tests => 3;
1142
1143         t::lib::Mocks::mock_preference('IndependentBranches', 0);
1144         my $patron = $builder->build(
1145             {   source => 'Borrower',
1146                 value  => { privacy => 1, }
1147             }
1148         );
1149         my $item = $builder->build_sample_item;
1150         my $issue = $builder->build(
1151             {   source => 'Issue',
1152                 value  => {
1153                     borrowernumber => $patron->{borrowernumber},
1154                     itemnumber     => $item->itemnumber,
1155                 },
1156             }
1157         );
1158
1159         my ( $returned, undef, undef ) = C4::Circulation::AddReturn( $item->barcode, undef, undef, dt_from_string('2010-10-10') );
1160         is( $returned, 1, 'The item should have been returned' );
1161         my $rows_affected = Koha::Patrons->search_patrons_to_anonymise( { before => '2010-10-11' } )->anonymise_issue_history( { before => '2010-10-11' } );
1162         ok( $rows_affected > 0, 'AnonymiseIssueHistory should affect at least 1 row' );
1163
1164         my $dbh = C4::Context->dbh;
1165         my ($borrowernumber_used_to_anonymised) = $dbh->selectrow_array(q|
1166             SELECT borrowernumber FROM old_issues where itemnumber = ?
1167         |, undef, $item->itemnumber);
1168         is( $borrowernumber_used_to_anonymised, undef, 'With AnonymousPatron is not defined, the issue should have been anonymised anyway' );
1169         Koha::Patrons->find( $patron->{borrowernumber})->delete;
1170     };
1171
1172     subtest 'Logged in librarian is not superlibrarian & IndependentBranches' => sub {
1173         plan tests => 1;
1174         t::lib::Mocks::mock_preference( 'IndependentBranches', 1 );
1175         my $patron = $builder->build(
1176             {   source => 'Borrower',
1177                 value  => { privacy => 1 }    # Another branchcode than the logged in librarian
1178             }
1179         );
1180         my $item = $builder->build_sample_item;
1181         my $issue = $builder->build(
1182             {   source => 'Issue',
1183                 value  => {
1184                     borrowernumber => $patron->{borrowernumber},
1185                     itemnumber     => $item->itemnumber,
1186                 },
1187             }
1188         );
1189
1190         my ( $returned, undef, undef ) = C4::Circulation::AddReturn( $item->barcode, undef, undef, dt_from_string('2010-10-10') );
1191         is( Koha::Patrons->search_patrons_to_anonymise( { before => '2010-10-11' } )->count, 0 );
1192         Koha::Patrons->find( $patron->{borrowernumber})->delete;
1193     };
1194
1195     Koha::Patrons->find( $anonymous->{borrowernumber})->delete;
1196     $userenv_patron->delete;
1197
1198     # Reset IndependentBranches for further tests
1199     t::lib::Mocks::mock_preference('IndependentBranches', 0);
1200 };
1201
1202 subtest 'libraries_where_can_see_patrons + can_see_patron_infos + search_limited' => sub {
1203     plan tests => 3;
1204
1205     # group1
1206     #   + library_11
1207     #   + library_12
1208     # group2
1209     #   + library21
1210     $nb_of_patrons = Koha::Patrons->search->count;
1211     my $group_1 = Koha::Library::Group->new( { title => 'TEST Group 1', ft_hide_patron_info => 1 } )->store;
1212     my $group_2 = Koha::Library::Group->new( { title => 'TEST Group 2', ft_hide_patron_info => 1 } )->store;
1213     my $library_11 = $builder->build( { source => 'Branch' } );
1214     my $library_12 = $builder->build( { source => 'Branch' } );
1215     my $library_21 = $builder->build( { source => 'Branch' } );
1216     $library_11 = Koha::Libraries->find( $library_11->{branchcode} );
1217     $library_12 = Koha::Libraries->find( $library_12->{branchcode} );
1218     $library_21 = Koha::Libraries->find( $library_21->{branchcode} );
1219     Koha::Library::Group->new(
1220         { branchcode => $library_11->branchcode, parent_id => $group_1->id } )->store;
1221     Koha::Library::Group->new(
1222         { branchcode => $library_12->branchcode, parent_id => $group_1->id } )->store;
1223     Koha::Library::Group->new(
1224         { branchcode => $library_21->branchcode, parent_id => $group_2->id } )->store;
1225
1226     my $sth = C4::Context->dbh->prepare(q|INSERT INTO user_permissions( borrowernumber, module_bit, code ) VALUES (?, 4, ?)|); # 4 for borrowers
1227     # 2 patrons from library_11 (group1)
1228     # patron_11_1 see patron's infos from outside its group
1229     # Setting flags => undef to not be considered as superlibrarian
1230     my $patron_11_1 = $builder->build({ source => 'Borrower', value => { branchcode => $library_11->branchcode, flags => undef, }});
1231     $patron_11_1 = Koha::Patrons->find( $patron_11_1->{borrowernumber} );
1232     $sth->execute( $patron_11_1->borrowernumber, 'edit_borrowers' );
1233     $sth->execute( $patron_11_1->borrowernumber, 'view_borrower_infos_from_any_libraries' );
1234     # patron_11_2 can only see patron's info from its group
1235     my $patron_11_2 = $builder->build({ source => 'Borrower', value => { branchcode => $library_11->branchcode, flags => undef, }});
1236     $patron_11_2 = Koha::Patrons->find( $patron_11_2->{borrowernumber} );
1237     $sth->execute( $patron_11_2->borrowernumber, 'edit_borrowers' );
1238     # 1 patron from library_12 (group1)
1239     my $patron_12 = $builder->build({ source => 'Borrower', value => { branchcode => $library_12->branchcode, flags => undef, }});
1240     $patron_12 = Koha::Patrons->find( $patron_12->{borrowernumber} );
1241     # 1 patron from library_21 (group2) can only see patron's info from its group
1242     my $patron_21 = $builder->build({ source => 'Borrower', value => { branchcode => $library_21->branchcode, flags => undef, }});
1243     $patron_21 = Koha::Patrons->find( $patron_21->{borrowernumber} );
1244     $sth->execute( $patron_21->borrowernumber, 'edit_borrowers' );
1245
1246     # Pfiou, we can start now!
1247     subtest 'libraries_where_can_see_patrons' => sub {
1248         plan tests => 3;
1249
1250         my @branchcodes;
1251
1252         t::lib::Mocks::mock_userenv({ patron => $patron_11_1 });
1253         @branchcodes = $patron_11_1->libraries_where_can_see_patrons;
1254         is_deeply( \@branchcodes, [], q|patron_11_1 has view_borrower_infos_from_any_libraries => No restriction| );
1255
1256         t::lib::Mocks::mock_userenv({ patron => $patron_11_2 });
1257         @branchcodes = $patron_11_2->libraries_where_can_see_patrons;
1258         is_deeply( \@branchcodes, [ sort ( $library_11->branchcode, $library_12->branchcode ) ], q|patron_11_2 has not view_borrower_infos_from_any_libraries => Can only see patron's from its group| );
1259
1260         t::lib::Mocks::mock_userenv({ patron => $patron_21 });
1261         @branchcodes = $patron_21->libraries_where_can_see_patrons;
1262         is_deeply( \@branchcodes, [$library_21->branchcode], q|patron_21 has not view_borrower_infos_from_any_libraries => Can only see patron's from its group| );
1263     };
1264     subtest 'can_see_patron_infos' => sub {
1265         plan tests => 6;
1266
1267         t::lib::Mocks::mock_userenv({ patron => $patron_11_1 });
1268         is( $patron_11_1->can_see_patron_infos( $patron_11_2 ), 1, q|patron_11_1 can see patron_11_2, from its library| );
1269         is( $patron_11_1->can_see_patron_infos( $patron_12 ),   1, q|patron_11_1 can see patron_12, from its group| );
1270         is( $patron_11_1->can_see_patron_infos( $patron_21 ),   1, q|patron_11_1 can see patron_11_2, from another group| );
1271
1272         t::lib::Mocks::mock_userenv({ patron => $patron_11_2 });
1273         is( $patron_11_2->can_see_patron_infos( $patron_11_1 ), 1, q|patron_11_2 can see patron_11_1, from its library| );
1274         is( $patron_11_2->can_see_patron_infos( $patron_12 ),   1, q|patron_11_2 can see patron_12, from its group| );
1275         is( $patron_11_2->can_see_patron_infos( $patron_21 ),   0, q|patron_11_2 can NOT see patron_21, from another group| );
1276     };
1277     subtest 'search_limited' => sub {
1278         plan tests => 6;
1279
1280         t::lib::Mocks::mock_userenv({ patron => $patron_11_1 });
1281         my $total_number_of_patrons = $nb_of_patrons + 4; #we added four in these tests
1282         is( Koha::Patrons->search->count, $total_number_of_patrons, 'Non-limited search should return all patrons' );
1283         is( Koha::Patrons->search_limited->count, $total_number_of_patrons, 'patron_11_1 is allowed to see all patrons' );
1284
1285         t::lib::Mocks::mock_userenv({ patron => $patron_11_2 });
1286         is( Koha::Patrons->search->count, $total_number_of_patrons, 'Non-limited search should return all patrons');
1287         is( Koha::Patrons->search_limited->count, 3, 'patron_12_1 is not allowed to see patrons from other groups, only patron_11_1, patron_11_2 and patron_12' );
1288
1289         t::lib::Mocks::mock_userenv({ patron => $patron_21 });
1290         is( Koha::Patrons->search->count, $total_number_of_patrons, 'Non-limited search should return all patrons');
1291         is( Koha::Patrons->search_limited->count, 1, 'patron_21 is not allowed to see patrons from other groups, only himself' );
1292     };
1293     $patron_11_1->delete;
1294     $patron_11_2->delete;
1295     $patron_12->delete;
1296     $patron_21->delete;
1297 };
1298
1299 subtest 'account_locked' => sub {
1300     plan tests => 13;
1301     my $patron = $builder->build({ source => 'Borrower', value => { login_attempts => 0 } });
1302     $patron = Koha::Patrons->find( $patron->{borrowernumber} );
1303     for my $value ( undef, '', 0 ) {
1304         t::lib::Mocks::mock_preference('FailedloginAttempts', $value);
1305         $patron->login_attempts(0)->store;
1306         is( $patron->account_locked, 0, 'Feature is disabled, patron account should not be considered locked' );
1307         $patron->login_attempts(1)->store;
1308         is( $patron->account_locked, 0, 'Feature is disabled, patron account should not be considered locked' );
1309         $patron->login_attempts(-1)->store;
1310         is( $patron->account_locked, 1, 'Feature is disabled but administrative lockout has been triggered' );
1311     }
1312
1313     t::lib::Mocks::mock_preference('FailedloginAttempts', 3);
1314     $patron->login_attempts(2)->store;
1315     is( $patron->account_locked, 0, 'Patron has 2 failed attempts, account should not be considered locked yet' );
1316     $patron->login_attempts(3)->store;
1317     is( $patron->account_locked, 1, 'Patron has 3 failed attempts, account should be considered locked yet' );
1318     $patron->login_attempts(4)->store;
1319     is( $patron->account_locked, 1, 'Patron could not have 4 failed attempts, but account should still be considered locked' );
1320     $patron->login_attempts(-1)->store;
1321     is( $patron->account_locked, 1, 'Administrative lockout triggered' );
1322
1323     $patron->delete;
1324 };
1325
1326 subtest 'is_child | is_adult' => sub {
1327     plan tests => 8;
1328     my $category = $builder->build_object(
1329         {
1330             class => 'Koha::Patron::Categories',
1331             value => { category_type => 'A' }
1332         }
1333     );
1334     my $patron_adult = $builder->build_object(
1335         {
1336             class => 'Koha::Patrons',
1337             value => { categorycode => $category->categorycode }
1338         }
1339     );
1340     $category = $builder->build_object(
1341         {
1342             class => 'Koha::Patron::Categories',
1343             value => { category_type => 'I' }
1344         }
1345     );
1346     my $patron_adult_i = $builder->build_object(
1347         {
1348             class => 'Koha::Patrons',
1349             value => { categorycode => $category->categorycode }
1350         }
1351     );
1352     $category = $builder->build_object(
1353         {
1354             class => 'Koha::Patron::Categories',
1355             value => { category_type => 'C' }
1356         }
1357     );
1358     my $patron_child = $builder->build_object(
1359         {
1360             class => 'Koha::Patrons',
1361             value => { categorycode => $category->categorycode }
1362         }
1363     );
1364     $category = $builder->build_object(
1365         {
1366             class => 'Koha::Patron::Categories',
1367             value => { category_type => 'O' }
1368         }
1369     );
1370     my $patron_other = $builder->build_object(
1371         {
1372             class => 'Koha::Patrons',
1373             value => { categorycode => $category->categorycode }
1374         }
1375     );
1376     is( $patron_adult->is_adult, 1, 'Patron from category A should be considered adult' );
1377     is( $patron_adult_i->is_adult, 1, 'Patron from category I should be considered adult' );
1378     is( $patron_child->is_adult, 0, 'Patron from category C should not be considered adult' );
1379     is( $patron_other->is_adult, 0, 'Patron from category O should not be considered adult' );
1380
1381     is( $patron_adult->is_child, 0, 'Patron from category A should be considered child' );
1382     is( $patron_adult_i->is_child, 0, 'Patron from category I should be considered child' );
1383     is( $patron_child->is_child, 1, 'Patron from category C should not be considered child' );
1384     is( $patron_other->is_child, 0, 'Patron from category O should not be considered child' );
1385
1386     # Clean up
1387     $patron_adult->delete;
1388     $patron_adult_i->delete;
1389     $patron_child->delete;
1390     $patron_other->delete;
1391 };
1392
1393 subtest 'get_overdues' => sub {
1394     plan tests => 7;
1395
1396     my $library = $builder->build( { source => 'Branch' } );
1397     my $biblionumber_1 = $builder->build_sample_biblio->biblionumber;
1398     my $item_1 = $builder->build_sample_item(
1399         {
1400             library      => $library->{branchcode},
1401             biblionumber => $biblionumber_1,
1402         }
1403     );
1404     my $item_2 = $builder->build_sample_item(
1405         {
1406             library      => $library->{branchcode},
1407             biblionumber => $biblionumber_1,
1408         }
1409     );
1410     my $item_3 = $builder->build_sample_item(
1411         {
1412             library      => $library->{branchcode},
1413         }
1414     );
1415
1416     my $patron = $builder->build(
1417         {
1418             source => 'Borrower',
1419             value  => { branchcode => $library->{branchcode} }
1420         }
1421     );
1422
1423     t::lib::Mocks::mock_preference({ branchcode => $library->{branchcode} });
1424
1425     AddIssue( $patron, $item_1->barcode, DateTime->now->subtract( days => 1 ) );
1426     AddIssue( $patron, $item_2->barcode, DateTime->now->subtract( days => 5 ) );
1427     AddIssue( $patron, $item_3->barcode );
1428
1429     $patron = Koha::Patrons->find( $patron->{borrowernumber} );
1430     my $overdues = $patron->get_overdues;
1431     is( $overdues->count, 2, 'Patron should have 2 overdues');
1432     is( $overdues->next->itemnumber, $item_1->itemnumber, 'The issue should be returned in the same order as they have been done, first is correct' );
1433     is( $overdues->next->itemnumber, $item_2->itemnumber, 'The issue should be returned in the same order as they have been done, second is correct' );
1434
1435     my $o = $overdues->reset->next;
1436     my $unblessed_overdue = $o->unblessed_all_relateds;
1437     is( exists( $unblessed_overdue->{issuedate} ), 1, 'Fields from the issues table should be filled' );
1438     is( exists( $unblessed_overdue->{itemcallnumber} ), 1, 'Fields from the items table should be filled' );
1439     is( exists( $unblessed_overdue->{title} ), 1, 'Fields from the biblio table should be filled' );
1440     is( exists( $unblessed_overdue->{itemtype} ), 1, 'Fields from the biblioitems table should be filled' );
1441
1442     # Clean stuffs
1443     $patron->checkouts->delete;
1444     $patron->delete;
1445 };
1446
1447 subtest 'userid_is_valid' => sub {
1448     plan tests => 9;
1449
1450     my $library = $builder->build_object( { class => 'Koha::Libraries' } );
1451     my $patron_category = $builder->build_object(
1452         {
1453             class => 'Koha::Patron::Categories',
1454             value => { category_type => 'P', enrolmentfee => 0 }
1455         }
1456     );
1457     my %data = (
1458         cardnumber   => "123456789",
1459         firstname    => "Tomasito",
1460         surname      => "None",
1461         categorycode => $patron_category->categorycode,
1462         branchcode   => $library->branchcode,
1463     );
1464
1465     my $expected_userid_patron_1 = 'tomasito.none';
1466     my $borrowernumber = Koha::Patron->new(\%data)->store->borrowernumber;
1467     my $patron_1       = Koha::Patrons->find($borrowernumber);
1468     is( $patron_1->has_valid_userid, 1, "Should be valid when compared against them self" );
1469     is ( $patron_1->userid, $expected_userid_patron_1, 'The userid generated should be the one we expect' );
1470
1471     $patron_1->userid( 'tomasito.non' );
1472     is( $patron_1->has_valid_userid, # FIXME Joubu: What is the difference with the next test?
1473         1, 'recently created userid -> unique (borrowernumber passed)' );
1474
1475     $patron_1->userid( 'tomasitoxxx' );
1476     is( $patron_1->has_valid_userid,
1477         1, 'non-existent userid -> unique (borrowernumber passed)' );
1478     $patron_1->discard_changes; # We compare with the original userid later
1479
1480     my $patron_not_in_storage = Koha::Patron->new( { userid => '' } );
1481     is( $patron_not_in_storage->has_valid_userid,
1482         0, 'userid exists for another patron, patron is not in storage yet' );
1483
1484     $patron_not_in_storage = Koha::Patron->new( { userid => 'tomasitoxxx' } );
1485     is( $patron_not_in_storage->has_valid_userid,
1486         1, 'non-existent userid, patron is not in storage yet' );
1487
1488     # Regression tests for BZ12226
1489     my $db_patron = Koha::Patron->new( { userid => C4::Context->config('user') } );
1490     is( $db_patron->has_valid_userid,
1491         0, 'Koha::Patron->has_valid_userid should return 0 for the DB user (Bug 12226)' );
1492
1493     # Add a new borrower with the same userid but different cardnumber
1494     $data{cardnumber} = "987654321";
1495     my $new_borrowernumber = Koha::Patron->new(\%data)->store->borrowernumber;
1496     my $patron_2 = Koha::Patrons->find($new_borrowernumber);
1497     $patron_2->userid($patron_1->userid);
1498     is( $patron_2->has_valid_userid,
1499         0, 'The userid is already in used, it cannot be used for another patron' );
1500
1501     my $new_userid = 'a_user_id';
1502     $data{cardnumber} = "234567890";
1503     $data{userid}     = 'a_user_id';
1504     $borrowernumber   = Koha::Patron->new(\%data)->store->borrowernumber;
1505     my $patron_3 = Koha::Patrons->find($borrowernumber);
1506     is( $patron_3->userid, $new_userid,
1507         'Koha::Patron->store should insert the given userid' );
1508
1509     # Cleanup
1510     $patron_1->delete;
1511     $patron_2->delete;
1512     $patron_3->delete;
1513 };
1514
1515 subtest 'generate_userid' => sub {
1516     plan tests => 7;
1517
1518     my $library = $builder->build_object( { class => 'Koha::Libraries' } );
1519     my $patron_category = $builder->build_object(
1520         {
1521             class => 'Koha::Patron::Categories',
1522             value => { category_type => 'P', enrolmentfee => 0 }
1523         }
1524     );
1525     my %data = (
1526         cardnumber   => "123456789",
1527         firstname    => "Tômàsító",
1528         surname      => "Ñoné",
1529         categorycode => $patron_category->categorycode,
1530         branchcode   => $library->branchcode,
1531     );
1532
1533     my $expected_userid_patron_1 = 'tomasito.none';
1534     my $new_patron = Koha::Patron->new({ firstname => $data{firstname}, surname => $data{surname} } );
1535     $new_patron->generate_userid;
1536     my $userid = $new_patron->userid;
1537     is( $userid, $expected_userid_patron_1, 'generate_userid should generate the userid we expect' );
1538     my $borrowernumber = Koha::Patron->new(\%data)->store->borrowernumber;
1539     my $patron_1 = Koha::Patrons->find($borrowernumber);
1540     is ( $patron_1->userid, $expected_userid_patron_1, 'The userid generated should be the one we expect' );
1541
1542     $new_patron->generate_userid;
1543     $userid = $new_patron->userid;
1544     is( $userid, $expected_userid_patron_1 . '1', 'generate_userid should generate the userid we expect' );
1545     $data{cardnumber} = '987654321';
1546     my $new_borrowernumber = Koha::Patron->new(\%data)->store->borrowernumber;
1547     my $patron_2 = Koha::Patrons->find($new_borrowernumber);
1548     isnt( $patron_2->userid, 'tomasito',
1549         "Patron with duplicate userid has new userid generated" );
1550     is( $patron_2->userid, $expected_userid_patron_1 . '1', # TODO we could make that configurable
1551         "Patron with duplicate userid has new userid generated (1 is appened" );
1552
1553     $new_patron->generate_userid;
1554     $userid = $new_patron->userid;
1555     is( $userid, $expected_userid_patron_1 . '2', 'generate_userid should generate the userid we expect' );
1556
1557     $patron_1 = Koha::Patrons->find($borrowernumber);
1558     $patron_1->userid(undef);
1559     $patron_1->generate_userid;
1560     $userid = $patron_1->userid;
1561     is( $userid, $expected_userid_patron_1, 'generate_userid should generate the userid we expect' );
1562
1563     # Cleanup
1564     $patron_1->delete;
1565     $patron_2->delete;
1566 };
1567
1568 $nb_of_patrons = Koha::Patrons->search->count;
1569 $retrieved_patron_1->delete;
1570 is( Koha::Patrons->search->count, $nb_of_patrons - 1, 'Delete should have deleted the patron' );
1571
1572 subtest 'BorrowersLog tests' => sub {
1573     plan tests => 4;
1574
1575     t::lib::Mocks::mock_preference( 'BorrowersLog', 1 );
1576     my $patron = $builder->build_object( { class => 'Koha::Patrons' } );
1577
1578     my $cardnumber = $patron->cardnumber;
1579     $patron->set( { cardnumber => 'TESTCARDNUMBER' });
1580     $patron->store;
1581
1582     my @logs = $schema->resultset('ActionLog')->search( { module => 'MEMBERS', action => 'MODIFY', object => $patron->borrowernumber } );
1583     my $log_info = from_json( $logs[0]->info );
1584     is( $log_info->{cardnumber}->{after}, 'TESTCARDNUMBER', 'Got correct new cardnumber' );
1585     is( $log_info->{cardnumber}->{before}, $cardnumber, 'Got correct old cardnumber' );
1586     is( scalar @logs, 1, 'With BorrowerLogs, one detailed MODIFY action should be logged for the modification.' );
1587
1588     t::lib::Mocks::mock_preference( 'TrackLastPatronActivity', 1 );
1589     $patron->track_login();
1590     @logs = $schema->resultset('ActionLog')->search( { module => 'MEMBERS', action => 'MODIFY', object => $patron->borrowernumber } );
1591     is( scalar @logs, 1, 'With BorrowerLogs and TrackLastPatronActivity we should not spam the logs');
1592 };
1593
1594 $schema->storage->txn_rollback;
1595
1596 subtest 'Test Koha::Patrons::merge' => sub {
1597     plan tests => 110;
1598
1599     my $schema = Koha::Database->new()->schema();
1600
1601     my $resultsets = $Koha::Patron::RESULTSET_PATRON_ID_MAPPING;
1602
1603     $schema->storage->txn_begin;
1604
1605     my $keeper  = $builder->build_object({ class => 'Koha::Patrons' });
1606     my $loser_1 = $builder->build({ source => 'Borrower' })->{borrowernumber};
1607     my $loser_2 = $builder->build({ source => 'Borrower' })->{borrowernumber};
1608
1609     while (my ($r, $field) = each(%$resultsets)) {
1610         $builder->build({ source => $r, value => { $field => $keeper->id } });
1611         $builder->build({ source => $r, value => { $field => $loser_1 } });
1612         $builder->build({ source => $r, value => { $field => $loser_2 } });
1613
1614         my $keeper_rs =
1615           $schema->resultset($r)->search( { $field => $keeper->id } );
1616         is( $keeper_rs->count(), 1, "Found 1 $r rows for keeper" );
1617
1618         my $loser_1_rs =
1619           $schema->resultset($r)->search( { $field => $loser_1 } );
1620         is( $loser_1_rs->count(), 1, "Found 1 $r rows for loser_1" );
1621
1622         my $loser_2_rs =
1623           $schema->resultset($r)->search( { $field => $loser_2 } );
1624         is( $loser_2_rs->count(), 1, "Found 1 $r rows for loser_2" );
1625     }
1626
1627     my $results = $keeper->merge_with([ $loser_1, $loser_2 ]);
1628
1629     while (my ($r, $field) = each(%$resultsets)) {
1630         my $keeper_rs =
1631           $schema->resultset($r)->search( {$field => $keeper->id } );
1632         is( $keeper_rs->count(), 3, "Found 2 $r rows for keeper" );
1633     }
1634
1635     is( Koha::Patrons->find($loser_1), undef, 'Loser 1 has been deleted' );
1636     is( Koha::Patrons->find($loser_2), undef, 'Loser 2 has been deleted' );
1637
1638     $schema->storage->txn_rollback;
1639 };
1640
1641 subtest '->store' => sub {
1642     plan tests => 7;
1643     my $schema = Koha::Database->new->schema;
1644     $schema->storage->txn_begin;
1645
1646     my $print_error = $schema->storage->dbh->{PrintError};
1647     $schema->storage->dbh->{PrintError} = 0; ; # FIXME This does not longer work - because of the transaction in Koha::Patron->store?
1648
1649     my $patron_1 = $builder->build_object({class=> 'Koha::Patrons'});
1650     my $patron_2 = $builder->build_object({class=> 'Koha::Patrons'});
1651
1652     {
1653         local *STDERR;
1654         open STDERR, '>', '/dev/null';
1655         throws_ok { $patron_2->userid( $patron_1->userid )->store; }
1656         'Koha::Exceptions::Object::DuplicateID',
1657           'Koha::Patron->store raises an exception on duplicate ID';
1658         close STDERR;
1659     }
1660
1661     # Test password
1662     t::lib::Mocks::mock_preference( 'RequireStrongPassword', 0 );
1663     my $password = 'password';
1664     $patron_1->set_password({ password => $password });
1665     like( $patron_1->password, qr|^\$2|, 'Password should be hashed using bcrypt (start with $2)' );
1666     my $digest = $patron_1->password;
1667     $patron_1->surname('xxx')->store;
1668     is( $patron_1->password, $digest, 'Password should not have changed on ->store');
1669
1670     # Test uppercasesurnames
1671     t::lib::Mocks::mock_preference( 'uppercasesurnames', 1 );
1672     my $surname = lc $patron_1->surname;
1673     $patron_1->surname($surname)->store;
1674     isnt( $patron_1->surname, $surname,
1675         'Surname converts to uppercase on store.');
1676     t::lib::Mocks::mock_preference( 'uppercasesurnames', 0 );
1677     $patron_1->surname($surname)->store;
1678     is( $patron_1->surname, $surname,
1679         'Surname remains unchanged on store.');
1680
1681     # Test relationship
1682     $patron_1->relationship("")->store;
1683     is( $patron_1->relationship, undef, );
1684
1685     $schema->storage->dbh->{PrintError} = $print_error;
1686     $schema->storage->txn_rollback;
1687
1688     subtest 'skip updated_on for BorrowersLog' => sub {
1689         plan tests => 1;
1690         $schema->storage->txn_begin;
1691         t::lib::Mocks::mock_preference('BorrowersLog', 1);
1692         my $patron = $builder->build_object({ class => 'Koha::Patrons' });
1693         $patron->updated_on(dt_from_string($patron->updated_on)->add( seconds => 1 ))->store;
1694         my $logs = Koha::ActionLogs->search({ module =>'MEMBERS', action => 'MODIFY', object => $patron->borrowernumber });
1695         is($logs->count, 0, '->store should not have generated a log for updated_on') or diag 'Log generated:'.Dumper($logs->unblessed);
1696         $schema->storage->txn_rollback;
1697     };
1698 };
1699
1700 subtest '->set_password' => sub {
1701
1702     plan tests => 14;
1703
1704     $schema->storage->txn_begin;
1705
1706     my $patron = $builder->build_object( { class => 'Koha::Patrons', value => { login_attempts => 3 } } );
1707
1708     # Disable logging password changes for this tests
1709     t::lib::Mocks::mock_preference( 'BorrowersLog', 0 );
1710
1711     # Password-length tests
1712     t::lib::Mocks::mock_preference( 'minPasswordLength', undef );
1713     throws_ok { $patron->set_password({ password => 'ab' }); }
1714         'Koha::Exceptions::Password::TooShort',
1715         'minPasswordLength is undef, fall back to 3, fail test';
1716     is( "$@",
1717         'Password length (2) is shorter than required (3)',
1718         'Exception parameters passed correctly'
1719     );
1720
1721     t::lib::Mocks::mock_preference( 'minPasswordLength', 2 );
1722     throws_ok { $patron->set_password({ password => 'ab' }); }
1723         'Koha::Exceptions::Password::TooShort',
1724         'minPasswordLength is 2, fall back to 3, fail test';
1725
1726     t::lib::Mocks::mock_preference( 'minPasswordLength', 5 );
1727     throws_ok { $patron->set_password({ password => 'abcb' }); }
1728         'Koha::Exceptions::Password::TooShort',
1729         'minPasswordLength is 5, fail test';
1730
1731     # Trailing spaces tests
1732     throws_ok { $patron->set_password({ password => 'abcD12d   ' }); }
1733         'Koha::Exceptions::Password::WhitespaceCharacters',
1734         'Password contains trailing spaces, exception is thrown';
1735
1736     # Require strong password tests
1737     t::lib::Mocks::mock_preference( 'RequireStrongPassword', 1 );
1738     throws_ok { $patron->set_password({ password => 'abcd   a' }); }
1739         'Koha::Exceptions::Password::TooWeak',
1740         'Password is too weak, exception is thrown';
1741
1742     # Refresh patron from DB, just to make sure
1743     $patron->discard_changes;
1744     is( $patron->login_attempts, 3, 'Previous tests kept login attemps count' );
1745
1746     $patron->set_password({ password => 'abcD12 34' });
1747     $patron->discard_changes;
1748
1749     is( $patron->login_attempts, 0, 'Changing the password resets the login attempts count' );
1750
1751     lives_ok { $patron->set_password({ password => 'abcd   a', skip_validation => 1 }) }
1752         'Password is weak, but skip_validation was passed, so no exception thrown';
1753
1754     # Completeness
1755     t::lib::Mocks::mock_preference( 'RequireStrongPassword', 0 );
1756     $patron->login_attempts(3)->store;
1757     my $old_digest = $patron->password;
1758     $patron->set_password({ password => 'abcd   a' });
1759     $patron->discard_changes;
1760
1761     isnt( $patron->password, $old_digest, 'Password has been updated' );
1762     ok( checkpw_hash('abcd   a', $patron->password), 'Password hash is correct' );
1763     is( $patron->login_attempts, 0, 'Login attemps have been reset' );
1764
1765     my $number_of_logs = $schema->resultset('ActionLog')->search( { module => 'MEMBERS', action => 'CHANGE PASS', object => $patron->borrowernumber } )->count;
1766     is( $number_of_logs, 0, 'Without BorrowerLogs, Koha::Patron->set_password doesn\'t log password changes' );
1767
1768     # Enable logging password changes
1769     t::lib::Mocks::mock_preference( 'BorrowersLog', 1 );
1770     $patron->set_password({ password => 'abcd   b' });
1771
1772     $number_of_logs = $schema->resultset('ActionLog')->search( { module => 'MEMBERS', action => 'CHANGE PASS', object => $patron->borrowernumber } )->count;
1773     is( $number_of_logs, 1, 'With BorrowerLogs, Koha::Patron->set_password does log password changes' );
1774
1775     $schema->storage->txn_rollback;
1776 };
1777
1778 $schema->storage->txn_begin;
1779 subtest 'search_unsubscribed' => sub {
1780     plan tests => 4;
1781
1782     t::lib::Mocks::mock_preference( 'FailedLoginAttempts', 3 );
1783     t::lib::Mocks::mock_preference( 'UnsubscribeReflectionDelay', '' );
1784     is( Koha::Patrons->search_unsubscribed->count, 0, 'Empty delay should return empty set' );
1785
1786     my $patron1 = $builder->build_object({ class => 'Koha::Patrons' });
1787     my $patron2 = $builder->build_object({ class => 'Koha::Patrons' });
1788
1789     t::lib::Mocks::mock_preference( 'UnsubscribeReflectionDelay', 0 );
1790     Koha::Patron::Consents->delete; # for correct counts
1791     Koha::Patron::Consent->new({ borrowernumber => $patron1->borrowernumber, type => 'GDPR_PROCESSING',  refused_on => dt_from_string })->store;
1792     is( Koha::Patrons->search_unsubscribed->count, 1, 'Find patron1' );
1793
1794     # Add another refusal but shift the period
1795     t::lib::Mocks::mock_preference( 'UnsubscribeReflectionDelay', 2 );
1796     Koha::Patron::Consent->new({ borrowernumber => $patron2->borrowernumber, type => 'GDPR_PROCESSING',  refused_on => dt_from_string->subtract(days=>2) })->store;
1797     is( Koha::Patrons->search_unsubscribed->count, 1, 'Find patron2 only' );
1798
1799     # Try another (special) attempts setting
1800     t::lib::Mocks::mock_preference( 'FailedLoginAttempts', 0 );
1801     # Lockout is now disabled
1802     # Patron2 still matches: refused earlier, not locked
1803     is( Koha::Patrons->search_unsubscribed->count, 1, 'Lockout disabled' );
1804 };
1805
1806 subtest 'search_anonymize_candidates' => sub {
1807     plan tests => 7;
1808     my $patron1 = $builder->build_object({ class => 'Koha::Patrons' });
1809     my $patron2 = $builder->build_object({ class => 'Koha::Patrons' });
1810     $patron1->anonymized(0);
1811     $patron1->dateexpiry( dt_from_string->add(days => 1) )->store;
1812     $patron2->anonymized(0);
1813     $patron2->dateexpiry( dt_from_string->add(days => 1) )->store;
1814
1815     t::lib::Mocks::mock_preference( 'PatronAnonymizeDelay', q{} );
1816     is( Koha::Patrons->search_anonymize_candidates->count, 0, 'Empty set' );
1817
1818     t::lib::Mocks::mock_preference( 'PatronAnonymizeDelay', 0 );
1819     my $cnt = Koha::Patrons->search_anonymize_candidates->count;
1820     $patron1->dateexpiry( dt_from_string->subtract(days => 1) )->store;
1821     $patron2->dateexpiry( dt_from_string->subtract(days => 3) )->store;
1822     is( Koha::Patrons->search_anonymize_candidates->count, $cnt+2, 'Delay 0' );
1823
1824     t::lib::Mocks::mock_preference( 'PatronAnonymizeDelay', 2 );
1825     $patron1->dateexpiry( dt_from_string->add(days => 1) )->store;
1826     $patron2->dateexpiry( dt_from_string->add(days => 1) )->store;
1827     $cnt = Koha::Patrons->search_anonymize_candidates->count;
1828     $patron1->dateexpiry( dt_from_string->subtract(days => 1) )->store;
1829     $patron2->dateexpiry( dt_from_string->subtract(days => 3) )->store;
1830     is( Koha::Patrons->search_anonymize_candidates->count, $cnt+1, 'Delay 2' );
1831
1832     t::lib::Mocks::mock_preference( 'PatronAnonymizeDelay', 4 );
1833     $patron1->dateexpiry( dt_from_string->add(days => 1) )->store;
1834     $patron2->dateexpiry( dt_from_string->add(days => 1) )->store;
1835     $cnt = Koha::Patrons->search_anonymize_candidates->count;
1836     $patron1->dateexpiry( dt_from_string->subtract(days => 1) )->store;
1837     $patron2->dateexpiry( dt_from_string->subtract(days => 3) )->store;
1838     is( Koha::Patrons->search_anonymize_candidates->count, $cnt, 'Delay 4' );
1839
1840     t::lib::Mocks::mock_preference( 'FailedLoginAttempts', 3 );
1841     $patron1->dateexpiry( dt_from_string->subtract(days => 5) )->store;
1842     $patron1->login_attempts(0)->store;
1843     $patron2->dateexpiry( dt_from_string->subtract(days => 5) )->store;
1844     $patron2->login_attempts(0)->store;
1845     $cnt = Koha::Patrons->search_anonymize_candidates({locked => 1})->count;
1846     $patron1->login_attempts(3)->store;
1847     is( Koha::Patrons->search_anonymize_candidates({locked => 1})->count,
1848         $cnt+1, 'Locked flag' );
1849
1850     t::lib::Mocks::mock_preference( 'FailedLoginAttempts', q{} );
1851     # Patron 1 still on 3 == locked
1852     is( Koha::Patrons->search_anonymize_candidates({locked => 1})->count,
1853         $cnt+1, 'Still expect same number for FailedLoginAttempts empty' );
1854     $patron1->login_attempts(0)->store;
1855     # Patron 1 unlocked
1856     is( Koha::Patrons->search_anonymize_candidates({locked => 1})->count,
1857         $cnt, 'Patron 1 unlocked' );
1858 };
1859
1860 subtest 'search_anonymized' => sub {
1861     plan tests => 3;
1862     my $patron1 = $builder->build_object( { class => 'Koha::Patrons' } );
1863
1864     t::lib::Mocks::mock_preference( 'PatronRemovalDelay', q{} );
1865     is( Koha::Patrons->search_anonymized->count, 0, 'Empty set' );
1866
1867     t::lib::Mocks::mock_preference( 'PatronRemovalDelay', 1 );
1868     $patron1->dateexpiry( dt_from_string );
1869     $patron1->anonymized(0)->store;
1870     my $cnt = Koha::Patrons->search_anonymized->count;
1871     $patron1->anonymized(1)->store;
1872     is( Koha::Patrons->search_anonymized->count, $cnt, 'Number unchanged' );
1873     $patron1->dateexpiry( dt_from_string->subtract(days => 1) )->store;
1874     is( Koha::Patrons->search_anonymized->count, $cnt+1, 'Found patron1' );
1875 };
1876
1877 subtest 'lock' => sub {
1878     plan tests => 8;
1879
1880     my $patron1 = $builder->build_object( { class => 'Koha::Patrons' } );
1881     my $patron2 = $builder->build_object( { class => 'Koha::Patrons' } );
1882     my $hold = $builder->build_object({
1883         class => 'Koha::Holds',
1884         value => { borrowernumber => $patron1->borrowernumber },
1885     });
1886
1887     t::lib::Mocks::mock_preference( 'FailedLoginAttempts', 3 );
1888     my $expiry = dt_from_string->add(days => 1);
1889     $patron1->dateexpiry( $expiry );
1890     $patron1->lock;
1891     is( $patron1->login_attempts, Koha::Patron::ADMINISTRATIVE_LOCKOUT, 'Check login_attempts' );
1892     is( $patron1->dateexpiry, $expiry, 'Not expired yet' );
1893     is( $patron1->holds->count, 1, 'No holds removed' );
1894
1895     $patron1->lock({ expire => 1, remove => 1});
1896     isnt( $patron1->dateexpiry, $expiry, 'Expiry date adjusted' );
1897     is( $patron1->holds->count, 0, 'Holds removed' );
1898
1899     # Disable lockout feature
1900     t::lib::Mocks::mock_preference( 'FailedLoginAttempts', q{} );
1901     $patron1->login_attempts(0);
1902     $patron1->dateexpiry( $expiry );
1903     $patron1->store;
1904     $patron1->lock;
1905     is( $patron1->login_attempts, Koha::Patron::ADMINISTRATIVE_LOCKOUT, 'Check login_attempts' );
1906
1907     # Trivial wrapper test (Koha::Patrons->lock)
1908     $patron1->login_attempts(0)->store;
1909     Koha::Patrons->search({ borrowernumber => [ $patron1->borrowernumber, $patron2->borrowernumber ] })->lock;
1910     $patron1->discard_changes; # refresh
1911     $patron2->discard_changes;
1912     is( $patron1->login_attempts, Koha::Patron::ADMINISTRATIVE_LOCKOUT, 'Check login_attempts patron 1' );
1913     is( $patron2->login_attempts, Koha::Patron::ADMINISTRATIVE_LOCKOUT, 'Check login_attempts patron 2' );
1914 };
1915
1916 subtest 'anonymize' => sub {
1917     plan tests => 10;
1918
1919     my $patron1 = $builder->build_object( { class => 'Koha::Patrons' } );
1920     my $patron2 = $builder->build_object( { class => 'Koha::Patrons' } );
1921
1922     # First try patron with issues
1923     my $issue = $builder->build_object({ class => 'Koha::Checkouts', value => { borrowernumber => $patron2->borrowernumber } });
1924     warning_like { $patron2->anonymize } qr/still has issues/, 'Skip patron with issues';
1925     $issue->delete;
1926
1927     t::lib::Mocks::mock_preference( 'BorrowerMandatoryField', 'surname|email|cardnumber' );
1928     my $surname = $patron1->surname; # expect change, no clear
1929     my $branchcode = $patron1->branchcode; # expect skip
1930     $patron1->anonymize;
1931     is($patron1->anonymized, 1, 'Check flag' );
1932
1933     is( $patron1->dateofbirth, undef, 'Birth date cleared' );
1934     is( $patron1->firstname, undef, 'First name cleared' );
1935     isnt( $patron1->surname, $surname, 'Surname changed' );
1936     ok( $patron1->surname =~ /^\w{10}$/, 'Mandatory surname randomized' );
1937     is( $patron1->branchcode, $branchcode, 'Branch code skipped' );
1938     is( $patron1->email, undef, 'Email was mandatory, must be cleared' );
1939
1940     # Test wrapper in Koha::Patrons
1941     $patron1->surname($surname)->store; # restore
1942     my $rs = Koha::Patrons->search({ borrowernumber => [ $patron1->borrowernumber, $patron2->borrowernumber ] })->anonymize;
1943     $patron1->discard_changes; # refresh
1944     isnt( $patron1->surname, $surname, 'Surname patron1 changed again' );
1945     $patron2->discard_changes; # refresh
1946     is( $patron2->firstname, undef, 'First name patron2 cleared' );
1947 };
1948 $schema->storage->txn_rollback;
1949
1950 subtest 'extended_attributes' => sub {
1951     plan tests => 14;
1952     my $schema = Koha::Database->new->schema;
1953     $schema->storage->txn_begin;
1954
1955     my $patron_1 = $builder->build_object({class=> 'Koha::Patrons'});
1956     my $patron_2 = $builder->build_object({class=> 'Koha::Patrons'});
1957
1958     t::lib::Mocks::mock_userenv({ patron => $patron_1 });
1959
1960     my $attribute_type1 = Koha::Patron::Attribute::Type->new(
1961         {
1962             code        => 'my code1',
1963             description => 'my description1',
1964             unique_id   => 1
1965         }
1966     )->store;
1967     my $attribute_type2 = Koha::Patron::Attribute::Type->new(
1968         {
1969             code             => 'my code2',
1970             description      => 'my description2',
1971             opac_display     => 1,
1972             staff_searchable => 1
1973         }
1974     )->store;
1975
1976     my $attribute_type3 = $builder->build_object({ class => 'Koha::Patron::Attribute::Types' });
1977
1978     my $deleted_attribute_type = $builder->build_object({ class => 'Koha::Patron::Attribute::Types' });
1979     my $deleted_attribute_type_code = $deleted_attribute_type->code;
1980     $deleted_attribute_type->delete;
1981
1982     my $new_library = $builder->build( { source => 'Branch' } );
1983     my $attribute_type_limited = Koha::Patron::Attribute::Type->new(
1984         { code => 'my code3', description => 'my description3' } )->store;
1985     $attribute_type_limited->library_limits( [ $new_library->{branchcode} ] );
1986
1987     my $attributes_for_1 = [
1988         {
1989             attribute => 'my attribute1',
1990             code => $attribute_type1->code(),
1991         },
1992         {
1993             attribute => 'my attribute2',
1994             code => $attribute_type2->code(),
1995         },
1996         {
1997             attribute => 'my attribute limited',
1998             code => $attribute_type_limited->code(),
1999         }
2000     ];
2001
2002     my $attributes_for_2 = [
2003         {
2004             attribute => 'my attribute12',
2005             code => $attribute_type1->code(),
2006         },
2007         {
2008             attribute => 'my attribute limited 2',
2009             code => $attribute_type_limited->code(),
2010         },
2011         {
2012             attribute => 'my nonexistent attribute 2',
2013             code => $deleted_attribute_type_code,
2014         }
2015     ];
2016
2017     my $extended_attributes = $patron_1->extended_attributes;
2018     is( ref($extended_attributes), 'Koha::Patron::Attributes', 'Koha::Patron->extended_attributes must return a Koha::Patron::Attribute set' );
2019     is( $extended_attributes->count, 0, 'There should not be attribute yet');
2020
2021     $patron_1->extended_attributes->filter_by_branch_limitations->delete;
2022     $patron_2->extended_attributes->filter_by_branch_limitations->delete;
2023     $patron_1->extended_attributes($attributes_for_1);
2024
2025     warning_like {
2026         $patron_2->extended_attributes($attributes_for_2);
2027     } [ qr/a foreign key constraint fails/ ], 'nonexistent attribute should have not exploded but print a warning';
2028
2029     my $extended_attributes_for_1 = $patron_1->extended_attributes;
2030     is( $extended_attributes_for_1->count, 3, 'There should be 3 attributes now for patron 1');
2031
2032     my $extended_attributes_for_2 = $patron_2->extended_attributes;
2033     is( $extended_attributes_for_2->count, 2, 'There should be 2 attributes now for patron 2');
2034
2035     my $attribute_12 = $extended_attributes_for_2->search({ code => $attribute_type1->code });
2036     is( $attribute_12->next->attribute, 'my attribute12', 'search by code should return the correct attribute' );
2037
2038     $attribute_12 = $patron_2->get_extended_attribute( $attribute_type1->code );
2039     is( $attribute_12->attribute, 'my attribute12', 'Koha::Patron->get_extended_attribute should return the correct attribute value' );
2040
2041     warning_is {
2042         $extended_attributes_for_2 = $patron_2->extended_attributes->merge_with(
2043             [
2044                 {
2045                     attribute => 'my attribute12 XXX',
2046                     code      => $attribute_type1->code(),
2047                 },
2048                 {
2049                     attribute => 'my nonexistent attribute 2',
2050                     code      => $deleted_attribute_type_code,
2051                 },
2052                 {
2053                     attribute => 'my attribute 3', # Adding a new attribute using merge_with
2054                     code      => $attribute_type3->code,
2055                 },
2056             ]
2057         );
2058     }
2059     "Cannot merge element: unrecognized code = '$deleted_attribute_type_code'",
2060     "Trying to merge_with using a nonexistent attribute code should display a warning";
2061
2062     is( @$extended_attributes_for_2, 3, 'There should be 3 attributes now for patron 3');
2063     my $expected_attributes_for_2 = [
2064         {
2065             code      => $attribute_type1->code(),
2066             attribute => 'my attribute12 XXX',
2067         },
2068         {
2069             code      => $attribute_type_limited->code(),
2070             attribute => 'my attribute limited 2',
2071         },
2072         {
2073             attribute => 'my attribute 3',
2074             code      => $attribute_type3->code,
2075         },
2076     ];
2077     # Sorting them by code
2078     $expected_attributes_for_2 = [ sort { $a->{code} cmp $b->{code} } @$expected_attributes_for_2 ];
2079
2080     is_deeply(
2081         [
2082             {
2083                 code      => $extended_attributes_for_2->[0]->{code},
2084                 attribute => $extended_attributes_for_2->[0]->{attribute}
2085             },
2086             {
2087                 code      => $extended_attributes_for_2->[1]->{code},
2088                 attribute => $extended_attributes_for_2->[1]->{attribute}
2089             },
2090             {
2091                 code      => $extended_attributes_for_2->[2]->{code},
2092                 attribute => $extended_attributes_for_2->[2]->{attribute}
2093             },
2094         ],
2095         $expected_attributes_for_2
2096     );
2097
2098     # TODO - What about multiple? POD explains the problem
2099     my $non_existent = $patron_2->get_extended_attribute( 'not_exist' );
2100     is( $non_existent, undef, 'Koha::Patron->get_extended_attribute must return undef if the attribute does not exist' );
2101
2102     # Test branch limitations
2103     t::lib::Mocks::mock_userenv({ patron => $patron_2 });
2104     # Return all
2105     $extended_attributes_for_1 = $patron_1->extended_attributes;
2106     is( $extended_attributes_for_1->count, 3, 'There should be 2 attributes for patron 1, the limited one should be returned');
2107
2108     # Return filtered
2109     $extended_attributes_for_1 = $patron_1->extended_attributes->filter_by_branch_limitations;
2110     is( $extended_attributes_for_1->count, 2, 'There should be 2 attributes for patron 1, the limited one should be returned');
2111
2112     # Not filtered
2113     my $limited_value = $patron_1->get_extended_attribute( $attribute_type_limited->code );
2114     is( $limited_value->attribute, 'my attribute limited', );
2115
2116     ## Do we need a filtered?
2117     #$limited_value = $patron_1->get_extended_attribute( $attribute_type_limited->code );
2118     #is( $limited_value, undef, );
2119
2120     $schema->storage->txn_rollback;
2121 };