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