3 # Copyright 2015 Koha Development team
5 # This file is part of Koha
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
22 use Test::More tests => 13;
32 use Koha::Virtualshelves;
34 use t::lib::TestBuilder;
37 my $schema = Koha::Database->new->schema;
38 $schema->storage->txn_begin;
40 my $builder = t::lib::TestBuilder->new;
41 my $library = $builder->build({source => 'Branch' });
42 my $category = $builder->build({source => 'Category' });
43 my $nb_of_patrons = Koha::Patrons->search->count;
44 my $new_patron_1 = Koha::Patron->new(
45 { cardnumber => 'test_cn_1',
46 branchcode => $library->{branchcode},
47 categorycode => $category->{categorycode},
48 surname => 'surname for patron1',
49 firstname => 'firstname for patron1',
50 userid => 'a_nonexistent_userid_1',
53 my $new_patron_2 = Koha::Patron->new(
54 { cardnumber => 'test_cn_2',
55 branchcode => $library->{branchcode},
56 categorycode => $category->{categorycode},
57 surname => 'surname for patron2',
58 firstname => 'firstname for patron2',
59 userid => 'a_nonexistent_userid_2',
63 C4::Context->_new_userenv('xxx');
64 C4::Context->set_userenv(0,0,0,'firstname','surname', $library->{branchcode}, 'Midway Public Library', '', '', '');
66 is( Koha::Patrons->search->count, $nb_of_patrons + 2, 'The 2 patrons should have been added' );
68 my $retrieved_patron_1 = Koha::Patrons->find( $new_patron_1->borrowernumber );
69 is( $retrieved_patron_1->cardnumber, $new_patron_1->cardnumber, 'Find a patron by borrowernumber should return the correct patron' );
71 subtest 'guarantees' => sub {
73 my $guarantees = $new_patron_1->guarantees;
74 is( ref($guarantees), 'Koha::Patrons', 'Koha::Patron->guarantees should return a Koha::Patrons result set in a scalar context' );
75 is( $guarantees->count, 0, 'new_patron_1 should have 0 guarantee' );
76 my @guarantees = $new_patron_1->guarantees;
77 is( ref(\@guarantees), 'ARRAY', 'Koha::Patron->guarantees should return an array in a list context' );
78 is( scalar(@guarantees), 0, 'new_patron_1 should have 0 guarantee' );
80 my $guarantee_1 = $builder->build({ source => 'Borrower', value => { guarantorid => $new_patron_1->borrowernumber }});
81 my $guarantee_2 = $builder->build({ source => 'Borrower', value => { guarantorid => $new_patron_1->borrowernumber }});
83 $guarantees = $new_patron_1->guarantees;
84 is( ref($guarantees), 'Koha::Patrons', 'Koha::Patron->guarantees should return a Koha::Patrons result set in a scalar context' );
85 is( $guarantees->count, 2, 'new_patron_1 should have 2 guarantees' );
86 @guarantees = $new_patron_1->guarantees;
87 is( ref(\@guarantees), 'ARRAY', 'Koha::Patron->guarantees should return an array in a list context' );
88 is( scalar(@guarantees), 2, 'new_patron_1 should have 2 guarantees' );
89 $_->delete for @guarantees;
92 subtest 'category' => sub {
94 my $patron_category = $new_patron_1->category;
95 is( ref( $patron_category), 'Koha::Patron::Category', );
96 is( $patron_category->categorycode, $category->{categorycode}, );
99 subtest 'siblings' => sub {
101 my $siblings = $new_patron_1->siblings;
102 is( $siblings, undef, 'Koha::Patron->siblings should not crashed if the patron has no guarantor' );
103 my $guarantee_1 = $builder->build( { source => 'Borrower', value => { guarantorid => $new_patron_1->borrowernumber } } );
104 my $retrieved_guarantee_1 = Koha::Patrons->find($guarantee_1);
105 $siblings = $retrieved_guarantee_1->siblings;
106 is( ref($siblings), 'Koha::Patrons', 'Koha::Patron->siblings should return a Koha::Patrons result set in a scalar context' );
107 my @siblings = $retrieved_guarantee_1->siblings;
108 is( ref( \@siblings ), 'ARRAY', 'Koha::Patron->siblings should return an array in a list context' );
109 is( $siblings->count, 0, 'guarantee_1 should not have siblings yet' );
110 my $guarantee_2 = $builder->build( { source => 'Borrower', value => { guarantorid => $new_patron_1->borrowernumber } } );
111 my $guarantee_3 = $builder->build( { source => 'Borrower', value => { guarantorid => $new_patron_1->borrowernumber } } );
112 $siblings = $retrieved_guarantee_1->siblings;
113 is( $siblings->count, 2, 'guarantee_1 should have 2 siblings' );
114 is( $guarantee_2->{borrowernumber}, $siblings->next->borrowernumber, 'guarantee_2 should exist in the guarantees' );
115 is( $guarantee_3->{borrowernumber}, $siblings->next->borrowernumber, 'guarantee_3 should exist in the guarantees' );
116 $_->delete for $retrieved_guarantee_1->siblings;
117 $retrieved_guarantee_1->delete;
120 subtest 'has_overdues' => sub {
123 my $biblioitem_1 = $builder->build( { source => 'Biblioitem' } );
124 my $item_1 = $builder->build(
127 homebranch => $library->{branchcode},
128 holdingbranch => $library->{branchcode},
132 biblionumber => $biblioitem_1->{biblionumber}
136 my $retrieved_patron = Koha::Patrons->find( $new_patron_1->borrowernumber );
137 is( $retrieved_patron->has_overdues, 0, );
139 my $tomorrow = DateTime->today( time_zone => C4::Context->tz() )->add( days => 1 );
140 my $issue = Koha::Issue->new({ borrowernumber => $new_patron_1->id, itemnumber => $item_1->{itemnumber}, date_due => $tomorrow, branchcode => $library->{branchcode} })->store();
141 is( $retrieved_patron->has_overdues, 0, );
143 my $yesterday = DateTime->today(time_zone => C4::Context->tz())->add( days => -1 );
144 $issue = Koha::Issue->new({ borrowernumber => $new_patron_1->id, itemnumber => $item_1->{itemnumber}, date_due => $yesterday, branchcode => $library->{branchcode} })->store();
145 $retrieved_patron = Koha::Patrons->find( $new_patron_1->borrowernumber );
146 is( $retrieved_patron->has_overdues, 1, );
150 subtest 'update_password' => sub {
153 t::lib::Mocks::mock_preference( 'BorrowersLog', 1 );
154 my $original_userid = $new_patron_1->userid;
155 my $original_password = $new_patron_1->password;
156 warning_like { $retrieved_patron_1->update_password( $new_patron_2->userid, 'another_password' ) }
158 'Koha::Patron->update_password should warn if the userid is already used by another patron';
159 is( Koha::Patrons->find( $new_patron_1->borrowernumber )->userid, $original_userid, 'Koha::Patron->update_password should not have updated the userid' );
160 is( Koha::Patrons->find( $new_patron_1->borrowernumber )->password, $original_password, 'Koha::Patron->update_password should not have updated the userid' );
162 $retrieved_patron_1->update_password( 'another_nonexistent_userid_1', 'another_password' );
163 is( Koha::Patrons->find( $new_patron_1->borrowernumber )->userid, 'another_nonexistent_userid_1', 'Koha::Patron->update_password should have updated the userid' );
164 is( Koha::Patrons->find( $new_patron_1->borrowernumber )->password, 'another_password', 'Koha::Patron->update_password should have updated the password' );
166 my $number_of_logs = $schema->resultset('ActionLog')->search( { module => 'MEMBERS', action => 'CHANGE PASS', object => $new_patron_1->borrowernumber } )->count;
167 is( $number_of_logs, 1, 'With BorrowerLogs, Koha::Patron->update_password should have logged' );
169 t::lib::Mocks::mock_preference( 'BorrowersLog', 0 );
170 $retrieved_patron_1->update_password( 'yet_another_nonexistent_userid_1', 'another_password' );
171 $number_of_logs = $schema->resultset('ActionLog')->search( { module => 'MEMBERS', action => 'CHANGE PASS', object => $new_patron_1->borrowernumber } )->count;
172 is( $number_of_logs, 1, 'With BorrowerLogs, Koha::Patron->update_password should not have logged' );
175 subtest 'is_expired' => sub {
177 my $patron = $builder->build({ source => 'Borrower' });
178 $patron = Koha::Patrons->find( $patron->{borrowernumber} );
179 $patron->dateexpiry( undef )->store->discard_changes;
180 is( $patron->is_expired, 0, 'Patron should not be considered expired if dateexpiry is not set');
181 $patron->dateexpiry( '0000-00-00' )->store->discard_changes;
182 is( $patron->is_expired, 0, 'Patron should not be considered expired if dateexpiry is not 0000-00-00');
183 $patron->dateexpiry( dt_from_string )->store->discard_changes;
184 is( $patron->is_expired, 0, 'Patron should not be considered expired if dateexpiry is today');
185 $patron->dateexpiry( dt_from_string->add( days => 1 ) )->store->discard_changes;
186 is( $patron->is_expired, 0, 'Patron should not be considered expired if dateexpiry is tomorrow');
187 $patron->dateexpiry( dt_from_string->add( days => -1 ) )->store->discard_changes;
188 is( $patron->is_expired, 1, 'Patron should be considered expired if dateexpiry is yesterday');
193 subtest 'is_going_to_expired' => sub {
195 my $patron = $builder->build({ source => 'Borrower' });
196 $patron = Koha::Patrons->find( $patron->{borrowernumber} );
197 $patron->dateexpiry( undef )->store->discard_changes;
198 is( $patron->is_going_to_expired, 0, 'Patron should not be considered going to expire if dateexpiry is not set');
199 $patron->dateexpiry( '0000-00-00' )->store->discard_changes;
200 is( $patron->is_going_to_expired, 0, 'Patron should not be considered going to expire if dateexpiry is not 0000-00-00');
201 $patron->dateexpiry( dt_from_string )->store->discard_changes;
202 is( $patron->is_going_to_expired, 0, 'Patron should not be considered going to expire if dateexpiry is today');
204 t::lib::Mocks::mock_preference('NotifyBorrowerDeparture', 0);
205 $patron->dateexpiry( dt_from_string )->store->discard_changes;
206 is( $patron->is_going_to_expired, 0, 'Patron should not be considered going to expire if dateexpiry is today and pref is 0');
208 t::lib::Mocks::mock_preference('NotifyBorrowerDeparture', 10);
209 $patron->dateexpiry( dt_from_string->add( days => 11 ) )->store->discard_changes;
210 is( $patron->is_going_to_expired, 0, 'Patron should not be considered going to expire if dateexpiry is 11 days ahead and pref is 10');
212 t::lib::Mocks::mock_preference('NotifyBorrowerDeparture', 0);
213 $patron->dateexpiry( dt_from_string->add( days => 10 ) )->store->discard_changes;
214 is( $patron->is_going_to_expired, 0, 'Patron should not be considered going to expire if dateexpiry is 10 days ahead and pref is 0');
216 t::lib::Mocks::mock_preference('NotifyBorrowerDeparture', 10);
217 $patron->dateexpiry( dt_from_string->add( days => 10 ) )->store->discard_changes;
218 is( $patron->is_going_to_expired, 0, 'Patron should not be considered going to expire if dateexpiry is 10 days ahead and pref is 10');
221 t::lib::Mocks::mock_preference('NotifyBorrowerDeparture', 10);
222 $patron->dateexpiry( dt_from_string->add( days => 20 ) )->store->discard_changes;
223 is( $patron->is_going_to_expired, 0, 'Patron should not be considered going to expire if dateexpiry is 20 days ahead and pref is 10');
225 t::lib::Mocks::mock_preference('NotifyBorrowerDeparture', 20);
226 $patron->dateexpiry( dt_from_string->add( days => 10 ) )->store->discard_changes;
227 is( $patron->is_going_to_expired, 1, 'Patron should be considered going to expire if dateexpiry is 10 days ahead and pref is 20');
233 subtest 'renew_account' => sub {
235 my $a_month_ago = dt_from_string->add( months => -1 )->truncate( to => 'day' );
236 my $a_year_later = dt_from_string->add( months => 12 )->truncate( to => 'day' );
237 my $a_year_later_minus_a_month = dt_from_string->add( months => 11 )->truncate( to => 'day' );
238 my $a_month_later = dt_from_string->add( months => 1 )->truncate( to => 'day' );
239 my $a_year_later_plus_a_month = dt_from_string->add( months => 13 )->truncate( to => 'day' );
240 my $patron_category = $builder->build(
241 { source => 'Category',
243 enrolmentperiod => 12,
244 enrolmentperioddate => undef,
248 my $patron = $builder->build(
249 { source => 'Borrower',
251 dateexpiry => $a_month_ago,
252 categorycode => $patron_category->{categorycode},
256 my $patron_2 = $builder->build(
257 { source => 'Borrower',
259 dateexpiry => $a_month_ago,
260 categorycode => $patron_category->{categorycode},
264 my $patron_3 = $builder->build(
265 { source => 'Borrower',
267 dateexpiry => $a_month_later,
268 categorycode => $patron_category->{categorycode},
272 my $retrieved_patron = Koha::Patrons->find( $patron->{borrowernumber} );
273 my $retrieved_patron_2 = Koha::Patrons->find( $patron_2->{borrowernumber} );
274 my $retrieved_patron_3 = Koha::Patrons->find( $patron_3->{borrowernumber} );
276 t::lib::Mocks::mock_preference( 'BorrowerRenewalPeriodBase', 'dateexpiry' );
277 t::lib::Mocks::mock_preference( 'BorrowersLog', 1 );
278 my $expiry_date = $retrieved_patron->renew_account;
279 is( $expiry_date, $a_year_later_minus_a_month, );
280 my $retrieved_expiry_date = Koha::Patrons->find( $patron->{borrowernumber} )->dateexpiry;
281 is( dt_from_string($retrieved_expiry_date), $a_year_later_minus_a_month );
282 my $number_of_logs = $schema->resultset('ActionLog')->search( { module => 'MEMBERS', action => 'RENEW', object => $retrieved_patron->borrowernumber } )->count;
283 is( $number_of_logs, 1, 'With BorrowerLogs, Koha::Patron->renew_account should have logged' );
285 t::lib::Mocks::mock_preference( 'BorrowerRenewalPeriodBase', 'now' );
286 t::lib::Mocks::mock_preference( 'BorrowersLog', 0 );
287 $expiry_date = $retrieved_patron->renew_account;
288 is( $expiry_date, $a_year_later, );
289 $retrieved_expiry_date = Koha::Patrons->find( $patron->{borrowernumber} )->dateexpiry;
290 is( dt_from_string($retrieved_expiry_date), $a_year_later );
291 $number_of_logs = $schema->resultset('ActionLog')->search( { module => 'MEMBERS', action => 'RENEW', object => $retrieved_patron->borrowernumber } )->count;
292 is( $number_of_logs, 1, 'Without BorrowerLogs, Koha::Patron->renew_account should not have logged' );
294 t::lib::Mocks::mock_preference( 'BorrowerRenewalPeriodBase', 'combination' );
295 $expiry_date = $retrieved_patron_2->renew_account;
296 is( $expiry_date, $a_year_later );
297 $retrieved_expiry_date = Koha::Patrons->find( $patron_2->{borrowernumber} )->dateexpiry;
298 is( dt_from_string($retrieved_expiry_date), $a_year_later );
300 $expiry_date = $retrieved_patron_3->renew_account;
301 is( $expiry_date, $a_year_later_plus_a_month );
302 $retrieved_expiry_date = Koha::Patrons->find( $patron_3->{borrowernumber} )->dateexpiry;
303 is( dt_from_string($retrieved_expiry_date), $a_year_later_plus_a_month );
305 $retrieved_patron->delete;
306 $retrieved_patron_2->delete;
307 $retrieved_patron_3->delete;
310 subtest "move_to_deleted" => sub {
312 my $patron = $builder->build( { source => 'Borrower' } );
313 my $retrieved_patron = Koha::Patrons->find( $patron->{borrowernumber} );
314 is( ref( $retrieved_patron->move_to_deleted ), 'Koha::Schema::Result::Deletedborrower', 'Koha::Patron->move_to_deleted should return the Deleted patron' )
315 ; # FIXME This should be Koha::Deleted::Patron
316 my $deleted_patron = $schema->resultset('Deletedborrower')
317 ->search( { borrowernumber => $patron->{borrowernumber} }, { result_class => 'DBIx::Class::ResultClass::HashRefInflator' } )
319 is_deeply( $deleted_patron, $patron, 'Koha::Patron->move_to_deleted should have correctly moved the patron to the deleted table' );
320 $retrieved_patron->delete( $patron->{borrowernumber} ); # Cleanup
323 subtest "delete" => sub {
325 t::lib::Mocks::mock_preference( 'BorrowersLog', 1 );
326 my $patron = $builder->build( { source => 'Borrower' } );
327 my $retrieved_patron = Koha::Patrons->find( $patron->{borrowernumber} );
328 my $hold = $builder->build(
329 { source => 'Reserve',
330 value => { borrowernumber => $patron->{borrowernumber} }
333 my $list = $builder->build(
334 { source => 'Virtualshelve',
335 value => { owner => $patron->{borrowernumber} }
339 my $deleted = $retrieved_patron->delete;
340 is( $deleted, 1, 'Koha::Patron->delete should return 1 if the patron has been correctly deleted' );
342 is( Koha::Patrons->find( $patron->{borrowernumber} ), undef, 'Koha::Patron->delete should have deleted the patron' );
344 is( Koha::Holds->search( { borrowernumber => $patron->{borrowernumber} } )->count, 0, q|Koha::Patron->delete should have deleted patron's holds| );
346 is( Koha::Virtualshelves->search( { owner => $patron->{borrowernumber} } )->count, 0, q|Koha::Patron->delete should have deleted patron's lists| );
348 my $number_of_logs = $schema->resultset('ActionLog')->search( { module => 'MEMBERS', action => 'DELETE', object => $retrieved_patron->borrowernumber } )->count;
349 is( $number_of_logs, 1, 'With BorrowerLogs, Koha::Patron->delete should have logged' );
352 subtest 'add_enrolment_fee_if_needed' => sub {
355 my $enrolmentfee_K = 5;
356 my $enrolmentfee_J = 10;
357 my $enrolmentfee_YA = 20;
359 my $dbh = C4::Context->dbh;
360 $dbh->do(q|UPDATE categories set enrolmentfee=? where categorycode=?|, undef, $enrolmentfee_K, 'K');
361 $dbh->do(q|UPDATE categories set enrolmentfee=? where categorycode=?|, undef, $enrolmentfee_J, 'J');
362 $dbh->do(q|UPDATE categories set enrolmentfee=? where categorycode=?|, undef, $enrolmentfee_YA, 'YA');
364 my %borrower_data = (
365 firstname => 'my firstname',
366 surname => 'my surname',
368 branchcode => $library->{branchcode},
371 my $borrowernumber = C4::Members::AddMember(%borrower_data);
372 $borrower_data{borrowernumber} = $borrowernumber;
374 my ($total) = C4::Members::GetMemberAccountRecords($borrowernumber);
375 is( $total, $enrolmentfee_K, "New kid pay $enrolmentfee_K" );
377 t::lib::Mocks::mock_preference( 'FeeOnChangePatronCategory', 0 );
378 $borrower_data{categorycode} = 'J';
379 C4::Members::ModMember(%borrower_data);
380 ($total) = C4::Members::GetMemberAccountRecords($borrowernumber);
381 is( $total, $enrolmentfee_K, "Kid growing and become a juvenile, but shouldn't pay for the upgrade " );
383 $borrower_data{categorycode} = 'K';
384 C4::Members::ModMember(%borrower_data);
385 t::lib::Mocks::mock_preference( 'FeeOnChangePatronCategory', 1 );
387 $borrower_data{categorycode} = 'J';
388 C4::Members::ModMember(%borrower_data);
389 ($total) = C4::Members::GetMemberAccountRecords($borrowernumber);
390 is( $total, $enrolmentfee_K + $enrolmentfee_J, "Kid growing and become a juvenile, he should pay " . ( $enrolmentfee_K + $enrolmentfee_J ) );
392 # Check with calling directly Koha::Patron->get_enrolment_fee_if_needed
393 my $patron = Koha::Patrons->find($borrowernumber);
394 $patron->categorycode('YA')->store;
395 my $fee = $patron->add_enrolment_fee_if_needed;
396 ($total) = C4::Members::GetMemberAccountRecords($borrowernumber);
398 $enrolmentfee_K + $enrolmentfee_J + $enrolmentfee_YA,
399 "Juvenile growing and become an young adult, he should pay " . ( $enrolmentfee_K + $enrolmentfee_J + $enrolmentfee_YA )
405 $retrieved_patron_1->delete;
406 is( Koha::Patrons->search->count, $nb_of_patrons + 1, 'Delete should have deleted the patron' );
408 $schema->storage->txn_rollback;