Bug 11577: Unit 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 => 56;
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 my $INDEPENDENT_BRANCHES_PREF = 'IndependentBranches';
51
52 # XXX make a non-commit transaction and rollback rather than insert/delete
53
54 #my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress, $branchprinter)= @_;
55 my @USERENV = (
56     1,
57     'test',
58     'MASTERTEST',
59     'Test',
60     'Test',
61     't',
62     'Test',
63     0,
64 );
65 my $BRANCH_IDX = 5;
66
67 C4::Context->_new_userenv ('DUMMY_SESSION_ID');
68 C4::Context::set_userenv ( @USERENV );
69
70 my $userenv = C4::Context->userenv
71   or BAIL_OUT("No userenv");
72
73 # Make a borrower for testing
74 my %data = (
75     cardnumber => $CARDNUMBER,
76     firstname =>  $FIRSTNAME,
77     surname => $SURNAME,
78     categorycode => $CATEGORYCODE,
79     branchcode => $BRANCHCODE,
80     dateofbirth => '',
81     dateexpiry => '9999-12-31',
82     userid => 'tomasito'
83 );
84
85 my $addmem=AddMember(%data);
86 ok($addmem, "AddMember()");
87
88 my $member=GetMemberDetails("",$CARDNUMBER)
89   or BAIL_OUT("Cannot read member with card $CARDNUMBER");
90
91 ok ( $member->{firstname}    eq $FIRSTNAME    &&
92      $member->{surname}      eq $SURNAME      &&
93      $member->{categorycode} eq $CATEGORYCODE &&
94      $member->{branchcode}   eq $BRANCHCODE
95      , "Got member")
96   or diag("Mismatching member details: ".Dumper(\%data, $member));
97
98 is($member->{dateofbirth}, undef, "Empty dates handled correctly");
99
100 $member->{firstname} = $CHANGED_FIRSTNAME;
101 $member->{email}     = $EMAIL;
102 $member->{ethnicity} = $ETHNICITY;
103 $member->{phone}     = $PHONE;
104 $member->{emailpro}  = $EMAILPRO;
105 ModMember(%$member);
106 my $changedmember=GetMemberDetails("",$CARDNUMBER);
107 ok ( $changedmember->{firstname} eq $CHANGED_FIRSTNAME &&
108      $changedmember->{email}     eq $EMAIL             &&
109      $changedmember->{ethnicity} eq $ETHNICITY         &&
110      $changedmember->{phone}     eq $PHONE             &&
111      $changedmember->{emailpro}  eq $EMAILPRO
112      , "Member Changed")
113   or diag("Mismatching member details: ".Dumper($member, $changedmember));
114
115 C4::Context->set_preference( $INDEPENDENT_BRANCHES_PREF, '0' );
116 C4::Context->clear_syspref_cache();
117
118 my $results = Search($CARDNUMBER);
119 ok (@$results == 1, "Search cardnumber returned only one result")
120   or diag("Multiple members with Card $CARDNUMBER: ".Dumper($results));
121 ok (_find_member($results), "Search cardnumber")
122   or diag("Card $CARDNUMBER not found in the resultset: ".Dumper($results));
123
124 my @searchstring=($SURNAME);
125 $results = Search(\@searchstring);
126 ok (_find_member($results), "Search (arrayref)")
127   or diag("Card $CARDNUMBER not found in the resultset: ".Dumper($results));
128
129 $results = Search(\@searchstring,undef,undef,undef,["surname"]);
130 ok (_find_member($results), "Surname Search (arrayref)")
131   or diag("Card $CARDNUMBER not found in the resultset: ".Dumper($results));
132
133 $results = Search("$CHANGED_FIRSTNAME $SURNAME", "surname");
134 ok (_find_member($results), "Full name  Search (string)")
135   or diag("Card $CARDNUMBER not found in the resultset: ".Dumper($results));
136
137 @searchstring=($PHONE);
138 $results = Search(\@searchstring,undef,undef,undef,["phone"]);
139 ok (_find_member($results), "Phone Search (arrayref)")
140   or diag("Card $CARDNUMBER not found in the resultset: ".Dumper($results));
141
142 $results = Search($PHONE,undef,undef,undef,["phone"]);
143 ok (_find_member($results), "Phone Search (string)")
144   or diag("Card $CARDNUMBER not found in the resultset: ".Dumper($results));
145
146 C4::Context->set_preference( $INDEPENDENT_BRANCHES_PREF, '1' );
147 C4::Context->clear_syspref_cache();
148
149 $results = Search("$CHANGED_FIRSTNAME $SURNAME", "surname");
150 ok (!_find_member($results), "Full name  Search (string) for independent branches, different branch")
151   or diag("Card $CARDNUMBER found in the resultset for independent branches: ".Dumper(C4::Context->preference($INDEPENDENT_BRANCHES_PREF), $results));
152
153 @searchstring=($SURNAME);
154 $results = Search(\@searchstring);
155 ok (!_find_member($results), "Search (arrayref) for independent branches, different branch")
156   or diag("Card $CARDNUMBER found in the resultset for independent branches: ".Dumper(C4::Context->preference($INDEPENDENT_BRANCHES_PREF), $results));
157
158 $USERENV[$BRANCH_IDX] = $BRANCHCODE;
159 C4::Context::set_userenv ( @USERENV );
160
161 $results = Search("$CHANGED_FIRSTNAME $SURNAME", "surname");
162 ok (_find_member($results), "Full name  Search (string) for independent branches, same branch")
163   or diag("Card $CARDNUMBER not found in the resultset for independent branches: ".Dumper(C4::Context->preference($INDEPENDENT_BRANCHES_PREF), $results));
164
165 @searchstring=($SURNAME);
166 $results = Search(\@searchstring);
167 ok (_find_member($results), "Search (arrayref) for independent branches, same branch")
168   or diag("Card $CARDNUMBER not found in the resultset for independent branches: ".Dumper(C4::Context->preference($INDEPENDENT_BRANCHES_PREF), $results));
169
170 C4::Context->set_preference( 'CardnumberLength', '' );
171 C4::Context->clear_syspref_cache();
172
173 my $checkcardnum=C4::Members::checkcardnumber($CARDNUMBER, "");
174 is ($checkcardnum, "1", "Card No. in use");
175
176 $checkcardnum=C4::Members::checkcardnumber($IMPOSSIBLE_CARDNUMBER, "");
177 is ($checkcardnum, "0", "Card No. not used");
178
179 C4::Context->set_preference( 'CardnumberLength', '4' );
180 C4::Context->clear_syspref_cache();
181
182 $checkcardnum=C4::Members::checkcardnumber($IMPOSSIBLE_CARDNUMBER, "");
183 is ($checkcardnum, "2", "Card number is too long");
184
185 my $age=GetAge("1992-08-14", "2011-01-19");
186 is ($age, "18", "Age correct");
187
188 $age=GetAge("2011-01-19", "1992-01-19");
189 is ($age, "-19", "Birthday In the Future");
190
191 C4::Context->set_preference( 'AutoEmailPrimaryAddress', 'OFF' );
192 C4::Context->clear_syspref_cache();
193
194 my $notice_email = GetNoticeEmailAddress($member->{'borrowernumber'});
195 is ($notice_email, $EMAIL, "GetNoticeEmailAddress returns correct value when AutoEmailPrimaryAddress is off");
196
197 C4::Context->set_preference( 'AutoEmailPrimaryAddress', 'emailpro' );
198 C4::Context->clear_syspref_cache();
199
200 $notice_email = GetNoticeEmailAddress($member->{'borrowernumber'});
201 is ($notice_email, $EMAILPRO, "GetNoticeEmailAddress returns correct value when AutoEmailPrimaryAddress is emailpro");
202
203 ok(!$member->{is_expired}, "GetMemberDetails() indicates that patron is not expired");
204 ModMember(borrowernumber => $member->{'borrowernumber'}, dateexpiry => '2001-01-1');
205 $member = GetMemberDetails($member->{'borrowernumber'});
206 ok($member->{is_expired}, "GetMemberDetails() indicates that patron is expired");
207
208
209 my $message_type = 'B';
210 my $message = 'my message';
211 my $messages_count = GetMessagesCount($member->{borrowernumber}, $message_type, $BRANCHCODE);
212 is( $messages_count, 0, 'GetMessagesCount returns the number of messages correclty' );
213
214 is( AddMessage(), undef, 'AddMessage without argument returns undef' );
215 is( AddMessage(undef, $message_type, $message, $BRANCHCODE), undef,  'AddMessage without the borrower number returns undef' );
216 is( AddMessage($member->{borrowernumber}, undef, $message, $BRANCHCODE), undef,  'AddMessage without the message type returns undef' );
217 is( AddMessage($member->{borrowernumber}, $message_type, undef, $BRANCHCODE), undef,  'AddMessage without the message returns undef' );
218 is( AddMessage($member->{borrowernumber}, $message_type, $message, undef), undef,  'AddMessage without the branch code returns undef' );
219 is( AddMessage($member->{borrowernumber}, $message_type, $message, $BRANCHCODE), 1,  'AddMessage functions correctly' );
220
221 $messages_count = GetMessagesCount();
222 is( $messages_count, 0, 'GetMessagesCount without argument returns 0' );
223 $messages_count = GetMessagesCount(undef, $message_type, $BRANCHCODE);
224 is( $messages_count, '0', 'GetMessagesCount without the borrower number returns the number of messages' );
225 $messages_count = GetMessagesCount($member->{borrowernumber}, undef, $BRANCHCODE);
226 is( $messages_count, '1', 'GetMessagesCount without the message type returns the total number of messages' );
227 $messages_count = GetMessagesCount($member->{borrowernumber}, $message_type, undef);
228 is( $messages_count, '1', 'GetMessagesCount without the branchcode returns the total number of messages' );
229 $messages_count = GetMessagesCount($member->{borrowernumber}, $message_type, $BRANCHCODE);
230 is( $messages_count, '1', 'GetMessagesCount returns the number of messages correctly' );
231
232 my $messages = GetMessages();
233 is( @$messages, 0, 'GetMessages without argument returns 0' );
234 $messages = GetMessages($member->{borrowernumber}, $message_type, $BRANCHCODE);
235 is( @$messages, 1, 'GetMessages returns the correct number of messages' );
236 is( $messages->[0]->{borrowernumber}, $member->{borrowernumber}, 'GetMessages returns the borrower number correctly' );
237 is( $messages->[0]->{message_type}, $message_type, 'GetMessages returns the message type correclty' );
238 is( $messages->[0]->{message}, $message, 'GetMessages returns the message correctly' );
239 is( $messages->[0]->{branchcode}, $BRANCHCODE, 'GetMessages returns the branch code correctly' );
240
241 $messages_count = GetMessagesCount($member->{borrowernumber}, $message_type, $BRANCHCODE);
242 is( $messages_count, 1, 'GetMessagesCount returns the number of messages correclty' );
243
244 DeleteMessage();
245 $messages = GetMessages($member->{borrowernumber}, $message_type, $BRANCHCODE);
246 is( @$messages, 1, 'DeleteMessage without message id does not delete messages' );
247 DeleteMessage($messages->[0]->{message_id});
248 $messages = GetMessages($member->{borrowernumber}, $message_type, $BRANCHCODE);
249 is( @$messages, 0, 'DeleteMessage deletes a message correctly' );
250
251
252 # clean up 
253 DelMember($member->{borrowernumber});
254 $results = Search($CARDNUMBER,undef,undef,undef,["cardnumber"]);
255 ok (!_find_member($results), "Delete member")
256   or diag("Card $CARDNUMBER found for the deleted member in the resultset: ".Dumper($results));
257
258 # Check_Userid tests
259 %data = (
260     cardnumber   => "123456789",
261     firstname    => "Tomasito",
262     surname      => "None",
263     categorycode => "S",
264     branchcode   => "MPL",
265     dateofbirth  => '',
266     dateexpiry   => '9999-12-31',
267     userid       => 'tomasito'
268 );
269 # Add a new borrower
270 my $borrowernumber = AddMember( %data );
271 is( Check_Userid( 'tomasito', $borrowernumber ), 1,
272     'recently created userid -> unique (borrowernumber passed)' );
273 is( Check_Userid( 'tomasitoxxx', $borrowernumber ), 1,
274     'non-existent userid -> unique (borrowernumber passed)' );
275 is( Check_Userid( 'tomasito', '' ), 0,
276     'userid exists (blank borrowernumber)' );
277 is( Check_Userid( 'tomasitoxxx', '' ), 1,
278     'non-existent userid -> unique (blank borrowernumber)' );
279
280 # Add a new borrower with the same userid but different cardnumber
281 $data{ cardnumber } = "987654321";
282 my $new_borrowernumber = AddMember( %data );
283 is( Check_Userid( 'tomasito', '' ), 0,
284     'userid not unique (blank borrowernumber)' );
285 is( Check_Userid( 'tomasito', $borrowernumber ), 0,
286     'userid not unique (first borrowernumber passed)' );
287 is( Check_Userid( 'tomasito', $new_borrowernumber ), 0,
288     'userid not unique (second borrowernumber passed)' );
289
290 # Regression tests for BZ12226
291 is( Check_Userid( C4::Context->config('user'), '' ), 0,
292     'Check_Userid should return 0 for the DB user (Bug 12226)');
293
294 subtest 'GetMemberAccountBalance' => sub {
295
296     plan tests => 6;
297
298     my $members_mock = new Test::MockModule('C4::Members');
299     $members_mock->mock( 'GetMemberAccountRecords', sub {
300         my @accountlines = (
301             { amountoutstanding => '7', accounttype => 'Rent' },
302             { amountoutstanding => '5', accounttype => 'Res' },
303             { amountoutstanding => '3', accounttype => 'Pay' } );
304         return ( 15, \@accountlines );
305     });
306
307     # do not count holds charges
308     C4::Context->set_preference( 'HoldsInNoissuesCharge', '1' );
309     C4::Context->set_preference( 'ManInvInNoissuesCharge', '0' );
310     my ($total, $total_minus_charges,
311         $other_charges) = C4::Members::GetMemberAccountBalance(123);
312     is( $total, 15 , "Total calculated correctly");
313     is( $total_minus_charges, 15, "Holds charges are not count if HoldsInNoissuesCharge=1");
314     is( $other_charges, 0, "Holds charges are not considered if HoldsInNoissuesCharge=1");
315
316     C4::Context->set_preference( 'HoldsInNoissuesCharge', '0' );
317     ($total, $total_minus_charges,
318         $other_charges) = C4::Members::GetMemberAccountBalance(123);
319     is( $total, 15 , "Total calculated correctly");
320     is( $total_minus_charges, 10, "Holds charges are count if HoldsInNoissuesCharge=0");
321     is( $other_charges, 5, "Holds charges are considered if HoldsInNoissuesCharge=1");
322
323     $dbh->rollback();
324 };
325
326 sub _find_member {
327     my ($resultset) = @_;
328     my $found = $resultset && grep( { $_->{cardnumber} && $_->{cardnumber} eq $CARDNUMBER } @$resultset );
329     return $found;
330 }
331
332 1;