LP#1673857: some test cases
[working/Evergreen.git] / Open-ILS / src / perlmods / t / 21-QueryParser.t
1 #!perl
2
3 use strict;
4 use warnings; # FATAL => qw(all);
5 use Test::More;
6
7 BEGIN {
8         use_ok( 'OpenILS::Application::Storage::QueryParser' );
9 #    use_ok( 'OpenILS::Application::Storage::Driver::Pg::QueryParser' );
10 }
11
12 my %args = ( debug => 0 );
13 my $QParser = QueryParser->new(%args);
14 is(ref $QParser, 'QueryParser', 'Created QueryParser');
15 is($QParser->operator('and'), '&&', 'Expected and operator');
16
17 $Data::Dumper::Indent = 1;
18
19 $QParser->add_search_class_alias( keyword => 'kw' );
20 is ($QParser->search_class_count, 1, "Added one search class");
21 init_qp();
22
23 is ($QParser->search_class_count, 5, "Correct number of search classes");
24 is (scalar(@{$QParser->search_fields()->{'author'}}), 3, "Correct number of search fields for 'author' class");
25 $QParser->remove_search_field('author', 'personal');
26 is (scalar(@{$QParser->search_fields()->{'author'}}), 2, "Removed search field");
27 $QParser->remove_search_class('title');
28 is ($QParser->search_class_count, 4, "Removed search class");
29 is (scalar(@{$QParser->search_class_aliases->{'author'}}), 3, "Correct number of aliases for 'author' class");
30 $QParser->remove_search_class_alias( author => 'au' );
31 is (scalar(@{$QParser->search_class_aliases->{'author'}}), 2, "Removed alias for 'author' class");
32 is (scalar(@{$QParser->search_field_aliases->{'subject'}->{'name'}}), 2, "Correct number of search field aliases for 'subject' class");
33 $QParser->remove_search_field_alias( subject => name => 'nomen' );
34 is (scalar(@{$QParser->search_field_aliases->{'subject'}->{'name'}}), 1, "Removed search field alias");
35
36 is ($QParser->facet_class_count, 2, "Correct number of facet classes");
37 is (scalar(@{$QParser->facet_fields()->{'author'}}), 2, "Correct number of facet fields for 'author' class");
38 $QParser->remove_facet_field('author', 'personal');
39 is (scalar(@{$QParser->facet_fields()->{'author'}}), 1, "Removed facet field");
40 $QParser->remove_facet_class('author');
41 is ($QParser->facet_class_count, 1, "Removed facet class");
42
43 is ($QParser->filter_count, 29, "Correct number of filters");
44 is (scalar(@{$QParser->filter_normalizers('skip_check')}), 0, 'No filter normalizers by default');
45 $QParser->add_filter_normalizer('skip_check', \&test_filter_norm);
46 is (scalar(@{$QParser->filter_normalizers('skip_check')}), 1, 'Added filter normalizer');
47 is ($QParser->modifier_count, 8, "Correct number of modifiers");
48
49 is_deeply ($QParser->custom_data('string'), { }, "No custom data set for 'string'");
50
51 is($QParser->core_limit(25000), 25000, 'Core limit setting works');
52 is($QParser->core_limit(), 25000, 'Core limit stays set');
53
54 is($QParser->superpage(1), 1, 'Superpage setting works');
55 is($QParser->superpage(), 1, 'Superpage stays set');
56
57 # see QueryParser.pm, this won't work:
58 # is($QParser->superpage(0), 0, 'Superpage can be unset');
59
60 is($QParser->superpage_size(1000), 1000, 'Superpage size setting works');
61 is($QParser->superpage_size(), 1000, 'Superpage size stays set');
62
63 init_qp();
64 eval {
65     local $SIG{ALRM} = sub { die "timed out!\n" };
66     alarm 1;
67     $QParser->parse('-"unclosed phrase');
68 };
69 if ($@) {
70     fail('parsing modified unclosed phrase query timed out');
71 } else {
72     pass('successfully parsed modified unclosed phrase query');
73 }
74
75 # It's unfortunate not to be able to use the following tests immediately, but
76 # they reflect assumptions that need to be updated in light of new qp_fix code.
77 # Also,, canonicalization may not preserve insignificant whitespace nor the
78 # exact, original number of non-semantic parentheses.
79
80 =cut
81
82 init_qp();
83
84 my %queries = (
85     '(keyword1 keyword2) || keyword3' => undef,
86     'keyword1 || keyword2' => undef,
87     'author:keyword1 keyword2' => undef,
88     '(keyword1) || (keyword2)' => undef,
89     'keyword1 || keyword2 || keyword3' => undef,
90     '(keyword1 || keyword2) && keyword3' => undef,
91     'keyword1 keyword2 || keyword3 keyword4' => sub {
92         my $query = shift;
93         # Unfortunately, the canonical representation of a query in master
94         # as of 2012/09/07 is not unambiguous
95         is($QParser->parse_tree()->to_abstract_query()->{children}->{'&'}, undef, "Outer-most operator in query {$query} is not AND");
96         is(ref $QParser->parse_tree()->to_abstract_query()->{children}->{'|'}, 'ARRAY', "Outer-most operator in query {$query} is OR");
97     },
98     'keyword1 keyword2 && keyword3 keyword4' => undef,
99     'keyword1 author:keyword2' => undef,
100     'au:keyword1 kw:keyword2' => undef,
101     'keyword1 pref_ou(lib)' => sub {
102         my $query = shift;
103         is($QParser->parse_tree->to_abstract_query()->{filters}->[0]->{name}, 'pref_ou', 'Generated filter for query');
104     },
105     'keyword1 #available' => sub {
106         my $query = shift;
107         is($QParser->parse_tree->to_abstract_query()->{modifiers}->[0], 'available', 'Set modifier for query');
108     },
109     '(keyword1 keyword2) || keyword3 #available' => sub {
110         my $query = shift;
111         is($QParser->parse_tree->to_abstract_query()->{modifiers}->[0], 'available', 'Set modifier for query');
112     },
113     'keyword1 testfilter(whatever)' => undef,
114     'keyword1 sort:something' => undef,
115     '"phrase1 phrase2" keyword1' => undef, # NOTE: phrases do not have a stable canonical representation, 2012-09-09
116     'keyword1 -keyword2' => undef,
117     'keyword1 +keyword2' => undef,
118 );
119
120 my $query;
121 my $testfunc;
122 while (($query, $testfunc) = each (%queries)) {
123     init_qp();
124     $QParser->parse($query);
125     # TODO: Test initial parse
126     &$testfunc($query) if ($testfunc);
127     my $canonical = clean(QueryParser::Canonicalize::abstract_query2str_impl($QParser->parse_tree()->to_abstract_query()));
128     $canonical = reparse($canonical);
129     init_qp();
130     $QParser->parse($canonical);
131     is(clean(QueryParser::Canonicalize::abstract_query2str_impl($QParser->parse_tree()->to_abstract_query())), $canonical, "Building query from canonical query is idempotent for query {$query}");
132 }
133
134 my %equivalences = (
135     'keyword1 keyword2' => 'keyword1 && keyword2',
136     'keyword1 keyword2 || keyword3 keyword4' => 'keyword1 && keyword2 || keyword3 && keyword4',
137     'keyword1 keyword2 || keyword3 keyword4' => '(keyword1 keyword2) || (keyword3 keyword4)',
138     'keyword1 keyword2 && keyword3 keyword4' => '(keyword1 && keyword2) && (keyword3 && keyword4)',
139     'keyword1 || && keyword2' => 'keyword1 || keyword2',
140     'keyword1' => 'keyword:keyword1',
141 );
142
143 my $equivalent;
144 while (($query, $equivalent) = each (%equivalences)) {
145     init_qp();
146     $QParser->parse($query);
147     my $canonical1 = reparse(clean(QueryParser::Canonicalize::abstract_query2str_impl($QParser->parse_tree()->to_abstract_query())));
148     init_qp();
149     $QParser->parse($equivalent);
150     my $canonical2 = reparse(clean(QueryParser::Canonicalize::abstract_query2str_impl($QParser->parse_tree()->to_abstract_query())));
151     is($canonical1, $canonical2, "Queries {$query} and {$equivalent} are equivalent");
152 }
153
154 my %differences = (
155     '(keyword1 keyword2) || keyword3' => 'keyword1 && (keyword2 || keyword3)',
156     'keyword1 || (keyword2 && keyword3)' => '(keyword1 || keyword2) && keyword3',
157     '(keyword1 || keyword2) && keyword3' => 'keyword1 || (keyword2 && keyword3)',
158     'keyword1 keyword2 || keyword3 keyword4' => '(keyword1 keyword2 || keyword3) keyword4', # this should fail on master, 2012-09-07
159 );
160
161
162 my $different;
163 while (($query, $different) = each (%differences)) {
164     init_qp();
165     $QParser->parse($query);
166     my $canonical1 = reparse(clean(QueryParser::Canonicalize::abstract_query2str_impl($QParser->parse_tree()->to_abstract_query())));
167     init_qp();
168     $QParser->parse($different);
169     my $canonical2 = reparse(clean(QueryParser::Canonicalize::abstract_query2str_impl($QParser->parse_tree()->to_abstract_query())));
170     isnt($canonical1, $canonical2, "Queries {$query} and {$different} are not equivalent");
171 }
172
173 =cut
174
175 done_testing;
176
177 sub test_filter_norm {
178     return;
179 }
180
181 sub test_filter_callback {
182     my ($QParser, $struct, $filter, $params, $negate) = @_;
183     is($filter, 'testfilter', 'Filter callback on correct filter');
184     return;
185 }
186
187 sub clean {
188     my $string = shift;
189     $string =~ s/\s+/ /g;
190     $string =~ s/ \)/\)/g;
191     $string =~ s/\( /\(/g;
192     $string =~ s/ $//g;
193     $string =~ s/^ //g;
194     
195     ($string, undef) = parse_parens($string);
196
197     $string =~ s/(^| )\(([^) ]+)\)/$2/g;
198     $string =~ s/^\(([^)]*)\)$/$1/g;
199
200     return $string;
201 }
202
203 sub parse_parens {
204     my $string = shift;
205     my $subres;
206     my $result = '';
207     while (my $nextchar = substr($string, 0, 1)) {
208         $string = substr($string, 1);
209         if ($nextchar eq '(') {
210             ($subres, $string) = parse_parens($string);
211             if ($result || ! (substr($string, 0, 1) eq ')')) {
212                 $result .= "($subres)";
213             } else {
214                 $result = $subres;
215             }
216         } elsif ($nextchar eq ')') {
217             return ($result, $string);
218         } else {
219             $result .= $nextchar;
220         }
221     }
222     return $result;
223 }
224
225 sub reparse {
226     my $canonical = shift;
227     my $repeats = $canonical =~ tr/&/&/;
228     $repeats = ($repeats / 2) + 1;
229     my $result;
230     while (--$repeats) {
231         init_qp();
232         $QParser->parse($canonical);
233         $canonical = clean(QueryParser::Canonicalize::abstract_query2str_impl($QParser->parse_tree()->to_abstract_query()));
234     }
235     return $canonical;
236 }
237
238 sub init_qp {
239     $QueryParser::parser_config{QueryParser}->{allow_nested_modifiers} = 1;
240     $QParser = QueryParser->new(%args);
241     $QParser->add_search_class_alias( title => 'ti' );
242     $QParser->add_search_class_alias( author => 'au' );
243     $QParser->add_search_class_alias( author => 'name' );
244     $QParser->add_search_class_alias( author => 'dc.contributor' );
245     $QParser->add_search_class_alias( subject => 'su' );
246     $QParser->add_search_class_alias( subject => 'bib.subject(?:Title|Place|Occupation)' );
247     $QParser->add_search_class_alias( series => 'se' );
248     $QParser->add_search_class_alias( keyword => 'dc.identifier' );
249
250     $QParser->add_query_normalizer( author => corporate => 'search_normalize' );
251     $QParser->add_query_normalizer( keyword => keyword => 'search_normalize' );
252     
253     $QParser->add_search_field_alias( subject => name => 'bib.subjectName' );
254     $QParser->add_search_field_alias( subject => name => 'nomen' );
255
256     $QParser->add_search_field( 'author' => 'personal' );
257     $QParser->add_search_field( 'author' => 'corporate' );
258     $QParser->add_search_field( 'author' => 'meeting' );
259
260     $QParser->default_search_class( 'keyword' );
261
262     # will be retained simply for back-compat
263     $QParser->add_search_filter( 'format' );
264
265     # grumble grumble, special cases against date1 and date2
266     $QParser->add_search_filter( 'before' );
267     $QParser->add_search_filter( 'after' );
268     $QParser->add_search_filter( 'between' );
269     $QParser->add_search_filter( 'during' );
270
271     # used by layers above this
272     $QParser->add_search_filter( 'statuses' );
273     $QParser->add_search_filter( 'locations' );
274     $QParser->add_search_filter( 'location_groups' );
275     $QParser->add_search_filter( 'site' );
276     $QParser->add_search_filter( 'pref_ou' );
277     $QParser->add_search_filter( 'lasso' );
278     $QParser->add_search_filter( 'my_lasso' );
279     $QParser->add_search_filter( 'depth' );
280     $QParser->add_search_filter( 'language' );
281     $QParser->add_search_filter( 'offset' );
282     $QParser->add_search_filter( 'limit' );
283     $QParser->add_search_filter( 'check_limit' );
284     $QParser->add_search_filter( 'skip_check' );
285     $QParser->add_search_filter( 'superpage' );
286     $QParser->add_search_filter( 'estimation_strategy' );
287     $QParser->add_search_filter( 'copy_tag' );
288     $QParser->add_search_modifier( 'available' );
289     $QParser->add_search_modifier( 'staff' );
290
291     # Start from container data (bre, acn, acp): container(bre,bookbag,123,deadb33fdeadb33fdeadb33fdeadb33f)
292     $QParser->add_search_filter( 'container' );
293
294     # Start from a list of record ids, either bre or metarecords, depending on the #metabib modifier
295     $QParser->add_search_filter( 'record_list' );
296
297     # used internally, but generally not user-settable
298     $QParser->add_search_filter( 'preferred_language' );
299     $QParser->add_search_filter( 'preferred_language_weight' );
300     $QParser->add_search_filter( 'preferred_language_multiplier' );
301     $QParser->add_search_filter( 'core_limit' );
302
303     # XXX Valid values to be supplied by SVF
304     $QParser->add_search_filter( 'sort' );
305
306     # modifies core query, not configurable
307     $QParser->add_search_modifier( 'descending' );
308     $QParser->add_search_modifier( 'ascending' );
309     $QParser->add_search_modifier( 'nullsfirst' );
310     $QParser->add_search_modifier( 'nullslast' );
311     $QParser->add_search_modifier( 'metarecord' );
312     $QParser->add_search_modifier( 'metabib' );
313
314     $QParser->add_facet_field( 'author' => 'personal' );
315     $QParser->add_facet_field( 'author' => 'corporate' );
316     $QParser->add_facet_field( 'subject' => 'topic' );
317     $QParser->add_facet_field( 'subject' => 'geographic' );
318
319     $QParser->add_search_filter( 'testfilter', \&test_filter_callback );
320 }