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