Bug 12787: Reorganise t/db_dependent files
[srvgit] / t / db_dependent / Reports / Guided.t
index 506acee..0e39710 100644 (file)
@@ -1,4 +1,5 @@
 # Copyright 2012 Catalyst IT Ltd.
+# Copyright 2015 Koha Development team
 #
 # This file is part of Koha.
 #
 # You should have received a copy of the GNU General Public License
 # along with Koha; if not, see <http://www.gnu.org/licenses>.
 
-use strict;
-use warnings;
+use Modern::Perl;
 
-use Test::More tests => 19;                      # last test to print
+use Test::More tests => 7;
+use Test::Warn;
+
+use t::lib::TestBuilder;
+use C4::Context;
+use Koha::Database;
 
 use_ok('C4::Reports::Guided');
+can_ok(
+    'C4::Reports::Guided',
+    qw(save_report delete_report execute_query)
+);
+
+my $schema = Koha::Database->new->schema;
+$schema->storage->txn_begin;
+my $builder = t::lib::TestBuilder->new;
 
-# This is the query I found that triggered bug 8594.
-my $sql = "SELECT aqorders.ordernumber, biblio.title, biblio.biblionumber, items.homebranch,
-    aqorders.entrydate, aqorders.datereceived,
-    (SELECT DATE(datetime) FROM statistics
-        WHERE itemnumber=items.itemnumber AND
-            (type='return' OR type='issue') LIMIT 1)
-    AS shelvedate,
-    DATEDIFF(COALESCE(
+subtest 'strip_limit' => sub {
+    # This is the query I found that triggered bug 8594.
+    my $sql = "SELECT aqorders.ordernumber, biblio.title, biblio.biblionumber, items.homebranch,
+        aqorders.entrydate, aqorders.datereceived,
         (SELECT DATE(datetime) FROM statistics
             WHERE itemnumber=items.itemnumber AND
-            (type='return' OR type='issue') LIMIT 1),
-    aqorders.datereceived), aqorders.entrydate) AS totaldays
-FROM aqorders
-LEFT JOIN biblio USING (biblionumber)
-LEFT JOIN items ON (items.biblionumber = biblio.biblionumber
-    AND dateaccessioned=aqorders.datereceived)
-WHERE (entrydate >= '2011-01-01' AND (datereceived < '2011-02-01' OR datereceived IS NULL))
-    AND items.homebranch LIKE 'INFO'
-ORDER BY title";
-
-my ($res_sql, $res_lim1, $res_lim2) = C4::Reports::Guided::strip_limit($sql);
-is($res_sql, $sql, "Not breaking subqueries");
-is($res_lim1, 0, "Returns correct default offset");
-is($res_lim2, undef, "Returns correct default LIMIT");
-
-# Now the same thing, but we want it to remove the LIMIT from the end
-
-my $test_sql = $res_sql . " LIMIT 242";
-($res_sql, $res_lim1, $res_lim2) = C4::Reports::Guided::strip_limit($test_sql);
-# The replacement drops a ' ' where the limit was
-is(trim($res_sql), $sql, "Correctly removes only final LIMIT");
-is($res_lim1, 0, "Returns correct default offset");
-is($res_lim2, 242, "Returns correct extracted LIMIT");
-
-$test_sql = $res_sql . " LIMIT 13,242";
-($res_sql, $res_lim1, $res_lim2) = C4::Reports::Guided::strip_limit($test_sql);
-# The replacement drops a ' ' where the limit was
-is(trim($res_sql), $sql, "Correctly removes only final LIMIT (with offset)");
-is($res_lim1, 13, "Returns correct extracted offset");
-is($res_lim2, 242, "Returns correct extracted LIMIT");
-
-# After here is the simpler case, where there isn't a WHERE clause to worry
-# about.
-
-# First case with nothing to change
-$sql = "SELECT * FROM items";
-($res_sql, $res_lim1, $res_lim2) = C4::Reports::Guided::strip_limit($sql);
-is($res_sql, $sql, "Not breaking simple queries");
-is($res_lim1, 0, "Returns correct default offset");
-is($res_lim2, undef, "Returns correct default LIMIT");
-
-$test_sql = $sql . " LIMIT 242";
-($res_sql, $res_lim1, $res_lim2) = C4::Reports::Guided::strip_limit($test_sql);
-is(trim($res_sql), $sql, "Correctly removes LIMIT in simple case");
-is($res_lim1, 0, "Returns correct default offset");
-is($res_lim2, 242, "Returns correct extracted LIMIT");
-
-$test_sql = $sql . " LIMIT 13,242";
-($res_sql, $res_lim1, $res_lim2) = C4::Reports::Guided::strip_limit($test_sql);
-is(trim($res_sql), $sql, "Correctly removes LIMIT in simple case (with offset)");
-is($res_lim1, 13, "Returns correct extracted offset");
-is($res_lim2, 242, "Returns correct extracted LIMIT");
+                (type='return' OR type='issue') LIMIT 1)
+        AS shelvedate,
+        DATEDIFF(COALESCE(
+            (SELECT DATE(datetime) FROM statistics
+                WHERE itemnumber=items.itemnumber AND
+                (type='return' OR type='issue') LIMIT 1),
+        aqorders.datereceived), aqorders.entrydate) AS totaldays
+    FROM aqorders
+    LEFT JOIN biblio USING (biblionumber)
+    LEFT JOIN items ON (items.biblionumber = biblio.biblionumber
+        AND dateaccessioned=aqorders.datereceived)
+    WHERE (entrydate >= '2011-01-01' AND (datereceived < '2011-02-01' OR datereceived IS NULL))
+        AND items.homebranch LIKE 'INFO'
+    ORDER BY title";
+
+    my ($res_sql, $res_lim1, $res_lim2) = C4::Reports::Guided::strip_limit($sql);
+    is($res_sql, $sql, "Not breaking subqueries");
+    is($res_lim1, 0, "Returns correct default offset");
+    is($res_lim2, undef, "Returns correct default LIMIT");
+
+    # Now the same thing, but we want it to remove the LIMIT from the end
+
+    my $test_sql = $res_sql . " LIMIT 242";
+    ($res_sql, $res_lim1, $res_lim2) = C4::Reports::Guided::strip_limit($test_sql);
+    # The replacement drops a ' ' where the limit was
+    is(trim($res_sql), $sql, "Correctly removes only final LIMIT");
+    is($res_lim1, 0, "Returns correct default offset");
+    is($res_lim2, 242, "Returns correct extracted LIMIT");
+
+    $test_sql = $res_sql . " LIMIT 13,242";
+    ($res_sql, $res_lim1, $res_lim2) = C4::Reports::Guided::strip_limit($test_sql);
+    # The replacement drops a ' ' where the limit was
+    is(trim($res_sql), $sql, "Correctly removes only final LIMIT (with offset)");
+    is($res_lim1, 13, "Returns correct extracted offset");
+    is($res_lim2, 242, "Returns correct extracted LIMIT");
+
+    # After here is the simpler case, where there isn't a WHERE clause to worry
+    # about.
+
+    # First case with nothing to change
+    $sql = "SELECT * FROM items";
+    ($res_sql, $res_lim1, $res_lim2) = C4::Reports::Guided::strip_limit($sql);
+    is($res_sql, $sql, "Not breaking simple queries");
+    is($res_lim1, 0, "Returns correct default offset");
+    is($res_lim2, undef, "Returns correct default LIMIT");
+
+    $test_sql = $sql . " LIMIT 242";
+    ($res_sql, $res_lim1, $res_lim2) = C4::Reports::Guided::strip_limit($test_sql);
+    is(trim($res_sql), $sql, "Correctly removes LIMIT in simple case");
+    is($res_lim1, 0, "Returns correct default offset");
+    is($res_lim2, 242, "Returns correct extracted LIMIT");
+
+    $test_sql = $sql . " LIMIT 13,242";
+    ($res_sql, $res_lim1, $res_lim2) = C4::Reports::Guided::strip_limit($test_sql);
+    is(trim($res_sql), $sql, "Correctly removes LIMIT in simple case (with offset)");
+    is($res_lim1, 13, "Returns correct extracted offset");
+    is($res_lim2, 242, "Returns correct extracted LIMIT");
+};
+
+$_->delete for Koha::AuthorisedValues->search({ category => 'XXX' });
+Koha::AuthorisedValue->new({category => 'LOC'})->store;
+
+subtest 'GetReservedAuthorisedValues' => sub {
+    plan tests => 1;
+    # This one will catch new reserved words not added
+    # to GetReservedAuthorisedValues
+    my %test_authval = (
+        'date' => 1,
+        'branches' => 1,
+        'itemtypes' => 1,
+        'cn_source' => 1,
+        'categorycode' => 1,
+        'biblio_framework' => 1,
+    );
+
+    my $reserved_authorised_values = GetReservedAuthorisedValues();
+    is_deeply(\%test_authval, $reserved_authorised_values,
+                'GetReservedAuthorisedValues returns a fixed list');
+};
+
+subtest 'IsAuthorisedValueValid' => sub {
+    plan tests => 8;
+    ok( IsAuthorisedValueValid('LOC'),
+        'User defined authorised value category is valid');
+
+    ok( ! IsAuthorisedValueValid('XXX'),
+        'Not defined authorised value category is invalid');
+
+    # Loop through the reserved authorised values
+    foreach my $authorised_value ( keys %{GetReservedAuthorisedValues()} ) {
+        ok( IsAuthorisedValueValid($authorised_value),
+            '\''.$authorised_value.'\' is a reserved word, and thus a valid authorised value');
+    }
+};
+
+subtest 'GetParametersFromSQL+ValidateSQLParameters' => sub  {
+    plan tests => 3;
+    my $test_query_1 = "
+        SELECT date_due
+        FROM old_issues
+        WHERE YEAR(timestamp) = <<Year|custom_list>> AND
+              branchcode = <<Branch|branches>> AND
+              borrowernumber = <<Borrower>>
+    ";
+
+    my @test_parameters_with_custom_list = (
+        { 'name' => 'Year', 'authval' => 'custom_list' },
+        { 'name' => 'Branch', 'authval' => 'branches' },
+        { 'name' => 'Borrower', 'authval' => undef }
+    );
+
+    is_deeply( GetParametersFromSQL($test_query_1), \@test_parameters_with_custom_list,
+        'SQL params are correctly parsed');
+
+    my @problematic_parameters = ();
+    push @problematic_parameters, { 'name' => 'Year', 'authval' => 'custom_list' };
+    is_deeply( ValidateSQLParameters( $test_query_1 ),
+               \@problematic_parameters,
+               '\'custom_list\' not a valid category' );
+
+    my $test_query_2 = "
+        SELECT date_due
+        FROM old_issues
+        WHERE YEAR(timestamp) = <<Year|date>> AND
+              branchcode = <<Branch|branches>> AND
+              borrowernumber = <<Borrower|LOC>>
+    ";
+
+    is_deeply( ValidateSQLParameters( $test_query_2 ),
+        [],
+        'All parameters valid, empty problematic authvals list'
+    );
+};
+
+subtest 'get_saved_reports' => sub {
+    plan tests => 16;
+    my $dbh = C4::Context->dbh;
+    $dbh->do(q|DELETE FROM saved_sql|);
+    $dbh->do(q|DELETE FROM saved_reports|);
+
+    #Test save_report
+    my $count = scalar @{ get_saved_reports() };
+    is( $count, 0, "There is no report" );
+
+    my @report_ids;
+    foreach ( 1..3 ) {
+        my $id = $builder->build({ source => 'Borrower' })->{ borrowernumber };
+        push @report_ids, save_report({
+            borrowernumber => $id,
+            sql            => "SQL$id",
+            name           => "Name$id",
+            area           => "area$id",
+            group          => "group$id",
+            subgroup       => "subgroup$id",
+            type           => "type$id",
+            notes          => "note$id",
+            cache_expiry   => "null",
+            public         => "null"
+        });
+        $count++;
+    }
+    like( $report_ids[0], '/^\d+$/', "Save_report returns an id for first" );
+    like( $report_ids[1], '/^\d+$/', "Save_report returns an id for second" );
+    like( $report_ids[2], '/^\d+$/', "Save_report returns an id for third" );
+
+    is( scalar @{ get_saved_reports() },
+        $count, "$count reports have been added" );
+
+    is( scalar @{ get_saved_reports( $report_ids[0] ) },
+        1, "filter takes report id" );
+
+    #Test delete_report
+    is (delete_report(),undef, "Without id delete_report returns undef");
+
+    is( delete_report( $report_ids[0] ), 1, "report 1 is deleted" );
+    $count--;
+
+    is( scalar @{ get_saved_reports() }, $count, "Report1 has been deleted" );
+
+    is( delete_report( $report_ids[1], $report_ids[2] ), 2, "report 2 and 3 are deleted" );
+    $count -= 2;
+
+    is( scalar @{ get_saved_reports() },
+        $count, "Report2 and report3 have been deleted" );
+
+    my $sth = execute_query('SELECT COUNT(*) FROM systempreferences', 0, 10);
+    my $results = $sth->fetchall_arrayref;
+    is(scalar @$results, 1, 'running a query returned a result');
+
+    my $version = C4::Context->preference('Version');
+    $sth = execute_query(
+        'SELECT value FROM systempreferences WHERE variable = ?',
+        0,
+        10,
+        [ 'Version' ],
+    );
+    $results = $sth->fetchall_arrayref;
+    is_deeply(
+        $results,
+        [ [ $version ] ],
+        'running a query with a parameter returned the expected result'
+    );
+
+    # for next test, we want to let execute_query capture any SQL errors
+    $dbh->{RaiseError} = 0;
+    my $errors;
+    warning_like { ($sth, $errors) = execute_query(
+            'SELECT surname FRM borrowers',  # error in the query is intentional
+            0, 10 ) }
+            qr/^DBD::mysql::st execute failed: You have an error in your SQL syntax;/,
+            "Wrong SQL syntax raises warning";
+    ok(
+        defined($errors) && exists($errors->{queryerr}),
+        'attempting to run a report with an SQL syntax error returns error message (Bug 12214)'
+    );
+
+    is_deeply( get_report_areas(), [ 'CIRC', 'CAT', 'PAT', 'ACQ', 'ACC', 'SER' ],
+        "get_report_areas returns the correct array of report areas");
+};
+
+$schema->storage->txn_rollback;
 
 sub trim {
     my ($s) = @_;