Koha/t/Search/buildQuery.t
Jonathan Druart 9d6d641d1f Bug 17600: Standardize our EXPORT_OK
On bug 17591 we discovered that there was something weird going on with
the way we export and use subroutines/modules.
This patch tries to standardize our EXPORT to use EXPORT_OK only.

That way we will need to explicitely define the subroutine we want to
use from a module.

This patch is a squashed version of:
Bug 17600: After export.pl
Bug 17600: After perlimport
Bug 17600: Manual changes
Bug 17600: Other manual changes after second perlimports run
Bug 17600: Fix tests

And a lot of other manual changes.

export.pl is a dirty script that can be found on bug 17600.

"perlimport" is:
git clone https://github.com/oalders/App-perlimports.git
cd App-perlimports/
cpanm --installdeps .
export PERL5LIB="$PERL5LIB:/kohadevbox/koha/App-perlimports/lib"
find . \( -name "*.pl" -o -name "*.pm" \) -exec perl App-perlimports/script/perlimports --inplace-edit --no-preserve-unused --filename {} \;

The ideas of this patch are to:
* use EXPORT_OK instead of EXPORT
* perltidy the EXPORT_OK list
* remove '&' before the subroutine names
* remove some uneeded use statements
* explicitely import the subroutines we need within the controllers or
modules

Note that the private subroutines (starting with _) should not be
exported (and not used from outside of the module except from tests).

EXPORT vs EXPORT_OK (from
https://www.thegeekstuff.com/2010/06/perl-exporter-examples/)
"""
Export allows to export the functions and variables of modules to user’s namespace using the standard import method. This way, we don’t need to create the objects for the modules to access it’s members.

@EXPORT and @EXPORT_OK are the two main variables used during export operation.

@EXPORT contains list of symbols (subroutines and variables) of the module to be exported into the caller namespace.

@EXPORT_OK does export of symbols on demand basis.
"""

If this patch caused a conflict with a patch you wrote prior to its
push:
* Make sure you are not reintroducing a "use" statement that has been
removed
* "$subroutine" is not exported by the C4::$MODULE module
means that you need to add the subroutine to the @EXPORT_OK list
* Bareword "$subroutine" not allowed while "strict subs"
means that you didn't imported the subroutine from the module:
  - use $MODULE qw( $subroutine list );
You can also use the fully qualified namespace: C4::$MODULE::$subroutine

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
2021-07-16 08:58:47 +02:00

330 lines
12 KiB
Raku
Executable file

#!/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;
use t::lib::Mocks;
use Module::Load::Conditional qw/check_install/;
BEGIN {
if ( check_install( module => 'Test::DBIx::Class' ) ) {
plan tests => 10;
} else {
plan skip_all => "Need Test::DBIx::Class"
}
}
# Mock the DB connection and C4::Context
use Test::DBIx::Class;
use_ok('C4::Search', qw( buildQuery ));
can_ok('C4::Search',
qw/buildQuery/);
use_ok("Net::Z3950::ZOOM");
#FIXME: would it be better to use our real ccl.properties file?
sub _get_ccl_properties {
my $config = q(
kw 1=1016
wrdl 4=6
rtrn 5=1
right-Truncation rtrn
rk 2=102
ti 1=4
title ti
ext 4=1 6=3
Title-cover 1=36
r1 9=32
r2 9=28
r3 9=26
r4 9=24
r5 9=22
r6 9=20
r7 9=18
r8 9=16
r9 9=14
phr 4=1
fuzzy 5=103
ccode 1=8009
);
return $config;
}
#FIXME: We should add QueryFuzzy and QueryStemming preferences to expand test permutations
subtest "test weighted autotruncated" => sub {
plan tests => 13;
t::lib::Mocks::mock_preference('QueryWeightFields', '1');
t::lib::Mocks::mock_preference('QueryAutoTruncate', '1');
my $config = _get_ccl_properties();
my $operators = [""];
my $operands = ["test"];
my $indexes = [""];
my $limits = [""];
my $sort_by = [""];
my ($scan,$lang);
my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type) =
C4::Search::buildQuery($operators,$operands,$indexes,$limits,$sort_by,$scan,$lang);
is($error,undef,"Error is correct");
is($query,'(rk=(kw,wrdl,rtrn=test )) ','Query is correct with auto truncation');
is($simple_query,'test',"Simple query is correct");
is($query_cgi,'idx=kw&q=test','Query cgi is correct');
is($query_desc,'kw,wrdl: test','Query desc is correct');
is($limit,'',"Limit is correct");
is($limit_cgi,'',"Limit cgi is correct");
is($limit_desc,'',"Limit desc is correct");
is($query_type,undef,"Query type is correct");
my $q = Net::Z3950::ZOOM::query_create();
my ($ccl_errcode, $ccl_errstr, $ccl_errpos) = (0,"",0);
my $res = Net::Z3950::ZOOM::query_ccl2rpn($q, $query, $config,
$ccl_errcode, $ccl_errstr, $ccl_errpos
);
is($res,0,"created CCL2RPN query");
is($ccl_errcode,0);
is($ccl_errstr,"");
is($ccl_errpos,0);
Net::Z3950::ZOOM::query_destroy($q);
};
subtest "test* weighted autotruncated" => sub {
plan tests => 13;
t::lib::Mocks::mock_preference('QueryWeightFields', '1');
t::lib::Mocks::mock_preference('QueryAutoTruncate', '1');
my $config = _get_ccl_properties();
my $operators = [""];
my $operands = ["test*"];
my $indexes = [""];
my $limits = [""];
my $sort_by = [""];
my ($scan,$lang);
my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type) =
C4::Search::buildQuery($operators,$operands,$indexes,$limits,$sort_by,$scan,$lang);
is($error,undef,"Error is correct");
is($query,'(rk=(kw,wrdl,rtrn=test )) ','Query is correct with manual truncation');
is($simple_query,'test*',"Simple query is correct");
is($query_cgi,'idx=kw&q=test%2A','Query cgi is correct');
is($query_desc,'kw,wrdl: test*','Query desc is correct');
is($limit,'',"Limit is correct");
is($limit_cgi,'',"Limit cgi is correct");
is($limit_desc,'',"Limit desc is correct");
is($query_type,undef,"Query type is correct");
my $q = Net::Z3950::ZOOM::query_create();
my ($ccl_errcode, $ccl_errstr, $ccl_errpos) = (0,"",0);
my $res = Net::Z3950::ZOOM::query_ccl2rpn($q, $query, $config,
$ccl_errcode, $ccl_errstr, $ccl_errpos
);
is($res,0,"created CCL2RPN query");
is($ccl_errcode,0);
is($ccl_errstr,"");
is($ccl_errpos,0);
Net::Z3950::ZOOM::query_destroy($q);
};
subtest "test weighted not-autotruncated" => sub {
plan tests => 13;
t::lib::Mocks::mock_preference('QueryWeightFields', '1');
t::lib::Mocks::mock_preference('QueryAutoTruncate', '0');
my $config = _get_ccl_properties();
my $operators = [""];
my $operands = ["test"];
my $indexes = [""];
my $limits = [""];
my $sort_by = [""];
my ($scan,$lang);
my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type) =
C4::Search::buildQuery($operators,$operands,$indexes,$limits,$sort_by,$scan,$lang);
is($error,undef,"Error is correct");
is($query,'(rk=(Title-cover,ext,r1="test" or ti,ext,r2="test" or Title-cover,phr,r3="test" or ti,wrdl,r4="test" or wrdl,fuzzy,r8="test" or wrdl,right-Truncation,r9="test" or wrdl,r9="test")) ','Query is correct with weighted fields');
is($simple_query,'test',"Simple query is correct");
is($query_cgi,'idx=kw&q=test','Query cgi is correct');
is($query_desc,'kw,wrdl: test','Query desc is correct');
is($limit,'',"Limit is correct");
is($limit_cgi,'',"Limit cgi is correct");
is($limit_desc,'',"Limit desc is correct");
is($query_type,undef,"Query type is correct");
my $q = Net::Z3950::ZOOM::query_create();
my ($ccl_errcode, $ccl_errstr, $ccl_errpos) = (0,"",0);
my $res = Net::Z3950::ZOOM::query_ccl2rpn($q, $query, $config,
$ccl_errcode, $ccl_errstr, $ccl_errpos
);
is($res,0,"created CCL2RPN query");
is($ccl_errcode,0);
is($ccl_errstr,"");
is($ccl_errpos,0);
Net::Z3950::ZOOM::query_destroy($q);
};
subtest "test ccode:REF weighted autotruncated" => sub {
plan tests => 13;
t::lib::Mocks::mock_preference('QueryWeightFields', '1');
t::lib::Mocks::mock_preference('QueryAutoTruncate', '1');
my $config = _get_ccl_properties();
my $operators = [""];
my $operands = ["test"];
my $indexes = [""];
my $limits = ["ccode:REF"];
my $sort_by = [""];
my ($scan,$lang);
my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type) =
C4::Search::buildQuery($operators,$operands,$indexes,$limits,$sort_by,$scan,$lang);
is($error,undef,"Error is correct");
is($query,'(rk=(kw,wrdl,rtrn=test )) and ccode=REF','Query is correct with auto truncation and limits');
is($simple_query,'test',"Simple query is correct");
is($query_cgi,'idx=kw&q=test','Query cgi is correct');
is($query_desc,'kw,wrdl: test','Query desc is correct');
is($limit,'and ccode=REF',"Limit is correct");
is($limit_cgi,'&limit=ccode%3AREF',"Limit cgi is correct");
is($limit_desc,'ccode:REF',"Limit desc is correct");
is($query_type,undef,"Query type is correct");
my $q = Net::Z3950::ZOOM::query_create();
my ($ccl_errcode, $ccl_errstr, $ccl_errpos) = (0,"",0);
my $res = Net::Z3950::ZOOM::query_ccl2rpn($q, $query, $config,
$ccl_errcode, $ccl_errstr, $ccl_errpos
);
is($res,0,"created CCL2RPN query");
is($ccl_errcode,0);
is($ccl_errstr,"");
is($ccl_errpos,0);
Net::Z3950::ZOOM::query_destroy($q);
};
subtest "test ccode:REF weighted not-autotruncated" => sub {
plan tests => 13;
t::lib::Mocks::mock_preference('QueryWeightFields', '1');
t::lib::Mocks::mock_preference('QueryAutoTruncate', '0');
my $config = _get_ccl_properties();
my $operators = [""];
my $operands = ["test"];
my $indexes = [""];
my $limits = ["ccode:REF"];
my $sort_by = [""];
my ($scan,$lang);
my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type) =
C4::Search::buildQuery($operators,$operands,$indexes,$limits,$sort_by,$scan,$lang);
is($error,undef,"Error is correct");
is($query,'(rk=(Title-cover,ext,r1="test" or ti,ext,r2="test" or Title-cover,phr,r3="test" or ti,wrdl,r4="test" or wrdl,fuzzy,r8="test" or wrdl,right-Truncation,r9="test" or wrdl,r9="test")) and ccode=REF','Query is correct with weighted fields and limits');
is($simple_query,'test',"Simple query is correct");
is($query_cgi,'idx=kw&q=test','Query cgi is correct');
is($query_desc,'kw,wrdl: test','Query desc is correct');
is($limit,'and ccode=REF',"Limit is correct");
is($limit_cgi,'&limit=ccode%3AREF',"Limit cgi is correct");
is($limit_desc,'ccode:REF',"Limit desc is correct");
is($query_type,undef,"Query type is correct");
my $q = Net::Z3950::ZOOM::query_create();
my ($ccl_errcode, $ccl_errstr, $ccl_errpos) = (0,"",0);
my $res = Net::Z3950::ZOOM::query_ccl2rpn($q, $query, $config,
$ccl_errcode, $ccl_errstr, $ccl_errpos
);
is($res,0,"created CCL2RPN query");
is($ccl_errcode,0);
is($ccl_errstr,"");
is($ccl_errpos,0);
Net::Z3950::ZOOM::query_destroy($q);
};
subtest "kw:one and title:two ccode:REF weighted autotruncated" => sub {
plan tests => 13;
t::lib::Mocks::mock_preference('QueryWeightFields', '1');
t::lib::Mocks::mock_preference('QueryAutoTruncate', '1');
my $config = _get_ccl_properties();
my $operators = ["and"];
my $operands = ["one","two"];
my $indexes = ["kw","title"];
my $limits = ["ccode:REF"];
my $sort_by = [""];
my ($scan,$lang);
my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type) =
C4::Search::buildQuery($operators,$operands,$indexes,$limits,$sort_by,$scan,$lang);
is($error,undef,"Error is correct");
is($query,'(rk=(kw,wrdl,rtrn=one )) and (rk=(title,wrdl,rtrn=two )) and ccode=REF','Query is correct with auto truncation, limits, and using indexes and operators');
is($simple_query,'one',"Simple query is correct?");
is($query_cgi,'idx=kw&q=one&op=%20and%20&idx=title&q=two','Query cgi is correct');
is($query_desc,'kw,wrdl: one and title,wrdl: two','Query desc is correct');
is($limit,'and ccode=REF',"Limit is correct");
is($limit_cgi,'&limit=ccode%3AREF',"Limit cgi is correct");
is($limit_desc,'ccode:REF',"Limit desc is correct");
is($query_type,undef,"Query type is correct");
my $q = Net::Z3950::ZOOM::query_create();
my ($ccl_errcode, $ccl_errstr, $ccl_errpos) = (0,"",0);
my $res = Net::Z3950::ZOOM::query_ccl2rpn($q, $query, $config,
$ccl_errcode, $ccl_errstr, $ccl_errpos
);
is($res,0,"created CCL2RPN query");
is($ccl_errcode,0);
is($ccl_errstr,"");
is($ccl_errpos,0);
Net::Z3950::ZOOM::query_destroy($q);
};
subtest "one and two weighted autotruncated" => sub {
plan tests => 13;
t::lib::Mocks::mock_preference('QueryWeightFields', '1');
t::lib::Mocks::mock_preference('QueryAutoTruncate', '1');
my $config = _get_ccl_properties();
my $operators = [""];
my $operands = ["one and two"];
my $indexes = [""];
my $limits = [""];
my $sort_by = [""];
my ($scan,$lang);
my ($error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$query_type) =
C4::Search::buildQuery($operators,$operands,$indexes,$limits,$sort_by,$scan,$lang);
is($error,undef,"Error is correct");
is($query,'(rk=(kw,wrdl,rtrn=one and two )) ','Query is correct with auto truncation and unstructured query');
is($simple_query,'one and two',"Simple query is correct");
is($query_cgi,'idx=kw&q=one%20and%20two','Query cgi is correct');
is($query_desc,'kw,wrdl: one and two','Query desc is correct');
is($limit,'',"Limit is correct");
is($limit_cgi,'',"Limit cgi is correct");
is($limit_desc,'',"Limit desc is correct");
is($query_type,undef,"Query type is correct");
my $q = Net::Z3950::ZOOM::query_create();
my ($ccl_errcode, $ccl_errstr, $ccl_errpos) = (0,"",0);
my $res = Net::Z3950::ZOOM::query_ccl2rpn($q, $query, $config,
$ccl_errcode, $ccl_errstr, $ccl_errpos
);
is($res,0,"created CCL2RPN query");
is($ccl_errcode,0);
is($ccl_errstr,"");
is($ccl_errpos,0);
Net::Z3950::ZOOM::query_destroy($q);
};