55ffd6fa545f8a9348bfefe0b73e86fbe3577e81
[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, 28, "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 # It's unfortunate not to be able to use the following tests immediately, but
64 # they reflect assumptions that need to be updated in light of new qp_fix code.
65 # Also,, canonicalization may not preserve insignificant whitespace nor the
66 # exact, original number of non-semantic parentheses.
67
68 =cut
69
70 init_qp();
71
72 my %queries = (
73     '(keyword1 keyword2) || keyword3' => undef,
74     'keyword1 || keyword2' => undef,
75     'author:keyword1 keyword2' => undef,
76     '(keyword1) || (keyword2)' => undef,
77     'keyword1 || keyword2 || keyword3' => undef,
78     '(keyword1 || keyword2) && keyword3' => undef,
79     'keyword1 keyword2 || keyword3 keyword4' => sub {
80         my $query = shift;
81         # Unfortunately, the canonical representation of a query in master
82         # as of 2012/09/07 is not unambiguous
83         is($QParser->parse_tree()->to_abstract_query()->{children}->{'&'}, undef, "Outer-most operator in query {$query} is not AND");
84         is(ref $QParser->parse_tree()->to_abstract_query()->{children}->{'|'}, 'ARRAY', "Outer-most operator in query {$query} is OR");
85     },
86     'keyword1 keyword2 && keyword3 keyword4' => undef,
87     'keyword1 author:keyword2' => undef,
88     'au:keyword1 kw:keyword2' => undef,
89     'keyword1 pref_ou(lib)' => sub {
90         my $query = shift;
91         is($QParser->parse_tree->to_abstract_query()->{filters}->[0]->{name}, 'pref_ou', 'Generated filter for query');
92     },
93     'keyword1 #available' => sub {
94         my $query = shift;
95         is($QParser->parse_tree->to_abstract_query()->{modifiers}->[0], 'available', 'Set modifier for query');
96     },
97     '(keyword1 keyword2) || keyword3 #available' => sub {
98         my $query = shift;
99         is($QParser->parse_tree->to_abstract_query()->{modifiers}->[0], 'available', 'Set modifier for query');
100     },
101     'keyword1 testfilter(whatever)' => undef,
102     'keyword1 sort:something' => undef,
103     '"phrase1 phrase2" keyword1' => undef, # NOTE: phrases do not have a stable canonical representation, 2012-09-09
104     'keyword1 -keyword2' => undef,
105     'keyword1 +keyword2' => undef,
106 );
107
108 my $query;
109 my $testfunc;
110 while (($query, $testfunc) = each (%queries)) {
111     init_qp();
112     $QParser->parse($query);
113     # TODO: Test initial parse
114     &$testfunc($query) if ($testfunc);
115     my $canonical = clean(QueryParser::Canonicalize::abstract_query2str_impl($QParser->parse_tree()->to_abstract_query()));
116     $canonical = reparse($canonical);
117     init_qp();
118     $QParser->parse($canonical);
119     is(clean(QueryParser::Canonicalize::abstract_query2str_impl($QParser->parse_tree()->to_abstract_query())), $canonical, "Building query from canonical query is idempotent for query {$query}");
120 }
121
122 my %equivalences = (
123     'keyword1 keyword2' => 'keyword1 && keyword2',
124     'keyword1 keyword2 || keyword3 keyword4' => 'keyword1 && keyword2 || keyword3 && keyword4',
125     'keyword1 keyword2 || keyword3 keyword4' => '(keyword1 keyword2) || (keyword3 keyword4)',
126     'keyword1 keyword2 && keyword3 keyword4' => '(keyword1 && keyword2) && (keyword3 && keyword4)',
127     'keyword1 || && keyword2' => 'keyword1 || keyword2',
128     'keyword1' => 'keyword:keyword1',
129 );
130
131 my $equivalent;
132 while (($query, $equivalent) = each (%equivalences)) {
133     init_qp();
134     $QParser->parse($query);
135     my $canonical1 = reparse(clean(QueryParser::Canonicalize::abstract_query2str_impl($QParser->parse_tree()->to_abstract_query())));
136     init_qp();
137     $QParser->parse($equivalent);
138     my $canonical2 = reparse(clean(QueryParser::Canonicalize::abstract_query2str_impl($QParser->parse_tree()->to_abstract_query())));
139     is($canonical1, $canonical2, "Queries {$query} and {$equivalent} are equivalent");
140 }
141
142 my %differences = (
143     '(keyword1 keyword2) || keyword3' => 'keyword1 && (keyword2 || keyword3)',
144     'keyword1 || (keyword2 && keyword3)' => '(keyword1 || keyword2) && keyword3',
145     '(keyword1 || keyword2) && keyword3' => 'keyword1 || (keyword2 && keyword3)',
146     'keyword1 keyword2 || keyword3 keyword4' => '(keyword1 keyword2 || keyword3) keyword4', # this should fail on master, 2012-09-07
147 );
148
149
150 my $different;
151 while (($query, $different) = each (%differences)) {
152     init_qp();
153     $QParser->parse($query);
154     my $canonical1 = reparse(clean(QueryParser::Canonicalize::abstract_query2str_impl($QParser->parse_tree()->to_abstract_query())));
155     init_qp();
156     $QParser->parse($different);
157     my $canonical2 = reparse(clean(QueryParser::Canonicalize::abstract_query2str_impl($QParser->parse_tree()->to_abstract_query())));
158     isnt($canonical1, $canonical2, "Queries {$query} and {$different} are not equivalent");
159 }
160
161 =cut
162
163 done_testing;
164
165 sub test_filter_norm {
166     return;
167 }
168
169 sub test_filter_callback {
170     my ($QParser, $struct, $filter, $params, $negate) = @_;
171     is($filter, 'testfilter', 'Filter callback on correct filter');
172     return;
173 }
174
175 sub clean {
176     my $string = shift;
177     $string =~ s/\s+/ /g;
178     $string =~ s/ \)/\)/g;
179     $string =~ s/\( /\(/g;
180     $string =~ s/ $//g;
181     $string =~ s/^ //g;
182     
183     ($string, undef) = parse_parens($string);
184
185     $string =~ s/(^| )\(([^) ]+)\)/$2/g;
186     $string =~ s/^\(([^)]*)\)$/$1/g;
187
188     return $string;
189 }
190
191 sub parse_parens {
192     my $string = shift;
193     my $subres;
194     my $result = '';
195     while (my $nextchar = substr($string, 0, 1)) {
196         $string = substr($string, 1);
197         if ($nextchar eq '(') {
198             ($subres, $string) = parse_parens($string);
199             if ($result || ! (substr($string, 0, 1) eq ')')) {
200                 $result .= "($subres)";
201             } else {
202                 $result = $subres;
203             }
204         } elsif ($nextchar eq ')') {
205             return ($result, $string);
206         } else {
207             $result .= $nextchar;
208         }
209     }
210     return $result;
211 }
212
213 sub reparse {
214     my $canonical = shift;
215     my $repeats = $canonical =~ tr/&/&/;
216     $repeats = ($repeats / 2) + 1;
217     my $result;
218     while (--$repeats) {
219         init_qp();
220         $QParser->parse($canonical);
221         $canonical = clean(QueryParser::Canonicalize::abstract_query2str_impl($QParser->parse_tree()->to_abstract_query()));
222     }
223     return $canonical;
224 }
225
226 sub init_qp {
227     $QueryParser::parser_config{QueryParser}->{allow_nested_modifiers} = 1;
228     $QParser = QueryParser->new(%args);
229     $QParser->add_search_class_alias( title => 'ti' );
230     $QParser->add_search_class_alias( author => 'au' );
231     $QParser->add_search_class_alias( author => 'name' );
232     $QParser->add_search_class_alias( author => 'dc.contributor' );
233     $QParser->add_search_class_alias( subject => 'su' );
234     $QParser->add_search_class_alias( subject => 'bib.subject(?:Title|Place|Occupation)' );
235     $QParser->add_search_class_alias( series => 'se' );
236     $QParser->add_search_class_alias( keyword => 'dc.identifier' );
237
238     $QParser->add_query_normalizer( author => corporate => 'search_normalize' );
239     $QParser->add_query_normalizer( keyword => keyword => 'search_normalize' );
240     
241     $QParser->add_search_field_alias( subject => name => 'bib.subjectName' );
242     $QParser->add_search_field_alias( subject => name => 'nomen' );
243
244     $QParser->add_search_field( 'author' => 'personal' );
245     $QParser->add_search_field( 'author' => 'corporate' );
246     $QParser->add_search_field( 'author' => 'meeting' );
247
248     $QParser->default_search_class( 'keyword' );
249
250     # will be retained simply for back-compat
251     $QParser->add_search_filter( 'format' );
252
253     # grumble grumble, special cases against date1 and date2
254     $QParser->add_search_filter( 'before' );
255     $QParser->add_search_filter( 'after' );
256     $QParser->add_search_filter( 'between' );
257     $QParser->add_search_filter( 'during' );
258
259     # used by layers above this
260     $QParser->add_search_filter( 'statuses' );
261     $QParser->add_search_filter( 'locations' );
262     $QParser->add_search_filter( 'location_groups' );
263     $QParser->add_search_filter( 'site' );
264     $QParser->add_search_filter( 'pref_ou' );
265     $QParser->add_search_filter( 'lasso' );
266     $QParser->add_search_filter( 'my_lasso' );
267     $QParser->add_search_filter( 'depth' );
268     $QParser->add_search_filter( 'language' );
269     $QParser->add_search_filter( 'offset' );
270     $QParser->add_search_filter( 'limit' );
271     $QParser->add_search_filter( 'check_limit' );
272     $QParser->add_search_filter( 'skip_check' );
273     $QParser->add_search_filter( 'superpage' );
274     $QParser->add_search_filter( 'estimation_strategy' );
275     $QParser->add_search_modifier( 'available' );
276     $QParser->add_search_modifier( 'staff' );
277
278     # Start from container data (bre, acn, acp): container(bre,bookbag,123,deadb33fdeadb33fdeadb33fdeadb33f)
279     $QParser->add_search_filter( 'container' );
280
281     # Start from a list of record ids, either bre or metarecords, depending on the #metabib modifier
282     $QParser->add_search_filter( 'record_list' );
283
284     # used internally, but generally not user-settable
285     $QParser->add_search_filter( 'preferred_language' );
286     $QParser->add_search_filter( 'preferred_language_weight' );
287     $QParser->add_search_filter( 'preferred_language_multiplier' );
288     $QParser->add_search_filter( 'core_limit' );
289
290     # XXX Valid values to be supplied by SVF
291     $QParser->add_search_filter( 'sort' );
292
293     # modifies core query, not configurable
294     $QParser->add_search_modifier( 'descending' );
295     $QParser->add_search_modifier( 'ascending' );
296     $QParser->add_search_modifier( 'nullsfirst' );
297     $QParser->add_search_modifier( 'nullslast' );
298     $QParser->add_search_modifier( 'metarecord' );
299     $QParser->add_search_modifier( 'metabib' );
300
301     $QParser->add_facet_field( 'author' => 'personal' );
302     $QParser->add_facet_field( 'author' => 'corporate' );
303     $QParser->add_facet_field( 'subject' => 'topic' );
304     $QParser->add_facet_field( 'subject' => 'geographic' );
305
306     $QParser->add_search_filter( 'testfilter', \&test_filter_callback );
307 }