Koha/t/db_dependent/Utils/Datatables_Members.t
Nick Clemens 65ed212fae Bug 14874 - Add ability to search for patrons by date of birth from checkout and patron quick searches
This patch adds a new syspef 'DefaultPatronSearchFields' which defines
the fields that should be used when searching for a patron if none are
defined.

To test:
1 - Aply patch, updatedatabase
2 - Ensure patron search has not changed
3 - Add dateofbirth to new pref
4 - Ensure things work wll
5 - Experiment with adding and removing other fields from borrowers
table
6 - prove t/db_dependent/Utils/Datatables_Members.t

Tested together with followup. Works as described.
Signed-off-by: Marc Véron <veron@veron.ch>

Bug 14874 (QA Followup)

    Fix atomicupdate file name

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>

Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
2016-10-27 13:21:13 +00:00

435 lines
14 KiB
Perl

#!/usr/bin/perl
# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# Koha is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Koha; if not, see <http://www.gnu.org/licenses>.
use Modern::Perl;
use Test::More tests => 49;
use C4::Context;
use C4::Members;
use C4::Members::Attributes;
use C4::Members::AttributeTypes;
use Koha::Library;
use Koha::Patron::Categories;
use t::lib::Mocks;
use t::lib::TestBuilder;
use Koha::Database;
use_ok( "C4::Utils::DataTables::Members" );
my $schema = Koha::Database->new->schema;
$schema->storage->txn_begin;
my $builder = t::lib::TestBuilder->new;
my $library = $builder->build({
source => "Branch",
});
my $branchcode=$library->{branchcode};
my $john_doe = $builder->build({
source => "Borrower",
value => {
cardnumber => '123456',
firstname => 'John',
surname => 'Doe',
branchcode => $branchcode,
dateofbirth => '1983-03-01',
userid => 'john.doe'
},
});
my $john_smith = $builder->build({
source => "Borrower",
value => {
cardnumber => '234567',
firstname => 'John',
surname => 'Smith',
branchcode => $branchcode,
dateofbirth => '1982-02-01',
userid => 'john.smith'
},
});
my $jane_doe = $builder->build({
source => "Borrower",
value => {
cardnumber => '345678',
firstname => 'Jane',
surname => 'Doe',
branchcode => $branchcode,
dateofbirth => '1983-03-01',
userid => 'jane.doe'
},
});
my $jeanpaul_dupont = $builder->build({
source => "Borrower",
value => {
cardnumber => '456789',
firstname => 'Jean Paul',
surname => 'Dupont',
branchcode => $branchcode,
dateofbirth => '1982-02-01',
userid => 'jeanpaul.dupont'
},
});
my $dupont_brown = $builder->build({
source => "Borrower",
value => {
cardnumber => '567890',
firstname => 'Dupont',
surname => 'Brown',
branchcode => $branchcode,
dateofbirth => '1979-01-01',
userid => 'dupont.brown'
},
});
# Set common datatables params
my %dt_params = (
iDisplayLength => 10,
iDisplayStart => 0
);
# Search "John Doe"
my $search_results = C4::Utils::DataTables::Members::search({
searchmember => "John Doe",
searchfieldstype => 'standard',
searchtype => 'contain',
branchcode => $branchcode,
dt_params => \%dt_params
});
is( $search_results->{ iTotalDisplayRecords }, 1,
"John Doe has only one match on $branchcode (Bug 12595)");
ok( $search_results->{ patrons }[0]->{ cardnumber } eq $john_doe->{ cardnumber }
&& ! $search_results->{ patrons }[1],
"John Doe is the only match (Bug 12595)");
# Search "Jane Doe"
$search_results = C4::Utils::DataTables::Members::search({
searchmember => "Jane Doe",
searchfieldstype => 'standard',
searchtype => 'contain',
branchcode => $branchcode,
dt_params => \%dt_params
});
is( $search_results->{ iTotalDisplayRecords }, 1,
"Jane Doe has only one match on $branchcode (Bug 12595)");
is( $search_results->{ patrons }[0]->{ cardnumber },
$jane_doe->{ cardnumber },
"Jane Doe is the only match (Bug 12595)");
# Search "John"
$search_results = C4::Utils::DataTables::Members::search({
searchmember => "John",
searchfieldstype => 'standard',
searchtype => 'contain',
branchcode => $branchcode,
dt_params => \%dt_params
});
is( $search_results->{ iTotalDisplayRecords }, 2,
"There are two John at $branchcode");
is( $search_results->{ patrons }[0]->{ cardnumber },
$john_doe->{ cardnumber },
"John Doe is the first result");
is( $search_results->{ patrons }[1]->{ cardnumber },
$john_smith->{ cardnumber },
"John Smith is the second result");
# Search "Doe"
$search_results = C4::Utils::DataTables::Members::search({
searchmember => "Doe",
searchfieldstype => 'standard',
searchtype => 'contain',
branchcode => $branchcode,
dt_params => \%dt_params
});
is( $search_results->{ iTotalDisplayRecords }, 2,
"There are two Doe at $branchcode");
is( $search_results->{ patrons }[0]->{ cardnumber },
$john_doe->{ cardnumber },
"John Doe is the first result");
is( $search_results->{ patrons }[1]->{ cardnumber },
$jane_doe->{ cardnumber },
"Jane Doe is the second result");
# Search "Smith" as surname - there is only one occurrence of Smith
$search_results = C4::Utils::DataTables::Members::search({
searchmember => "Smith",
searchfieldstype => 'surname',
searchtype => 'contain',
branchcode => $branchcode,
dt_params => \%dt_params
});
is( $search_results->{ iTotalDisplayRecords }, 1,
"There is one Smith at $branchcode when searching for surname");
is( $search_results->{ patrons }[0]->{ cardnumber },
$john_smith->{ cardnumber },
"John Smith is the first result");
# Search "Dupont" as surname - Dupont is used both as firstname and surname, we
# Should only fin d the user with Dupont as surname
$search_results = C4::Utils::DataTables::Members::search({
searchmember => "Dupont",
searchfieldstype => 'surname',
searchtype => 'contain',
branchcode => $branchcode,
dt_params => \%dt_params
});
is( $search_results->{ iTotalDisplayRecords }, 1,
"There is one Dupont at $branchcode when searching for surname");
is( $search_results->{ patrons }[0]->{ cardnumber },
$jeanpaul_dupont->{ cardnumber },
"Jean Paul Dupont is the first result");
# Search "Doe" as surname - Doe is used twice as surname
$search_results = C4::Utils::DataTables::Members::search({
searchmember => "Doe",
searchfieldstype => 'surname',
searchtype => 'contain',
branchcode => $branchcode,
dt_params => \%dt_params
});
is( $search_results->{ iTotalDisplayRecords }, 2,
"There are two Doe at $branchcode when searching for surname");
is( $search_results->{ patrons }[0]->{ cardnumber },
$john_doe->{ cardnumber },
"John Doe is the first result");
is( $search_results->{ patrons }[1]->{ cardnumber },
$jane_doe->{ cardnumber },
"Jane Doe is the second result");
# Search by userid
$search_results = C4::Utils::DataTables::Members::search({
searchmember => "john.doe",
searchfieldstype => 'standard',
searchtype => 'contain',
branchcode => $branchcode,
dt_params => \%dt_params
});
is( $search_results->{ iTotalDisplayRecords }, 1,
"John Doe is found by userid, standard search (Bug 14782)");
$search_results = C4::Utils::DataTables::Members::search({
searchmember => "john.doe",
searchfieldstype => 'userid',
searchtype => 'contain',
branchcode => $branchcode,
dt_params => \%dt_params
});
is( $search_results->{ iTotalDisplayRecords }, 1,
"John Doe is found by userid, userid search (Bug 14782)");
$search_results = C4::Utils::DataTables::Members::search({
searchmember => "john.doe",
searchfieldstype => 'surname',
searchtype => 'contain',
branchcode => $branchcode,
dt_params => \%dt_params
});
is( $search_results->{ iTotalDisplayRecords }, 0,
"No members are found by userid, surname search");
my $attribute_type = C4::Members::AttributeTypes->new( 'ATM_1', 'my attribute type' );
$attribute_type->{staff_searchable} = 1;
$attribute_type->store;
C4::Members::Attributes::SetBorrowerAttributes(
$john_doe->{borrowernumber}, [ { code => $attribute_type->{code}, value => 'the default value for a common user' } ]
);
C4::Members::Attributes::SetBorrowerAttributes(
$jane_doe->{borrowernumber}, [ { code => $attribute_type->{code}, value => 'the default value for another common user' } ]
);
t::lib::Mocks::mock_preference('ExtendedPatronAttributes', 1);
$search_results = C4::Utils::DataTables::Members::search({
searchmember => "common user",
searchfieldstype => 'standard',
searchtype => 'contain',
branchcode => $branchcode,
dt_params => \%dt_params
});
is( $search_results->{ iTotalDisplayRecords}, 2, "There are 2 common users" );
t::lib::Mocks::mock_preference('ExtendedPatronAttributes', 0);
$search_results = C4::Utils::DataTables::Members::search({
searchmember => "common user",
searchfieldstype => 'standard',
searchtype => 'contain',
branchcode => $branchcode,
dt_params => \%dt_params
});
is( $search_results->{ iTotalDisplayRecords}, 0, "There are still 2 common users, but the patron attribute is not searchable " );
$search_results = C4::Utils::DataTables::Members::search({
searchmember => "Jean Paul",
searchfieldstype => 'standard',
searchtype => 'start_with',
branchcode => $branchcode,
dt_params => \%dt_params
});
is( $search_results->{ iTotalDisplayRecords }, 1,
"Jean Paul Dupont is found using start with and two terms search 'Jean Paul' (Bug 15252)");
$search_results = C4::Utils::DataTables::Members::search({
searchmember => "Jean Pau",
searchfieldstype => 'standard',
searchtype => 'start_with',
branchcode => $branchcode,
dt_params => \%dt_params
});
is( $search_results->{ iTotalDisplayRecords }, 1,
"Jean Paul Dupont is found using start with and two terms search 'Jean Pau' (Bug 15252)");
$search_results = C4::Utils::DataTables::Members::search({
searchmember => "Jea Pau",
searchfieldstype => 'standard',
searchtype => 'start_with',
branchcode => $branchcode,
dt_params => \%dt_params
});
is( $search_results->{ iTotalDisplayRecords }, 0,
"Jean Paul Dupont is not found using start with and two terms search 'Jea Pau' (Bug 15252)");
$search_results = C4::Utils::DataTables::Members::search({
searchmember => "Jea Pau",
searchfieldstype => 'standard',
searchtype => 'contain',
branchcode => $branchcode,
dt_params => \%dt_params
});
is( $search_results->{ iTotalDisplayRecords }, 1,
"Jean Paul Dupont is found using contains and two terms search 'Jea Pau' (Bug 15252)");
my @datetimeprefs = ("dmydot","iso","metric","us");
my %dates_in_pref = (
dmydot => ["01.02.1982","01.03.1983","01.01.1979","01.01.1988"],
iso => ["1982-02-01","1983-03-01","1979-01-01","1988-01-01"],
metric => ["01/02/1982","01/03/1983","01/01/1979","01/01/1988"],
us => ["02/01/1982","03/01/1983","01/01/1979","01/01/1988"],
);
foreach my $dateformloo (@datetimeprefs){
t::lib::Mocks::mock_preference('dateformat', $dateformloo);
t::lib::Mocks::mock_preference('DefaultPatronSearchFields', 'surname,firstname,othernames,userid,dateofbirth');
$search_results = C4::Utils::DataTables::Members::search({
searchmember => $dates_in_pref{$dateformloo}[0],
searchfieldstype => 'standard',
searchtype => 'contain',
branchcode => $branchcode,
dt_params => \%dt_params
});
is( $search_results->{ iTotalDisplayRecords }, 2,
"dateformat: $dateformloo Two borrowers have dob $dates_in_pref{$dateformloo}[0], standard search fields plus dob works");
$search_results = C4::Utils::DataTables::Members::search({
searchmember => $dates_in_pref{$dateformloo}[2],
searchfieldstype => 'standard',
searchtype => 'contain',
branchcode => $branchcode,
dt_params => \%dt_params
});
is( $search_results->{ iTotalDisplayRecords }, 1,
"dateformat: $dateformloo One borrower has dob $dates_in_pref{$dateformloo}[2], standard search fields plus dob works");
$search_results = C4::Utils::DataTables::Members::search({
searchmember => $dates_in_pref{$dateformloo}[1],
searchfieldstype => 'dateofbirth',
searchtype => 'contain',
branchcode => $branchcode,
dt_params => \%dt_params
});
is( $search_results->{ iTotalDisplayRecords }, 2,
"dateformat: $dateformloo Two borrowers have dob $dates_in_pref{$dateformloo}[1], dateofbirth search field works");
$search_results = C4::Utils::DataTables::Members::search({
searchmember => $dates_in_pref{$dateformloo}[3],
searchfieldstype => 'dateofbirth',
searchtype => 'contain',
branchcode => $branchcode,
dt_params => \%dt_params
});
is( $search_results->{ iTotalDisplayRecords }, 0,
"dateformat: $dateformloo No borrowers have dob $dates_in_pref{$dateformloo}[3], dateofbirth search field works");
$search_results = C4::Utils::DataTables::Members::search({
searchmember => $dates_in_pref{$dateformloo}[3],
searchfieldstype => 'standard',
searchtype => 'contain',
branchcode => $branchcode,
dt_params => \%dt_params
});
is( $search_results->{ iTotalDisplayRecords }, 0,
"dateformat: $dateformloo No borrowers have dob $dates_in_pref{$dateformloo}[3], standard search fields plus dob works");
}
# Date of birth formatting
t::lib::Mocks::mock_preference('dateformat', 'metric');
$search_results = C4::Utils::DataTables::Members::search({
searchmember => "01/02/1982",
searchfieldstype => 'dateofbirth',
dt_params => \%dt_params
});
is( $search_results->{ iTotalDisplayRecords }, 2,
"Sarching by date of birth should handle date formatted given the dateformat pref");
$search_results = C4::Utils::DataTables::Members::search({
searchmember => "1982-02-01",
searchfieldstype => 'dateofbirth',
dt_params => \%dt_params
});
is( $search_results->{ iTotalDisplayRecords }, 2,
"Sarching by date of birth should handle date formatted in iso");
# End
$schema->storage->txn_rollback;
1;