1 # Copyright 2012 Catalyst IT Ltd.
2 # Copyright 2015 Koha Development team
4 # This file is part of Koha.
6 # Koha is free software; you can redistribute it and/or modify it
7 # under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 3 of the License, or
9 # (at your option) any later version.
11 # Koha is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with Koha; if not, see <http://www.gnu.org/licenses>.
21 use Test::More tests => 11;
24 use t::lib::TestBuilder;
29 use Koha::Notice::Messages;
31 use_ok('C4::Reports::Guided');
33 'C4::Reports::Guided',
34 qw(save_report delete_report execute_query)
37 my $schema = Koha::Database->new->schema;
38 $schema->storage->txn_begin;
39 my $builder = t::lib::TestBuilder->new;
41 subtest 'strip_limit' => sub {
42 # This is the query I found that triggered bug 8594.
43 my $sql = "SELECT aqorders.ordernumber, biblio.title, biblio.biblionumber, items.homebranch,
44 aqorders.entrydate, aqorders.datereceived,
45 (SELECT DATE(datetime) FROM statistics
46 WHERE itemnumber=items.itemnumber AND
47 (type='return' OR type='issue') LIMIT 1)
50 (SELECT DATE(datetime) FROM statistics
51 WHERE itemnumber=items.itemnumber AND
52 (type='return' OR type='issue') LIMIT 1),
53 aqorders.datereceived), aqorders.entrydate) AS totaldays
55 LEFT JOIN biblio USING (biblionumber)
56 LEFT JOIN items ON (items.biblionumber = biblio.biblionumber
57 AND dateaccessioned=aqorders.datereceived)
58 WHERE (entrydate >= '2011-01-01' AND (datereceived < '2011-02-01' OR datereceived IS NULL))
59 AND items.homebranch LIKE 'INFO'
62 my ($res_sql, $res_lim1, $res_lim2) = C4::Reports::Guided::strip_limit($sql);
63 is($res_sql, $sql, "Not breaking subqueries");
64 is($res_lim1, 0, "Returns correct default offset");
65 is($res_lim2, undef, "Returns correct default LIMIT");
67 # Now the same thing, but we want it to remove the LIMIT from the end
69 my $test_sql = $res_sql . " LIMIT 242";
70 ($res_sql, $res_lim1, $res_lim2) = C4::Reports::Guided::strip_limit($test_sql);
71 # The replacement drops a ' ' where the limit was
72 is(trim($res_sql), $sql, "Correctly removes only final LIMIT");
73 is($res_lim1, 0, "Returns correct default offset");
74 is($res_lim2, 242, "Returns correct extracted LIMIT");
76 $test_sql = $res_sql . " LIMIT 13,242";
77 ($res_sql, $res_lim1, $res_lim2) = C4::Reports::Guided::strip_limit($test_sql);
78 # The replacement drops a ' ' where the limit was
79 is(trim($res_sql), $sql, "Correctly removes only final LIMIT (with offset)");
80 is($res_lim1, 13, "Returns correct extracted offset");
81 is($res_lim2, 242, "Returns correct extracted LIMIT");
83 # After here is the simpler case, where there isn't a WHERE clause to worry
86 # First case with nothing to change
87 $sql = "SELECT * FROM items";
88 ($res_sql, $res_lim1, $res_lim2) = C4::Reports::Guided::strip_limit($sql);
89 is($res_sql, $sql, "Not breaking simple queries");
90 is($res_lim1, 0, "Returns correct default offset");
91 is($res_lim2, undef, "Returns correct default LIMIT");
93 $test_sql = $sql . " LIMIT 242";
94 ($res_sql, $res_lim1, $res_lim2) = C4::Reports::Guided::strip_limit($test_sql);
95 is(trim($res_sql), $sql, "Correctly removes LIMIT in simple case");
96 is($res_lim1, 0, "Returns correct default offset");
97 is($res_lim2, 242, "Returns correct extracted LIMIT");
99 $test_sql = $sql . " LIMIT 13,242";
100 ($res_sql, $res_lim1, $res_lim2) = C4::Reports::Guided::strip_limit($test_sql);
101 is(trim($res_sql), $sql, "Correctly removes LIMIT in simple case (with offset)");
102 is($res_lim1, 13, "Returns correct extracted offset");
103 is($res_lim2, 242, "Returns correct extracted LIMIT");
106 $_->delete for Koha::AuthorisedValues->search({ category => 'XXX' });
107 Koha::AuthorisedValue->new({category => 'LOC'})->store;
109 subtest 'GetReservedAuthorisedValues' => sub {
111 # This one will catch new reserved words not added
112 # to GetReservedAuthorisedValues
119 'biblio_framework' => 1,
122 my $reserved_authorised_values = GetReservedAuthorisedValues();
123 is_deeply(\%test_authval, $reserved_authorised_values,
124 'GetReservedAuthorisedValues returns a fixed list');
127 subtest 'IsAuthorisedValueValid' => sub {
129 ok( IsAuthorisedValueValid('LOC'),
130 'User defined authorised value category is valid');
132 ok( ! IsAuthorisedValueValid('XXX'),
133 'Not defined authorised value category is invalid');
135 # Loop through the reserved authorised values
136 foreach my $authorised_value ( keys %{GetReservedAuthorisedValues()} ) {
137 ok( IsAuthorisedValueValid($authorised_value),
138 '\''.$authorised_value.'\' is a reserved word, and thus a valid authorised value');
142 subtest 'GetParametersFromSQL+ValidateSQLParameters' => sub {
147 WHERE YEAR(timestamp) = <<Year|custom_list>> AND
148 branchcode = <<Branch|branches>> AND
149 borrowernumber = <<Borrower>> AND
150 itemtype = <<Item type|itemtypes:all>>
153 my @test_parameters_with_custom_list = (
154 { 'name' => 'Year', 'authval' => 'custom_list' },
155 { 'name' => 'Branch', 'authval' => 'branches' },
156 { 'name' => 'Borrower', 'authval' => undef },
157 { 'name' => 'Item type', 'authval' => 'itemtypes' }
160 is_deeply( GetParametersFromSQL($test_query_1), \@test_parameters_with_custom_list,
161 'SQL params are correctly parsed');
163 my @problematic_parameters = ();
164 push @problematic_parameters, { 'name' => 'Year', 'authval' => 'custom_list' };
165 is_deeply( ValidateSQLParameters( $test_query_1 ),
166 \@problematic_parameters,
167 '\'custom_list\' not a valid category' );
172 WHERE YEAR(timestamp) = <<Year|date>> AND
173 branchcode = <<Branch|branches>> AND
174 borrowernumber = <<Borrower|LOC>>
177 is_deeply( ValidateSQLParameters( $test_query_2 ),
179 'All parameters valid, empty problematic authvals list'
183 subtest 'get_saved_reports' => sub {
185 my $dbh = C4::Context->dbh;
186 $dbh->do(q|DELETE FROM saved_sql|);
187 $dbh->do(q|DELETE FROM saved_reports|);
190 my $count = scalar @{ get_saved_reports() };
191 is( $count, 0, "There is no report" );
194 foreach my $ii ( 1..3 ) {
195 my $id = $builder->build({ source => 'Borrower' })->{ borrowernumber };
196 push @report_ids, save_report({
197 borrowernumber => $id,
200 area => "area$ii", # ii vs id area is varchar(6)
202 subgroup => "subgroup$id",
205 cache_expiry => undef,
210 like( $report_ids[0], '/^\d+$/', "Save_report returns an id for first" );
211 like( $report_ids[1], '/^\d+$/', "Save_report returns an id for second" );
212 like( $report_ids[2], '/^\d+$/', "Save_report returns an id for third" );
214 is( scalar @{ get_saved_reports() },
215 $count, "$count reports have been added" );
217 ok( 0 < scalar @{ get_saved_reports( $report_ids[0] ) }, "filter takes report id" );
220 is (delete_report(),undef, "Without id delete_report returns undef");
222 is( delete_report( $report_ids[0] ), 1, "report 1 is deleted" );
225 is( scalar @{ get_saved_reports() }, $count, "Report1 has been deleted" );
227 is( delete_report( $report_ids[1], $report_ids[2] ), 2, "report 2 and 3 are deleted" );
230 is( scalar @{ get_saved_reports() },
231 $count, "Report2 and report3 have been deleted" );
233 my $sth = execute_query('SELECT COUNT(*) FROM systempreferences', 0, 10);
234 my $results = $sth->fetchall_arrayref;
235 is(scalar @$results, 1, 'running a query returned a result');
237 my $version = C4::Context->preference('Version');
238 $sth = execute_query(
239 'SELECT value FROM systempreferences WHERE variable = ?',
244 $results = $sth->fetchall_arrayref;
248 'running a query with a parameter returned the expected result'
251 # for next test, we want to let execute_query capture any SQL errors
252 $dbh->{RaiseError} = 0;
254 warning_like { ($sth, $errors) = execute_query(
255 'SELECT surname FRM borrowers', # error in the query is intentional
257 qr/^DBD::mysql::st execute failed: You have an error in your SQL syntax;/,
258 "Wrong SQL syntax raises warning";
260 defined($errors) && exists($errors->{queryerr}),
261 'attempting to run a report with an SQL syntax error returns error message (Bug 12214)'
264 is_deeply( get_report_areas(), [ 'CIRC', 'CAT', 'PAT', 'ACQ', 'ACC', 'SER' ],
265 "get_report_areas returns the correct array of report areas");
268 subtest 'Ensure last_run is populated' => sub {
271 my $rs = Koha::Database->new()->schema()->resultset('SavedSql');
273 my $report = $rs->new(
275 report_name => 'Test Report',
276 savedsql => 'SELECT * FROM branches',
281 is( $report->last_run, undef, 'Newly created report has null last_run ' );
283 execute_query( $report->savedsql, undef, undef, undef, $report->id );
284 $report->discard_changes();
286 isnt( $report->last_run, undef, 'First run of report populates last_run' );
288 my $previous_last_run = $report->last_run;
289 sleep(1); # last_run is stored to the second, so we need to ensure at least one second has passed between runs
290 execute_query( $report->savedsql, undef, undef, undef, $report->id );
291 $report->discard_changes();
293 isnt( $report->last_run, $previous_last_run, 'Second run of report updates last_run' );
296 subtest 'convert_sql' => sub {
300 SELECT biblionumber, ExtractValue(marcxml,
301 'count(//datafield[@tag="505"])') AS count505
303 HAVING count505 > 1|;
304 my $expected_converted_sql = q|
305 SELECT biblionumber, ExtractValue(metadata,
306 'count(//datafield[@tag="505"])') AS count505
308 HAVING count505 > 1|;
310 is( C4::Reports::Guided::convert_sql( $sql ), $expected_converted_sql, "Simple query should have been correctly converted");
313 SELECT biblionumber, substring(
314 ExtractValue(marcxml,'//controlfield[@tag="008"]'), 8,4 ) AS 'PUB DATE',
317 INNER JOIN biblio USING (biblionumber)
318 WHERE biblionumber = 14|;
320 $expected_converted_sql = q|
321 SELECT biblionumber, substring(
322 ExtractValue(metadata,'//controlfield[@tag="008"]'), 8,4 ) AS 'PUB DATE',
325 INNER JOIN biblio USING (biblionumber)
326 WHERE biblionumber = 14|;
327 is( C4::Reports::Guided::convert_sql( $sql ), $expected_converted_sql, "Query with biblio info should have been correctly converted");
330 SELECT concat(b.title, ' ', ExtractValue(m.marcxml,
331 '//datafield[@tag="245"]/subfield[@code="b"]')) AS title, b.author,
332 count(h.reservedate) AS 'holds'
334 LEFT JOIN biblioitems m USING (biblionumber)
335 LEFT JOIN reserves h ON (b.biblionumber=h.biblionumber)
336 GROUP BY b.biblionumber
337 HAVING count(h.reservedate) >= 42|;
339 $expected_converted_sql = q|
340 SELECT concat(b.title, ' ', ExtractValue(m.metadata,
341 '//datafield[@tag="245"]/subfield[@code="b"]')) AS title, b.author,
342 count(h.reservedate) AS 'holds'
344 LEFT JOIN biblio_metadata m USING (biblionumber)
345 LEFT JOIN reserves h ON (b.biblionumber=h.biblionumber)
346 GROUP BY b.biblionumber
347 HAVING count(h.reservedate) >= 42|;
348 is( C4::Reports::Guided::convert_sql( $sql ), $expected_converted_sql, "Query with 2 joins should have been correctly converted");
351 SELECT t1.marcxml AS first, t2.marcxml AS second,
353 LEFT JOIN biblioitems t2 USING ( biblionumber )|;
355 $expected_converted_sql = q|
356 SELECT t1.metadata AS first, t2.metadata AS second,
357 FROM biblio_metadata t1
358 LEFT JOIN biblio_metadata t2 USING ( biblionumber )|;
359 is( C4::Reports::Guided::convert_sql( $sql ), $expected_converted_sql, "Query with multiple instances of marcxml and biblioitems should have them all replaced");
362 subtest 'Email report test' => sub {
366 my $id1 = $builder->build({ source => 'Borrower',value => { surname => 'mailer', email => 'a@b.com' } })->{ borrowernumber };
367 my $id2 = $builder->build({ source => 'Borrower',value => { surname => 'nomailer', email => undef } })->{ borrowernumber };
368 my $id3 = $builder->build({ source => 'Borrower',value => { surname => 'norman', email => 'a@b.com' } })->{ borrowernumber };
369 my $report1 = $builder->build({ source => 'SavedSql', value => { savedsql => "SELECT surname,borrowernumber,email FROM borrowers WHERE borrowernumber IN ($id1,$id2,$id3)" } })->{ id };
370 my $report2 = $builder->build({ source => 'SavedSql', value => { savedsql => "SELECT potato FROM mashed" } })->{ id };
372 my $letter1 = $builder->build({
375 content => "[% surname %]",
377 message_transport_type => 'email'
380 my $letter2 = $builder->build({
383 content => "[% firstname %]",
385 message_transport_type => 'email'
389 my $message_count = Koha::Notice::Messages->search({})->count;
391 my ( $emails, $errors ) = C4::Reports::Guided::EmailReport();
392 is( $errors->[0]{FATAL}, 'MISSING_PARAMS', "Need to enter required params");
394 ($emails, $errors ) = C4::Reports::Guided::EmailReport({report_id => $report1, module => $letter1->{module}, code => $letter2->{code}});
395 is( $errors->[0]{FATAL}, 'NO_LETTER', "Must have a letter that exists");
397 warning_like { ($emails, $errors ) = C4::Reports::Guided::EmailReport({report_id => $report2, module => $letter1->{module} , code => $letter1->{code} }) }
398 qr/^DBD::mysql::st execute failed/,
399 'Error from bad report';
400 is( $errors->[0]{FATAL}, 'REPORT_FAIL', "Bad report returns failure");
402 ($emails, $errors ) = C4::Reports::Guided::EmailReport({report_id => $report1, module => $letter1->{module} , code => $letter1->{code} });
403 is( $errors->[0]{NO_FROM_COL} == 1 && $errors->[1]{NO_EMAIL_COL} == 2 && $errors->[2]{NO_FROM_COL} == 2, 1, "Correct warnings from the routine");
405 ($emails, $errors ) = C4::Reports::Guided::EmailReport({report_id => $report1, module => $letter1->{module} , code => $letter1->{code}, from => 'the@future.ooh' });
406 is( $errors->[0]{NO_EMAIL_COL}, 2, "Warning only for patron with no email");
408 is( $message_count, Koha::Notice::Messages->search({})->count, "Messages not added without commit");
410 ($emails, $errors ) = C4::Reports::Guided::EmailReport({report_id => $report1, module => $letter1->{module} , code => $letter1->{code}, from => 'the@future.ooh' });
411 is( $emails->[0]{letter}->{content}, "mailer", "Message has expected content");
412 is( $emails->[1]{letter}->{content}, "norman", "Message has expected content");
416 $schema->storage->txn_rollback;
418 subtest 'nb_rows() tests' => sub {
422 $schema->storage->txn_begin;
424 my $items_count = Koha::Items->search->count;
425 $builder->build_object({ class => 'Koha::Items' });
426 $builder->build_object({ class => 'Koha::Items' });
430 SELECT * FROM items xxx
433 my $nb_rows = nb_rows( $query );
435 is( $nb_rows, $items_count, 'nb_rows returns the right value' );
442 { $nb_rows = nb_rows( $bad_query ) }
443 qr/^DBD::mysql::st execute failed:/,
444 'Bad queries raise a warning';
446 is( $nb_rows, 0, 'nb_rows returns 0 on bad queries' );
448 $schema->storage->txn_rollback;
453 $s =~ s/^\s*(.*?)\s*$/$1/s;