t/db_dependent/Koha/SearchEngine/Elasticsearch/QueryBuilder.t

   1 #!/usr/bin/perl
   2 #
   3 # This file is part of Koha.
   4 #
   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.
   9 #
  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.
  14 #
  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>.
  17
  18 use Modern::Perl;
  19
  20 use C4::Context;
  21 use Test::Exception;
  22 use t::lib::Mocks;
  23 use t::lib::TestBuilder;
  24 use Test::More tests => 6;
  25
  26 use Koha::Database;
  27 use Koha::SearchEngine::Elasticsearch::QueryBuilder;
  28
  29 my $schema = Koha::Database->new->schema;
  30 $schema->storage->txn_begin;
  31
  32 my $se = Test::MockModule->new( 'Koha::SearchEngine::Elasticsearch' );
  33 $se->mock( 'get_elasticsearch_mappings', sub {
  34     my ($self) = @_;
  35
  36     my %all_mappings;
  37
  38     my $mappings = {
  39         data => {
  40             properties => {
  41                 title => {
  42                     type => 'text'
  43                 },
  44                 title__sort => {
  45                     type => 'text'
  46                 },
  47                 subject => {
  48                     type => 'text'
  49                 },
  50                 itemnumber => {
  51                     type => 'integer'
  52                 },
  53                 sortablenumber => {
  54                     type => 'integer'
  55                 },
  56                 sortablenumber__sort => {
  57                     type => 'integer'
  58                 },
  59                 Heading => {
  60                     type => 'text'
  61                 },
  62                 Heading__sort => {
  63                     type => 'text'
  64                 }
  65             }
  66         }
  67     };
  68     $all_mappings{$self->index} = $mappings;
  69
  70     my $sort_fields = {
  71         $self->index => {
  72             title => 1,
  73             subject => 0,
  74             itemnumber => 0,
  75             sortablenumber => 1,
  76             mainentry => 1
  77         }
  78     };
  79     $self->sort_fields($sort_fields->{$self->index});
  80
  81     return $all_mappings{$self->index};
  82 });
  83
  84 subtest 'build_authorities_query_compat() tests' => sub {
  85     plan tests => 36;
  86
  87     my $qb;
  88
  89     ok(
  90         $qb = Koha::SearchEngine::Elasticsearch::QueryBuilder->new({ 'index' => 'authorities' }),
  91         'Creating new query builder object for authorities'
  92     );
  93
  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},
 100                 "a*");
 101         } else {
 102             is( $query->{query}->{bool}->{must}[0]->{query_string}->{query},
 103                 "a*");
 104         }
 105     }
 106
 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*)");
 113         } else {
 114             is( $query->{query}->{bool}->{must}[0]->{query_string}->{query},
 115                 "(Donald*) AND (Duck*)");
 116         }
 117     }
 118
 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"},
 123                 "donald duck");
 124         } else {
 125             is( $query->{query}->{bool}->{must}[0]->{match_phrase}->{$koha_to_index_name->{$koha_name}.".phrase"},
 126                 "donald duck");
 127         }
 128     }
 129
 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"},
 134                 "donald duck");
 135         } else {
 136             is( $query->{query}->{bool}->{must}[0]->{match_phrase_prefix}->{$koha_to_index_name->{$koha_name}.".phrase"},
 137                 "donald duck");
 138         }
 139     }
 140
 141     # Sorting
 142     my $query = $qb->build_authorities_query_compat( [ 'mainentry' ],  undef, undef, ['start'], [$search_term], 'AUTH_TYPE', 'HeadingAsc' );
 143     is_deeply(
 144         $query->{sort},
 145         [
 146             {
 147                 'heading__sort' => 'asc'
 148             }
 149         ],
 150         "ascending sort parameter properly formed"
 151     );
 152     $query = $qb->build_authorities_query_compat( [ 'mainentry' ],  undef, undef, ['start'], [$search_term], 'AUTH_TYPE', 'HeadingDsc' );
 153     is_deeply(
 154         $query->{sort},
 155         [
 156             {
 157                 'heading__sort' => 'desc'
 158             }
 159         ],
 160         "descending sort parameter properly formed"
 161     );
 162
 163     # Failing case
 164     throws_ok {
 165         $qb->build_authorities_query_compat( [ 'tomas' ],  undef, undef, ['contains'], [$search_term], 'AUTH_TYPE', 'asc' );
 166     }
 167     'Koha::Exceptions::WrongParameter',
 168         'Exception thrown on invalid value in the marclist param';
 169 };
 170
 171 subtest 'build_query tests' => sub {
 172     plan tests => 30;
 173
 174     my $qb;
 175
 176     ok(
 177         $qb = Koha::SearchEngine::Elasticsearch::QueryBuilder->new({ 'index' => 'biblios' }),
 178         'Creating new query builder object for biblios'
 179     );
 180
 181     my @sort_by = 'title_asc';
 182     my @sort_params = $qb->_convert_sort_fields(@sort_by);
 183     my %options;
 184     $options{sort} = \@sort_params;
 185     my $query = $qb->build_query('test', %options);
 186
 187     is_deeply(
 188         $query->{sort},
 189         [
 190             {
 191             'title__sort.phrase' => {
 192                     'order' => 'asc'
 193                 }
 194             }
 195         ],
 196         "sort parameter properly formed"
 197     );
 198
 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' );
 217
 218     t::lib::Mocks::mock_preference( 'QueryAutoTruncate', '' );
 219
 220     ( undef, $query ) = $qb->build_query_compat( undef, ['donald duck'] );
 221     is(
 222         $query->{query}{query_string}{query},
 223         "(donald duck)",
 224         "query not altered if QueryAutoTruncate disabled"
 225     );
 226
 227     ( undef, $query ) = $qb->build_query_compat( undef, ['donald duck'], ['title'] );
 228     is(
 229         $query->{query}{query_string}{query},
 230         '(title:(donald duck))',
 231         'multiple words in a query term are enclosed in parenthesis'
 232     );
 233
 234     ( undef, $query ) = $qb->build_query_compat( ['AND'], ['donald duck', 'disney'], ['title', 'author'] );
 235     is(
 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'
 239     );
 240
 241     t::lib::Mocks::mock_preference( 'QueryAutoTruncate', '1' );
 242
 243     ( undef, $query ) = $qb->build_query_compat( undef, ['donald duck'] );
 244     is(
 245         $query->{query}{query_string}{query},
 246         "(donald* duck*)",
 247         "simple query is auto truncated when QueryAutoTruncate enabled"
 248     );
 249
 250     # Ensure reserved words are not truncated
 251     ( undef, $query ) = $qb->build_query_compat( undef,
 252         ['donald or duck and mickey not mouse'] );
 253     is(
 254         $query->{query}{query_string}{query},
 255         "(donald* or duck* and mickey* not mouse*)",
 256         "reserved words are not affected by QueryAutoTruncate"
 257     );
 258
 259     ( undef, $query ) = $qb->build_query_compat( undef, ['donald* duck*'] );
 260     is(
 261         $query->{query}{query_string}{query},
 262         "(donald* duck*)",
 263         "query with '*' is unaltered when QueryAutoTruncate is enabled"
 264     );
 265
 266     ( undef, $query ) = $qb->build_query_compat( undef, ['donald duck and the mouse'] );
 267     is(
 268         $query->{query}{query_string}{query},
 269         "(donald* duck* and the* mouse*)",
 270         "individual words are all truncated and stopwords ignored"
 271     );
 272
 273     ( undef, $query ) = $qb->build_query_compat( undef, ['*'] );
 274     is(
 275         $query->{query}{query_string}{query},
 276         "(*)",
 277         "query of just '*' is unaltered when QueryAutoTruncate is enabled"
 278     );
 279
 280     ( undef, $query ) = $qb->build_query_compat( undef, ['"donald duck"'] );
 281     is(
 282         $query->{query}{query_string}{query},
 283         '("donald duck")',
 284         "query with quotes is unaltered when QueryAutoTruncate is enabled"
 285     );
 286
 287
 288     ( undef, $query ) = $qb->build_query_compat( undef, ['"donald duck" and "the mouse"'] );
 289     is(
 290         $query->{query}{query_string}{query},
 291         '("donald duck" and "the mouse")',
 292         "all quoted strings are unaltered if more than one in query"
 293     );
 294
 295     ( undef, $query ) = $qb->build_query_compat( undef, ['barcode:123456'] );
 296     is(
 297         $query->{query}{query_string}{query},
 298         '(barcode:123456*)',
 299         "query of specific field is truncated"
 300     );
 301
 302     ( undef, $query ) = $qb->build_query_compat( undef, ['Local-number:"123456"'] );
 303     is(
 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"
 307     );
 308
 309     ( undef, $query ) = $qb->build_query_compat( undef, ['Local-number:123456'] );
 310     is(
 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"
 314     );
 315
 316     ( undef, $query ) = $qb->build_query_compat( undef, ['Local-number.raw:123456'] );
 317     is(
 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"
 321     );
 322
 323     ( undef, $query ) = $qb->build_query_compat( undef, ['Local-number.raw:"123456"'] );
 324     is(
 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"
 328     );
 329
 330     ( undef, $query ) = $qb->build_query_compat( undef, ['J.R.R'] );
 331     is(
 332         $query->{query}{query_string}{query},
 333         '(J.R.R*)',
 334         "query including period is truncated but not split at periods"
 335     );
 336
 337     ( undef, $query ) = $qb->build_query_compat( undef, ['title:"donald duck"'] );
 338     is(
 339         $query->{query}{query_string}{query},
 340         '(title:"donald duck")',
 341         "query of specific field is not truncated when surrounded by quotes"
 342     );
 343
 344     ( undef, $query ) = $qb->build_query_compat( undef, ['donald duck'], ['title'] );
 345     is(
 346         $query->{query}{query_string}{query},
 347         '(title:(donald* duck*))',
 348         'words of a multi-word term are properly truncated'
 349     );
 350
 351     ( undef, $query ) = $qb->build_query_compat( ['AND'], ['donald duck', 'disney'], ['title', 'author'] );
 352     is(
 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'
 356     );
 357
 358     ( undef, $query ) = $qb->build_query_compat( undef, ['title:"donald duck"'], undef, undef, undef, undef, undef, { suppress => 1 } );
 359     is(
 360         $query->{query}{query_string}{query},
 361         '(title:"donald duck") AND suppress:0',
 362         "query of specific field is added AND suppress:0"
 363     );
 364
 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 } );
 367     is(
 368         $query->{query}{query_string}{query},
 369         '(title:"donald duck")',
 370         "query of specific field is not added AND suppress:0"
 371     );
 372     is($query_cgi, 'q=title%3A%22donald%20duck%22', 'query cgi');
 373 };
 374
 375
 376 subtest 'build query from form subtests' => sub {
 377     plan tests => 5;
 378
 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');
 384
 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");
 389
 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");
 396
 397
 398 };
 399
 400 subtest 'build_query with weighted fields tests' => sub {
 401     plan tests => 4;
 402
 403     my $qb = Koha::SearchEngine::Elasticsearch::QueryBuilder->new( { index => 'mydb' } );
 404     my $db_builder = t::lib::TestBuilder->new();
 405
 406     Koha::SearchFields->search({})->delete;
 407
 408     $db_builder->build({
 409         source => 'SearchField',
 410         value => {
 411             name    => 'acqdate',
 412             label   => 'acqdate',
 413             weight  => undef
 414         }
 415     });
 416
 417     $db_builder->build({
 418         source => 'SearchField',
 419         value => {
 420             name    => 'title',
 421             label   => 'title',
 422             weight  => 25
 423         }
 424     });
 425
 426     $db_builder->build({
 427         source => 'SearchField',
 428         value => {
 429             name    => 'subject',
 430             label   => 'subject',
 431             weight  => 15
 432         }
 433     });
 434
 435     my ( undef, $query ) = $qb->build_query_compat( undef, ['title:"donald duck"'], undef, undef,
 436     undef, undef, undef, { weighted_fields => 1 });
 437
 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');
 443 };
 444
 445 subtest "_convert_sort_fields() tests" => sub {
 446     plan tests => 3;
 447
 448     my $qb;
 449
 450     ok(
 451         $qb = Koha::SearchEngine::Elasticsearch::QueryBuilder->new({ 'index' => 'biblios' }),
 452         'Creating new query builder object for biblios'
 453     );
 454
 455     my @sort_by = $qb->_convert_sort_fields(qw( call_number_asc author_dsc ));
 456     is_deeply(
 457         \@sort_by,
 458         [
 459             { field => 'local-classification', direction => 'asc' },
 460             { field => 'author',  direction => 'desc' }
 461         ],
 462         'sort fields should have been split correctly'
 463     );
 464
 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 ));
 467     is_deeply(
 468         \@sort_by,
 469         [
 470             { field => 'local-classification', direction => 'asc' },
 471             { field => 'author',  direction => 'desc' }
 472         ],
 473         'sort fields should have been split correctly'
 474     );
 475 };
 476
 477 subtest "_sort_field() tests" => sub {
 478     plan tests => 5;
 479
 480     my $qb;
 481
 482     ok(
 483         $qb = Koha::SearchEngine::Elasticsearch::QueryBuilder->new({ 'index' => 'biblios' }),
 484         'Creating new query builder object for biblios'
 485     );
 486
 487     my $f = $qb->_sort_field('title');
 488     is(
 489         $f,
 490         'title__sort.phrase',
 491         'title sort mapped correctly'
 492     );
 493
 494     $f = $qb->_sort_field('subject');
 495     is(
 496         $f,
 497         'subject.raw',
 498         'subject sort mapped correctly'
 499     );
 500
 501     $f = $qb->_sort_field('itemnumber');
 502     is(
 503         $f,
 504         'itemnumber',
 505         'itemnumber sort mapped correctly'
 506     );
 507
 508     $f = $qb->_sort_field('sortablenumber');
 509     is(
 510         $f,
 511         'sortablenumber__sort',
 512         'sortablenumber sort mapped correctly'
 513     );
 514 };
 515
 516 $schema->storage->txn_rollback;