3 # This file is part of Koha.
5 # Koha is free software; you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
10 # Koha is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 use t::lib::TestBuilder;
24 use Test::More tests => 6;
27 use Koha::SearchEngine::Elasticsearch::QueryBuilder;
29 my $schema = Koha::Database->new->schema;
30 $schema->storage->txn_begin;
32 my $se = Test::MockModule->new( 'Koha::SearchEngine::Elasticsearch' );
33 $se->mock( 'get_elasticsearch_mappings', sub {
56 sortablenumber__sort => {
68 $all_mappings{$self->index} = $mappings;
79 $self->sort_fields($sort_fields->{$self->index});
81 return $all_mappings{$self->index};
84 subtest 'build_authorities_query_compat() tests' => sub {
90 $qb = Koha::SearchEngine::Elasticsearch::QueryBuilder->new({ 'index' => 'authorities' }),
91 'Creating new query builder object for authorities'
94 my $koha_to_index_name = $Koha::SearchEngine::Elasticsearch::QueryBuilder::koha_to_index_name;
95 my $search_term = 'a';
96 foreach my $koha_name ( keys %{ $koha_to_index_name } ) {
97 my $query = $qb->build_authorities_query_compat( [ $koha_name ], undef, undef, ['contains'], [$search_term], 'AUTH_TYPE', 'asc' );
98 if ( $koha_name eq 'all' || $koha_name eq 'any' ) {
99 is( $query->{query}->{bool}->{must}[0]->{query_string}->{query},
102 is( $query->{query}->{bool}->{must}[0]->{query_string}->{query},
107 $search_term = 'Donald Duck';
108 foreach my $koha_name ( keys %{ $koha_to_index_name } ) {
109 my $query = $qb->build_authorities_query_compat( [ $koha_name ], undef, undef, ['contains'], [$search_term], 'AUTH_TYPE', 'asc' );
110 if ( $koha_name eq 'all' || $koha_name eq 'any' ) {
111 is( $query->{query}->{bool}->{must}[0]->{query_string}->{query},
112 "(Donald*) AND (Duck*)");
114 is( $query->{query}->{bool}->{must}[0]->{query_string}->{query},
115 "(Donald*) AND (Duck*)");
119 foreach my $koha_name ( keys %{ $koha_to_index_name } ) {
120 my $query = $qb->build_authorities_query_compat( [ $koha_name ], undef, undef, ['is'], [$search_term], 'AUTH_TYPE', 'asc' );
121 if ( $koha_name eq 'all' || $koha_name eq 'any' ) {
122 is( $query->{query}->{bool}->{must}[0]->{match_phrase}->{"_all.phrase"},
125 is( $query->{query}->{bool}->{must}[0]->{match_phrase}->{$koha_to_index_name->{$koha_name}.".phrase"},
130 foreach my $koha_name ( keys %{ $koha_to_index_name } ) {
131 my $query = $qb->build_authorities_query_compat( [ $koha_name ], undef, undef, ['start'], [$search_term], 'AUTH_TYPE', 'asc' );
132 if ( $koha_name eq 'all' || $koha_name eq 'any' ) {
133 is( $query->{query}->{bool}->{must}[0]->{match_phrase_prefix}->{"_all.phrase"},
136 is( $query->{query}->{bool}->{must}[0]->{match_phrase_prefix}->{$koha_to_index_name->{$koha_name}.".phrase"},
142 my $query = $qb->build_authorities_query_compat( [ 'mainentry' ], undef, undef, ['start'], [$search_term], 'AUTH_TYPE', 'HeadingAsc' );
147 'heading__sort' => 'asc'
150 "ascending sort parameter properly formed"
152 $query = $qb->build_authorities_query_compat( [ 'mainentry' ], undef, undef, ['start'], [$search_term], 'AUTH_TYPE', 'HeadingDsc' );
157 'heading__sort' => 'desc'
160 "descending sort parameter properly formed"
165 $qb->build_authorities_query_compat( [ 'tomas' ], undef, undef, ['contains'], [$search_term], 'AUTH_TYPE', 'asc' );
167 'Koha::Exceptions::WrongParameter',
168 'Exception thrown on invalid value in the marclist param';
171 subtest 'build_query tests' => sub {
177 $qb = Koha::SearchEngine::Elasticsearch::QueryBuilder->new({ 'index' => 'biblios' }),
178 'Creating new query builder object for biblios'
181 my @sort_by = 'title_asc';
182 my @sort_params = $qb->_convert_sort_fields(@sort_by);
184 $options{sort} = \@sort_params;
185 my $query = $qb->build_query('test', %options);
191 'title__sort.phrase' => {
196 "sort parameter properly formed"
199 t::lib::Mocks::mock_preference('DisplayLibraryFacets','both');
200 $query = $qb->build_query();
201 ok( defined $query->{aggregations}{homebranch},
202 'homebranch added to facets if DisplayLibraryFacets=both' );
203 ok( defined $query->{aggregations}{holdingbranch},
204 'holdingbranch added to facets if DisplayLibraryFacets=both' );
205 t::lib::Mocks::mock_preference('DisplayLibraryFacets','holding');
206 $query = $qb->build_query();
207 ok( !defined $query->{aggregations}{homebranch},
208 'homebranch not added to facets if DisplayLibraryFacets=holding' );
209 ok( defined $query->{aggregations}{holdingbranch},
210 'holdingbranch added to facets if DisplayLibraryFacets=holding' );
211 t::lib::Mocks::mock_preference('DisplayLibraryFacets','home');
212 $query = $qb->build_query();
213 ok( defined $query->{aggregations}{homebranch},
214 'homebranch added to facets if DisplayLibraryFacets=home' );
215 ok( !defined $query->{aggregations}{holdingbranch},
216 'holdingbranch not added to facets if DisplayLibraryFacets=home' );
218 t::lib::Mocks::mock_preference( 'QueryAutoTruncate', '' );
220 ( undef, $query ) = $qb->build_query_compat( undef, ['donald duck'] );
222 $query->{query}{query_string}{query},
224 "query not altered if QueryAutoTruncate disabled"
227 ( undef, $query ) = $qb->build_query_compat( undef, ['donald duck'], ['title'] );
229 $query->{query}{query_string}{query},
230 '(title:(donald duck))',
231 'multiple words in a query term are enclosed in parenthesis'
234 ( undef, $query ) = $qb->build_query_compat( ['AND'], ['donald duck', 'disney'], ['title', 'author'] );
236 $query->{query}{query_string}{query},
237 '(title:(donald duck)) AND (author:disney)',
238 'multiple query terms are enclosed in parenthesis while a single one is not'
241 t::lib::Mocks::mock_preference( 'QueryAutoTruncate', '1' );
243 ( undef, $query ) = $qb->build_query_compat( undef, ['donald duck'] );
245 $query->{query}{query_string}{query},
247 "simple query is auto truncated when QueryAutoTruncate enabled"
250 # Ensure reserved words are not truncated
251 ( undef, $query ) = $qb->build_query_compat( undef,
252 ['donald or duck and mickey not mouse'] );
254 $query->{query}{query_string}{query},
255 "(donald* or duck* and mickey* not mouse*)",
256 "reserved words are not affected by QueryAutoTruncate"
259 ( undef, $query ) = $qb->build_query_compat( undef, ['donald* duck*'] );
261 $query->{query}{query_string}{query},
263 "query with '*' is unaltered when QueryAutoTruncate is enabled"
266 ( undef, $query ) = $qb->build_query_compat( undef, ['donald duck and the mouse'] );
268 $query->{query}{query_string}{query},
269 "(donald* duck* and the* mouse*)",
270 "individual words are all truncated and stopwords ignored"
273 ( undef, $query ) = $qb->build_query_compat( undef, ['*'] );
275 $query->{query}{query_string}{query},
277 "query of just '*' is unaltered when QueryAutoTruncate is enabled"
280 ( undef, $query ) = $qb->build_query_compat( undef, ['"donald duck"'] );
282 $query->{query}{query_string}{query},
284 "query with quotes is unaltered when QueryAutoTruncate is enabled"
288 ( undef, $query ) = $qb->build_query_compat( undef, ['"donald duck" and "the mouse"'] );
290 $query->{query}{query_string}{query},
291 '("donald duck" and "the mouse")',
292 "all quoted strings are unaltered if more than one in query"
295 ( undef, $query ) = $qb->build_query_compat( undef, ['barcode:123456'] );
297 $query->{query}{query_string}{query},
299 "query of specific field is truncated"
302 ( undef, $query ) = $qb->build_query_compat( undef, ['Local-number:"123456"'] );
304 $query->{query}{query_string}{query},
305 '(local-number:"123456")',
306 "query of specific field including hyphen and quoted is not truncated, field name is converted to lower case"
309 ( undef, $query ) = $qb->build_query_compat( undef, ['Local-number:123456'] );
311 $query->{query}{query_string}{query},
312 '(local-number:123456*)',
313 "query of specific field including hyphen and not quoted is truncated, field name is converted to lower case"
316 ( undef, $query ) = $qb->build_query_compat( undef, ['Local-number.raw:123456'] );
318 $query->{query}{query_string}{query},
319 '(local-number.raw:123456*)',
320 "query of specific field including period and not quoted is truncated, field name is converted to lower case"
323 ( undef, $query ) = $qb->build_query_compat( undef, ['Local-number.raw:"123456"'] );
325 $query->{query}{query_string}{query},
326 '(local-number.raw:"123456")',
327 "query of specific field including period and quoted is not truncated, field name is converted to lower case"
330 ( undef, $query ) = $qb->build_query_compat( undef, ['J.R.R'] );
332 $query->{query}{query_string}{query},
334 "query including period is truncated but not split at periods"
337 ( undef, $query ) = $qb->build_query_compat( undef, ['title:"donald duck"'] );
339 $query->{query}{query_string}{query},
340 '(title:"donald duck")',
341 "query of specific field is not truncated when surrounded by quotes"
344 ( undef, $query ) = $qb->build_query_compat( undef, ['donald duck'], ['title'] );
346 $query->{query}{query_string}{query},
347 '(title:(donald* duck*))',
348 'words of a multi-word term are properly truncated'
351 ( undef, $query ) = $qb->build_query_compat( ['AND'], ['donald duck', 'disney'], ['title', 'author'] );
353 $query->{query}{query_string}{query},
354 '(title:(donald* duck*)) AND (author:disney*)',
355 'words of a multi-word term and single-word term are properly truncated'
358 ( undef, $query ) = $qb->build_query_compat( undef, ['title:"donald duck"'], undef, undef, undef, undef, undef, { suppress => 1 } );
360 $query->{query}{query_string}{query},
361 '(title:"donald duck") AND suppress:0',
362 "query of specific field is added AND suppress:0"
365 my ($simple_query, $query_cgi);
366 ( undef, $query, $simple_query, $query_cgi ) = $qb->build_query_compat( undef, ['title:"donald duck"'], undef, undef, undef, undef, undef, { suppress => 0 } );
368 $query->{query}{query_string}{query},
369 '(title:"donald duck")',
370 "query of specific field is not added AND suppress:0"
372 is($query_cgi, 'q=title%3A%22donald%20duck%22', 'query cgi');
376 subtest 'build query from form subtests' => sub {
379 my $qb = Koha::SearchEngine::Elasticsearch::QueryBuilder->new({ 'index' => 'authorities' }),
380 #when searching for authorities from a record the form returns marclist with blanks for unentered terms
381 my @marclist = ('mainmainentry','mainentry','match', 'all');
382 my @values = ( undef, 'Hamilton', undef, undef);
383 my @operator = ( 'contains', 'contains', 'contains', 'contains');
385 my $query = $qb->build_authorities_query_compat( \@marclist, undef,
386 undef, \@operator , \@values, 'AUTH_TYPE', 'asc' );
387 is($query->{query}->{bool}->{must}[0]->{query_string}->{query}, "Hamilton*","Expected search is populated");
388 is( scalar @{ $query->{query}->{bool}->{must} }, 1,"Only defined search is populated");
390 @values[2] = 'Jefferson';
391 $query = $qb->build_authorities_query_compat( \@marclist, undef,
392 undef, \@operator , \@values, 'AUTH_TYPE', 'asc' );
393 is($query->{query}->{bool}->{must}[0]->{query_string}->{query}, "Hamilton*","First index searched as expected");
394 is($query->{query}->{bool}->{must}[1]->{query_string}->{query}, "Jefferson*","Second index searched when populated");
395 is( scalar @{ $query->{query}->{bool}->{must} }, 2,"Only defined searches are populated");
400 subtest 'build_query with weighted fields tests' => sub {
403 my $qb = Koha::SearchEngine::Elasticsearch::QueryBuilder->new( { index => 'mydb' } );
404 my $db_builder = t::lib::TestBuilder->new();
406 Koha::SearchFields->search({})->delete;
409 source => 'SearchField',
418 source => 'SearchField',
427 source => 'SearchField',
435 my ( undef, $query ) = $qb->build_query_compat( undef, ['title:"donald duck"'], undef, undef,
436 undef, undef, undef, { weighted_fields => 1 });
438 my $fields = $query->{query}{query_string}{fields};
439 is(scalar(@$fields), 3, 'Search is done on 3 fields');
440 is($fields->[0], '_all', 'First search field is _all');
441 is($fields->[1], 'title^25.00', 'Second search field is title');
442 is($fields->[2], 'subject^15.00', 'Third search field is subject');
445 subtest "_convert_sort_fields() tests" => sub {
451 $qb = Koha::SearchEngine::Elasticsearch::QueryBuilder->new({ 'index' => 'biblios' }),
452 'Creating new query builder object for biblios'
455 my @sort_by = $qb->_convert_sort_fields(qw( call_number_asc author_dsc ));
459 { field => 'local-classification', direction => 'asc' },
460 { field => 'author', direction => 'desc' }
462 'sort fields should have been split correctly'
465 # We could expect this to pass, but direction is undef instead of 'desc'
466 @sort_by = $qb->_convert_sort_fields(qw( call_number_asc author_desc ));
470 { field => 'local-classification', direction => 'asc' },
471 { field => 'author', direction => 'desc' }
473 'sort fields should have been split correctly'
477 subtest "_sort_field() tests" => sub {
483 $qb = Koha::SearchEngine::Elasticsearch::QueryBuilder->new({ 'index' => 'biblios' }),
484 'Creating new query builder object for biblios'
487 my $f = $qb->_sort_field('title');
490 'title__sort.phrase',
491 'title sort mapped correctly'
494 $f = $qb->_sort_field('subject');
498 'subject sort mapped correctly'
501 $f = $qb->_sort_field('itemnumber');
505 'itemnumber sort mapped correctly'
508 $f = $qb->_sort_field('sortablenumber');
511 'sortablenumber__sort',
512 'sortablenumber sort mapped correctly'
516 $schema->storage->txn_rollback;