3 # Copyright 2015 Koha Development team
5 # This file is part of Koha
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.
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.
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>.
21 use Test::More tests => 174;
24 use Encode qw( encode_utf8 );
27 # To be replaced by t::lib::Mock
30 use Koha::Patron::Relationships;
32 use File::Temp qw(tempfile tempdir);
33 my $temp_dir = tempdir('Koha_patrons_import_test_XXXX', CLEANUP => 1, TMPDIR => 1);
36 use t::lib::TestBuilder;
37 my $builder = t::lib::TestBuilder->new;
39 my $schema = Koha::Database->new->schema;
40 $schema->storage->txn_begin;
42 # ########## Tests start here #############################
43 # Given ... we can use the module
44 BEGIN { use_ok('Koha::Patrons::Import'); }
46 my $patrons_import = new_ok('Koha::Patrons::Import');
48 subtest 'test_methods' => sub {
51 # Given ... we can reach the method(s)
52 my @methods = ('import_patrons',
53 'set_attribute_types',
56 'generate_patron_attributes',
60 can_ok('Koha::Patrons::Import', @methods);
63 subtest 'test_attributes' => sub {
66 my @attributes = ('today_iso', 'text_csv');
67 can_ok('Koha::Patrons::Import', @attributes);
70 # Tests for Koha::Patrons::Import::import_patrons()
71 # Given ... nothing much. When ... Then ...
73 warning_is { $result = $patrons_import->import_patrons(undef) }
74 { carped => 'No file handle passed in!' },
75 " Koha::Patrons::Import->import_patrons carps if no file handle is passed";
76 is($result, undef, 'Got the expected undef from import_patrons with nothing much');
78 # Given ... some params but no file handle.
79 my $params_0 = { some_stuff => 'random stuff', };
83 warning_is { $result_0 = $patrons_import->import_patrons($params_0) }
84 { carped => 'No file handle passed in!' },
85 " Koha::Patrons::Import->import_patrons carps if no file handle is passed";
86 is($result_0, undef, 'Got the expected undef from import_patrons with no file handle');
88 # Given ... a file handle to file with headers only.
89 t::lib::Mocks::mock_preference('ExtendedPatronAttributes', 0);
90 t::lib::Mocks::mock_preference('dateformat', 'us');
92 my $csv_headers = 'cardnumber,surname,firstname,title,othernames,initials,streetnumber,streettype,address,address2,city,state,zipcode,country,email,phone,mobile,fax,dateofbirth,branchcode,categorycode,dateenrolled,dateexpiry,userid,password';
93 my $res_header = 'cardnumber, surname, firstname, title, othernames, initials, streetnumber, streettype, address, address2, city, state, zipcode, country, email, phone, mobile, fax, dateofbirth, branchcode, categorycode, dateenrolled, dateexpiry, userid, password';
94 my $csv_one_line = '1000,Nancy,Jenkins,Dr,,NJ,78,Circle,Bunting,El Paso,Henderson,Texas,79984,United States,ajenkins0@sourceforge.net,7-(388)559-6763,3-(373)151-4471,8-(509)286-4001,10/16/1965,CPL,PT,12/28/2014,07/01/2015,jjenkins0,DPQILy';
95 my $csv_one_line_a = '1001,Nancy,Jenkins,Dr,,NJ,78,Circle,Bunting,El Paso,Henderson,Texas,79984,United States,ajenkins0@sourceforge.net,7-(388)559-6763,3-(373)151-4471,8-(509)286-4001,10/16/1965,CPL,PT,12/28/2014,07/01/2015,jjenkins0,DPQILy';
96 my $csv_one_line_b = '1000,Nancy2,Jenkins2,Dr,,NJ,78,Circle,Bunting,El Paso,Henderson,Texas,79984,United States,ajenkins0@sourceforge.net,7-(388)559-6763,3-(373)151-4471,8-(509)286-4001,10/16/1965,CPL,PT,12/28/2014,07/01/2015,jjenkins0,DPQILy';
98 my $filename_1 = make_csv($temp_dir, $csv_headers, $csv_one_line);
99 open(my $handle_1, "<", $filename_1) or die "cannot open < $filename_1: $!";
100 my $params_1 = { file => $handle_1, };
103 my $result_1 = $patrons_import->import_patrons($params_1);
106 is($result_1->{already_in_db}, 0, 'Got the expected 0 already_in_db from import_patrons with no matchpoint defined');
107 is(scalar @{$result_1->{errors}}, 0, 'Got the expected 0 size error array from import_patrons with no matchpoint defined');
109 is($result_1->{feedback}->[0]->{feedback}, 1, 'Got the expected 1 feedback from import_patrons with no matchpoint defined');
110 is($result_1->{feedback}->[0]->{name}, 'headerrow', 'Got the expected header row name from import_patrons with no matchpoint defined');
111 is($result_1->{feedback}->[0]->{value}, $res_header, 'Got the expected header row value from import_patrons with no matchpoint defined');
113 is($result_1->{feedback}->[1]->{feedback}, 1, 'Got the expected second feedback from import_patrons with no matchpoint defined');
114 is($result_1->{feedback}->[1]->{name}, 'lastimported', 'Got the expected last imported name from import_patrons with no matchpoint defined');
115 like($result_1->{feedback}->[1]->{value}, qr/^Nancy \/ \d+/, 'Got the expected second header row value from import_patrons with no matchpoint defined');
117 is($result_1->{imported}, 1, 'Got the expected 1 imported result from import_patrons with no matchpoint defined');
118 is($result_1->{invalid}, 0, 'Got the expected 0 invalid result from import_patrons with no matchpoint defined');
119 is($result_1->{overwritten}, 0, 'Got the expected 0 overwritten result from import_patrons with no matchpoint defined');
121 # Given ... a valid file handle, a bad matchpoint resulting in invalid card number
122 my $filename_2 = make_csv($temp_dir, $csv_headers, $csv_one_line);
123 open(my $handle_2, "<", $filename_2) or die "cannot open < $filename_2: $!";
124 my $params_2 = { file => $handle_2, matchpoint => 'SHOW_BCODE', };
127 my $result_2 = $patrons_import->import_patrons($params_2);
130 is($result_2->{already_in_db}, 0, 'Got the expected 0 already_in_db from import_patrons with invalid card number');
131 is($result_2->{errors}->[0]->{borrowernumber}, undef, 'Got the expected undef borrower number from import patrons with invalid card number');
132 is($result_2->{errors}->[0]->{cardnumber}, 1000, 'Got the expected 1000 card number from import patrons with invalid card number');
133 is($result_2->{errors}->[0]->{invalid_cardnumber}, 1, 'Got the expected invalid card number from import patrons with invalid card number');
135 is($result_2->{feedback}->[0]->{feedback}, 1, 'Got the expected 1 feedback from import_patrons with invalid card number');
136 is($result_2->{feedback}->[0]->{name}, 'headerrow', 'Got the expected header row name from import_patrons with invalid card number');
137 is($result_2->{feedback}->[0]->{value}, $res_header, 'Got the expected header row value from import_patrons with invalid card number');
139 is($result_2->{imported}, 0, 'Got the expected 0 imported result from import_patrons with invalid card number');
140 is($result_2->{invalid}, 1, 'Got the expected 1 invalid result from import_patrons with invalid card number');
141 is($result_2->{overwritten}, 0, 'Got the expected 0 overwritten result from import_patrons with invalid card number');
143 # Given ... valid file handle, good matchpoint that matches should not overwrite when not set.
144 my $filename_3 = make_csv($temp_dir, $csv_headers, $csv_one_line);
145 open(my $handle_3, "<", $filename_3) or die "cannot open < $filename_3: $!";
146 my $params_3 = { file => $handle_3, matchpoint => 'cardnumber', };
149 my $result_3 = $patrons_import->import_patrons($params_3);
152 is($result_3->{already_in_db}, 1, 'Got the expected 1 already_in_db from import_patrons with duplicate userid');
153 is($result_3->{errors}->[0]->{duplicate_userid}, undef, 'No duplicate userid error from import patrons with duplicate userid (it is our own)');
154 is($result_3->{errors}->[0]->{userid}, undef, 'No duplicate userid error from import patrons with duplicate userid (it is our own)');
156 is($result_3->{feedback}->[0]->{feedback}, 1, 'Got 1 expected feedback from import_patrons that matched but not overwritten');
157 is($result_3->{feedback}->[0]->{name}, 'headerrow', 'Got the expected header row name from import_patrons with duplicate userid');
158 is($result_3->{feedback}->[0]->{value}, $res_header, 'Got the expected header row value from import_patrons with duplicate userid');
160 is($result_3->{imported}, 0, 'Got the expected 0 imported result from import_patrons');
161 is($result_3->{invalid}, 0, 'Got the expected 0 invalid result from import_patrons');
162 is($result_3->{overwritten}, 0, 'Got the expected 0 overwritten result from import_patrons that matched');
164 # Given ... valid file handle, good matchpoint that matches should overwrite when set.
165 my $filename_3a = make_csv($temp_dir, $csv_headers, $csv_one_line);
166 open(my $handle_3a, "<", $filename_3a) or die "cannot open < $filename_3: $!";
167 my $params_3a = { file => $handle_3a, matchpoint => 'cardnumber', overwrite_cardnumber => 1};
171 warning_is { $result_3a = $patrons_import->import_patrons($params_3a) }
173 "No warning raised by import_patrons";
176 is($result_3a->{already_in_db}, 0, 'Got the expected 0 already_in_db from import_patrons when matched and overwrite set');
177 is($result_3a->{errors}->[0]->{duplicate_userid}, undef, 'No duplicate userid error from import patrons with duplicate userid (it is our own)');
178 is($result_3a->{errors}->[0]->{userid}, undef, 'No duplicate userid error from import patrons with duplicate userid (it is our own)');
180 is($result_3a->{feedback}->[0]->{feedback}, 1, 'Got 1 expected feedback from import_patrons that matched and overwritten');
181 is($result_3a->{feedback}->[0]->{name}, 'headerrow', 'Got the expected header row name from import_patrons with duplicate userid');
182 is($result_3a->{feedback}->[0]->{value}, $res_header, 'Got the expected header row value from import_patrons with duplicate userid');
184 is($result_3a->{imported}, 0, 'Got the expected 0 imported result from import_patrons');
185 is($result_3a->{invalid}, 0, 'Got the expected 0 invalid result from import_patrons');
186 is($result_3a->{overwritten}, 1, 'Got the expected 1 overwritten result from import_patrons that matched');
188 # Given ... valid file handle, good matchpoint that matches should overwrite when set, surname is protected from
189 # overwrite but firstname is not
190 my $filename_3c = make_csv($temp_dir, $csv_headers, $csv_one_line_b);
191 open(my $handle_3c, "<", $filename_3c) or die "cannot open < $filename_3: $!";
192 my $params_3c = { file => $handle_3c, matchpoint => 'cardnumber', overwrite_cardnumber => 1, preserve_fields => [ 'firstname' ] };
196 warning_is { $result_3c = $patrons_import->import_patrons($params_3c) }
198 "No warning raised by import_patrons";
201 is($result_3c->{already_in_db}, 0, 'Got the expected 0 already_in_db from import_patrons when matched and overwrite set');
202 is($result_3c->{errors}->[0]->{duplicate_userid}, undef, 'No duplicate userid error from import patrons with duplicate userid (it is our own)');
203 is($result_3c->{errors}->[0]->{userid}, undef, 'No duplicate userid error from import patrons with duplicate userid (it is our own)');
205 is($result_3c->{feedback}->[0]->{feedback}, 1, 'Got 1 expected feedback from import_patrons that matched and overwritten');
206 is($result_3c->{feedback}->[0]->{name}, 'headerrow', 'Got the expected header row name from import_patrons with duplicate userid');
207 is($result_3c->{feedback}->[0]->{value}, $res_header, 'Got the expected header row value from import_patrons with duplicate userid');
209 is($result_3c->{imported}, 0, 'Got the expected 0 imported result from import_patrons');
210 is($result_3c->{invalid}, 0, 'Got the expected 0 invalid result from import_patrons');
211 is($result_3c->{overwritten}, 1, 'Got the expected 1 overwritten result from import_patrons that matched');
213 my $patron_3c = Koha::Patrons->find({ cardnumber => '1000' });
214 is( $patron_3c->surname, "Nancy2", "Surname field is preserved from original" );
215 is( $patron_3c->firstname, "Jenkins", "Firstname field is overwritten" );
217 # Given ... valid file handle, good matchpoint that does not match and conflicting userid.
218 my $filename_3b = make_csv($temp_dir, $csv_headers, $csv_one_line_a);
219 open(my $handle_3b, "<", $filename_3b) or die "cannot open < $filename_3: $!";
220 my $params_3b = { file => $handle_3b, matchpoint => 'cardnumber', };
223 my $result_3b = $patrons_import->import_patrons($params_3b);
226 is($result_3b->{already_in_db}, 0, 'Got the expected 0 already_in_db from import_patrons with duplicate userid');
227 is($result_3b->{errors}->[0]->{duplicate_userid}, 1, 'Got the expected duplicate userid error from import patrons with duplicate userid');
228 is($result_3b->{errors}->[0]->{userid}, 'jjenkins0', 'Got the expected userid error from import patrons with duplicate userid');
230 is($result_3b->{feedback}->[0]->{feedback}, 1, 'Got the expected 1 feedback from import_patrons with duplicate userid');
231 is($result_3b->{feedback}->[0]->{name}, 'headerrow', 'Got the expected header row name from import_patrons with duplicate userid');
232 is($result_3b->{feedback}->[0]->{value}, $res_header, 'Got the expected header row value from import_patrons with duplicate userid');
234 is($result_3b->{imported}, 0, 'Got the expected 0 imported result from import_patrons with duplicate userid');
235 is($result_3b->{invalid}, 1, 'Got the expected 1 invalid result from import_patrons with duplicate userid');
236 is($result_3b->{overwritten}, 0, 'Got the expected 0 overwritten result from import_patrons with duplicate userid');
238 # Given ... a new input and mocked C4::Context
239 t::lib::Mocks::mock_preference('ExtendedPatronAttributes', 1);
240 my $attribute = $builder->build({ source => "BorrowerAttributeType"});
242 my $csv_headers_a = 'cardnumber,surname,firstname,title,othernames,initials,streetnumber,streettype,address,address2,city,state,zipcode,country,email,phone,mobile,fax,dateofbirth,branchcode,categorycode,dateenrolled,dateexpiry,userid,password,patron_attributes';
243 my $res_header_a = 'cardnumber, surname, firstname, title, othernames, initials, streetnumber, streettype, address, address2, city, state, zipcode, country, email, phone, mobile, fax, dateofbirth, branchcode, categorycode, dateenrolled, dateexpiry, userid, password, patron_attributes';
244 my $new_input_line = '1001,Donna,Sullivan,Mrs,Henry,DS,59,Court,Burrows,Reading,Salt Lake City,Pennsylvania,19605,United States,hsullivan1@purevolume.com,3-(864)009-3006,7-(291)885-8423,1-(879)095-5038,09/19/1970,LPL,PT,03/04/2015,07/01/2015,hsullivan1,8j6P6Dmap,'.$attribute->{code}.':1';
245 my $filename_4 = make_csv($temp_dir, $csv_headers_a, $new_input_line);
246 open(my $handle_4, "<", $filename_4) or die "cannot open < $filename_4: $!";
247 my $params_4 = { file => $handle_4, matchpoint => $attribute->{code}, };
250 my $result_4 = $patrons_import->import_patrons($params_4);
253 is($result_4->{already_in_db}, 0, 'Got the expected 0 already_in_db from import_patrons with extended user');
254 is(scalar @{$result_4->{errors}}, 0, 'Got the expected 0 size error array from import_patrons with extended user');
256 is($result_4->{feedback}->[0]->{feedback}, 1, 'Got the expected 1 feedback from import_patrons with extended user');
257 is($result_4->{feedback}->[0]->{name}, 'headerrow', 'Got the expected header row name from import_patrons with extended user');
258 is($result_4->{feedback}->[0]->{value}, $res_header_a, 'Got the expected header row value from import_patrons with extended user');
260 is($result_4->{feedback}->[1]->{feedback}, 1, 'Got the expected second feedback from import_patrons with extended user');
261 is($result_4->{feedback}->[1]->{name}, 'attribute string', 'Got the expected attribute string from import_patrons with extended user');
262 is($result_4->{feedback}->[1]->{value}, $attribute->{code}.':1', 'Got the expected second feedback value from import_patrons with extended user');
264 is($result_4->{feedback}->[2]->{feedback}, 1, 'Got the expected third feedback from import_patrons with extended user');
265 is($result_4->{feedback}->[2]->{name}, 'lastimported', 'Got the expected last imported name from import_patrons with extended user');
266 like($result_4->{feedback}->[2]->{value}, qr/^Donna \/ \d+/, 'Got the expected third feedback value from import_patrons with extended user');
268 is($result_4->{imported}, 1, 'Got the expected 1 imported result from import_patrons with extended user');
269 is($result_4->{invalid}, 0, 'Got the expected 0 invalid result from import_patrons with extended user');
270 is($result_4->{overwritten}, 0, 'Got the expected 0 overwritten result from import_patrons with extended user');
272 seek $handle_4,0,0; #Reset to verify finding a matched patron works
273 my $result_4a = $patrons_import->import_patrons($params_4);
274 is($result_4a->{already_in_db}, 1, 'Got the expected 1 already_in_db from import_patrons with extended user matched');
275 is(scalar @{$result_4->{errors}}, 0, 'Got the expected 0 size error array from import_patrons with extended user matched');
277 is($result_4a->{feedback}->[0]->{feedback}, 1, 'Got the expected 1 feedback from import_patrons with extended user matched');
278 is($result_4a->{feedback}->[0]->{name}, 'headerrow', 'Got the expected header row name from import_patrons with extended user matched');
279 is($result_4a->{feedback}->[0]->{value}, $res_header_a, 'Got the expected header row value from import_patrons with extended user matched');
281 is($result_4a->{feedback}->[1]->{feedback}, 1, 'Got the expected second feedback from import_patrons with extended user matched');
282 is($result_4a->{feedback}->[1]->{name}, 'attribute string', 'Got the expected attribute string from import_patrons with extended user matched');
283 is($result_4a->{feedback}->[1]->{value}, $attribute->{code}.':1', 'Got the expected second feedback value from import_patrons with extended user matched');
285 is($result_4a->{feedback}->[2]->{already_in_db}, '1', 'Got the expected already_in_db from import_patrons with extended user matched');
286 like($result_4a->{feedback}->[2]->{value}, qr/^Donna \/ \d+/, 'Got the expected third feedback value from import_patrons with extended user matched');
288 is($result_4a->{imported}, 0, 'Got the expected 0 imported result from import_patrons with extended user matched');
289 is($result_4a->{invalid}, 0, 'Got the expected 0 invalid result from import_patrons with extended user matched');
290 is($result_4a->{overwritten}, 0, 'Got the expected 0 overwritten result from import_patrons with extended user matched');
292 t::lib::Mocks::mock_preference('ExtendedPatronAttributes', 0);
294 my $surname ='Chloé❤';
295 # Given ... 3 new inputs. One with no branch code, one with unexpected branch code.
296 my $input_no_branch = qq|1002,$surname,Reynolds,Mr,Patricia,JR,12,Hill,Kennedy,Saint Louis,Colorado Springs,Missouri,63131,United States,preynolds2i\@washington.edu,7-(925)314-9514,0-(315)973-8956,4-(510)556-2323,09/18/1967,,PT,05/07/2015,07/01/2015,preynolds2,K3HiDzl|;
297 my $input_good_branch = qq|1003,$surname,Richardson,Mr,Kimberly,LR,90,Place,Bayside,Atlanta,Erie,Georgia,31190,United States,krichardson3\@pcworld.com,8-(035)185-0387,4-(796)518-3676,3-(644)960-3789,04/13/1954,RPL,PT,06/06/2015,07/01/2015,krichardson3,P3EO0MVRPXbM|;
298 my $input_na_branch = qq|1005,$surname,Greene,Mr,Michael,RG,3,Avenue,Grim,Peoria,Jacksonville,Illinois,61614,United States,mgreene5\@seesaa.net,3-(941)565-5752,1-(483)885-8138,4-(979)577-6908,02/09/1957,ZZZ,ST,04/02/2015,07/01/2015,mgreene5,or4ORT6JH|;
300 my $filename_5 = make_csv($temp_dir, $csv_headers, encode_utf8($input_no_branch), encode_utf8($input_good_branch), encode_utf8($input_na_branch));
301 open(my $handle_5, "<", $filename_5) or die "cannot open < $filename_5: $!";
302 my $params_5 = { file => $handle_5, matchpoint => 'cardnumber', };
305 my $result_5 = $patrons_import->import_patrons($params_5);
308 is($result_5->{already_in_db}, 0, 'Got the expected 0 already_in_db from import_patrons for branch tests');
310 is($result_5->{errors}->[0]->{missing_criticals}->[0]->{borrowernumber}, 'UNDEF', 'Got the expected undef borrower number error from import patrons for branch tests');
311 is($result_5->{errors}->[0]->{missing_criticals}->[0]->{key}, 'branchcode', 'Got the expected branch code key from import patrons for branch tests');
312 is($result_5->{errors}->[0]->{missing_criticals}->[0]->{line}, 2, 'Got the expected 2 line number error from import patrons for branch tests');
313 is($result_5->{errors}->[0]->{missing_criticals}->[0]->{lineraw}, $input_no_branch."\r\n", 'Got the expected lineraw error from import patrons for branch tests');
314 is($result_5->{errors}->[0]->{missing_criticals}->[0]->{surname}, $surname, 'Got the expected surname error from import patrons for branch tests');
316 is($result_5->{errors}->[1]->{missing_criticals}->[0]->{borrowernumber}, 'UNDEF', 'Got the expected undef borrower number error from import patrons for branch tests');
317 is($result_5->{errors}->[1]->{missing_criticals}->[0]->{branch_map}, 1, 'Got the expected 1 branchmap error from import patrons for branch tests');
318 is($result_5->{errors}->[1]->{missing_criticals}->[0]->{key}, 'branchcode', 'Got the expected branch code key from import patrons for branch tests');
319 is($result_5->{errors}->[1]->{missing_criticals}->[0]->{line}, 4, 'Got the expected 4 line number error from import patrons for branch tests');
320 is($result_5->{errors}->[1]->{missing_criticals}->[0]->{lineraw}, $input_na_branch."\r\n", 'Got the expected lineraw error from import patrons for branch tests');
321 is($result_5->{errors}->[1]->{missing_criticals}->[0]->{surname}, $surname, 'Got the expected surname error from import patrons for branch tests');
322 is($result_5->{errors}->[1]->{missing_criticals}->[0]->{value}, 'ZZZ', 'Got the expected ZZZ value error from import patrons for branch tests');
324 is($result_5->{feedback}->[0]->{feedback}, 1, 'Got the expected 1 feedback from import_patrons for branch tests');
325 is($result_5->{feedback}->[0]->{name}, 'headerrow', 'Got the expected header row name from import_patrons for branch tests');
326 is($result_5->{feedback}->[0]->{value}, $res_header, 'Got the expected header row value from import_patrons for branch tests');
328 is($result_5->{feedback}->[1]->{feedback}, 1, 'Got the expected 1 feedback from import_patrons for branch tests');
329 is($result_5->{feedback}->[1]->{name}, 'lastimported', 'Got the expected lastimported name from import_patrons for branch tests');
330 like($result_5->{feedback}->[1]->{value}, qr/^$surname \/ \d+/, 'Got the expected last imported value from import_patrons with for branch tests');
332 is($result_5->{imported}, 1, 'Got the expected 1 imported result from import patrons for branch tests');
333 is($result_5->{invalid}, 2, 'Got the expected 2 invalid result from import patrons for branch tests');
334 is($result_5->{overwritten}, 0, 'Got the expected 0 overwritten result from import patrons for branch tests');
336 # Given ... 3 new inputs. One with no category code, one with unexpected category code.
337 my $input_no_category = '1006,Christina,Olson,Rev,Kimberly,CO,8,Avenue,Northridge,Lexington,Wilmington,Kentucky,40510,United States,kolson6@dropbox.com,7-(810)636-6048,1-(052)012-8984,8-(567)232-7818,03/26/1952,FFL,,09/07/2014,01/07/2015,kolson6,x5D3qGbLlptx';
338 my $input_good_category = '1007,Peter,Peters,Mrs,Lawrence,PP,6,Trail,South,Oklahoma City,Topeka,Oklahoma,73135,United States,lpeters7@bandcamp.com,5-(992)205-9318,0-(732)586-9365,3-(448)146-7936,08/16/1983,PVL,T,03/24/2015,07/01/2015,lpeters7,Z19BrQ4';
339 my $input_na_category = '1008,Emily,Richards,Ms,Judy,ER,73,Way,Kedzie,Fort Wayne,Phoenix,Indiana,46825,United States,jrichards8@arstechnica.com,5-(266)658-8957,3-(550)500-9107,7-(816)675-9822,08/09/1984,FFL,ZZ,11/09/2014,07/01/2015,jrichards8,D5PvU6H2R';
341 my $filename_6 = make_csv($temp_dir, $csv_headers, $input_no_category, $input_good_category, $input_na_category);
342 open(my $handle_6, "<", $filename_6) or die "cannot open < $filename_6: $!";
343 my $params_6 = { file => $handle_6, matchpoint => 'cardnumber', };
346 my $result_6 = $patrons_import->import_patrons($params_6);
349 is($result_6->{already_in_db}, 0, 'Got the expected 0 already_in_db from import_patrons for category tests');
351 is($result_6->{errors}->[0]->{missing_criticals}->[0]->{borrowernumber}, 'UNDEF', 'Got the expected undef borrower number error from import patrons for category tests');
352 is($result_6->{errors}->[0]->{missing_criticals}->[0]->{key}, 'categorycode', 'Got the expected category code key from import patrons for category tests');
353 is($result_6->{errors}->[0]->{missing_criticals}->[0]->{line}, 2, 'Got the expected 2 line number error from import patrons for category tests');
354 is($result_6->{errors}->[0]->{missing_criticals}->[0]->{lineraw}, $input_no_category."\r\n", 'Got the expected lineraw error from import patrons for category tests');
355 is($result_6->{errors}->[0]->{missing_criticals}->[0]->{surname}, 'Christina', 'Got the expected surname error from import patrons for category tests');
357 is($result_6->{errors}->[1]->{missing_criticals}->[0]->{borrowernumber}, 'UNDEF', 'Got the expected undef borrower number error from import patrons for category tests');
358 is($result_6->{errors}->[1]->{missing_criticals}->[0]->{category_map}, 1, 'Got the expected 1 category_map error from import patrons for category tests');
359 is($result_6->{errors}->[1]->{missing_criticals}->[0]->{key}, 'categorycode', 'Got the expected category code key from import patrons for category tests');
360 is($result_6->{errors}->[1]->{missing_criticals}->[0]->{line}, 4, 'Got the expected 4 line number error from import patrons for category tests');
361 is($result_6->{errors}->[1]->{missing_criticals}->[0]->{lineraw}, $input_na_category."\r\n", 'Got the expected lineraw error from import patrons for category tests');
362 is($result_6->{errors}->[1]->{missing_criticals}->[0]->{surname}, 'Emily', 'Got the expected surname error from import patrons for category tests');
363 is($result_6->{errors}->[1]->{missing_criticals}->[0]->{value}, 'ZZ', 'Got the expected ZZ value error from import patrons for category tests');
365 is($result_6->{feedback}->[0]->{feedback}, 1, 'Got the expected 1 feedback from import_patrons for category tests');
366 is($result_6->{feedback}->[0]->{name}, 'headerrow', 'Got the expected header row name from import_patrons for category tests');
367 is($result_6->{feedback}->[0]->{value}, $res_header, 'Got the expected header row value from import_patrons for category tests');
369 is($result_6->{feedback}->[1]->{feedback}, 1, 'Got the expected 1 feedback from import_patrons for category tests');
370 is($result_6->{feedback}->[1]->{name}, 'lastimported', 'Got the expected lastimported name from import_patrons for category tests');
371 like($result_6->{feedback}->[1]->{value}, qr/^Peter \/ \d+/, 'Got the expected last imported value from import_patrons with for category tests');
373 is($result_6->{imported}, 1, 'Got the expected 1 imported result from import patrons for category tests');
374 is($result_6->{invalid}, 2, 'Got the expected 2 invalid result from import patrons for category tests');
375 is($result_6->{overwritten}, 0, 'Got the expected 0 overwritten result from import patrons for category tests');
377 # Given ... 2 new inputs. One without dateofbirth, dateenrolled and dateexpiry values.
378 my $input_complete = '1009,Christina,Harris,Dr,Philip,CH,99,Street,Grayhawk,Baton Rouge,Dallas,Louisiana,70810,United States,pharris9@hp.com,9-(317)603-5513,7-(005)062-7593,8-(349)134-1627,06/19/1969,IPT,PT,04/09/2015,07/01/2015,pharris9,NcAhcvvnB';
379 my $input_no_date = '1010,Ralph,Warren,Ms,Linda,RW,6,Way,Barby,Orlando,Albany,Florida,32803,United States,lwarrena@multiply.com,7-(579)753-7752,6-(847)086-7566,9-(122)729-8226,26/01/2001,LPL,T,25/01/2001,24/01/2001,lwarrena,tJ56RD4uV';
381 my $filename_7 = make_csv($temp_dir, $csv_headers, $input_complete, $input_no_date);
382 open(my $handle_7, "<", $filename_7) or die "cannot open < $filename_7: $!";
383 my $params_7 = { file => $handle_7, matchpoint => 'cardnumber', };
386 my $result_7 = $patrons_import->import_patrons($params_7);
389 is($result_7->{already_in_db}, 0, 'Got the expected 0 already_in_db from import_patrons for dates tests');
390 is(scalar @{$result_7->{errors}}, 1, 'Got the expected 1 error array size from import_patrons for dates tests');
391 is(scalar @{$result_7->{errors}->[0]->{missing_criticals}}, 3, 'Got the expected 3 missing critical errors from import_patrons for dates tests');
393 is($result_7->{errors}->[0]->{missing_criticals}->[0]->{bad_date}, 1, 'Got the expected 1 bad_date error from import patrons for dates tests');
394 is($result_7->{errors}->[0]->{missing_criticals}->[0]->{borrowernumber}, 'UNDEF', 'Got the expected undef borrower number error from import patrons for dates tests');
395 is($result_7->{errors}->[0]->{missing_criticals}->[0]->{key}, 'dateofbirth', 'Got the expected dateofbirth key from import patrons for dates tests');
396 is($result_7->{errors}->[0]->{missing_criticals}->[0]->{line}, 3, 'Got the expected 2 line number error from import patrons for dates tests');
397 is($result_7->{errors}->[0]->{missing_criticals}->[0]->{lineraw}, $input_no_date."\r\n", 'Got the expected lineraw error from import patrons for dates tests');
398 is($result_7->{errors}->[0]->{missing_criticals}->[0]->{surname}, 'Ralph', 'Got the expected surname error from import patrons for dates tests');
400 is($result_7->{errors}->[0]->{missing_criticals}->[1]->{key}, 'dateenrolled', 'Got the expected dateenrolled key from import patrons for dates tests');
401 is($result_7->{errors}->[0]->{missing_criticals}->[2]->{key}, 'dateexpiry', 'Got the expected dateexpiry key from import patrons for dates tests');
403 is(scalar @{$result_7->{feedback}}, 2, 'Got the expected 2 feedback from import patrons for dates tests');
404 is($result_7->{feedback}->[0]->{feedback}, 1, 'Got the expected 1 feedback from import_patrons for dates tests');
405 is($result_7->{feedback}->[0]->{name}, 'headerrow', 'Got the expected header row name from import_patrons for dates tests');
406 is($result_7->{feedback}->[0]->{value}, $res_header, 'Got the expected header row value from import_patrons for dates tests');
408 is($result_7->{feedback}->[1]->{feedback}, 1, 'Got the expected 1 feedback from import_patrons for dates tests');
409 is($result_7->{feedback}->[1]->{name}, 'lastimported', 'Got the expected lastimported from import_patrons for dates tests');
410 like($result_7->{feedback}->[1]->{value}, qr/^Christina \/ \d+/, 'Got the expected lastimported value from import_patrons for dates tests');
412 is($result_7->{imported}, 1, 'Got the expected 1 imported result from import patrons for dates tests');
413 is($result_7->{invalid}, 1, 'Got the expected 1 invalid result from import patrons for dates tests');
414 is($result_7->{overwritten}, 0, 'Got the expected 0 overwritten result from import patrons for dates tests');
416 subtest 'test_import_without_cardnumber' => sub {
419 #Remove possible existing user with a "" as cardnumber
420 my $blank_card = Koha::Patrons->find({ cardnumber => '' });
421 $blank_card->delete if $blank_card;
423 my $branchcode = $builder->build({ source => "Branch"})->{branchcode};
424 my $categorycode = $builder->build({ source => "Category"})->{categorycode};
425 my $csv_headers = 'surname, branchcode, categorycode';
426 my $res_headers = 'surname, branchcode, categorycode';
427 my $csv_nocard_1 = "Squarepants,$branchcode,$categorycode";
428 my $csv_nocard_2 = "Star,$branchcode,$categorycode";
430 my $filename_1 = make_csv($temp_dir, $csv_headers, $csv_nocard_1, $csv_nocard_2);
431 open(my $handle_1, "<", $filename_1) or die "cannot open < $filename_1: $!";
432 my $params_1 = { file => $handle_1, };
434 my $defaults = { cardnumber => "" }; #currently all the defaults come as "" if not filled
436 my $result = $patrons_import->import_patrons($params_1, $defaults);
437 like($result->{feedback}->[1]->{value}, qr/^Squarepants \/ \d+/, 'First borrower imported as expected');
438 like($result->{feedback}->[2]->{value}, qr/^Star \/ \d+/, 'Second borrower imported as expected');
442 subtest 'test_import_with_cardnumber_0' => sub {
445 #Remove possible existing user with a "" as cardnumber
446 my $zero_card = Koha::Patrons->find({ cardnumber => 0 });
447 $zero_card->delete if $zero_card;
449 my $branchcode = $builder->build({ source => "Branch"})->{branchcode};
450 my $categorycode = $builder->build({ source => "Category"})->{categorycode};
451 my $csv_headers = 'cardnumber,surname, branchcode, categorycode';
452 my $res_headers = 'cardnumber,surname, branchcode, categorycode';
453 my $csv_nocard_1 = "0,Squarepants,$branchcode,$categorycode";
455 my $filename_1 = make_csv($temp_dir, $csv_headers, $csv_nocard_1);
456 open(my $handle_1, "<", $filename_1) or die "cannot open < $filename_1: $!";
457 my $params_1 = { file => $handle_1, };
459 my $defaults = { cardnumber => "" }; #currently all the defaults come as "" if not filled
461 my $result = $patrons_import->import_patrons($params_1, $defaults);
462 like($result->{feedback}->[1]->{value}, qr/^Squarepants \/ \d+/, 'First borrower imported as expected');
463 $zero_card = Koha::Patrons->find({ cardnumber => 0 });
464 is($zero_card->surname.$zero_card->branchcode.$zero_card->categorycode,'Squarepants'.$branchcode.$categorycode,"Patron with cardnumber 0 is the imported patron");
468 subtest 'Import patron with guarantor' => sub {
470 t::lib::Mocks::mock_preference( 'borrowerRelationship', 'guarantor' );
472 my $category = $builder->build( { source => 'Category' } )->{categorycode};
473 my $branch = $builder->build( { source => 'Branch' } )->{branchcode};
474 my $guarantor = Koha::Patron->new(
476 surname => 'Guarantor',
477 branchcode => $branch,
478 categorycode => $category,
481 my $guarantor_id = $guarantor->id;
483 my $branchcode = $builder->build( { source => "Branch" } )->{branchcode};
484 my $categorycode = $builder->build( { source => "Category" } )->{categorycode};
485 my $csv_headers = 'cardnumber,surname, branchcode, categorycode, guarantor_id, guarantor_relationship';
486 my $csv = "kylemhall,Hall,$branchcode,$categorycode,$guarantor_id,guarantor";
488 my $filename_1 = make_csv( $temp_dir, $csv_headers, $csv );
489 open( my $handle_1, "<", $filename_1 ) or die "cannot open < $filename_1: $!";
490 my $params_1 = { file => $handle_1, };
492 my $result = $patrons_import->import_patrons( $params_1 );
493 like( $result->{feedback}->[1]->{value}, qr/^Hall \/ \d+/, 'First borrower imported as expected' );
494 my $patron = Koha::Patrons->find( { cardnumber => 'kylemhall' } );
495 is( $patron->surname, "Hall", "Patron was created" );
497 my $r = Koha::Patron::Relationships->find( { guarantor_id => $guarantor_id } );
498 ok( $r, 'Found relationship' );
499 is( $r->guarantee->cardnumber, 'kylemhall', 'Found the correct guarantee' );
502 subtest 'test_import_with_password_overwrite' => sub {
505 #Remove possible existing user to avoid clashes
506 my $ernest = Koha::Patrons->find({ userid => 'ErnestP' });
507 $ernest->delete if $ernest;
510 my $branchcode = $builder->build({ source => "Branch"})->{branchcode};
511 my $categorycode = $builder->build({ source => "Category", value => { category_type => 'A' } })->{categorycode};
512 my $staff_categorycode = $builder->build({ source => "Category", value => { category_type => 'S' } })->{categorycode};
513 my $csv_headers = 'surname,userid,branchcode,categorycode,password';
514 my $csv_password = "Worrell,ErnestP,$branchcode,$categorycode,Ernest11";
515 my $csv_password_change = "Worrell,ErnestP,$branchcode,$categorycode,Vern1234";
516 my $csv_blank_password = "Worel,ErnestP,$branchcode,$categorycode,";
517 my $defaults = { cardnumber => "" }; #currently all the defaults come as "" if not filled
518 my $csv_staff_password_change = "Worrell,ErnestP,$branchcode,$staff_categorycode,Vern1234";
520 #Make the test files for importing
521 my $filename_1 = make_csv($temp_dir, $csv_headers, $csv_password);
522 open(my $handle_1, "<", $filename_1) or die "cannot open < $filename_1: $!";
523 my $params_1 = { file => $handle_1, matchpoint => 'userid', overwrite_passwords => 1, overwrite_cardnumber => 1};
524 my $filename_2 = make_csv($temp_dir, $csv_headers, $csv_password_change);
525 open(my $handle_2, "<", $filename_2) or die "cannot open < $filename_2: $!";
526 my $params_2 = { file => $handle_2, matchpoint => 'userid', overwrite_passwords => 1, overwrite_cardnumber => 1};
528 my $filename_3 = make_csv($temp_dir, $csv_headers, $csv_blank_password);
529 open(my $handle_3, "<", $filename_3) or die "cannot open < $filename_3: $!";
530 my $params_3 = { file => $handle_3, matchpoint => 'userid', overwrite_passwords => 1, overwrite_cardnumber => 1};
532 my $filename_4 = make_csv($temp_dir, $csv_headers, $csv_staff_password_change);
533 open(my $handle_4, "<", $filename_4) or die "cannot open < $filename_4: $!";
534 my $params_4 = { file => $handle_4, matchpoint => 'userid', overwrite_passwords => 1, overwrite_cardnumber => 1};
537 my $result = $patrons_import->import_patrons($params_1, $defaults);
538 like($result->{feedback}->[1]->{value}, qr/^Worrell \/ \d+/, 'First borrower imported as expected');
539 $ernest = Koha::Patrons->find({ userid => 'ErnestP' });
540 isnt($ernest->password,'Ernest',"New patron is imported, password is encrypted");
542 #Save info to double check
543 my $orig_pass = $ernest->password;
545 $result = $patrons_import->import_patrons($params_2, $defaults);
546 $ernest = Koha::Patrons->find({ userid => 'ErnestP' });
547 isnt($ernest->password,$orig_pass,"New patron is overwritten, password is overwritten");
548 isnt($ernest->password,'Vern',"Password is overwritten and is encrypted from value provided");
550 #Save info to check not changed
551 $orig_pass = $ernest->password;
553 $result = $patrons_import->import_patrons($params_3, $defaults);
554 $ernest = Koha::Patrons->find({ userid => 'ErnestP' });
555 is($ernest->surname,'Worel',"Patron is overwritten, surname changed");
556 is($ernest->password,$orig_pass,"Patron was overwritten but password is not overwritten if blank");
558 $ernest->category($staff_categorycode);
561 $result = $patrons_import->import_patrons($params_4, $defaults);
562 $ernest = Koha::Patrons->find({ userid => 'ErnestP' });
563 is($ernest->surname,'Worrell',"Patron is overwritten, surname changed");
564 is($ernest->password,$orig_pass,"Patron is imported, password is not changed for staff");
569 subtest 'test_prepare_columns' => sub {
572 # Given ... no header row
577 my @csvcolumns_0 = $patrons_import->prepare_columns({headerrow => undef, keycol => \%csvkeycol_0, errors => \@errors_0, });
580 is(scalar @csvcolumns_0, 0, 'Got the expected empty column array from prepare columns with no header row');
582 is(scalar @errors_0, 1, 'Got the expected 1 entry in error array from prepare columns with no header row');
583 is($errors_0[0]->{badheader}, 1, 'Got the expected 1 badheader from prepare columns with no header row');
584 is($errors_0[0]->{line}, 1, 'Got the expected 1 line from prepare columns with no header row');
585 is($errors_0[0]->{lineraw}, undef, 'Got the expected undef lineraw from prepare columns with no header row');
587 # Given ... a good header row with plenty of whitespaces
588 my $headerrow_1 = 'a, b , c, , d';
593 my @csvcolumns_1 = $patrons_import->prepare_columns({headerrow => $headerrow_1, keycol => \%csvkeycol_1, errors => \@errors_1, });
596 is(scalar @csvcolumns_1, 5, 'Got the expected 5 column array from prepare columns');
597 is($csvcolumns_1[0], 'a', 'Got the expected a header from prepare columns');
598 is($csvcolumns_1[1], 'b', 'Got the expected b header from prepare columns');
599 is($csvcolumns_1[2], 'c', 'Got the expected c header from prepare columns');
600 is($csvcolumns_1[3], '', 'Got the expected empty header from prepare columns');
601 is($csvcolumns_1[4], 'd', 'Got the expected d header from prepare columns');
603 is($csvkeycol_1{a}, 0, 'Got the expected 0 value for key a from prepare columns hash');
604 is($csvkeycol_1{b}, 1, 'Got the expected 1 value for key b from prepare columns hash');
605 is($csvkeycol_1{c}, 2, 'Got the expected 2 value for key c from prepare columns hash');
606 is($csvkeycol_1{''}, 3, 'Got the expected 3 value for empty string key from prepare columns hash');
607 is($csvkeycol_1{d}, 4, 'Got the expected 4 value for key d from prepare columns hash');
610 subtest 'test_set_column_keys' => sub {
613 # Given ... nothing at all
615 my $attr_type_0 = $patrons_import->set_attribute_types(undef);
616 is($attr_type_0, undef, 'Got the expected undef attribute type from set attribute types with nothing');
618 # Given ... extended but not matchpoint
619 my $params_1 = { extended => 1, matchpoint => undef, };
622 my $attr_type_1 = $patrons_import->set_attribute_types($params_1);
623 is($attr_type_1, undef, 'Got the expected undef attribute type from set attribute types with no matchpoint');
625 # Given ... extended and unexpected matchpoint
626 my $params_2 = { extended => 1, matchpoint => 'unexpected', };
629 my $attr_type_2 = $patrons_import->set_attribute_types($params_2);
630 is($attr_type_2, undef, 'Got the expected undef attribute type from set attribute types with unexpected matchpoint');
633 my $code_3 = 'SHOW_BCODE';
634 my $params_3 = { extended => 1, matchpoint => $code_3, };
637 my $attr_type_3 = $patrons_import->set_attribute_types($params_3);
640 isa_ok($attr_type_3, 'Koha::Patron::Attribute::Type');
641 is($attr_type_3->code, $code_3, 'Got the expected code attribute type from set attribute types');
644 subtest 'test_set_column_keys' => sub {
647 my @columns = Koha::Patrons->columns;
648 # Given ... nothing at all
650 my @columnkeys_0 = $patrons_import->set_column_keys(undef);
651 # -1 because we do not want the borrowernumber column
652 # +2 for guarantor id and guarantor relationship
653 is(scalar @columnkeys_0, @columns - 1 + 2, 'Got the expected array size from set column keys with undef extended');
655 # Given ... extended.
659 my @columnkeys_1 = $patrons_import->set_column_keys($extended);
660 is(scalar @columnkeys_1, @columns - 1 + 2 + $extended, 'Got the expected array size from set column keys with extended');
663 subtest 'test_generate_patron_attributes' => sub {
666 # Given ... nothing at all
668 my $result_0 = $patrons_import->generate_patron_attributes(undef, undef, undef);
669 is($result_0, undef, 'Got the expected undef from set patron attributes with nothing');
671 # Given ... not extended.
675 my $result_1 = $patrons_import->generate_patron_attributes($extended_1, undef, undef);
676 is($result_1, undef, 'Got the expected undef from set patron attributes with not extended');
678 # Given ... NO patrons attributes
680 my $patron_attributes_2 = undef;
684 my $result_2 = $patrons_import->generate_patron_attributes($extended_2, $patron_attributes_2, \@feedback_2);
687 is($result_2, undef, 'Got the expected undef from set patron attributes with no patrons attributes');
688 is(scalar @feedback_2, 0, 'Got the expected 0 size feedback array from set patron attributes with no patrons attributes');
690 # Given ... some patrons attributes
691 my $patron_attributes_3 = "homeroom:1150605,grade:01";
695 my $result_3 = $patrons_import->generate_patron_attributes($extended_2, $patron_attributes_3, \@feedback_3);
698 ok($result_3, 'Got some data back from set patron attributes');
699 is($result_3->[0]->{code}, 'grade', 'Got the expected first code from set patron attributes');
700 is($result_3->[0]->{attribute}, '01', 'Got the expected first value from set patron attributes');
702 is($result_3->[1]->{code}, 'homeroom', 'Got the expected second code from set patron attributes');
703 is($result_3->[1]->{attribute}, 1150605, 'Got the expected second value from set patron attributes');
705 is(scalar @feedback_3, 1, 'Got the expected 1 array size from set patron attributes with extended user');
706 is($feedback_3[0]->{feedback}, 1, 'Got the expected second feedback from set patron attributes with extended user');
707 is($feedback_3[0]->{name}, 'attribute string', 'Got the expected attribute string from set patron attributes with extended user');
708 is($feedback_3[0]->{value}, 'homeroom:1150605,grade:01', 'Got the expected feedback value from set patron attributes with extended user');
711 subtest 'test_check_branch_code' => sub {
714 # Given ... no branch code.
715 my $borrowerline = 'some, line';
716 my $line_number = 78;
717 my @missing_criticals = ();
720 $patrons_import->check_branch_code(undef, $borrowerline, $line_number, \@missing_criticals);
723 is(scalar @missing_criticals, 1, 'Got the expected missing critical array size of 1 from check_branch_code with no branch code');
725 is($missing_criticals[0]->{key}, 'branchcode', 'Got the expected branchcode key from check_branch_code with no branch code');
726 is($missing_criticals[0]->{line}, $line_number, 'Got the expected line number from check_branch_code with no branch code');
727 is($missing_criticals[0]->{lineraw}, $borrowerline, 'Got the expected lineraw value from check_branch_code with no branch code');
729 # Given ... unknown branch code
730 my $branchcode_1 = 'unexpected';
731 my $borrowerline_1 = 'some, line,'.$branchcode_1;
732 my $line_number_1 = 79;
733 my @missing_criticals_1 = ();
736 $patrons_import->check_branch_code($branchcode_1, $borrowerline_1, $line_number_1, \@missing_criticals_1);
739 is(scalar @missing_criticals_1, 1, 'Got the expected missing critical array size of 1 from check_branch_code with unexpected branch code');
741 is($missing_criticals_1[0]->{branch_map}, 1, 'Got the expected 1 branch_map from check_branch_code with unexpected branch code');
742 is($missing_criticals_1[0]->{key}, 'branchcode', 'Got the expected branchcode key from check_branch_code with unexpected branch code');
743 is($missing_criticals_1[0]->{line}, $line_number_1, 'Got the expected line number from check_branch_code with unexpected branch code');
744 is($missing_criticals_1[0]->{lineraw}, $borrowerline_1, 'Got the expected lineraw value from check_branch_code with unexpected branch code');
745 is($missing_criticals_1[0]->{value}, $branchcode_1, 'Got the expected value from check_branch_code with unexpected branch code');
747 # Given ... a known branch code. Relies on database sample data
748 my $branchcode_2 = 'FFL';
749 my $borrowerline_2 = 'some, line,'.$branchcode_2;
750 my $line_number_2 = 80;
751 my @missing_criticals_2 = ();
754 $patrons_import->check_branch_code($branchcode_2, $borrowerline_2, $line_number_2, \@missing_criticals_2);
757 is(scalar @missing_criticals_2, 0, 'Got the expected missing critical array size of 0 from check_branch_code');
760 subtest 'test_check_borrower_category' => sub {
763 # Given ... no category code.
764 my $borrowerline = 'some, line';
765 my $line_number = 781;
766 my @missing_criticals = ();
769 $patrons_import->check_borrower_category(undef, $borrowerline, $line_number, \@missing_criticals);
772 is(scalar @missing_criticals, 1, 'Got the expected missing critical array size of 1 from check_branch_code with no category code');
774 is($missing_criticals[0]->{key}, 'categorycode', 'Got the expected categorycode key from check_branch_code with no category code');
775 is($missing_criticals[0]->{line}, $line_number, 'Got the expected line number from check_branch_code with no category code');
776 is($missing_criticals[0]->{lineraw}, $borrowerline, 'Got the expected lineraw value from check_branch_code with no category code');
778 # Given ... unknown category code
779 my $categorycode_1 = 'unexpected';
780 my $borrowerline_1 = 'some, line, line, '.$categorycode_1;
781 my $line_number_1 = 791;
782 my @missing_criticals_1 = ();
785 $patrons_import->check_borrower_category($categorycode_1, $borrowerline_1, $line_number_1, \@missing_criticals_1);
788 is(scalar @missing_criticals_1, 1, 'Got the expected missing critical array size of 1 from check_branch_code with unexpected category code');
790 is($missing_criticals_1[0]->{category_map}, 1, 'Got the expected 1 category_map from check_branch_code with unexpected category code');
791 is($missing_criticals_1[0]->{key}, 'categorycode', 'Got the expected branchcode key from check_branch_code with unexpected category code');
792 is($missing_criticals_1[0]->{line}, $line_number_1, 'Got the expected line number from check_branch_code with unexpected category code');
793 is($missing_criticals_1[0]->{lineraw}, $borrowerline_1, 'Got the expected lineraw value from check_branch_code with unexpected category code');
794 is($missing_criticals_1[0]->{value}, $categorycode_1, 'Got the expected value from check_branch_code with unexpected category code');
796 # Given ... a known category code. Relies on database sample data.
797 my $categorycode_2 = 'T';
798 my $borrowerline_2 = 'some, line,'.$categorycode_2;
799 my $line_number_2 = 801;
800 my @missing_criticals_2 = ();
803 $patrons_import->check_borrower_category($categorycode_2, $borrowerline_2, $line_number_2, \@missing_criticals_2);
806 is(scalar @missing_criticals_2, 0, 'Got the expected missing critical array size of 0 from check_branch_code');
809 subtest 'test_format_dates' => sub {
812 # Given ... no borrower data.
813 my $borrowerline = 'another line';
814 my $line_number = 987;
815 my @missing_criticals = ();
817 my $params = {borrower => \%borrower, lineraw => $borrowerline, line => $line_number, missing_criticals => \@missing_criticals, };
820 $patrons_import->format_dates($params);
823 ok( not(%borrower), 'Got the expected no borrower from format_dates with no dates');
824 is(scalar @missing_criticals, 0, 'Got the expected missing critical array size of 0 from format_dates with no dates');
826 # Given ... some good dates
827 my @missing_criticals_1 = ();
828 my $dateofbirth_1 = '2016-05-03';
829 my $dateenrolled_1 = '2016-05-04';
830 my $dateexpiry_1 = '2016-05-06';
831 my $borrower_1 = { dateofbirth => $dateofbirth_1, dateenrolled => $dateenrolled_1, dateexpiry => $dateexpiry_1, };
832 my $params_1 = {borrower => $borrower_1, lineraw => $borrowerline, line => $line_number, missing_criticals => \@missing_criticals_1, };
835 $patrons_import->format_dates($params_1);
838 is($borrower_1->{dateofbirth}, $dateofbirth_1, 'Got the expected date of birth from format_dates with good dates');
839 is($borrower_1->{dateenrolled}, $dateenrolled_1, 'Got the expected date of birth from format_dates with good dates');
840 is($borrower_1->{dateexpiry}, $dateexpiry_1, 'Got the expected date of birth from format_dates with good dates');
841 is(scalar @missing_criticals_1, 0, 'Got the expected missing critical array size of 0 from check_branch_code with good dates');
843 # Given ... some very bad dates
844 my @missing_criticals_2 = ();
845 my $dateofbirth_2 = '03-2016-05';
846 my $dateenrolled_2 = '04-2016-05';
847 my $dateexpiry_2 = '06-2016-05';
848 my $borrower_2 = { dateofbirth => $dateofbirth_2, dateenrolled => $dateenrolled_2, dateexpiry => $dateexpiry_2, };
849 my $params_2 = {borrower => $borrower_2, lineraw => $borrowerline, line => $line_number, missing_criticals => \@missing_criticals_2, };
852 $patrons_import->format_dates($params_2);
855 is($borrower_2->{dateofbirth}, '', 'Got the expected empty date of birth from format_dates with bad dates');
856 is($borrower_2->{dateenrolled}, '', 'Got the expected emptydate of birth from format_dates with bad dates');
857 is($borrower_2->{dateexpiry}, '', 'Got the expected empty date of birth from format_dates with bad dates');
859 is(scalar @missing_criticals_2, 3, 'Got the expected missing critical array size of 3 from check_branch_code with bad dates');
860 is($missing_criticals_2[0]->{bad_date}, 1, 'Got the expected first bad date flag from check_branch_code with bad dates');
861 is($missing_criticals_2[0]->{key}, 'dateofbirth', 'Got the expected dateofbirth key from check_branch_code with bad dates');
862 is($missing_criticals_2[0]->{line}, $line_number, 'Got the expected first line from check_branch_code with bad dates');
863 is($missing_criticals_2[0]->{lineraw}, $borrowerline, 'Got the expected first lineraw from check_branch_code with bad dates');
865 is($missing_criticals_2[1]->{bad_date}, 1, 'Got the expected second bad date flag from check_branch_code with bad dates');
866 is($missing_criticals_2[1]->{key}, 'dateenrolled', 'Got the expected dateenrolled key from check_branch_code with bad dates');
867 is($missing_criticals_2[1]->{line}, $line_number, 'Got the expected second line from check_branch_code with bad dates');
868 is($missing_criticals_2[1]->{lineraw}, $borrowerline, 'Got the expected second lineraw from check_branch_code with bad dates');
870 is($missing_criticals_2[2]->{bad_date}, 1, 'Got the expected third bad date flag from check_branch_code with bad dates');
871 is($missing_criticals_2[2]->{key}, 'dateexpiry', 'Got the expected dateexpiry key from check_branch_code with bad dates');
872 is($missing_criticals_2[2]->{line}, $line_number, 'Got the expected third line from check_branch_code with bad dates');
873 is($missing_criticals_2[2]->{lineraw}, $borrowerline, 'Got the expected third lineraw from check_branch_code with bad dates');
876 subtest 'patron_attributes' => sub {
880 t::lib::Mocks::mock_preference('ExtendedPatronAttributes', 1);
882 my $unique_attribute_type = $builder->build_object(
884 class => 'Koha::Patron::Attribute::Types',
885 value => { unique_id=> 1, repeatable => 0 }
888 my $repeatable_attribute_type = $builder->build_object(
890 class => 'Koha::Patron::Attribute::Types',
891 value => { unique_id => 0, repeatable => 1 }
894 my $normal_attribute_type = $builder->build_object(
896 class => 'Koha::Patron::Attribute::Types',
897 value => { unique_id => 0, repeatable => 0 }
900 my $non_existent_attribute_type = $builder->build_object(
902 class => 'Koha::Patron::Attribute::Types',
905 my $non_existent_attribute_type_code = $non_existent_attribute_type->code;
906 $non_existent_attribute_type->delete;
908 our $cardnumber = "1042";
910 # attributes is { code => \@attributes }
912 my ($attributes) = @_;
914 my $csv_headers = 'cardnumber,surname,firstname,branchcode,categorycode,patron_attributes';
915 my @attributes_str = map { my $code = $_; map { sprintf "%s:%s", $code, $_ } @{ $attributes->{$code} } } keys %$attributes;
916 my $attributes_str = join ',', @attributes_str;
917 my $csv_line = sprintf '%s,John,D,MPL,PT,"%s"', $cardnumber, $attributes_str;
918 my $filename = make_csv( $temp_dir, $csv_headers, $csv_line );
919 open( my $fh, "<:encoding(utf8)", $filename ) or die "cannot open $filename: $!";
923 { # Everything good, we create a patron with 3 attributes
925 $unique_attribute_type->code => ['my unique attribute 1'],
926 $repeatable_attribute_type->code => [ 'my repeatable attribute 1', 'my repeatable attribute 2' ],
927 $normal_attribute_type->code => ['my normal attribute 1'],
929 my $fh = build_csv({ %$attributes });
930 my $result = $patrons_import->import_patrons({file => $fh});
932 is( $result->{imported}, 1 );
934 my $patron = Koha::Patrons->find({cardnumber => $cardnumber});
935 compare_patron_attributes($patron->extended_attributes->unblessed, { %$attributes } );
939 { # UniqueIDConstraint
940 $builder->build_object(
942 class => 'Koha::Patron::Attributes',
943 value => { code => $unique_attribute_type->code, attribute => 'unique' }
948 $unique_attribute_type->code => ['unique'],
949 $normal_attribute_type->code => ['my normal attribute 1']
951 my $fh = build_csv({ %$attributes });
953 my $result = $patrons_import->import_patrons({file => $fh, matchpoint => 'cardnumber'});
954 my $error = $result->{errors}->[0];
955 is( $error->{patron_attribute_unique_id_constraint}, 1 );
956 is( $error->{patron_id}, $cardnumber );
957 is( $error->{attribute}->code, $unique_attribute_type->code );
959 my $patron = Koha::Patrons->find({cardnumber => $cardnumber});
960 is( $patron, undef, 'Patron is not created' );
965 $non_existent_attribute_type_code => ['my non-existent attribute'],
966 $normal_attribute_type->code => ['my attribute 1'],
968 my $fh = build_csv({ %$attributes });
970 my $result = $patrons_import->import_patrons({file => $fh, matchpoint => 'cardnumber'});
971 is( $result->{imported}, 0 );
973 my $error = $result->{errors}->[0];
974 is( $error->{patron_attribute_invalid_type}, 1 );
975 is( $error->{patron_id}, $cardnumber );
976 is( $error->{attribute_type_code}, $non_existent_attribute_type_code );
978 my $patron = Koha::Patrons->find({cardnumber => $cardnumber});
979 is( $patron, undef );
985 $repeatable_attribute_type->code => ['my repeatable attribute 1', 'my repeatable attribute 2'],
986 $normal_attribute_type->code => ['my normal attribute 1', 'my normal attribute 2'],
988 my $fh = build_csv({ %$attributes });
989 my $result = $patrons_import->import_patrons({file => $fh, matchpoint => 'cardnumber'});
990 is( $result->{imported}, 0 );
992 my $error = $result->{errors}->[0];
993 is( $error->{patron_attribute_non_repeatable}, 1 );
994 is( $error->{patron_id}, $cardnumber );
995 is( $error->{attribute}->code, $normal_attribute_type->code );
997 my $patron = Koha::Patrons->find({cardnumber => $cardnumber});
998 is( $patron, undef );
1001 subtest 'update existing patron' => sub {
1004 my $patron = $builder->build_object(
1006 class => 'Koha::Patrons',
1007 value => { cardnumber => $cardnumber }
1012 $unique_attribute_type->code => ['my unique attribute 1'],
1013 $repeatable_attribute_type->code => [ 'my repeatable attribute 1', 'my repeatable attribute 2' ],
1014 $normal_attribute_type->code => ['my normal attribute 1'],
1016 my $fh = build_csv({ %$attributes });
1017 my $result = $patrons_import->import_patrons(
1020 matchpoint => 'cardnumber',
1021 overwrite_cardnumber => 1,
1022 preserve_extended_attributes => 1
1026 is( $result->{overwritten}, 1 );
1028 compare_patron_attributes($patron->extended_attributes->unblessed, { %$attributes } );
1030 # Adding a new non-repeatable attribute
1031 my $new_attributes = {
1032 $normal_attribute_type->code => ['my normal attribute 2'],
1034 $fh = build_csv({ %$new_attributes });
1035 $result = $patrons_import->import_patrons(
1038 matchpoint => 'cardnumber',
1039 overwrite_cardnumber => 1,
1040 preserve_extended_attributes => 1
1044 is( $result->{overwritten}, 1 );
1046 # The normal_attribute_type has been replaced with 'my normal attribute 2'
1047 compare_patron_attributes($patron->extended_attributes->unblessed, { %$attributes, %$new_attributes } );
1049 # UniqueIDConstraint
1050 $patron->extended_attributes->delete; # reset
1051 $builder->build_object(
1053 class => 'Koha::Patron::Attributes',
1054 value => { code => $unique_attribute_type->code, attribute => 'unique' }
1058 $unique_attribute_type->code => ['unique'],
1059 $repeatable_attribute_type->code => [ 'my repeatable attribute 1', 'my repeatable attribute 2' ],
1060 $normal_attribute_type->code => ['my normal attribute 1'],
1062 $fh = build_csv({ %$attributes });
1063 $result = $patrons_import->import_patrons(
1066 matchpoint => 'cardnumber',
1067 overwrite_cardnumber => 1,
1068 preserve_extended_attributes => 1
1072 is( $result->{overwritten}, 0 );
1073 my $error = $result->{errors}->[0];
1074 is( $error->{patron_attribute_unique_id_constraint}, 1 );
1075 is( $error->{borrowernumber}, $patron->borrowernumber );
1076 is( $error->{attribute}->code, $unique_attribute_type->code );
1078 compare_patron_attributes($patron->extended_attributes->unblessed, {}, );
1083 $non_existent_attribute_type_code => ['my non-existent attribute'],
1084 $normal_attribute_type->code => ['my attribute 1'],
1086 $fh = build_csv({ %$attributes });
1088 $result = $patrons_import->import_patrons(
1091 matchpoint => 'cardnumber',
1092 overwrite_cardnumber => 1,
1093 preserve_extended_attributes => 1
1096 is( $result->{overwritten}, 0 );
1098 $error = $result->{errors}->[0];
1099 is( $error->{patron_attribute_invalid_type}, 1 );
1100 is( $error->{borrowernumber}, $patron->borrowernumber );
1101 is( $error->{attribute_type_code}, $non_existent_attribute_type_code );
1105 $repeatable_attribute_type->code => ['my repeatable attribute 1', 'my repeatable attribute 2'],
1106 $normal_attribute_type->code => ['my normal attribute 1', 'my normal attribute 2'],
1108 $fh = build_csv({ %$attributes });
1109 $result = $patrons_import->import_patrons(
1112 matchpoint => 'cardnumber',
1113 overwrite_cardnumber => 1,
1114 preserve_extended_attributes => 1
1117 is( $result->{overwritten}, 0 );
1119 $error = $result->{errors}->[0];
1120 is( $error->{patron_attribute_non_repeatable}, 1 );
1121 is( $error->{borrowernumber}, $patron->borrowernumber );
1122 is( $error->{attribute}->code, $normal_attribute_type->code );
1124 # Don't preserve existing attributes
1126 $repeatable_attribute_type->code => ['my repeatable attribute 3', 'my repeatable attribute 4'],
1127 $normal_attribute_type->code => ['my normal attribute 1'],
1129 $fh = build_csv({ %$attributes });
1130 $result = $patrons_import->import_patrons(
1133 matchpoint => 'cardnumber',
1134 overwrite_cardnumber => 1,
1135 preserve_extended_attributes => 1
1138 is( $result->{overwritten}, 1 );
1140 compare_patron_attributes($patron->extended_attributes->unblessed, { %$attributes } );
1146 subtest 'welcome_email' => sub {
1151 my $branchcode = $builder->build({ source => "Branch"})->{branchcode};
1152 my $categorycode = $builder->build({ source => "Category", value => { category_type => 'A' } })->{categorycode};
1153 my $staff_categorycode = $builder->build({ source => "Category", value => { category_type => 'S' } })->{categorycode};
1154 my $csv_headers = 'surname,userid,branchcode,categorycode,password,email';
1155 my $csv_new = "Spagobi,EldridgeS,$branchcode,$categorycode,H4ckR".',me@myemail.com';
1156 my $defaults = { cardnumber => "" }; #currently all the defaults come as "" if not filled
1158 #Make the test files for importing
1159 my $filename_1 = make_csv($temp_dir, $csv_headers, $csv_new);
1160 open(my $handle_1, "<", $filename_1) or die "cannot open < $filename_1: $!";
1162 my $params_1 = { file => $handle_1, matchpoint => 'userid', overwrite_passwords => 1, overwrite_cardnumber => 1, send_welcome => 1};
1164 my $result = $patrons_import->import_patrons($params_1, $defaults);
1165 is($result->{already_in_db}, 0, 'New borrower imported as expected');
1166 is($result->{feedback}->[3]->{name}, 'welcome_sent', 'Email send reported');
1167 my $eldridge = Koha::Patrons->find({ userid => 'EldridgeS'});
1168 my $notices = Koha::Notice::Messages->search({ borrowernumber => $eldridge->borrowernumber });
1169 is($notices->count, 1, 'Notice was queued');
1172 # got is { code => $code, attribute => $attribute }
1173 # expected is { $code => \@attributes }
1174 sub compare_patron_attributes {
1175 my ( $got, $expected ) = @_;
1177 $got = [ map { { code => $_->{code}, attribute => $_->{attribute} } } @$got ];
1181 map { { code => $code, attribute => $_ } } @{ $expected->{$code} }
1184 for my $v ( $got, $expected ) {
1187 $a->{code} cmp $b->{code} || $a->{attribute} cmp $b->{attribute}
1191 is_deeply($got, $expected);
1194 # ###### Test utility ###########
1196 my ($temp_dir, @lines) = @_;
1198 my ($fh, $filename) = tempfile( DIR => $temp_dir) or die $!;
1199 print $fh $_."\r\n" foreach @lines;
1200 close $fh or die $!;