Bug 11425: Add unit tests

package Koha::Item::Search::Field
function C4::SQLHelper::GetColumns
function C4::Items::SearchItems

Signed-off-by: Bernardo Gonzalez Kriegel <bgkriegel@gmail.com>
Tests run without error

Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>

C4/Items.pm

@@ -2689,12 +2689,13 @@ sub _SearchItems_build_where_fragment {
 
 =head2 SearchItems
 
-    my ($items, $total) = SearchItemsByField($filters, $params);
+    my ($items, $total) = SearchItems($filter, $params);
 
 Perform a search among items
 
-$filters is a reference to an array of filters, where each filter is a hash with
-the following keys:
+$filter is a reference to a hash which can be a filter, or a combination of filters.
+
+A filter has the following keys:
 
 =over 2
 
@@ -2706,7 +2707,15 @@ the following keys:
 
 =back
 
-A logical AND is used to combine filters.
+A combination of filters hash the following keys:
+
+=over 2
+
+=item * conjunction: 'AND' or 'OR'
+
+=item * filters: array ref of filters
+
+=back
 
 $params is a reference to a hash that can contain the following parameters:
 

Koha/Item/Search/Field.pm

@@ -19,6 +19,8 @@ sub AddItemSearchField {
     my ( $name, $label, $tagfield, $tagsubfield, $av_category ) =
       @$field{qw(name label tagfield tagsubfield authorised_values_category)};
 
+    return unless ($name and $label and $tagfield);
+
     my $dbh = C4::Context->dbh;
     my $query = q{
         INSERT INTO items_search_fields (name, label, tagfield, tagsubfield, authorised_values_category)
@@ -36,6 +38,8 @@ sub ModItemSearchField {
     my ( $name, $label, $tagfield, $tagsubfield, $av_category ) =
       @$field{qw(name label tagfield tagsubfield authorised_values_category)};
 
+    return unless ($name and $label and $tagfield);
+
     my $dbh = C4::Context->dbh;
     my $query = q{
         UPDATE items_search_fields

t/db_dependent/Items.t

@@ -40,6 +40,8 @@ subtest 'General Add, Get and Del tests' => sub {
     $dbh->{RaiseError} = 1;
 
     # Create a biblio instance for testing
+    diag("Creating biblio instance for testing.");
+    C4::Context->set_preference('marcflavour', 'MARC21');
     my ($bibnum, $bibitemnum) = get_biblio();
 
     # Add an item.
@@ -76,8 +78,17 @@ subtest 'GetHiddenItemnumbers tests' => sub {
     $dbh->{RaiseError} = 1;
 
     # Create a new biblio
+    C4::Context->set_preference('marcflavour', 'MARC21');
     my ($biblionumber, $biblioitemnumber) = get_biblio();
 
+    # Add branches if they don't exist
+    if (not defined GetBranchDetail('CPL')) {
+        ModBranch({add => 1, branchcode => 'CPL', branchname => 'Centerville'});
+    }
+    if (not defined GetBranchDetail('MPL')) {
+        ModBranch({add => 1, branchcode => 'MPL', branchname => 'Midway'});
+    }
+
     # Add two items
     my ($item1_bibnum, $item1_bibitemnum, $item1_itemnumber) = AddItem(
             { homebranch => 'CPL',
@@ -213,6 +224,118 @@ subtest q{Test Koha::Database->schema()->resultset('Item')->itemtype()} => sub {
     C4::Context->set_preference( 'item-level_itypes', 1 );
     ok( $item->effective_itemtype() eq 'ITEM_LEVEL', '$item->itemtype() returns items.itype when item-level_itypes is disabled' );
 
+    $dbh->rollback;
+};
+
+subtest 'SearchItems test' => sub {
+    plan tests => 10;
+
+    # Start transaction
+    $dbh->{AutoCommit} = 0;
+    $dbh->{RaiseError} = 1;
+
+    C4::Context->set_preference('marcflavour', 'MARC21');
+    my ($biblionumber) = get_biblio();
+
+    # Add branches if they don't exist
+    if (not defined GetBranchDetail('CPL')) {
+        ModBranch({add => 1, branchcode => 'CPL', branchname => 'Centerville'});
+    }
+    if (not defined GetBranchDetail('MPL')) {
+        ModBranch({add => 1, branchcode => 'MPL', branchname => 'Midway'});
+    }
+
+    my (undef, $initial_items_count) = SearchItems(undef, {rows => 1});
+
+    # Add two items
+    my (undef, undef, $item1_itemnumber) = AddItem({
+        homebranch => 'CPL',
+        holdingbranch => 'CPL',
+    }, $biblionumber);
+    my (undef, undef, $item2_itemnumber) = AddItem({
+        homebranch => 'MPL',
+        holdingbranch => 'MPL',
+    }, $biblionumber);
+
+    my ($items, $total_results);
+
+    ($items, $total_results) = SearchItems();
+    is($total_results, $initial_items_count + 2, "Created 2 new items");
+    is(scalar @$items, $total_results, "SearchItems() returns all items");
+
+    ($items, $total_results) = SearchItems(undef, {rows => 1});
+    is($total_results, $initial_items_count + 2);
+    is(scalar @$items, 1, "SearchItems(undef, {rows => 1}) returns only 1 item");
+
+    # Search all items where homebranch = 'CPL'
+    my $filter = {
+        field => 'homebranch',
+        query => 'CPL',
+        operator => '=',
+    };
+    ($items, $total_results) = SearchItems($filter);
+    ok($total_results > 0, "There is at least one CPL item");
+    my $all_items_are_CPL = 1;
+    foreach my $item (@$items) {
+        if ($item->{homebranch} ne 'CPL') {
+            $all_items_are_CPL = 0;
+            last;
+        }
+    }
+    ok($all_items_are_CPL, "All items returned by SearchItems are from CPL");
+
+    # Search all items where homebranch != 'CPL'
+    $filter = {
+        field => 'homebranch',
+        query => 'CPL',
+        operator => '!=',
+    };
+    ($items, $total_results) = SearchItems($filter);
+    ok($total_results > 0, "There is at least one non-CPL item");
+    my $all_items_are_not_CPL = 1;
+    foreach my $item (@$items) {
+        if ($item->{homebranch} eq 'CPL') {
+            $all_items_are_not_CPL = 0;
+            last;
+        }
+    }
+    ok($all_items_are_not_CPL, "All items returned by SearchItems are not from CPL");
+
+    # Search all items where biblio title (245$a) is like 'Silence in the %'
+    $filter = {
+        field => 'marc:245$a',
+        query => 'Silence in the %',
+        operator => 'like',
+    };
+    ($items, $total_results) = SearchItems($filter);
+    ok($total_results >= 2, "There is at least 2 items with a biblio title like 'Silence in the %'");
+
+    # Search all items where biblio title is 'Silence in the library'
+    # and homebranch is 'CPL'
+    $filter = {
+        conjunction => 'AND',
+        filters => [
+            {
+                field => 'marc:245$a',
+                query => 'Silence in the %',
+                operator => 'like',
+            },
+            {
+                field => 'homebranch',
+                query => 'CPL',
+                operator => '=',
+            },
+        ],
+    };
+    ($items, $total_results) = SearchItems($filter);
+    my $found = 0;
+    foreach my $item (@$items) {
+        if ($item->{itemnumber} == $item1_itemnumber) {
+            $found = 1;
+            last;
+        }
+    }
+    ok($found, "item1 found");
 
     $dbh->rollback;
 };

t/db_dependent/Koha/Item/Search/Field.t

@@ -0,0 +1,39 @@
+#!/usr/bin/perl
+
+use Modern::Perl;
+use Test::More tests => 11;
+
+use C4::Context;
+
+use_ok('Koha::Item::Search::Field');
+import Koha::Item::Search::Field qw(AddItemSearchField ModItemSearchField
+    DelItemSearchField GetItemSearchField GetItemSearchFields);
+
+my $dbh = C4::Context->dbh;
+$dbh->{AutoCommit} = 0;
+
+# Start with empty table.
+foreach my $field (GetItemSearchFields()) {
+    DelItemSearchField($field->{name});
+}
+is(scalar GetItemSearchFields(), 0, "No existing search field");
+
+# Missing keys in hashref parameter, so returns undef
+ok(not (defined AddItemSearchField()), "missing keys => fail");
+ok(not (defined AddItemSearchField({})), "missing keys => fail");
+ok(not (defined AddItemSearchField({name => 'foo'})), "missing keys => fail");
+ok(not (defined AddItemSearchField({name => 'foo', label => 'Foo'})), "missing keys => fail");
+
+# Success, the field hashref is returned
+ok('HASH' eq ref AddItemSearchField({name => 'foo', label => 'Foo', tagfield => '001'}), "successful add");
+
+# Check the table now contains one row.
+is(scalar GetItemSearchFields(), 1, "Table now contains one row");
+my $field = GetItemSearchField('foo');
+is_deeply($field, {name => 'foo', label => 'Foo', tagfield => '001', tagsubfield => undef, authorised_values_category => undef});
+
+ok((defined ModItemSearchField({name => 'foo', label => 'Foobar', tagfield => '100', 'tagsubfield' => 'a'})), "successful mod");
+$field = GetItemSearchField('foo');
+is_deeply($field, {name => 'foo', label => 'Foobar', tagfield => '100', tagsubfield => 'a', authorised_values_category => undef});
+
+$dbh->rollback;

t/db_dependent/SQLHelper.t

@@ -10,7 +10,7 @@ use YAML;
 use C4::Debug;
 use C4::SQLHelper qw(:all);
 
-use Test::More tests => 20;
+use Test::More tests => 21;
 
 use_ok('C4::SQLHelper');
 
@@ -63,3 +63,8 @@ $status=DeleteInTable("borrowers",{borrowernumber=>$borrtmp});
 ok($status>0 && !($@), "DeleteInTable OK");
 $status=DeleteInTable("branches", {branchcode => 'ZZZZ'});
 ok($status>0 && !($@), "DeleteInTable (branch) OK");
+
+my @biblio_columns = C4::SQLHelper::GetColumns('biblio');
+my @expected_columns = qw(biblionumber frameworkcode author title unititle notes
+    serial seriestitle copyrightdate timestamp datecreated abstract);
+is_deeply([sort @biblio_columns], [sort @expected_columns], "GetColumns('biblio') returns all columns of biblio table");