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