Test sqlt_deploy_hook on the Schema level
[dbsrgits/DBIx-Class.git] / t / 86sqlt.t
1 use strict;
2 use warnings;
3
4 use Test::More;
5 use lib qw(t/lib);
6 use DBICTest;
7
8 eval "use SQL::Translator";
9 plan skip_all => 'SQL::Translator required' if $@;
10
11 my $schema = DBICTest->init_schema;
12
13 plan tests => 56;
14
15 my $translator = SQL::Translator->new( 
16   parser_args => {
17     'DBIx::Schema' => $schema,
18   },
19   producer_args => {},
20 );
21
22 $translator->parser('SQL::Translator::Parser::DBIx::Class');
23 $translator->producer('SQLite');
24
25 my $output = $translator->translate();
26
27
28 ok($output, "SQLT produced someoutput")
29   or diag($translator->error);
30
31 # Note that the constraints listed here are the only ones that are tested -- if
32 # more exist in the Schema than are listed here and all listed constraints are
33 # correct, the test will still pass. If you add a class with UNIQUE or FOREIGN
34 # KEY constraints to DBICTest::Schema, add tests here if you think the existing
35 # test coverage is not sufficient
36
37 my %fk_constraints = (
38
39   # TwoKeys
40   twokeys => [
41     {
42       'display' => 'twokeys->cd',
43       'selftable' => 'twokeys', 'foreigntable' => 'cd', 
44       'selfcols'  => ['cd'], 'foreigncols' => ['cdid'], 
45       on_delete => '', on_update => '',
46     },
47     {
48       'display' => 'twokeys->artist',
49       'selftable' => 'twokeys', 'foreigntable' => 'artist', 
50       'selfcols'  => ['artist'], 'foreigncols' => ['artistid'],
51       on_delete => 'CASCADE', on_update => 'CASCADE',
52     },
53   ],
54
55   # FourKeys_to_TwoKeys
56   fourkeys_to_twokeys => [
57     {
58       'display' => 'fourkeys_to_twokeys->twokeys',
59       'selftable' => 'fourkeys_to_twokeys', 'foreigntable' => 'twokeys', 
60       'selfcols'  => ['t_artist', 't_cd'], 'foreigncols' => ['artist', 'cd'], 
61       on_delete => 'CASCADE', on_update => 'CASCADE',
62     },
63     {
64       'display' => 'fourkeys_to_twokeys->fourkeys',
65       'selftable' => 'fourkeys_to_twokeys', 'foreigntable' => 'fourkeys', 
66       'selfcols'  => [qw(f_foo f_bar f_hello f_goodbye)],
67       'foreigncols' => [qw(foo bar hello goodbye)], 
68       on_delete => 'CASCADE', on_update => 'CASCADE',
69     },
70   ],
71
72   # CD_to_Producer
73   cd_to_producer => [
74     {
75       'display' => 'cd_to_producer->cd',
76       'selftable' => 'cd_to_producer', 'foreigntable' => 'cd', 
77       'selfcols'  => ['cd'], 'foreigncols' => ['cdid'],
78       on_delete => 'CASCADE', on_update => 'CASCADE',
79     },
80     {
81       'display' => 'cd_to_producer->producer',
82       'selftable' => 'cd_to_producer', 'foreigntable' => 'producer', 
83       'selfcols'  => ['producer'], 'foreigncols' => ['producerid'],
84       on_delete => '', on_update => '',
85     },
86   ],
87
88   # Self_ref_alias
89   self_ref_alias => [
90     {
91       'display' => 'self_ref_alias->self_ref for self_ref',
92       'selftable' => 'self_ref_alias', 'foreigntable' => 'self_ref', 
93       'selfcols'  => ['self_ref'], 'foreigncols' => ['id'],
94       on_delete => 'CASCADE', on_update => 'CASCADE',
95     },
96     {
97       'display' => 'self_ref_alias->self_ref for alias',
98       'selftable' => 'self_ref_alias', 'foreigntable' => 'self_ref', 
99       'selfcols'  => ['alias'], 'foreigncols' => ['id'],
100       on_delete => '', on_update => '',
101     },
102   ],
103
104   # CD
105   cd => [
106     {
107       'display' => 'cd->artist',
108       'selftable' => 'cd', 'foreigntable' => 'artist', 
109       'selfcols'  => ['artist'], 'foreigncols' => ['artistid'],
110       on_delete => 'CASCADE', on_update => 'CASCADE',
111     },
112   ],
113
114   # Artist_undirected_map
115   artist_undirected_map => [
116     {
117       'display' => 'artist_undirected_map->artist for id1',
118       'selftable' => 'artist_undirected_map', 'foreigntable' => 'artist', 
119       'selfcols'  => ['id1'], 'foreigncols' => ['artistid'],
120       on_delete => 'CASCADE', on_update => '',
121     },
122     {
123       'display' => 'artist_undirected_map->artist for id2',
124       'selftable' => 'artist_undirected_map', 'foreigntable' => 'artist', 
125       'selfcols'  => ['id2'], 'foreigncols' => ['artistid'],
126       on_delete => 'CASCADE', on_update => '',
127     },
128   ],
129
130   # Track
131   track => [
132     {
133       'display' => 'track->cd',
134       'selftable' => 'track', 'foreigntable' => 'cd', 
135       'selfcols'  => ['cd'], 'foreigncols' => ['cdid'],
136       on_delete => 'CASCADE', on_update => 'CASCADE',
137     },
138   ],
139
140   # TreeLike
141   treelike => [
142     {
143       'display' => 'treelike->treelike for parent',
144       'selftable' => 'treelike', 'foreigntable' => 'treelike', 
145       'selfcols'  => ['parent'], 'foreigncols' => ['id'],
146       on_delete => 'CASCADE', on_update => 'CASCADE',
147     },
148   ],
149
150   # TwoKeyTreeLike
151   twokeytreelike => [
152     {
153       'display' => 'twokeytreelike->twokeytreelike for parent1,parent2',
154       'selftable' => 'twokeytreelike', 'foreigntable' => 'twokeytreelike', 
155       'selfcols'  => ['parent1', 'parent2'], 'foreigncols' => ['id1','id2'],
156       on_delete => '', on_update => '',
157     },
158   ],
159
160   # Tags
161   tags => [
162     {
163       'display' => 'tags->cd',
164       'selftable' => 'tags', 'foreigntable' => 'cd', 
165       'selfcols'  => ['cd'], 'foreigncols' => ['cdid'],
166       on_delete => 'CASCADE', on_update => 'CASCADE',
167     },
168   ],
169
170   # Bookmark
171   bookmark => [
172     {
173       'display' => 'bookmark->link',
174       'selftable' => 'bookmark', 'foreigntable' => 'link', 
175       'selfcols'  => ['link'], 'foreigncols' => ['id'],
176       on_delete => '', on_update => '',
177     },
178   ],
179 );
180
181 my %unique_constraints = (
182   # CD
183   cd => [
184     {
185       'display' => 'cd artist and title unique',
186       'table' => 'cd', 'cols' => ['artist', 'title'],
187     },
188   ],
189
190   # Producer
191   producer => [
192     {
193       'display' => 'producer name unique',
194       'table' => 'producer', 'cols' => ['name'],
195     },
196   ],
197
198   # TwoKeyTreeLike
199   twokeytreelike => [
200     {
201       'display' => 'twokeytreelike name unique',
202       'table' => 'twokeytreelike', 'cols'  => ['name'],
203     },
204   ],
205
206   # Employee
207 # Constraint is commented out in DBICTest/Schema/Employee.pm
208 #  employee => [
209 #    {
210 #      'display' => 'employee position and group_id unique',
211 #      'table' => 'employee', cols => ['position', 'group_id'],
212 #    },
213 #  ],
214 );
215
216 my %indexes = (
217   artist => [
218     {
219       'fields' => ['name']
220     },
221   ]
222 );
223
224 my $tschema = $translator->schema();
225
226 # Test that the $schema->sqlt_deploy_hook was called okay and that it removed
227 # the 'link' table
228 ok( !defined($tschema->get_table('link')), "Link table was removed by hook");
229
230 # Test that nonexistent constraints are not found
231 my $constraint = get_constraint('FOREIGN KEY', 'cd', ['title'], 'cd', ['year']);
232 ok( !defined($constraint), 'nonexistent FOREIGN KEY constraint not found' );
233 $constraint = get_constraint('UNIQUE', 'cd', ['artist']);
234 ok( !defined($constraint), 'nonexistent UNIQUE constraint not found' );
235
236 for my $expected_constraints (keys %fk_constraints) {
237   for my $expected_constraint (@{ $fk_constraints{$expected_constraints} }) {
238     my $desc = $expected_constraint->{display};
239     my $constraint = get_constraint(
240       'FOREIGN KEY',
241       $expected_constraint->{selftable}, $expected_constraint->{selfcols},
242       $expected_constraint->{foreigntable}, $expected_constraint->{foreigncols},
243     );
244     ok( defined($constraint), "FOREIGN KEY constraint matching `$desc' found" );
245     test_fk($expected_constraint, $constraint);
246   }
247 }
248
249 for my $expected_constraints (keys %unique_constraints) {
250   for my $expected_constraint (@{ $unique_constraints{$expected_constraints} }) {
251     my $desc = $expected_constraint->{display};
252     my $constraint = get_constraint(
253       'UNIQUE', $expected_constraint->{table}, $expected_constraint->{cols},
254     );
255     ok( defined($constraint), "UNIQUE constraint matching `$desc' found" );
256   }
257 }
258
259 for my $table_index (keys %indexes) {
260   for my $expected_index ( @{ $indexes{$table_index} } ) {
261
262     ok ( get_index($table_index, $expected_index), "Got a matching index on $table_index table");
263   }
264 }
265
266 # Returns the Constraint object for the specified constraint type, table and
267 # columns from the SQL::Translator schema, or undef if no matching constraint
268 # is found.
269 #
270 # NB: $type is either 'FOREIGN KEY' or 'UNIQUE'. In UNIQUE constraints the last
271 # two parameters are not used.
272 sub get_constraint {
273   my ($type, $table_name, $cols, $f_table, $f_cols) = @_;
274   $f_table ||= ''; # For UNIQUE constraints, reference_table is ''
275   $f_cols ||= [];
276
277   my $table = $tschema->get_table($table_name);
278
279   my %fields = map { $_ => 1 } @$cols;
280   my %f_fields = map { $_ => 1 } @$f_cols;
281
282  CONSTRAINT:
283   for my $constraint ( $table->get_constraints ) {
284     next unless $constraint->type eq $type;
285     next unless $constraint->reference_table eq $f_table;
286
287     my %rev_fields = map { $_ => 1 } $constraint->fields;
288     my %rev_f_fields = map { $_ => 1 } $constraint->reference_fields;
289
290     # Check that the given fields are a subset of the constraint's fields
291     for my $field ($constraint->fields) {
292       next CONSTRAINT unless $fields{$field};
293     }
294     if ($type eq 'FOREIGN KEY') {
295       for my $f_field ($constraint->reference_fields) {
296         next CONSTRAINT unless $f_fields{$f_field};
297       }
298     }
299
300     # Check that the constraint's fields are a subset of the given fields
301     for my $field (@$cols) {
302       next CONSTRAINT unless $rev_fields{$field};
303     }
304     if ($type eq 'FOREIGN KEY') {
305       for my $f_field (@$f_cols) {
306         next CONSTRAINT unless $rev_f_fields{$f_field};
307       }
308     }
309
310     return $constraint; # everything passes, found the constraint
311   }
312   return undef; # didn't find a matching constraint
313 }
314
315 sub get_index {
316   my ($table_name, $index) = @_;
317
318   my $table = $tschema->get_table($table_name);
319
320  CAND_INDEX:
321   for my $cand_index ( $table->get_indices ) {
322    
323     next CAND_INDEX if $index->{name} && $cand_index->name ne $index->{name}
324                     || $index->{type} && $cand_index->type ne $index->{type};
325
326     my %idx_fields = map { $_ => 1 } $cand_index->fields;
327
328     for my $field ( @{ $index->{fields} } ) {
329       next CAND_INDEX unless $idx_fields{$field};
330     }
331
332     %idx_fields = map { $_ => 1 } @{$index->{fields}};
333     for my $field ( $cand_index->fields) {
334       next CAND_INDEX unless $idx_fields{$field};
335     }
336
337     return $cand_index;
338   }
339
340   return undef; # No matching idx
341 }
342
343 # Test parameters in a FOREIGN KEY constraint other than columns
344 sub test_fk {
345   my ($expected, $got) = @_;
346   my $desc = $expected->{display};
347   is( $got->on_delete, $expected->{on_delete},
348       "on_delete parameter correct for `$desc'" );
349   is( $got->on_update, $expected->{on_update},
350       "on_update parameter correct for `$desc'" );
351 }