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 => 11;
  23 use Test::Warn;
  24
  25 use C4::Members;
  26
  27 use Koha::Holds;
  28 use Koha::Patron;
  29 use Koha::Patrons;
  30 use Koha::Database;
  31 use Koha::DateUtils;
  32 use Koha::Virtualshelves;
  33
  34 use t::lib::TestBuilder;
  35 use t::lib::Mocks;
  36
  37 my $schema = Koha::Database->new->schema;
  38 $schema->storage->txn_begin;
  39
  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',
  51     }
  52 )->store;
  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',
  60     }
  61 )->store;
  62
  63 C4::Context->_new_userenv('xxx');
  64 C4::Context->set_userenv(0,0,0,'firstname','surname', $library->{branchcode}, 'Midway Public Library', '', '', '');
  65
  66 is( Koha::Patrons->search->count, $nb_of_patrons + 2, 'The 2 patrons should have been added' );
  67
  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' );
  70
  71 subtest 'guarantees' => sub {
  72     plan tests => 8;
  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' );
  79
  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 }});
  82
  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;
  90 };
  91
  92 subtest 'siblings' => sub {
  93     plan tests => 7;
  94     my $siblings = $new_patron_1->siblings;
  95     is( $siblings, undef, 'Koha::Patron->siblings should not crashed if the patron has no guarantor' );
  96     my $guarantee_1 = $builder->build( { source => 'Borrower', value => { guarantorid => $new_patron_1->borrowernumber } } );
  97     my $retrieved_guarantee_1 = Koha::Patrons->find($guarantee_1);
  98     $siblings = $retrieved_guarantee_1->siblings;
  99     is( ref($siblings), 'Koha::Patrons', 'Koha::Patron->siblings should return a Koha::Patrons result set in a scalar context' );
 100     my @siblings = $retrieved_guarantee_1->siblings;
 101     is( ref( \@siblings ), 'ARRAY', 'Koha::Patron->siblings should return an array in a list context' );
 102     is( $siblings->count,  0,       'guarantee_1 should not have siblings yet' );
 103     my $guarantee_2 = $builder->build( { source => 'Borrower', value => { guarantorid => $new_patron_1->borrowernumber } } );
 104     my $guarantee_3 = $builder->build( { source => 'Borrower', value => { guarantorid => $new_patron_1->borrowernumber } } );
 105     $siblings = $retrieved_guarantee_1->siblings;
 106     is( $siblings->count,               2,                               'guarantee_1 should have 2 siblings' );
 107     is( $guarantee_2->{borrowernumber}, $siblings->next->borrowernumber, 'guarantee_2 should exist in the guarantees' );
 108     is( $guarantee_3->{borrowernumber}, $siblings->next->borrowernumber, 'guarantee_3 should exist in the guarantees' );
 109     $_->delete for $retrieved_guarantee_1->siblings;
 110     $retrieved_guarantee_1->delete;
 111 };
 112
 113 subtest 'has_overdues' => sub {
 114     plan tests => 3;
 115
 116     my $biblioitem_1 = $builder->build( { source => 'Biblioitem' } );
 117     my $item_1 = $builder->build(
 118         {   source => 'Item',
 119             value  => {
 120                 homebranch    => $library->{branchcode},
 121                 holdingbranch => $library->{branchcode},
 122                 notforloan    => 0,
 123                 itemlost      => 0,
 124                 withdrawn     => 0,
 125                 biblionumber  => $biblioitem_1->{biblionumber}
 126             }
 127         }
 128     );
 129     my $retrieved_patron = Koha::Patrons->find( $new_patron_1->borrowernumber );
 130     is( $retrieved_patron->has_overdues, 0, );
 131
 132     my $tomorrow = DateTime->today( time_zone => C4::Context->tz() )->add( days => 1 );
 133     my $issue = Koha::Issue->new({ borrowernumber => $new_patron_1->id, itemnumber => $item_1->{itemnumber}, date_due => $tomorrow, branchcode => $library->{branchcode} })->store();
 134     is( $retrieved_patron->has_overdues, 0, );
 135     $issue->delete();
 136     my $yesterday = DateTime->today(time_zone => C4::Context->tz())->add( days => -1 );
 137     $issue = Koha::Issue->new({ borrowernumber => $new_patron_1->id, itemnumber => $item_1->{itemnumber}, date_due => $yesterday, branchcode => $library->{branchcode} })->store();
 138     $retrieved_patron = Koha::Patrons->find( $new_patron_1->borrowernumber );
 139     is( $retrieved_patron->has_overdues, 1, );
 140     $issue->delete();
 141 };
 142
 143 subtest 'update_password' => sub {
 144     plan tests => 7;
 145
 146     t::lib::Mocks::mock_preference( 'BorrowersLog', 1 );
 147     my $original_userid   = $new_patron_1->userid;
 148     my $original_password = $new_patron_1->password;
 149     warning_like { $retrieved_patron_1->update_password( $new_patron_2->userid, 'another_password' ) }
 150     qr{Duplicate entry},
 151       'Koha::Patron->update_password should warn if the userid is already used by another patron';
 152     is( Koha::Patrons->find( $new_patron_1->borrowernumber )->userid,   $original_userid,   'Koha::Patron->update_password should not have updated the userid' );
 153     is( Koha::Patrons->find( $new_patron_1->borrowernumber )->password, $original_password, 'Koha::Patron->update_password should not have updated the userid' );
 154
 155     $retrieved_patron_1->update_password( 'another_nonexistent_userid_1', 'another_password' );
 156     is( Koha::Patrons->find( $new_patron_1->borrowernumber )->userid,   'another_nonexistent_userid_1', 'Koha::Patron->update_password should have updated the userid' );
 157     is( Koha::Patrons->find( $new_patron_1->borrowernumber )->password, 'another_password',             'Koha::Patron->update_password should have updated the password' );
 158
 159     my $number_of_logs = $schema->resultset('ActionLog')->search( { module => 'MEMBERS', action => 'CHANGE PASS', object => $new_patron_1->borrowernumber } )->count;
 160     is( $number_of_logs, 1, 'With BorrowerLogs, Koha::Patron->update_password should have logged' );
 161
 162     t::lib::Mocks::mock_preference( 'BorrowersLog', 0 );
 163     $retrieved_patron_1->update_password( 'yet_another_nonexistent_userid_1', 'another_password' );
 164     $number_of_logs = $schema->resultset('ActionLog')->search( { module => 'MEMBERS', action => 'CHANGE PASS', object => $new_patron_1->borrowernumber } )->count;
 165     is( $number_of_logs, 1, 'With BorrowerLogs, Koha::Patron->update_password should not have logged' );
 166 };
 167
 168 subtest 'renew_account' => sub {
 169     plan tests => 6;
 170     my $a_month_ago                = dt_from_string->add( months => -1 )->truncate( to => 'day' );
 171     my $a_year_later               = dt_from_string->add( months => 12 )->truncate( to => 'day' );
 172     my $a_year_later_minus_a_month = dt_from_string->add( months => 11 )->truncate( to => 'day' );
 173     my $patron_category = $builder->build(
 174         {   source => 'Category',
 175             value  => {
 176                 enrolmentperiod     => 12,
 177                 enrolmentperioddate => undef,
 178             }
 179         }
 180     );
 181     my $patron = $builder->build(
 182         {   source => 'Borrower',
 183             value  => {
 184                 dateexpiry   => $a_month_ago,
 185                 categorycode => $patron_category->{categorycode},
 186             }
 187         }
 188     );
 189     my $retrieved_patron = Koha::Patrons->find( $patron->{borrowernumber} );
 190
 191     t::lib::Mocks::mock_preference( 'BorrowerRenewalPeriodBase', 'dateexpiry' );
 192     t::lib::Mocks::mock_preference( 'BorrowersLog',              1 );
 193     my $expiry_date = $retrieved_patron->renew_account;
 194     is( $expiry_date, $a_year_later_minus_a_month, );
 195     my $retrieved_expiry_date = Koha::Patrons->find( $patron->{borrowernumber} )->dateexpiry;
 196     is( dt_from_string($retrieved_expiry_date), $a_year_later_minus_a_month );
 197     my $number_of_logs = $schema->resultset('ActionLog')->search( { module => 'MEMBERS', action => 'RENEW', object => $retrieved_patron->borrowernumber } )->count;
 198     is( $number_of_logs, 1, 'With BorrowerLogs, Koha::Patron->renew_account should have logged' );
 199
 200     t::lib::Mocks::mock_preference( 'BorrowerRenewalPeriodBase', 'now' );
 201     t::lib::Mocks::mock_preference( 'BorrowersLog',              0 );
 202     $expiry_date = $retrieved_patron->renew_account;
 203     is( $expiry_date, $a_year_later, );
 204     $retrieved_expiry_date = Koha::Patrons->find( $patron->{borrowernumber} )->dateexpiry;
 205     is( dt_from_string($retrieved_expiry_date), $a_year_later );
 206     $number_of_logs = $schema->resultset('ActionLog')->search( { module => 'MEMBERS', action => 'RENEW', object => $retrieved_patron->borrowernumber } )->count;
 207     is( $number_of_logs, 1, 'Without BorrowerLogs, Koha::Patron->renew_account should not have logged' );
 208
 209     $retrieved_patron->delete;
 210 };
 211
 212 subtest "move_to_deleted" => sub {
 213     plan tests => 2;
 214     my $patron = $builder->build( { source => 'Borrower' } );
 215     my $retrieved_patron = Koha::Patrons->find( $patron->{borrowernumber} );
 216     is( ref( $retrieved_patron->move_to_deleted ), 'Koha::Schema::Result::Deletedborrower', 'Koha::Patron->move_to_deleted should return the Deleted patron' )
 217       ;    # FIXME This should be Koha::Deleted::Patron
 218     my $deleted_patron = $schema->resultset('Deletedborrower')
 219         ->search( { borrowernumber => $patron->{borrowernumber} }, { result_class => 'DBIx::Class::ResultClass::HashRefInflator' } )
 220         ->next;
 221     is_deeply( $deleted_patron, $patron, 'Koha::Patron->move_to_deleted should have correctly moved the patron to the deleted table' );
 222     $retrieved_patron->delete( $patron->{borrowernumber} );    # Cleanup
 223 };
 224
 225 subtest "delete" => sub {
 226     plan tests => 5;
 227     t::lib::Mocks::mock_preference( 'BorrowersLog', 1 );
 228     my $patron           = $builder->build( { source => 'Borrower' } );
 229     my $retrieved_patron = Koha::Patrons->find( $patron->{borrowernumber} );
 230     my $hold             = $builder->build(
 231         {   source => 'Reserve',
 232             value  => { borrowernumber => $patron->{borrowernumber} }
 233         }
 234     );
 235     my $list = $builder->build(
 236         {   source => 'Virtualshelve',
 237             value  => { owner => $patron->{borrowernumber} }
 238         }
 239     );
 240
 241     my $deleted = $retrieved_patron->delete;
 242     is( $deleted, 1, 'Koha::Patron->delete should return 1 if the patron has been correctly deleted' );
 243
 244     is( Koha::Patrons->find( $patron->{borrowernumber} ), undef, 'Koha::Patron->delete should have deleted the patron' );
 245
 246     is( Koha::Holds->search( { borrowernumber => $patron->{borrowernumber} } )->count, 0, q|Koha::Patron->delete should have deleted patron's holds| );
 247
 248     is( Koha::Virtualshelves->search( { owner => $patron->{borrowernumber} } )->count, 0, q|Koha::Patron->delete should have deleted patron's lists| );
 249
 250     my $number_of_logs = $schema->resultset('ActionLog')->search( { module => 'MEMBERS', action => 'DELETE', object => $retrieved_patron->borrowernumber } )->count;
 251     is( $number_of_logs, 1, 'With BorrowerLogs, Koha::Patron->delete should have logged' );
 252 };
 253
 254 subtest 'add_enrolment_fee_if_needed' => sub {
 255     plan tests => 4;
 256
 257     my $enrolmentfee_K  = 5;
 258     my $enrolmentfee_J  = 10;
 259     my $enrolmentfee_YA = 20;
 260
 261     my $dbh = C4::Context->dbh;
 262     $dbh->do(q|UPDATE categories set enrolmentfee=? where categorycode=?|, undef, $enrolmentfee_K, 'K');
 263     $dbh->do(q|UPDATE categories set enrolmentfee=? where categorycode=?|, undef, $enrolmentfee_J, 'J');
 264     $dbh->do(q|UPDATE categories set enrolmentfee=? where categorycode=?|, undef, $enrolmentfee_YA, 'YA');
 265
 266     my %borrower_data = (
 267         firstname    => 'my firstname',
 268         surname      => 'my surname',
 269         categorycode => 'K',
 270         branchcode   => $library->{branchcode},
 271     );
 272
 273     my $borrowernumber = C4::Members::AddMember(%borrower_data);
 274     $borrower_data{borrowernumber} = $borrowernumber;
 275
 276     my ($total) = C4::Members::GetMemberAccountRecords($borrowernumber);
 277     is( $total, $enrolmentfee_K, "New kid pay $enrolmentfee_K" );
 278
 279     t::lib::Mocks::mock_preference( 'FeeOnChangePatronCategory', 0 );
 280     $borrower_data{categorycode} = 'J';
 281     C4::Members::ModMember(%borrower_data);
 282     ($total) = C4::Members::GetMemberAccountRecords($borrowernumber);
 283     is( $total, $enrolmentfee_K, "Kid growing and become a juvenile, but shouldn't pay for the upgrade " );
 284
 285     $borrower_data{categorycode} = 'K';
 286     C4::Members::ModMember(%borrower_data);
 287     t::lib::Mocks::mock_preference( 'FeeOnChangePatronCategory', 1 );
 288
 289     $borrower_data{categorycode} = 'J';
 290     C4::Members::ModMember(%borrower_data);
 291     ($total) = C4::Members::GetMemberAccountRecords($borrowernumber);
 292     is( $total, $enrolmentfee_K + $enrolmentfee_J, "Kid growing and become a juvenile, he should pay " . ( $enrolmentfee_K + $enrolmentfee_J ) );
 293
 294     # Check with calling directly Koha::Patron->get_enrolment_fee_if_needed
 295     my $patron = Koha::Patrons->find($borrowernumber);
 296     $patron->categorycode('YA')->store;
 297     my $fee = $patron->add_enrolment_fee_if_needed;
 298     ($total) = C4::Members::GetMemberAccountRecords($borrowernumber);
 299     is( $total,
 300         $enrolmentfee_K + $enrolmentfee_J + $enrolmentfee_YA,
 301         "Juvenile growing and become an young adult, he should pay " . ( $enrolmentfee_K + $enrolmentfee_J + $enrolmentfee_YA )
 302     );
 303
 304     $patron->delete;
 305 };
 306
 307 $retrieved_patron_1->delete;
 308 is( Koha::Patrons->search->count, $nb_of_patrons + 1, 'Delete should have deleted the patron' );
 309
 310 $schema->storage->txn_rollback;
 311
 312 1;