added a test case for various matching behaviors
[catagits/Web-Simple.git] / t / dispatch_parser.t
1 use strict;
2 use warnings FATAL => 'all';
3
4 use Test::More qw(no_plan);
5
6 use Web::Dispatch::Parser;
7
8 my $dp = Web::Dispatch::Parser->new;
9
10 {
11   my $all = $dp->parse('');
12
13   is_deeply(
14     [ $all->({ REQUEST_METHOD => 'GET' }) ],
15     [ {} ],
16     'GET matches'
17   );
18
19   is_deeply(
20     [ $all->({ REQUEST_METHOD => 'POST' }) ],
21     [ {} ],
22     'POST matches'
23   );
24 };
25
26 {
27   my $get = $dp->parse('GET');
28
29   is_deeply(
30     [ $get->({ REQUEST_METHOD => 'GET' }) ],
31     [ {} ],
32     'GET matches'
33   );
34
35   is_deeply(
36     [ $get->({ REQUEST_METHOD => 'POST' }) ],
37     [],
38     'POST does not match'
39   );
40 }
41
42 {
43   my $html = $dp->parse('.html');
44
45   is_deeply(
46     [ $html->({ PATH_INFO => '/foo/bar.html' }) ],
47     [ { } ],
48     '.html matches'
49   );
50
51   is_deeply(
52     [ $html->({ PATH_INFO => '/foo/bar.xml' }) ],
53     [],
54     '.xml does not match .html'
55   );
56 }
57
58 {
59   my $any_ext = $dp->parse('.*');
60
61   is_deeply(
62     [ $any_ext->({ PATH_INFO => '/foo/bar.html' }) ],
63     [ { }, 'html' ],
64     '.html matches .* and extension returned'
65   );
66
67   is_deeply(
68     [ $any_ext->({ PATH_INFO => '/foo/bar' }) ],
69     [],
70     'no extension does not match .*'
71   );
72 }
73
74 {
75   my $slash = $dp->parse('/');
76
77   is_deeply(
78     [ $slash->({ PATH_INFO => '/' }) ],
79     [ {} ],
80     '/ matches /'
81   );
82
83   is_deeply(
84     [ $slash->({ PATH_INFO => '/foo' }) ],
85     [ ],
86     '/foo does not match /'
87   );
88 }
89
90 {
91   my $post = $dp->parse('/post/*');
92
93   is_deeply(
94     [ $post->({ PATH_INFO => '/post/one' }) ],
95     [ {}, 'one' ],
96     '/post/one parses out one'
97   );
98
99   is_deeply(
100     [ $post->({ PATH_INFO => '/post/one/' }) ],
101     [],
102     '/post/one/ does not match'
103   );
104
105   is_deeply(
106     [ $post->({ PATH_INFO => '/post/one.html' }) ],
107     [ {}, 'one' ],
108     '/post/one.html still parses out one'
109   );
110 }
111
112 {
113   my $post = $dp->parse('/foo-bar/*');
114
115   is_deeply(
116     [ $post->({ PATH_INFO => '/foo-bar/one' }) ],
117     [ {}, 'one' ],
118     '/foo-bar/one parses out one'
119   );
120
121   is_deeply(
122     [ $post->({ PATH_INFO => '/foo-bar/one/' }) ],
123     [],
124     '/foo-bar/one/ does not match'
125   );
126 }
127
128 {
129   my $combi = $dp->parse('GET+/post/*');
130
131   is_deeply(
132     [ $combi->({ PATH_INFO => '/post/one', REQUEST_METHOD => 'GET' }) ],
133     [ {}, 'one' ],
134     '/post/one parses out one'
135   );
136
137   is_deeply(
138     [ $combi->({ PATH_INFO => '/post/one/', REQUEST_METHOD => 'GET' }) ],
139     [],
140     '/post/one/ does not match'
141   );
142
143   is_deeply(
144     [ $combi->({ PATH_INFO => '/post/one', REQUEST_METHOD => 'POST' }) ],
145     [],
146     'POST /post/one does not match'
147   );
148 }
149
150 {
151   my $or = $dp->parse('GET|POST');
152
153   foreach my $meth (qw(GET POST)) {
154
155     is_deeply(
156       [ $or->({ REQUEST_METHOD => $meth }) ],
157       [ {} ],
158       'GET|POST matches method '.$meth
159     );
160   }
161
162   is_deeply(
163     [ $or->({ REQUEST_METHOD => 'PUT' }) ],
164     [],
165     'GET|POST does not match PUT'
166   );
167 }
168
169 {
170   my $or = $dp->parse('GET|POST|DELETE');
171
172   foreach my $meth (qw(GET POST DELETE)) {
173
174     is_deeply(
175       [ $or->({ REQUEST_METHOD => $meth }) ],
176       [ {} ],
177       'GET|POST|DELETE matches method '.$meth
178     );
179   }
180
181   is_deeply(
182     [ $or->({ REQUEST_METHOD => 'PUT' }) ],
183     [],
184     'GET|POST|DELETE does not match PUT'
185   );
186 }
187
188 {
189   my $nest = $dp->parse('(GET+/foo)|POST');
190
191   is_deeply(
192     [ $nest->({ PATH_INFO => '/foo', REQUEST_METHOD => 'GET' }) ],
193     [ {} ],
194     '(GET+/foo)|POST matches GET /foo'
195   );
196
197   is_deeply(
198     [ $nest->({ PATH_INFO => '/bar', REQUEST_METHOD => 'GET' }) ],
199     [],
200     '(GET+/foo)|POST does not match GET /bar'
201   );
202
203   is_deeply(
204     [ $nest->({ PATH_INFO => '/bar', REQUEST_METHOD => 'POST' }) ],
205     [ {} ],
206     '(GET+/foo)|POST matches POST /bar'
207   );
208
209   is_deeply(
210     [ $nest->({ PATH_INFO => '/foo', REQUEST_METHOD => 'PUT' }) ],
211     [],
212     '(GET+/foo)|POST does not match PUT /foo'
213   );
214 }
215
216 {
217   local $@;
218   ok(
219     !eval { $dp->parse('/foo+(GET'); 1 },
220     'Death with missing closing )'
221   );
222   my $err = q{
223     /foo+(GET
224          ^
225   };
226   (s/^\n//s,s/\n  $//s,s/^    //mg) for $err;
227   like(
228     $@,
229     qr{\Q$err\E},
230     "Error $@ matches\n${err}\n"
231   );
232 }
233
234 {
235   my $not = $dp->parse('!.html+.*');
236
237   is_deeply(
238     [ $not->({ PATH_INFO => '/foo.xml' }) ],
239     [ {}, 'xml' ],
240     '!.html+.* matches /foo.xml'
241   );
242
243   is_deeply(
244     [ $not->({ PATH_INFO => '/foo.html' }) ],
245     [],
246     '!.html+.* does not match /foo.html'
247   );
248
249   is_deeply(
250     [ $not->({ PATH_INFO => '/foo' }) ],
251     [],
252     '!.html+.* does not match /foo'
253   );
254 }
255
256 {
257   my $ext = $dp->parse('/foo.bar');
258
259   is_deeply(
260     [ $ext->({ PATH_INFO => '/foo.bar' }) ],
261     [ {} ],
262     '/foo.bar matches /foo.bar'
263   );
264
265   is_deeply(
266     [ $ext->({ PATH_INFO => '/foo.bar.ext' }) ],
267     [ {} ],
268     '/foo.bar matches /foo.bar.ext'
269   );
270
271   is_deeply(
272     [ $ext->({ PATH_INFO => '/foo.notbar' }) ],
273     [],
274     '/foo.bar does not match /foo.notbar'
275   );
276 }
277
278 {
279   my $sub = $dp->parse('/foo/*/...');
280
281   is_deeply(
282     [ $sub->({ PATH_INFO => '/foo/1/bar' }) ],
283     [ { PATH_INFO => '/bar', SCRIPT_NAME => '/foo/1' }, 1 ],
284     '/foo/*/... matches /foo/1/bar and strips to /bar'
285   );
286
287   is_deeply(
288     [ $sub->({ PATH_INFO => '/foo/1/' }) ],
289     [ { PATH_INFO => '/', SCRIPT_NAME => '/foo/1' }, 1 ],
290     '/foo/*/... matches /foo/1/bar and strips to /'
291   );
292
293   is_deeply(
294     [ $sub->({ PATH_INFO => '/foo/1' }) ],
295     [],
296     '/foo/*/... does not match /foo/1 (no trailing /)'
297   );
298 }
299
300 {
301   my $sub = $dp->parse('/foo/**/belief');
302   my $match = 'barred/beyond';
303   is_deeply(
304     [ $sub->({ PATH_INFO => "/foo/${match}/belief" }) ],
305     [ {}, $match ],
306     "/foo/**/belief matches /foo/${match}/belief"
307   );
308 }
309
310 {
311   my $match = '~';
312   my $sub = $dp->parse($match);
313
314   is_deeply(
315     [ $sub->({ PATH_INFO => '/foo' }) ],
316     [],
317     "$match does not match /foo"
318   );
319
320   is_deeply(
321     [ $sub->({ PATH_INFO => '' }) ],
322     [ {} ],
323     "$match matches empty path with empty env"
324   );
325 }
326
327 {
328   my $match = '/foo...';
329   my $sub = $dp->parse($match);
330
331   is_deeply(
332     [ $sub->({ PATH_INFO => '/foo/bar' }) ],
333     [ { PATH_INFO => '/bar', SCRIPT_NAME => '/foo' } ],
334     "$match matches /foo/bar and strips to /bar"
335   );
336
337   is_deeply(
338     [ $sub->({ PATH_INFO => '/foo/' }) ],
339     [ { PATH_INFO => '/', SCRIPT_NAME => '/foo' } ],
340     "$match matches /foo/ and strips to /"
341   );
342
343   is_deeply(
344     [ $sub->({ PATH_INFO => '/foo' }) ],
345     [ { PATH_INFO => '', SCRIPT_NAME => '/foo' } ],
346     "$match matches /foo and strips to empty path"
347   );
348 }
349
350 {
351   my @dot_pairs = (
352     [ '/one/*' => 'two' ],
353     [ '/one/*.*' => 'two.three' ],
354     [ '/**' => 'one/two' ],
355     [ '/**.*' => 'one/two.three' ],
356   );
357
358   foreach my $p (@dot_pairs) {
359     is_deeply(
360       [ $dp->parse($p->[0])->({ PATH_INFO => '/one/two.three' }) ],
361       [ {}, $p->[1] ],
362       "${\$p->[0]} matches /one/two.three and returns ${\$p->[1]}"
363     );
364   }
365 }
366
367 #
368 # query string
369 #
370
371 my $q = 'foo=FOO&bar=BAR1&baz=one+two&quux=QUUX1&quux=QUUX2'
372   .'&bar=BAR2&quux=QUUX3&evil=%2F';
373
374 my %all_single = (
375   foo => 'FOO',
376   bar => 'BAR2',
377   baz => 'one two',
378   quux => 'QUUX3',
379   evil => '/',
380 );
381
382 my %all_multi = (
383   foo => [ 'FOO' ],
384   bar => [ qw(BAR1 BAR2) ],
385   baz => [ 'one two' ],
386   quux => [ qw(QUUX1 QUUX2 QUUX3) ],
387   evil => [ '/' ],
388 );
389
390 foreach my $lose ('?foo=','?:foo=','?@foo=','?:@foo=') {
391   my $foo = $dp->parse($lose);
392
393   is_deeply(
394     [ $foo->({ QUERY_STRING => '' }) ],
395     [],
396     "${lose} fails with no query"
397   );
398
399   is_deeply(
400     [ $foo->({ QUERY_STRING => 'bar=baz' }) ],
401     [],
402     "${lose} fails with query missing foo key"
403   );
404 }
405
406 foreach my $win (
407   [ '?foo=' => 'FOO' ],
408   [ '?:foo=' => { foo => 'FOO' } ],
409   [ '?spoo~' => undef ],
410   [ '?:spoo~' => {} ],
411   [ '?@spoo~' => [] ],
412   [ '?:@spoo~' => { spoo => [] } ],
413   [ '?bar=' => 'BAR2' ],
414   [ '?:bar=' => { bar => 'BAR2' } ],
415   [ '?@bar=' => [ qw(BAR1 BAR2) ] ],
416   [ '?:@bar=' => { bar => [ qw(BAR1 BAR2) ] } ],
417   [ '?foo=&@bar=' => 'FOO', [ qw(BAR1 BAR2) ] ],
418   [ '?foo=&:@bar=' => 'FOO', { bar => [ qw(BAR1 BAR2) ] } ],
419   [ '?:foo=&:@bar=' => { foo => 'FOO', bar => [ qw(BAR1 BAR2) ] } ],
420   [ '?:baz=&:evil=' => { baz => 'one two', evil => '/' } ],
421   [ '?*' => \%all_single ],
422   [ '?@*' => \%all_multi ],
423   [ '?foo=&@*' => 'FOO', \%all_multi ],
424   [ '?:foo=&@*' => { %all_multi, foo => 'FOO' } ],
425   [ '?:@bar=&*' => { %all_single, bar => [ qw(BAR1 BAR2) ] } ],
426 ) {
427   my ($spec, @res) = @$win;
428   my $match = $dp->parse($spec);
429   #use Data::Dump::Streamer; warn Dump($match);
430   is_deeply(
431     [ $match->({ QUERY_STRING => $q }) ],
432     [ {}, @res ],
433     "${spec} matches correctly"
434   );
435 }
436
437 #
438 # /path/info/ + query string
439 #
440
441 foreach my $lose2 ('/foo/bar/+?foo=','/foo/bar/+?:foo=','/foo/bar/+?@foo=','/foo/bar/+?:@foo=') {
442   my $foo = $dp->parse($lose2);
443
444   is_deeply(
445     [ $foo->({ PATH_INFO => '/foo/bar/', QUERY_STRING => '' }) ],
446     [ ],
447     "${lose2} fails with no query"
448   );
449
450   is_deeply(
451     [ $foo->({ PATH_INFO => '/foo/bar/', QUERY_STRING => 'bar=baz' }) ],
452     [ ],
453     "${lose2} fails with query missing foo key"
454   );
455 }
456
457 foreach my $win2 (
458   [ '/foo/bar/+?foo=' => 'FOO' ],
459   [ '/foo/bar/+?:foo=' => { foo => 'FOO' } ],
460   [ '/foo/bar/+?spoo~' => undef ],
461   [ '/foo/bar/+?:spoo~' => {} ],
462   [ '/foo/bar/+?@spoo~' => [] ],
463   [ '/foo/bar/+?:@spoo~' => { spoo => [] } ],
464   [ '/foo/bar/+?bar=' => 'BAR2' ],
465   [ '/foo/bar/+?:bar=' => { bar => 'BAR2' } ],
466   [ '/foo/bar/+?@bar=' => [ qw(BAR1 BAR2) ] ],
467   [ '/foo/bar/+?:@bar=' => { bar => [ qw(BAR1 BAR2) ] } ],
468   [ '/foo/bar/+?foo=&@bar=' => 'FOO', [ qw(BAR1 BAR2) ] ],
469   [ '/foo/bar/+?foo=&:@bar=' => 'FOO', { bar => [ qw(BAR1 BAR2) ] } ],
470   [ '/foo/bar/+?:foo=&:@bar=' => { foo => 'FOO', bar => [ qw(BAR1 BAR2) ] } ],
471   [ '/foo/bar/+?:baz=&:evil=' => { baz => 'one two', evil => '/' } ],
472   [ '/foo/bar/+?*' => \%all_single ],
473   [ '/foo/bar/+?@*' => \%all_multi ],
474   [ '/foo/bar/+?foo=&@*' => 'FOO', \%all_multi ],
475   [ '/foo/bar/+?:foo=&@*' => { %all_multi, foo => 'FOO' } ],
476   [ '/foo/bar/+?:@bar=&*' => { %all_single, bar => [ qw(BAR1 BAR2) ] } ],
477 ) {
478   my ($spec, @res) = @$win2;
479   my $match = $dp->parse($spec);
480   # use Data::Dump::Streamer; warn Dump($match);
481   is_deeply(
482     [ $match->({ PATH_INFO => '/foo/bar/', QUERY_STRING => $q }) ],
483     [ {}, @res ],
484     "${spec} matches correctly"
485   );
486 }
487
488 #
489 # /path/info + query string
490 #
491
492 foreach my $lose3 ('/foo/bar+?foo=','/foo/bar+?:foo=','/foo/bar+?@foo=','/foo/bar+?:@foo=') {
493   my $foo = $dp->parse($lose3);
494
495   is_deeply(
496     [ $foo->({ PATH_INFO => '/foo/bar', QUERY_STRING => '' }) ],
497     [ ],
498     "${lose3} fails with no query"
499   );
500
501   is_deeply(
502     [ $foo->({ PATH_INFO => '/foo/bar', QUERY_STRING => 'bar=baz' }) ],
503     [ ],
504     "${lose3} fails with query missing foo key"
505   );
506 }
507
508 foreach my $win3 (
509   [ '/foo/bar+?foo=' => 'FOO' ],
510   [ '/foo/bar+?:foo=' => { foo => 'FOO' } ],
511   [ '/foo/bar+?spoo~' => undef ],
512   [ '/foo/bar+?:spoo~' => {} ],
513   [ '/foo/bar+?@spoo~' => [] ],
514   [ '/foo/bar+?:@spoo~' => { spoo => [] } ],
515   [ '/foo/bar+?bar=' => 'BAR2' ],
516   [ '/foo/bar+?:bar=' => { bar => 'BAR2' } ],
517   [ '/foo/bar+?@bar=' => [ qw(BAR1 BAR2) ] ],
518   [ '/foo/bar+?:@bar=' => { bar => [ qw(BAR1 BAR2) ] } ],
519   [ '/foo/bar+?foo=&@bar=' => 'FOO', [ qw(BAR1 BAR2) ] ],
520   [ '/foo/bar+?foo=&:@bar=' => 'FOO', { bar => [ qw(BAR1 BAR2) ] } ],
521   [ '/foo/bar+?:foo=&:@bar=' => { foo => 'FOO', bar => [ qw(BAR1 BAR2) ] } ],
522   [ '/foo/bar+?:baz=&:evil=' => { baz => 'one two', evil => '/' } ],
523   [ '/foo/bar+?*' => \%all_single ],
524   [ '/foo/bar+?@*' => \%all_multi ],
525   [ '/foo/bar+?foo=&@*' => 'FOO', \%all_multi ],
526   [ '/foo/bar+?:foo=&@*' => { %all_multi, foo => 'FOO' } ],
527   [ '/foo/bar+?:@bar=&*' => { %all_single, bar => [ qw(BAR1 BAR2) ] } ],
528 ) {
529   my ($spec, @res) = @$win3;
530   my $match = $dp->parse($spec);
531   # use Data::Dump::Streamer; warn Dump($match);
532   is_deeply(
533     [ $match->({ PATH_INFO => '/foo/bar', QUERY_STRING => $q }) ],
534     [ {}, @res ],
535     "${spec} matches correctly"
536   );
537 }