Some stylistic test changes in preparation for next commits
[dbsrgits/DBIx-Class.git] / t / 88result_set_column.t
1 use strict;
2 use warnings;
3
4 use Test::More;
5 use Test::Warn;
6 use Test::Exception;
7
8 # MASSIVE FIXME - there is a hole in ::RSC / as_subselect_rs
9 # losing the order. Needs a rework/extract of the realiaser,
10 # and that's a whole another bag of dicks
11 BEGIN { $ENV{DBIC_SHUFFLE_UNORDERED_RESULTSETS} = 0 }
12
13 use lib qw(t/lib);
14 use DBICTest ':DiffSQL';
15
16 my $schema = DBICTest->init_schema();
17
18 my $rs = $schema->resultset("CD");
19
20 cmp_ok (
21   $rs->count,
22     '>',
23   $rs->search ({}, {columns => ['year'], distinct => 1})->count,
24   'At least one year is the same in rs'
25 );
26
27 my $rs_title = $rs->get_column('title');
28 my $rs_year = $rs->get_column('year');
29 my $max_year = $rs->get_column(\'MAX (year)');
30
31 my @all_titles = $rs_title->all;
32 cmp_ok(scalar @all_titles, '==', 5, "five titles returned");
33
34 my @nexted_titles;
35 while (my $r = $rs_title->next) {
36   push @nexted_titles, $r;
37 }
38
39 is_deeply (\@all_titles, \@nexted_titles, 'next works');
40
41 is_deeply( [ sort $rs_year->func('DISTINCT') ], [ 1997, 1998, 1999, 2001 ],  "wantarray context okay");
42 ok ($max_year->next == $rs_year->max, q/get_column (\'FUNC') ok/);
43
44 cmp_ok($rs_year->max, '==', 2001, "max okay for year");
45 is($rs_title->min, 'Caterwaulin\' Blues', "min okay for title");
46
47 cmp_ok($rs_year->sum, '==', 9996, "three artists returned");
48
49 {
50   my $rso_year = $rs->search({}, { order_by => 'cdid' })->get_column('year');
51   is($rso_year->next, 1999, "reset okay");
52
53   is($rso_year->first, 1999, "first okay");
54
55   warnings_exist (sub {
56     is($rso_year->single, 1999, "single okay");
57   }, qr/Query returned more than one row/, 'single warned');
58 }
59
60
61 # test distinct propagation
62 is_deeply (
63   [sort $rs->search ({}, { distinct => 1 })->get_column ('year')->all],
64   [sort $rs_year->func('distinct')],
65   'distinct => 1 is passed through properly',
66 );
67
68 # test illogical distinct
69 my $dist_rs = $rs->search ({}, {
70   columns => ['year'],
71   distinct => 1,
72   order_by => { -desc => [qw( cdid year )] },
73 });
74
75 is_same_sql_bind(
76   $dist_rs->as_query,
77   '(
78     SELECT me.year
79       FROM cd me
80     GROUP BY me.year
81     ORDER BY MAX(cdid) DESC, year DESC
82   )',
83   [],
84   'Correct SQL on external-ordered distinct',
85 );
86
87 is_same_sql_bind(
88   $dist_rs->count_rs->as_query,
89   '(
90     SELECT COUNT( * )
91       FROM (
92         SELECT me.year
93           FROM cd me
94         GROUP BY me.year
95       ) me
96   )',
97   [],
98   'Correct SQL on count of external-orderdd distinct',
99 );
100
101 is (
102   $dist_rs->count_rs->next,
103   4,
104   'Correct rs-count',
105 );
106
107 is (
108   $dist_rs->count,
109   4,
110   'Correct direct count',
111 );
112
113 # test +select/+as for single column
114 my $psrs = $schema->resultset('CD')->search({},
115     {
116         '+select'   => \'MAX(year)',
117         '+as'       => 'last_year'
118     }
119 );
120 lives_ok(sub { $psrs->get_column('last_year')->next }, '+select/+as additional column "last_year" present (scalar)');
121 dies_ok(sub { $psrs->get_column('noSuchColumn')->next }, '+select/+as nonexistent column throws exception');
122
123 # test +select/+as for overriding a column
124 $psrs = $schema->resultset('CD')->search({},
125     {
126         'select'   => \"'The Final Countdown'",
127         'as'       => 'title'
128     }
129 );
130 is($psrs->get_column('title')->next, 'The Final Countdown', '+select/+as overridden column "title"');
131
132
133 # test +select/+as for multiple columns
134 $psrs = $schema->resultset('CD')->search({},
135     {
136         '+select'   => [ \'LENGTH(title) AS title_length', 'title' ],
137         '+as'       => [ 'tlength', 'addedtitle' ]
138     }
139 );
140 lives_ok(sub { $psrs->get_column('tlength')->next }, '+select/+as multiple additional columns, "tlength" column present');
141 lives_ok(sub { $psrs->get_column('addedtitle')->next }, '+select/+as multiple additional columns, "addedtitle" column present');
142
143 # test that +select/+as specs do not leak
144 is_same_sql_bind (
145   $psrs->get_column('year')->as_query,
146   '(SELECT me.year FROM cd me)',
147   [],
148   'Correct SQL for get_column/as'
149 );
150
151 is_same_sql_bind (
152   $psrs->get_column('addedtitle')->as_query,
153   '(SELECT me.title FROM cd me)',
154   [],
155   'Correct SQL for get_column/+as col'
156 );
157
158 is_same_sql_bind (
159   $psrs->get_column('tlength')->as_query,
160   '(SELECT LENGTH(title) AS title_length FROM cd me)',
161   [],
162   'Correct SQL for get_column/+as func'
163 );
164
165 # test that order_by over a function forces a subquery
166 lives_ok ( sub {
167   is_deeply (
168     [ $psrs->search ({}, { order_by => { -desc => 'title_length' } })->get_column ('title')->all ],
169     [
170       "Generic Manufactured Singles",
171       "Come Be Depressed With Us",
172       "Caterwaulin' Blues",
173       "Spoonful of bees",
174       "Forkful of bees",
175     ],
176     'Subquery count induced by aliased ordering function',
177   );
178 });
179
180 # test for prefetch not leaking
181 {
182   my $rs = $schema->resultset("CD")->search({}, { prefetch => 'artist' });
183   my $rsc = $rs->get_column('year');
184   is( $rsc->{_parent_resultset}->{attrs}->{prefetch}, undef, 'prefetch wiped' );
185 }
186
187 # test sum()
188 is ($schema->resultset('BooksInLibrary')->get_column ('price')->sum, 125, 'Sum of a resultset works correctly');
189
190 # test sum over search_related
191 my $owner = $schema->resultset('Owners')->find ({ name => 'Newton' });
192 ok ($owner->books->count > 1, 'Owner Newton has multiple books');
193 is ($owner->search_related ('books')->get_column ('price')->sum, 60, 'Correctly calculated price of all owned books');
194
195
196 # make sure joined/prefetched get_column of a PK dtrt
197 $rs->reset;
198 my $j_rs = $rs->search ({}, { join => 'tracks' })->get_column ('cdid');
199 is_deeply (
200   [ sort $j_rs->all ],
201   [ sort map { my $c = $rs->next; ( ($c->id) x $c->tracks->count ) } (1 .. $rs->count) ],
202   'join properly explodes amount of rows from get_column',
203 );
204
205 $rs->reset;
206 my $p_rs = $rs->search ({}, { prefetch => 'tracks' })->get_column ('cdid');
207 is_deeply (
208   [ sort $p_rs->all ],
209   [ sort $rs->get_column ('cdid')->all ],
210   'prefetch properly collapses amount of rows from get_column',
211 );
212
213 $rs->reset;
214 my $pob_rs = $rs->search({}, {
215   select   => ['me.title', 'tracks.title'],
216   prefetch => 'tracks',
217   order_by => [{-asc => ['position']}],
218   group_by => ['me.title', 'tracks.title'],
219 });
220 is_same_sql_bind (
221   $pob_rs->get_column("me.title")->as_query,
222   '(SELECT me.title FROM (SELECT me.title, tracks.title FROM cd me LEFT JOIN track tracks ON tracks.cd = me.cdid GROUP BY me.title, tracks.title ORDER BY position ASC) me)',
223   [],
224   'Correct SQL for prefetch/order_by/group_by'
225 );
226
227 # test aggregate on a function (create an extra track on one cd)
228 {
229   my $tr_rs = $schema->resultset("Track");
230   $tr_rs->create({ cd => 2, title => 'dealbreaker' });
231
232   is(
233     $tr_rs->get_column('cd')->max,
234     5,
235     "Correct: Max cd in Track is 5"
236   );
237
238   my $track_counts_per_cd_via_group_by = $tr_rs->search({}, {
239     columns => [ 'cd', { cnt => { count => 'trackid', -as => 'cnt' } } ],
240     group_by => 'cd',
241   })->get_column('cnt');
242
243   is ($track_counts_per_cd_via_group_by->max, 4, 'Correct max tracks per cd');
244   is ($track_counts_per_cd_via_group_by->min, 3, 'Correct min tracks per cd');
245   is (
246     sprintf('%0.1f', $track_counts_per_cd_via_group_by->func('avg') ),
247     '3.2',
248     'Correct avg tracks per cd'
249   );
250 }
251
252 # test exotic scenarious (create a track-less cd)
253 # "How many CDs (not tracks) have been released per year where a given CD has at least one track and the artist isn't evancarroll?"
254 {
255
256   $schema->resultset('CD')->create({ artist => 1, title => 'dealbroker no tracks', year => 2001 });
257
258   my $yp1 = \[ 'year + ?', 1 ];
259
260   my $rs = $schema->resultset ('CD')->search (
261     { 'artist.name' => { '!=', 'evancarrol' }, 'tracks.trackid' => { '!=', undef } },
262     {
263       order_by => 'me.year',
264       join => [qw(artist tracks)],
265       columns => [
266         'year',
267         { cnt => { count => 'me.cdid' } },
268         {  year_plus_one => $yp1 },
269       ],
270     },
271   );
272
273   my $rstypes = {
274     'explicitly grouped' => $rs->search_rs({}, { group_by => [ 'year', $yp1 ] } ),
275     'implicitly grouped' => $rs->search_rs({}, { distinct => 1 }),
276   };
277
278   for my $type (keys %$rstypes) {
279     is ($rstypes->{$type}->count, 4, "correct cd count with $type column");
280
281     is_deeply (
282       [ $rstypes->{$type}->get_column ('year')->all ],
283       [qw(1997 1998 1999 2001)],
284       "Getting $type column works",
285     );
286   }
287
288   # Why do we test this - we want to make sure that the selector *will* actually make
289   # it to the group_by as per the distinct => 1 contract. Before 0.08251 this situation
290   # would silently drop the group_by entirely, likely ending up with nonsensival results
291   # With the current behavior the user will at least get a nice fat exception from the
292   # RDBMS (or maybe the RDBMS will even decide to handle the situation sensibly...)
293   for (
294     [ cnt => 'COUNT( me.cdid )' ],
295     [ year_plus_one => 'year + ?' => [ {} => 1 ] ],
296   ) {
297     my ($col, $sel_grp_sql, @sel_grp_bind) = @$_;
298
299     warnings_exist { is_same_sql_bind(
300       $rstypes->{'implicitly grouped'}->get_column($col)->as_query,
301       "(
302         SELECT $sel_grp_sql
303           FROM cd me
304           JOIN artist artist
305             ON artist.artistid = me.artist
306           LEFT JOIN track tracks
307             ON tracks.cd = me.cdid
308         WHERE artist.name != ? AND tracks.trackid IS NOT NULL
309         GROUP BY $sel_grp_sql
310         ORDER BY MIN(me.year)
311       )",
312       [
313         @sel_grp_bind,
314         [ { dbic_colname => 'artist.name', sqlt_datatype => 'varchar', sqlt_size => 100 }
315           => 'evancarrol' ],
316         @sel_grp_bind,
317       ],
318       'Expected (though nonsensical) SQL generated on rscol-with-distinct-over-function',
319     ) } qr/
320       \QUse of distinct => 1 while selecting anything other than a column \E
321       \Qdeclared on the primary ResultSource is deprecated (you selected '$col')\E
322     /x, 'deprecation warning';
323   }
324
325   {
326     local $TODO = 'multiplying join leaks through to the count aggregate... this may never actually work';
327     is_deeply (
328       [ $rstypes->{'explicitly grouped'}->get_column ('cnt')->all ],
329       [qw(1 1 1 2)],
330       "Get aggregate over group works",
331     );
332   }
333 }
334
335 done_testing;