make the DBIC required warning scoped
[scpubgit/Q-Branch.git] / t / 05in_between.t
1 use strict;
2 use warnings;
3 use Test::More;
4 use Test::Warn;
5 use Test::Exception;
6 use SQL::Abstract::Test import => [qw(is_same_sql_bind diag_where dumper)];
7
8 use SQL::Abstract;
9
10 my @in_between_tests = (
11   {
12     where => { x => { -between => [1, 2] } },
13     stmt => 'WHERE (x BETWEEN ? AND ?)',
14     bind => [qw/1 2/],
15     test => '-between with two placeholders',
16   },
17   {
18     where => { x => { -between => [\"1", 2] } },
19     stmt => 'WHERE (x BETWEEN 1 AND ?)',
20     bind => [qw/2/],
21     test => '-between with one literal sql arg and one placeholder',
22   },
23   {
24     where => { x => { -between => [1, \"2"] } },
25     stmt => 'WHERE (x BETWEEN ? AND 2)',
26     bind => [qw/1/],
27     test => '-between with one placeholder and one literal sql arg',
28   },
29   {
30     where => { x => { -between => [\'current_date - 1', \'current_date - 0'] } },
31     stmt => 'WHERE (x BETWEEN current_date - 1 AND current_date - 0)',
32     bind => [],
33     test => '-between with two literal sql arguments',
34   },
35   {
36     where => { x => { -between => [ \['current_date - ?', 1], \['current_date - ?', 0] ] } },
37     stmt => 'WHERE (x BETWEEN current_date - ? AND current_date - ?)',
38     bind => [1, 0],
39     test => '-between with two literal sql arguments with bind',
40   },
41   {
42     where => { x => { -between => \['? AND ?', 1, 2] } },
43     stmt => 'WHERE (x BETWEEN ? AND ?)',
44     bind => [1,2],
45     test => '-between with literal sql with placeholders (\["? AND ?", scalar, scalar])',
46   },
47   {
48     where => { x => { -between => \["'something' AND ?", 2] } },
49     stmt => "WHERE (x BETWEEN 'something' AND ?)",
50     bind => [2],
51     test => '-between with literal sql with one literal arg and one placeholder (\["\'something\' AND ?", scalar])',
52   },
53   {
54     where => { x => { -between => \["? AND 'something'", 1] } },
55     stmt => "WHERE (x BETWEEN ? AND 'something')",
56     bind => [1],
57     test => '-between with literal sql with one placeholder and one literal arg (\["? AND \'something\'", scalar])',
58   },
59   {
60     where => { x => { -between => \"'this' AND 'that'" } },
61     stmt => "WHERE (x BETWEEN 'this' AND 'that')",
62     bind => [],
63     test => '-between with literal sql with a literal (\"\'this\' AND \'that\'")',
64   },
65
66   # generate a set of invalid -between tests
67   ( map { {
68     where => { x => { -between => $_ } },
69     test => 'invalid -between args',
70     throws => qr|Operator 'BETWEEN' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref|,
71   } } (
72     [ 1, 2, 3 ],
73     [ 1, undef, 3 ],
74     [ undef, 2, 3 ],
75     [ 1, 2, undef ],
76     [ 1, undef ],
77     [ undef, 2 ],
78     [ undef, undef ],
79     [ 1 ],
80     [ undef ],
81     [],
82     1,
83     undef,
84   )),
85   {
86     where => {
87       start0 => { -between => [ 1, { -upper => 2 } ] },
88       start1 => { -between => \["? AND ?", 1, 2] },
89       start2 => { -between => \"lower(x) AND upper(y)" },
90       start3 => { -between => [
91         \"lower(x)",
92         \["upper(?)", 'stuff' ],
93       ] },
94     },
95     stmt => "WHERE (
96           ( start0 BETWEEN ? AND UPPER ?          )
97       AND ( start1 BETWEEN ? AND ?                )
98       AND ( start2 BETWEEN lower(x) AND upper(y)  )
99       AND ( start3 BETWEEN lower(x) AND upper(?)  )
100     )",
101     bind => [1, 2, 1, 2, 'stuff'],
102     test => '-between POD test',
103   },
104   {
105     args => { bindtype => 'columns' },
106     where => {
107       start0 => { -between => [ 1, { -upper => 2 } ] },
108       start1 => { -between => \["? AND ?", [ start1 => 1], [start1 => 2] ] },
109       start2 => { -between => \"lower(x) AND upper(y)" },
110       start3 => { -between => [
111         \"lower(x)",
112         \["upper(?)", [ start3 => 'stuff'] ],
113       ] },
114     },
115     stmt => "WHERE (
116           ( start0 BETWEEN ? AND UPPER ?          )
117       AND ( start1 BETWEEN ? AND ?                )
118       AND ( start2 BETWEEN lower(x) AND upper(y)  )
119       AND ( start3 BETWEEN lower(x) AND upper(?)  )
120     )",
121     bind => [
122       [ start0 => 1 ],
123       [ start0 => 2 ],
124       [ start1 => 1 ],
125       [ start1 => 2 ],
126       [ start3 => 'stuff' ],
127     ],
128     test => '-between POD test',
129   },
130   {
131     where => { 'test1.a' => { 'In', ['boom', 'bang'] } },
132     stmt => ' WHERE ( test1.a IN ( ?, ? ) )',
133     bind => ['boom', 'bang'],
134     test => 'In (no dash, initial cap) with qualified column',
135   },
136   {
137     where => { a => { 'between', ['boom', 'bang'] } },
138     stmt => ' WHERE ( a BETWEEN ? AND ? )',
139     bind => ['boom', 'bang'],
140     test => 'between (no dash) with two placeholders',
141   },
142
143   {
144     where => { x => { -in => [ 1 .. 3] } },
145     stmt => "WHERE x IN (?, ?, ?)",
146     bind => [ 1 .. 3 ],
147     test => '-in with an array of scalars',
148   },
149   {
150     where => { x => { -in => [] } },
151     stmt => "WHERE 0=1",
152     bind => [],
153     test => '-in with an empty array',
154   },
155   {
156     where => { x => { -in => \'( 1,2,lower(y) )' } },
157     stmt => "WHERE x IN ( 1,2,lower(y) )",
158     bind => [],
159     test => '-in with a literal scalarref',
160   },
161
162   # note that outer parens are opened even though literal was requested below
163   {
164     where => { x => { -in => \['( ( ?,?,lower(y) ) )', 1, 2] } },
165     stmt => "WHERE x IN ( ?,?,lower(y) )",
166     bind => [1, 2],
167     test => '-in with a literal arrayrefref',
168   },
169   {
170     where => {
171       status => { -in => \"(SELECT status_codes\nFROM states)" },
172     },
173     stmt => " WHERE status IN ( SELECT status_codes FROM states )",
174     bind => [],
175     test => '-in multi-line subquery test',
176   },
177
178   # check that the outer paren opener is not too agressive
179   # note: this syntax *is not legal* on SQLite (maybe others)
180   #       see end of https://rt.cpan.org/Ticket/Display.html?id=99503
181   {
182     where => { foo => { -in => \ '(SELECT 1) UNION (SELECT 2)' } },
183     stmt => 'WHERE foo IN ( (SELECT 1) UNION (SELECT 2) )',
184     bind => [],
185     test => '-in paren-opening works on balanced pairs only',
186   },
187
188   {
189     where => {
190       customer => { -in => \[
191         'SELECT cust_id FROM cust WHERE balance > ?',
192         2000,
193       ]},
194       status => { -in => \'SELECT status_codes FROM states' },
195     },
196     stmt => "
197       WHERE
198             customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
199         AND status IN ( SELECT status_codes FROM states )
200     ",
201     bind => [2000],
202     test => '-in POD test',
203   },
204
205   {
206     where => { x => { -in => [ \['LOWER(?)', 'A' ], \'LOWER(b)', { -lower => 'c' } ] } },
207     stmt => " WHERE ( x IN ( LOWER(?), LOWER(b), LOWER ? ) )",
208     bind => [qw/A c/],
209     test => '-in with an array of function array refs with args',
210   },
211   {
212     throws => qr/
213       \QSQL::Abstract before v1.75 used to generate incorrect SQL \E
214       \Qwhen the -IN operator was given an undef-containing list: \E
215       \Q!!!AUDIT YOUR CODE AND DATA!!! (the upcoming Data::Query-based \E
216       \Qversion of SQL::Abstract will emit the logically correct SQL \E
217       \Qinstead of raising this exception)\E
218     /x,
219     where => { x => { -in => [ 1, undef ] } },
220     stmt => " WHERE ( x IN ( ? ) OR x IS NULL )",
221     bind => [ 1 ],
222     test => '-in with undef as an element',
223   },
224   {
225     throws => qr/
226       \QSQL::Abstract before v1.75 used to generate incorrect SQL \E
227       \Qwhen the -IN operator was given an undef-containing list: \E
228       \Q!!!AUDIT YOUR CODE AND DATA!!! (the upcoming Data::Query-based \E
229       \Qversion of SQL::Abstract will emit the logically correct SQL \E
230       \Qinstead of raising this exception)\E
231     /x,
232     where => { x => { -in => [ 1, undef, 2, 3, undef ] } },
233     stmt => " WHERE ( x IN ( ?, ?, ? ) OR x IS NULL )",
234     bind => [ 1, 2, 3 ],
235     test => '-in with multiple undef elements',
236   },
237   {
238     where => { a => { -in => 42 }, b => { -not_in => 42 } },
239     stmt => ' WHERE a IN ( ? ) AND b NOT IN ( ? )',
240     bind => [ 42, 42 ],
241     test => '-in, -not_in with scalar',
242   },
243   {
244     where => { a => { -in => [] }, b => { -not_in => [] } },
245     stmt => ' WHERE ( 0=1 AND 1=1 )',
246     bind => [],
247     test => '-in, -not_in with empty arrays',
248   },
249   {
250     throws => qr/
251       \QSQL::Abstract before v1.75 used to generate incorrect SQL \E
252       \Qwhen the -IN operator was given an undef-containing list: \E
253       \Q!!!AUDIT YOUR CODE AND DATA!!! (the upcoming Data::Query-based \E
254       \Qversion of SQL::Abstract will emit the logically correct SQL \E
255       \Qinstead of raising this exception)\E
256     /x,
257     where => { a => { -in => [42, undef] }, b => { -not_in => [42, undef] } },
258     stmt => ' WHERE ( ( a IN ( ? ) OR a IS NULL ) AND b NOT IN ( ? ) AND b IS NOT NULL )',
259     bind => [ 42, 42 ],
260     test => '-in, -not_in with undef among elements',
261   },
262   {
263     throws => qr/
264       \QSQL::Abstract before v1.75 used to generate incorrect SQL \E
265       \Qwhen the -IN operator was given an undef-containing list: \E
266       \Q!!!AUDIT YOUR CODE AND DATA!!! (the upcoming Data::Query-based \E
267       \Qversion of SQL::Abstract will emit the logically correct SQL \E
268       \Qinstead of raising this exception)\E
269     /x,
270     where => { a => { -in => [undef] }, b => { -not_in => [undef] } },
271     stmt => ' WHERE ( a IS NULL AND b IS NOT NULL )',
272     bind => [],
273     test => '-in, -not_in with just undef element',
274   },
275   {
276     where => { a => { -in => undef } },
277     throws => qr/Argument passed to the 'IN' operator can not be undefined/,
278     test => '-in with undef argument',
279   },
280
281   {
282     where => { -in => [42] },
283     throws => qr/Illegal use of top-level '-in'/,
284     test => 'Top level -in',
285   },
286   {
287     where => { -between => [42, 69] },
288     throws => qr/Illegal use of top-level '-between'/,
289     test => 'Top level -between',
290   },
291 );
292
293 for my $case (@in_between_tests) {
294   TODO: {
295     local $TODO = $case->{todo} if $case->{todo};
296     local $SQL::Abstract::Test::parenthesis_significant = $case->{parenthesis_significant};
297     my $label = $case->{test} || 'in-between test';
298
299     my $sql = SQL::Abstract->new($case->{args} || {});
300
301     if (my $e = $case->{throws}) {
302       my $stmt;
303       throws_ok { ($stmt) = $sql->where($case->{where}) } $e, "$label throws correctly"
304         or diag dumper ({ where => $case->{where}, result => $stmt });
305     }
306     else {
307       my ($stmt, @bind);
308       warnings_are {
309         ($stmt, @bind) = $sql->where($case->{where});
310       } [], "$label gives no warnings";
311
312       is_same_sql_bind(
313         $stmt,
314         \@bind,
315         $case->{stmt},
316         $case->{bind},
317         "$label generates correct SQL and bind",
318       ) || diag dumper ({ where => $case->{where}, exp => $sql->_expand_expr($case->{where}) });
319     }
320   }
321 }
322
323 done_testing;