t/db_dependent/Members.t

   1 #!/usr/bin/perl
   2
   3 # This file is part of Koha.
   4 #
   5 # Koha is free software; you can redistribute it and/or modify it
   6 # under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # Koha is distributed in the hope that it will be useful, but
  11 # WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  17
  18 use Modern::Perl;
  19
  20 use Test::More tests => 74;
  21 use Test::MockModule;
  22 use Data::Dumper;
  23 use C4::Context;
  24
  25 BEGIN {
  26         use_ok('C4::Members');
  27 }
  28
  29 my $dbh = C4::Context->dbh;
  30
  31 # Start transaction
  32 $dbh->{AutoCommit} = 0;
  33 $dbh->{RaiseError} = 1;
  34
  35 my $CARDNUMBER   = 'TESTCARD01';
  36 my $FIRSTNAME    = 'Marie';
  37 my $SURNAME      = 'Mcknight';
  38 my $CATEGORYCODE = 'S';
  39 my $BRANCHCODE   = 'CPL';
  40
  41 my $CHANGED_FIRSTNAME = "Marry Ann";
  42 my $EMAIL             = "Marie\@email.com";
  43 my $EMAILPRO          = "Marie\@work.com";
  44 my $ETHNICITY         = "German";
  45 my $PHONE             = "555-12123";
  46
  47 # XXX should be randomised and checked against the database
  48 my $IMPOSSIBLE_CARDNUMBER = "XYZZZ999";
  49
  50 # XXX make a non-commit transaction and rollback rather than insert/delete
  51
  52 #my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress, $branchprinter)= @_;
  53 my @USERENV = (
  54     1,
  55     'test',
  56     'MASTERTEST',
  57     'Test',
  58     'Test',
  59     't',
  60     'Test',
  61     0,
  62 );
  63 my $BRANCH_IDX = 5;
  64
  65 C4::Context->_new_userenv ('DUMMY_SESSION_ID');
  66 C4::Context->set_userenv ( @USERENV );
  67
  68 my $userenv = C4::Context->userenv
  69   or BAIL_OUT("No userenv");
  70
  71 # Make a borrower for testing
  72 my %data = (
  73     cardnumber => $CARDNUMBER,
  74     firstname =>  $FIRSTNAME,
  75     surname => $SURNAME,
  76     categorycode => $CATEGORYCODE,
  77     branchcode => $BRANCHCODE,
  78     dateofbirth => '',
  79     dateexpiry => '9999-12-31',
  80     userid => 'tomasito'
  81 );
  82
  83 testAgeAccessors(\%data); #Age accessor tests don't touch the db so it is safe to run them with just the object.
  84
  85 my $addmem=AddMember(%data);
  86 ok($addmem, "AddMember()");
  87
  88 # It's not really a Move, it's a Copy.
  89 my $result = MoveMemberToDeleted($addmem);
  90 ok($result,"MoveMemberToDeleted()");
  91
  92 my $sth = $dbh->prepare("SELECT * from borrowers WHERE borrowernumber=?");
  93 $sth->execute($addmem);
  94 my $MemberAdded = $sth->fetchrow_hashref;
  95
  96 $sth = $dbh->prepare("SELECT * from deletedborrowers WHERE borrowernumber=?");
  97 $sth->execute($addmem);
  98 my $MemberMoved = $sth->fetchrow_hashref;
  99
 100 is_deeply($MemberMoved,$MemberAdded,"Confirm MoveMemberToDeleted.");
 101
 102 my $member=GetMemberDetails("",$CARDNUMBER)
 103   or BAIL_OUT("Cannot read member with card $CARDNUMBER");
 104
 105 ok ( $member->{firstname}    eq $FIRSTNAME    &&
 106      $member->{surname}      eq $SURNAME      &&
 107      $member->{categorycode} eq $CATEGORYCODE &&
 108      $member->{branchcode}   eq $BRANCHCODE
 109      , "Got member")
 110   or diag("Mismatching member details: ".Dumper(\%data, $member));
 111
 112 is($member->{dateofbirth}, undef, "Empty dates handled correctly");
 113
 114 $member->{firstname} = $CHANGED_FIRSTNAME;
 115 $member->{email}     = $EMAIL;
 116 $member->{ethnicity} = $ETHNICITY;
 117 $member->{phone}     = $PHONE;
 118 $member->{emailpro}  = $EMAILPRO;
 119 ModMember(%$member);
 120 my $changedmember=GetMemberDetails("",$CARDNUMBER);
 121 ok ( $changedmember->{firstname} eq $CHANGED_FIRSTNAME &&
 122      $changedmember->{email}     eq $EMAIL             &&
 123      $changedmember->{ethnicity} eq $ETHNICITY         &&
 124      $changedmember->{phone}     eq $PHONE             &&
 125      $changedmember->{emailpro}  eq $EMAILPRO
 126      , "Member Changed")
 127   or diag("Mismatching member details: ".Dumper($member, $changedmember));
 128
 129 C4::Context->set_preference( 'CardnumberLength', '' );
 130 C4::Context->clear_syspref_cache();
 131
 132 my $checkcardnum=C4::Members::checkcardnumber($CARDNUMBER, "");
 133 is ($checkcardnum, "1", "Card No. in use");
 134
 135 $checkcardnum=C4::Members::checkcardnumber($IMPOSSIBLE_CARDNUMBER, "");
 136 is ($checkcardnum, "0", "Card No. not used");
 137
 138 C4::Context->set_preference( 'CardnumberLength', '4' );
 139 C4::Context->clear_syspref_cache();
 140
 141 $checkcardnum=C4::Members::checkcardnumber($IMPOSSIBLE_CARDNUMBER, "");
 142 is ($checkcardnum, "2", "Card number is too long");
 143
 144
 145
 146 C4::Context->set_preference( 'AutoEmailPrimaryAddress', 'OFF' );
 147 C4::Context->clear_syspref_cache();
 148
 149 my $notice_email = GetNoticeEmailAddress($member->{'borrowernumber'});
 150 is ($notice_email, $EMAIL, "GetNoticeEmailAddress returns correct value when AutoEmailPrimaryAddress is off");
 151
 152 C4::Context->set_preference( 'AutoEmailPrimaryAddress', 'emailpro' );
 153 C4::Context->clear_syspref_cache();
 154
 155 $notice_email = GetNoticeEmailAddress($member->{'borrowernumber'});
 156 is ($notice_email, $EMAILPRO, "GetNoticeEmailAddress returns correct value when AutoEmailPrimaryAddress is emailpro");
 157
 158 ok(!$member->{is_expired}, "GetMemberDetails() indicates that patron is not expired");
 159 ModMember(borrowernumber => $member->{'borrowernumber'}, dateexpiry => '2001-01-1');
 160 $member = GetMemberDetails($member->{'borrowernumber'});
 161 ok($member->{is_expired}, "GetMemberDetails() indicates that patron is expired");
 162
 163
 164 my $message_type = 'B';
 165 my $message = 'my message';
 166 my $messages_count = GetMessagesCount($member->{borrowernumber}, $message_type, $BRANCHCODE);
 167 is( $messages_count, 0, 'GetMessagesCount returns the number of messages correclty' );
 168
 169 is( AddMessage(), undef, 'AddMessage without argument returns undef' );
 170 is( AddMessage(undef, $message_type, $message, $BRANCHCODE), undef,  'AddMessage without the borrower number returns undef' );
 171 is( AddMessage($member->{borrowernumber}, undef, $message, $BRANCHCODE), undef,  'AddMessage without the message type returns undef' );
 172 is( AddMessage($member->{borrowernumber}, $message_type, undef, $BRANCHCODE), undef,  'AddMessage without the message returns undef' );
 173 is( AddMessage($member->{borrowernumber}, $message_type, $message, undef), undef,  'AddMessage without the branch code returns undef' );
 174 is( AddMessage($member->{borrowernumber}, $message_type, $message, $BRANCHCODE), 1,  'AddMessage functions correctly' );
 175
 176 $messages_count = GetMessagesCount();
 177 is( $messages_count, 0, 'GetMessagesCount without argument returns 0' );
 178 $messages_count = GetMessagesCount(undef, $message_type, $BRANCHCODE);
 179 is( $messages_count, '0', 'GetMessagesCount without the borrower number returns the number of messages' );
 180 $messages_count = GetMessagesCount($member->{borrowernumber}, undef, $BRANCHCODE);
 181 is( $messages_count, '1', 'GetMessagesCount without the message type returns the total number of messages' );
 182 $messages_count = GetMessagesCount($member->{borrowernumber}, $message_type, undef);
 183 is( $messages_count, '1', 'GetMessagesCount without the branchcode returns the total number of messages' );
 184 $messages_count = GetMessagesCount($member->{borrowernumber}, $message_type, $BRANCHCODE);
 185 is( $messages_count, '1', 'GetMessagesCount returns the number of messages correctly' );
 186
 187 my $messages = GetMessages();
 188 is( @$messages, 0, 'GetMessages without argument returns 0' );
 189 $messages = GetMessages($member->{borrowernumber}, $message_type, $BRANCHCODE);
 190 is( @$messages, 1, 'GetMessages returns the correct number of messages' );
 191 is( $messages->[0]->{borrowernumber}, $member->{borrowernumber}, 'GetMessages returns the borrower number correctly' );
 192 is( $messages->[0]->{message_type}, $message_type, 'GetMessages returns the message type correclty' );
 193 is( $messages->[0]->{message}, $message, 'GetMessages returns the message correctly' );
 194 is( $messages->[0]->{branchcode}, $BRANCHCODE, 'GetMessages returns the branch code correctly' );
 195
 196 $messages_count = GetMessagesCount($member->{borrowernumber}, $message_type, $BRANCHCODE);
 197 is( $messages_count, 1, 'GetMessagesCount returns the number of messages correclty' );
 198
 199 DeleteMessage();
 200 $messages = GetMessages($member->{borrowernumber}, $message_type, $BRANCHCODE);
 201 is( @$messages, 1, 'DeleteMessage without message id does not delete messages' );
 202 DeleteMessage($messages->[0]->{message_id});
 203 $messages = GetMessages($member->{borrowernumber}, $message_type, $BRANCHCODE);
 204 is( @$messages, 0, 'DeleteMessage deletes a message correctly' );
 205
 206
 207 # clean up
 208 DelMember($member->{borrowernumber});
 209 my $borrower = GetMember( cardnumber => $CARDNUMBER );
 210 is( $borrower, undef, 'DelMember should remove the patron' );
 211
 212 # Check_Userid tests
 213 %data = (
 214     cardnumber   => "123456789",
 215     firstname    => "Tomasito",
 216     surname      => "None",
 217     categorycode => "S",
 218     branchcode   => "MPL",
 219     dateofbirth  => '',
 220     debarred     => '',
 221     dateexpiry   => '',
 222     dateenrolled => '',
 223 );
 224 # Add a new borrower
 225 my $borrowernumber = AddMember( %data );
 226 is( Check_Userid( 'tomasito.non', $borrowernumber ), 1,
 227     'recently created userid -> unique (borrowernumber passed)' );
 228 is( Check_Userid( 'tomasitoxxx', $borrowernumber ), 1,
 229     'non-existent userid -> unique (borrowernumber passed)' );
 230 is( Check_Userid( 'tomasito.none', '' ), 0,
 231     'userid exists (blank borrowernumber)' );
 232 is( Check_Userid( 'tomasitoxxx', '' ), 1,
 233     'non-existent userid -> unique (blank borrowernumber)' );
 234
 235 $borrower = GetMember( borrowernumber => $borrowernumber );
 236 is( $borrower->{dateofbirth}, undef, 'AddMember should undef dateofbirth if empty string is given');
 237 is( $borrower->{debarred}, undef, 'AddMember should undef debarred if empty string is given');
 238 isnt( $borrower->{dateexpiry}, '0000-00-00', 'AddMember should not set dateexpiry to 0000-00-00 if empty string is given');
 239 isnt( $borrower->{dateenrolled}, '0000-00-00', 'AddMember should not set dateenrolled to 0000-00-00 if empty string is given');
 240
 241 ModMember( borrowernumber => $borrowernumber, dateofbirth => '', debarred => '', dateexpiry => '', dateenrolled => '' );
 242 $borrower = GetMember( borrowernumber => $borrowernumber );
 243 is( $borrower->{dateofbirth}, undef, 'ModMember should undef dateofbirth if empty string is given');
 244 is( $borrower->{debarred}, undef, 'ModMember should undef debarred if empty string is given');
 245 isnt( $borrower->{dateexpiry}, '0000-00-00', 'ModMember should not set dateexpiry to 0000-00-00 if empty string is given');
 246 isnt( $borrower->{dateenrolled}, '0000-00-00', 'ModMember should not set dateenrolled to 0000-00-00 if empty string is given');
 247
 248 ModMember( borrowernumber => $borrowernumber, dateofbirth => '1970-01-01', debarred => '2042-01-01', dateexpiry => '9999-12-31', dateenrolled => '2015-09-06' );
 249 $borrower = GetMember( borrowernumber => $borrowernumber );
 250 is( $borrower->{dateofbirth}, '1970-01-01', 'ModMember should correctly set dateofbirth if a valid date is given');
 251 is( $borrower->{debarred}, '2042-01-01', 'ModMember should correctly set debarred if a valid date is given');
 252 is( $borrower->{dateexpiry}, '9999-12-31', 'ModMember should correctly set dateexpiry if a valid date is given');
 253 is( $borrower->{dateenrolled}, '2015-09-06', 'ModMember should correctly set dateenrolled if a valid date is given');
 254
 255 # Add a new borrower with the same userid but different cardnumber
 256 $data{ cardnumber } = "987654321";
 257 my $new_borrowernumber = AddMember( %data );
 258 is( Check_Userid( 'tomasito.none', '' ), 0,
 259     'userid not unique (blank borrowernumber)' );
 260 is( Check_Userid( 'tomasito.none', $new_borrowernumber ), 0,
 261     'userid not unique (second borrowernumber passed)' );
 262 $borrower = GetMember( borrowernumber => $new_borrowernumber );
 263 ok( $borrower->{userid} ne 'tomasito', "Borrower with duplicate userid has new userid generated" );
 264
 265 $data{ cardnumber } = "234567890";
 266 $data{userid} = 'a_user_id';
 267 $borrowernumber = AddMember( %data );
 268 $borrower = GetMember( borrowernumber => $borrowernumber );
 269 is( $borrower->{userid}, $data{userid}, 'AddMember should insert the given userid' );
 270
 271 # Regression tests for BZ13502
 272 ## Remove all entries with userid='' (should be only 1 max)
 273 $dbh->do(q|DELETE FROM borrowers WHERE userid = ''|);
 274 ## And create a patron with a userid=''
 275 $borrowernumber = AddMember( categorycode => 'S', branchcode => 'MPL' );
 276 $dbh->do(q|UPDATE borrowers SET userid = '' WHERE borrowernumber = ?|, undef, $borrowernumber);
 277 # Create another patron and verify the userid has been generated
 278 $borrowernumber = AddMember( categorycode => 'S', branchcode => 'MPL' );
 279 ok( $borrowernumber > 0, 'AddMember should have inserted the patron even if no userid is given' );
 280 $borrower = GetMember( borrowernumber => $borrowernumber );
 281 ok( $borrower->{userid},  'A userid should have been generated correctly' );
 282
 283 # Regression tests for BZ12226
 284 is( Check_Userid( C4::Context->config('user'), '' ), 0,
 285     'Check_Userid should return 0 for the DB user (Bug 12226)');
 286
 287 subtest 'GetMemberAccountBalance' => sub {
 288
 289     plan tests => 10;
 290
 291     my $members_mock = new Test::MockModule('C4::Members');
 292     $members_mock->mock( 'GetMemberAccountRecords', sub {
 293         my ($borrowernumber) = @_;
 294         if ($borrowernumber) {
 295             my @accountlines = (
 296             { amountoutstanding => '7', accounttype => 'Rent' },
 297             { amountoutstanding => '5', accounttype => 'Res' },
 298             { amountoutstanding => '3', accounttype => 'Pay' } );
 299             return ( 15, \@accountlines );
 300         }
 301         else {
 302             my @accountlines;
 303             return ( 0, \@accountlines );
 304         }
 305     });
 306
 307     my $person = GetMemberDetails(undef,undef);
 308     ok( !$person , 'Expected no member details from undef,undef' );
 309     $person = GetMemberDetails(undef,'987654321');
 310     is( $person->{amountoutstanding}, 15,
 311         'Expected 15 outstanding for cardnumber.');
 312     $borrowernumber = $person->{borrowernumber};
 313     $person = GetMemberDetails($borrowernumber,undef);
 314     is( $person->{amountoutstanding}, 15,
 315         'Expected 15 outstanding for borrowernumber.');
 316     $person = GetMemberDetails($borrowernumber,'987654321');
 317     is( $person->{amountoutstanding}, 15,
 318         'Expected 15 outstanding for both borrowernumber and cardnumber.');
 319
 320     # do not count holds charges
 321     C4::Context->set_preference( 'HoldsInNoissuesCharge', '1' );
 322     C4::Context->set_preference( 'ManInvInNoissuesCharge', '0' );
 323     my ($total, $total_minus_charges,
 324         $other_charges) = C4::Members::GetMemberAccountBalance(123);
 325     is( $total, 15 , "Total calculated correctly");
 326     is( $total_minus_charges, 15, "Holds charges are not count if HoldsInNoissuesCharge=1");
 327     is( $other_charges, 0, "Holds charges are not considered if HoldsInNoissuesCharge=1");
 328
 329     C4::Context->set_preference( 'HoldsInNoissuesCharge', '0' );
 330     ($total, $total_minus_charges,
 331         $other_charges) = C4::Members::GetMemberAccountBalance(123);
 332     is( $total, 15 , "Total calculated correctly");
 333     is( $total_minus_charges, 10, "Holds charges are count if HoldsInNoissuesCharge=0");
 334     is( $other_charges, 5, "Holds charges are considered if HoldsInNoissuesCharge=1");
 335
 336     $dbh->rollback();
 337 };
 338
 339 subtest 'purgeSelfRegistration' => sub {
 340     plan tests => 2;
 341
 342     #purge unverified
 343     my $d=360;
 344     C4::Members::DeleteUnverifiedOpacRegistrations($d);
 345     foreach(1..3) {
 346         $dbh->do("INSERT INTO borrower_modifications (timestamp, borrowernumber, verification_token) VALUES ('2014-01-01 01:02:03',0,?)", undef, (scalar localtime)."_$_");
 347     }
 348     is( C4::Members::DeleteUnverifiedOpacRegistrations($d), 3, 'Test for DeleteUnverifiedOpacRegistrations' );
 349
 350     #purge members in temporary category
 351     my $c= 'XYZ';
 352     $dbh->do("INSERT IGNORE INTO categories (categorycode) VALUES ('$c')");
 353     C4::Context->set_preference('PatronSelfRegistrationDefaultCategory', $c );
 354     C4::Context->set_preference('PatronSelfRegistrationExpireTemporaryAccountsDelay', 360);
 355     C4::Members::DeleteExpiredOpacRegistrations();
 356     $dbh->do("INSERT INTO borrowers (surname, address, city, branchcode, categorycode, dateenrolled) VALUES ('Testaabbcc', 'Street 1', 'CITY', 'CPL', '$c', '2014-01-01 01:02:03')");
 357     is( C4::Members::DeleteExpiredOpacRegistrations(), 1, 'Test for DeleteExpiredOpacRegistrations');
 358     $dbh->rollback();
 359 };
 360
 361 sub _find_member {
 362     my ($resultset) = @_;
 363     my $found = $resultset && grep( { $_->{cardnumber} && $_->{cardnumber} eq $CARDNUMBER } @$resultset );
 364     return $found;
 365 }
 366
 367 ### ------------------------------------- ###
 368 ### Testing GetAge() / SetAge() functions ###
 369 ### ------------------------------------- ###
 370 #USES the package $member-variable to mock a koha.borrowers-object
 371 sub testAgeAccessors {
 372     my ($member) = @_;
 373     my $original_dateofbirth = $member->{dateofbirth};
 374
 375     ##Testing GetAge()
 376     my $age=GetAge("1992-08-14", "2011-01-19");
 377     is ($age, "18", "Age correct");
 378
 379     $age=GetAge("2011-01-19", "1992-01-19");
 380     is ($age, "-19", "Birthday In the Future");
 381
 382     ##Testing SetAge() for now()
 383     my $dt_now = DateTime->now();
 384     $age = DateTime::Duration->new(years => 12, months => 6, days => 1);
 385     C4::Members::SetAge( $member, $age );
 386     $age = C4::Members::GetAge( $member->{dateofbirth} );
 387     is ($age, '12', "SetAge 12 years");
 388
 389     $age = DateTime::Duration->new(years => 18, months => 12, days => 31);
 390     C4::Members::SetAge( $member, $age );
 391     $age = C4::Members::GetAge( $member->{dateofbirth} );
 392     is ($age, '19', "SetAge 18+1 years"); #This is a special case, where months=>12 and days=>31 constitute one full year, hence we get age 19 instead of 18.
 393
 394     $age = DateTime::Duration->new(years => 18, months => 12, days => 30);
 395     C4::Members::SetAge( $member, $age );
 396     $age = C4::Members::GetAge( $member->{dateofbirth} );
 397     is ($age, '19', "SetAge 18 years");
 398
 399     $age = DateTime::Duration->new(years => 0, months => 1, days => 1);
 400     C4::Members::SetAge( $member, $age );
 401     $age = C4::Members::GetAge( $member->{dateofbirth} );
 402     is ($age, '0', "SetAge 0 years");
 403
 404     $age = '0018-12-31';
 405     C4::Members::SetAge( $member, $age );
 406     $age = C4::Members::GetAge( $member->{dateofbirth} );
 407     is ($age, '19', "SetAge ISO_Date 18+1 years"); #This is a special case, where months=>12 and days=>31 constitute one full year, hence we get age 19 instead of 18.
 408
 409     $age = '0018-12-30';
 410     C4::Members::SetAge( $member, $age );
 411     $age = C4::Members::GetAge( $member->{dateofbirth} );
 412     is ($age, '19', "SetAge ISO_Date 18 years");
 413
 414     $age = '18-1-1';
 415     eval { C4::Members::SetAge( $member, $age ); };
 416     is ((length $@ > 1), '1', "SetAge ISO_Date $age years FAILS");
 417
 418     $age = '0018-01-01';
 419     eval { C4::Members::SetAge( $member, $age ); };
 420     is ((length $@ == 0), '1', "SetAge ISO_Date $age years succeeds");
 421
 422     ##Testing SetAge() for relative_date
 423     my $relative_date = DateTime->new(year => 3010, month => 3, day => 15);
 424
 425     $age = DateTime::Duration->new(years => 10, months => 3);
 426     C4::Members::SetAge( $member, $age, $relative_date );
 427     $age = C4::Members::GetAge( $member->{dateofbirth}, $relative_date->ymd() );
 428     is ($age, '10', "SetAge, 10 years and 3 months old person was born on ".$member->{dateofbirth}." if todays is ".$relative_date->ymd());
 429
 430     $age = DateTime::Duration->new(years => 112, months => 1, days => 1);
 431     C4::Members::SetAge( $member, $age, $relative_date );
 432     $age = C4::Members::GetAge( $member->{dateofbirth}, $relative_date->ymd() );
 433     is ($age, '112', "SetAge, 112 years, 1 months and 1 days old person was born on ".$member->{dateofbirth}." if today is ".$relative_date->ymd());
 434
 435     $age = '0112-01-01';
 436     C4::Members::SetAge( $member, $age, $relative_date );
 437     $age = C4::Members::GetAge( $member->{dateofbirth}, $relative_date->ymd() );
 438     is ($age, '112', "SetAge ISO_Date, 112 years, 1 months and 1 days old person was born on ".$member->{dateofbirth}." if today is ".$relative_date->ymd());
 439
 440     $member->{dateofbirth} = $original_dateofbirth; #It is polite to revert made changes in the unit tests.
 441 } #sub testAgeAccessors
 442
 443 1;