0.02002 release, added moniker_map and inflect_map args
[dbsrgits/DBIx-Class-Schema-Loader.git] / t / lib / dbixcsl_common_tests.pm
1 package dbixcsl_common_tests;
2
3 use strict;
4 use warnings;
5
6 use Test::More;
7 use DBIx::Class::Schema::Loader;
8 use DBI;
9
10 sub new {
11     my $class = shift;
12
13     my $self;
14
15     if( ref($_[0]) eq 'HASH') {
16        my $args = shift;
17        $self = { (%$args) };
18     }
19     else {
20        $self = { @_ };
21     }
22
23     # Only MySQL uses this
24     $self->{innodb} ||= '';
25     
26     $self->{verbose} = $ENV{TEST_VERBOSE} || 0;
27
28     return bless $self => $class;
29 }
30
31 sub skip_tests {
32     my ($self, $why) = @_;
33
34     plan skip_all => $why;
35 }
36
37 sub _monikerize {
38     my $name = shift;
39     return 'LoaderTest2X' if $name =~ /^loader_test2$/i;
40     return undef;
41 }
42
43 sub run_tests {
44     my $self = shift;
45
46     plan tests => 50;
47
48     $self->create();
49
50     my $schema_class = 'DBIXCSL_Test::Schema';
51
52     my $debug = ($self->{verbose} > 1) ? 1 : 0;
53
54     my %loader_opts = (
55         dsn                     => $self->{dsn},
56         user                    => $self->{user},
57         password                => $self->{password},
58         constraint              => '^(?:\S+\.)?(?i:loader_test)[0-9]+$',
59         relationships           => 1,
60         additional_classes      => 'TestAdditional',
61         additional_base_classes => 'TestAdditionalBase',
62         left_base_classes       => [ qw/TestLeftBase/ ],
63         components              => [ qw/TestComponent/ ],
64         resultset_components    => [ qw/TestRSComponent/ ],
65         inflect_map             => { loader_test4 => 'loader_test4zes' },
66         moniker_map             => \&_monikerize,
67         debug                   => $debug,
68     );
69
70     $loader_opts{db_schema} = $self->{db_schema} if $self->{db_schema};
71     $loader_opts{drop_db_schema} = $self->{drop_db_schema} if $self->{drop_db_schema};
72
73     eval qq{
74         package $schema_class;
75         use base qw/DBIx::Class::Schema::Loader/;
76
77         __PACKAGE__->load_from_connection(\%loader_opts);
78     };
79     ok(!$@, "Loader initialization") or diag $@;
80
81     my $conn = $schema_class->connect($self->{dsn},$self->{user},$self->{password});
82     my $monikers = $schema_class->loader->monikers;
83     my $classes = $schema_class->loader->classes;
84
85     my $moniker1 = $monikers->{loader_test1};
86     my $class1   = $classes->{loader_test1};
87     my $rsobj1   = $conn->resultset($moniker1);
88
89     my $moniker2 = $monikers->{loader_test2};
90     my $class2   = $classes->{loader_test2};
91     my $rsobj2   = $conn->resultset($moniker2);
92
93     isa_ok( $rsobj1, "DBIx::Class::ResultSet" );
94     isa_ok( $rsobj2, "DBIx::Class::ResultSet" );
95
96     is($moniker2, 'LoaderTest2X', "moniker_map testing");
97
98     {
99         my ($skip_tab, $skip_tabo, $skip_taba, $skip_cmeth,
100             $skip_rsmeth, $skip_tcomp, $skip_trscomp);
101
102         can_ok( $class1, 'test_additional_base' ) or $skip_tab = 1;
103         can_ok( $class1, 'test_additional_base_override' ) or $skip_tabo = 1;
104         can_ok( $class1, 'test_additional_base_additional' ) or $skip_taba = 1;
105         can_ok( $class1, 'dbix_class_testcomponent' ) or $skip_tcomp = 1;
106         can_ok( $rsobj1, 'dbix_class_testrscomponent' ) or $skip_trscomp = 1;
107         can_ok( $class1, 'loader_test1_classmeth' ) or $skip_cmeth = 1;
108
109         TODO: {
110             local $TODO = "Not yet supported by ResultSetManger code";
111             can_ok( $rsobj1, 'loader_test1_rsmeth' ) or $skip_rsmeth = 1;
112         }
113
114         SKIP: {
115             skip "Pre-requisite test failed", 1 if $skip_tab;
116             is( $class1->test_additional_base, "test_additional_base",
117                 "Additional Base method" );
118         }
119
120         SKIP: {
121             skip "Pre-requisite test failed", 1 if $skip_tabo;
122             is( $class1->test_additional_base_override,
123                 "test_left_base_override",
124                 "Left Base overrides Additional Base method" );
125         }
126
127         SKIP: {
128             skip "Pre-requisite test failed", 1 if $skip_taba;
129             is( $class1->test_additional_base_additional, "test_additional",
130                 "Additional Base can use Additional package method" );
131         }
132
133         SKIP: {
134             skip "Pre-requisite test failed", 1 if $skip_tcomp;
135             is( $class1->dbix_class_testcomponent,
136                 'dbix_class_testcomponent works' );
137         }
138
139         SKIP: {
140             skip "Pre-requisite test failed", 1 if $skip_trscomp;
141             is( $rsobj1->dbix_class_testrscomponent,
142                 'dbix_class_testrscomponent works' );
143         }
144
145         SKIP: {
146             skip "Pre-requisite test failed", 1 if $skip_cmeth;
147             is( $class1->loader_test1_classmeth, 'all is well' );
148         }
149
150         # XXX put this back in when the TODO above works...
151         #SKIP: {
152         #    skip "Pre-requisite test failed", 1 if $skip_rsmeth;
153         #    is( $rsobj1->loader_test1_rsmeth, 'all is still well' );
154         #}
155     }
156
157
158     my $obj    = $rsobj1->find(1);
159     is( $obj->id,  1 );
160     is( $obj->dat, "foo" );
161     is( $rsobj2->count, 4 );
162
163     my ($obj2) = $rsobj2->find( dat => 'bbb' );
164     is( $obj2->id, 2 );
165
166     SKIP: {
167         skip $self->{skip_rels}, 29 if $self->{skip_rels};
168
169         my $moniker3 = $monikers->{loader_test3};
170         my $class3   = $classes->{loader_test3};
171         my $rsobj3   = $conn->resultset($moniker3);
172
173         my $moniker4 = $monikers->{loader_test4};
174         my $class4   = $classes->{loader_test4};
175         my $rsobj4   = $conn->resultset($moniker4);
176
177         my $moniker5 = $monikers->{loader_test5};
178         my $class5   = $classes->{loader_test5};
179         my $rsobj5   = $conn->resultset($moniker5);
180
181         my $moniker6 = $monikers->{loader_test6};
182         my $class6   = $classes->{loader_test6};
183         my $rsobj6   = $conn->resultset($moniker6);
184
185         my $moniker7 = $monikers->{loader_test7};
186         my $class7   = $classes->{loader_test7};
187         my $rsobj7   = $conn->resultset($moniker7);
188
189         my $moniker8 = $monikers->{loader_test8};
190         my $class8   = $classes->{loader_test8};
191         my $rsobj8   = $conn->resultset($moniker8);
192
193         my $moniker9 = $monikers->{loader_test9};
194         my $class9   = $classes->{loader_test9};
195         my $rsobj9   = $conn->resultset($moniker9);
196
197         isa_ok( $rsobj3, "DBIx::Class::ResultSet" );
198         isa_ok( $rsobj4, "DBIx::Class::ResultSet" );
199         isa_ok( $rsobj5, "DBIx::Class::ResultSet" );
200         isa_ok( $rsobj6, "DBIx::Class::ResultSet" );
201         isa_ok( $rsobj7, "DBIx::Class::ResultSet" );
202         isa_ok( $rsobj8, "DBIx::Class::ResultSet" );
203         isa_ok( $rsobj9, "DBIx::Class::ResultSet" );
204
205         # basic rel test
206         my $obj4 = $rsobj4->find(123);
207         isa_ok( $obj4->fkid, $class3);
208
209         my $obj3 = $rsobj3->find(1);
210         my $rs_rel4 = $obj3->search_related('loader_test4zes');
211         isa_ok( $rs_rel4->first, $class4);
212
213         # fk def in comments should not be parsed
214         my $obj5 = $rsobj5->find( id1 => 1, id2 => 1 );
215         is( ref( $obj5->id2 ), '' );
216
217         # mulit-col fk def
218         my $obj6 = $rsobj6->find(1);
219         isa_ok( $obj6->loader_test2, $class2);
220         isa_ok( $obj6->loader_test5, $class5);
221
222         # fk that references a non-pk key (UNIQUE)
223         my $obj8 = $rsobj8->find(1);
224         isa_ok( $obj8->loader_test7, $class7);
225
226         # from Chisel's tests...
227         SKIP: {
228             if($self->{vendor} =~ /sqlite/i) {
229                 skip 'SQLite cannot do the advanced tests', 8;
230             }
231
232             my $moniker10 = $monikers->{loader_test10};
233             my $class10   = $classes->{loader_test10};
234             my $rsobj10   = $conn->resultset($moniker10);
235
236             my $moniker11 = $monikers->{loader_test11};
237             my $class11   = $classes->{loader_test11};
238             my $rsobj11   = $conn->resultset($moniker11);
239
240             isa_ok( $rsobj10, "DBIx::Class::ResultSet" ); 
241             isa_ok( $rsobj11, "DBIx::Class::ResultSet" );
242
243             my $obj10 = $rsobj10->create({ subject => 'xyzzy' });
244
245             $obj10->update();
246             ok( defined $obj10, '$obj10 is defined' );
247
248             my $obj11 = $rsobj11->create({ loader_test10 => $obj10->id() });
249             $obj11->update();
250             ok( defined $obj11, '$obj11 is defined' );
251
252             eval {
253                 my $obj10_2 = $obj11->loader_test10;
254                 $obj10_2->loader_test11( $obj11->id11() );
255                 $obj10_2->update();
256             };
257             is($@, '', 'No errors after eval{}');
258
259             SKIP: {
260                 skip 'Previous eval block failed', 3
261                     unless ($@ eq '');
262         
263                 my $results = $rsobj10->search({ subject => 'xyzzy' });
264                 is( $results->count(), 1,
265                     'One $rsobj10 returned from search' );
266
267                 my $obj10_3 = $results->first();
268                 isa_ok( $obj10_3, $class10 );
269                 is( $obj10_3->loader_test11()->id(), $obj11->id(),
270                     'found same $rsobj11 object we expected' );
271             }
272         }
273
274         SKIP: {
275             skip 'This vendor cannot do inline relationship definitions', 5
276                 if $self->{no_inline_rels};
277
278             my $moniker12 = $monikers->{loader_test12};
279             my $class12   = $classes->{loader_test12};
280             my $rsobj12   = $conn->resultset($moniker12);
281
282             my $moniker13 = $monikers->{loader_test13};
283             my $class13   = $classes->{loader_test13};
284             my $rsobj13   = $conn->resultset($moniker13);
285
286             isa_ok( $rsobj12, "DBIx::Class::ResultSet" ); 
287             isa_ok( $rsobj13, "DBIx::Class::ResultSet" );
288
289             my $obj13 = $rsobj13->find(1);
290             isa_ok( $obj13->id, $class12 );
291             isa_ok( $obj13->loader_test12, $class12);
292             isa_ok( $obj13->dat, $class12);
293         }
294
295         SKIP: {
296             skip 'This vendor cannot do out-of-line implicit rel defs', 3
297                 if $self->{no_implicit_rels};
298             my $moniker14 = $monikers->{loader_test14};
299             my $class14   = $classes->{loader_test14};
300             my $rsobj14   = $conn->resultset($moniker14);
301
302             my $moniker15 = $monikers->{loader_test15};
303             my $class15   = $classes->{loader_test15};
304             my $rsobj15   = $conn->resultset($moniker15);
305
306             isa_ok( $rsobj14, "DBIx::Class::ResultSet" ); 
307             isa_ok( $rsobj15, "DBIx::Class::ResultSet" );
308
309             my $obj15 = $rsobj15->find(1);
310             isa_ok( $obj15->loader_test14, $class14 );
311         }
312     }
313 }
314
315 sub dbconnect {
316     my ($self, $complain) = @_;
317
318     my $dbh = DBI->connect(
319          $self->{dsn}, $self->{user},
320          $self->{password},
321          {
322              RaiseError => $complain,
323              PrintError => $complain,
324              AutoCommit => 1,
325          }
326     );
327
328     die "Failed to connect to database: $DBI::errstr" if !$dbh;
329
330     return $dbh;
331 }
332
333 sub create {
334     my $self = shift;
335
336     my @statements = (
337         qq{
338             CREATE TABLE loader_test1 (
339                 id $self->{auto_inc_pk},
340                 dat VARCHAR(32)
341             ) $self->{innodb}
342         },
343
344         q{ INSERT INTO loader_test1 (dat) VALUES('foo') },
345         q{ INSERT INTO loader_test1 (dat) VALUES('bar') }, 
346         q{ INSERT INTO loader_test1 (dat) VALUES('baz') }, 
347
348         qq{ 
349             CREATE TABLE loader_test2 (
350                 id $self->{auto_inc_pk},
351                 dat VARCHAR(32)
352             ) $self->{innodb}
353         },
354
355         q{ INSERT INTO loader_test2 (dat) VALUES('aaa') }, 
356         q{ INSERT INTO loader_test2 (dat) VALUES('bbb') }, 
357         q{ INSERT INTO loader_test2 (dat) VALUES('ccc') }, 
358         q{ INSERT INTO loader_test2 (dat) VALUES('ddd') }, 
359     );
360
361     my @statements_reltests = (
362         qq{
363             CREATE TABLE loader_test3 (
364                 id INTEGER NOT NULL PRIMARY KEY,
365                 dat VARCHAR(32)
366             ) $self->{innodb}
367         },
368
369         q{ INSERT INTO loader_test3 (id,dat) VALUES(1,'aaa') }, 
370         q{ INSERT INTO loader_test3 (id,dat) VALUES(2,'bbb') }, 
371         q{ INSERT INTO loader_test3 (id,dat) VALUES(3,'ccc') }, 
372         q{ INSERT INTO loader_test3 (id,dat) VALUES(4,'ddd') }, 
373
374         qq{
375             CREATE TABLE loader_test4 (
376                 id INTEGER NOT NULL PRIMARY KEY,
377                 fkid INTEGER NOT NULL,
378                 dat VARCHAR(32),
379                 FOREIGN KEY (fkid) REFERENCES loader_test3 (id)
380             ) $self->{innodb}
381         },
382
383         q{ INSERT INTO loader_test4 (id,fkid,dat) VALUES(123,1,'aaa') },
384         q{ INSERT INTO loader_test4 (id,fkid,dat) VALUES(124,2,'bbb') }, 
385         q{ INSERT INTO loader_test4 (id,fkid,dat) VALUES(125,3,'ccc') },
386         q{ INSERT INTO loader_test4 (id,fkid,dat) VALUES(126,4,'ddd') },
387
388         qq{
389             CREATE TABLE loader_test5 (
390                 id1 INTEGER NOT NULL,
391                 id2 INTEGER NOT NULL, -- , id2 INTEGER REFERENCES loader_test1,
392                 dat VARCHAR(8),
393                 PRIMARY KEY (id1,id2)
394             ) $self->{innodb}
395         },
396
397         q{ INSERT INTO loader_test5 (id1,id2,dat) VALUES (1,1,'aaa') },
398
399         qq{
400             CREATE TABLE loader_test6 (
401                 id INTEGER NOT NULL PRIMARY KEY,
402                 id2 INTEGER,
403                 loader_test2 INTEGER,
404                 dat VARCHAR(8),
405                 FOREIGN KEY (loader_test2) REFERENCES loader_test2 (id),
406                 FOREIGN KEY (id, id2 ) REFERENCES loader_test5 (id1,id2)
407             ) $self->{innodb}
408         },
409
410         (q{ INSERT INTO loader_test6 (id, id2,loader_test2,dat) } .
411          q{ VALUES (1, 1,1,'aaa') }),
412
413         qq{
414             CREATE TABLE loader_test7 (
415                 id INTEGER NOT NULL PRIMARY KEY,
416                 id2 VARCHAR(8) NOT NULL UNIQUE,
417                 dat VARCHAR(8)
418             ) $self->{innodb}
419         },
420
421         q{ INSERT INTO loader_test7 (id,id2,dat) VALUES (1,'aaa','bbb') },
422
423         qq{
424             CREATE TABLE loader_test8 (
425                 id INTEGER NOT NULL PRIMARY KEY,
426                 loader_test7 VARCHAR(8) NOT NULL,
427                 dat VARCHAR(8),
428                 FOREIGN KEY (loader_test7) REFERENCES loader_test7 (id2)
429             ) $self->{innodb}
430         },
431
432         (q{ INSERT INTO loader_test8 (id,loader_test7,dat) } .
433          q{ VALUES (1,'aaa','bbb') }),
434
435         qq{
436             CREATE TABLE loader_test9 (
437                 loader_test9 VARCHAR(8) NOT NULL
438             ) $self->{innodb}
439         },
440     );
441
442     my @statements_advanced = (
443         qq{
444             CREATE TABLE loader_test10 (
445                 id10 $self->{auto_inc_pk},
446                 subject VARCHAR(8),
447                 loader_test11 INTEGER
448             ) $self->{innodb}
449         },
450
451         qq{
452             CREATE TABLE loader_test11 (
453                 id11 $self->{auto_inc_pk},
454                 message VARCHAR(8) DEFAULT 'foo',
455                 loader_test10 INTEGER,
456                 FOREIGN KEY (loader_test10) REFERENCES loader_test10 (id10)
457             ) $self->{innodb}
458         },
459
460         (q{ ALTER TABLE loader_test10 ADD CONSTRAINT } .
461          q{ loader_test11_fk FOREIGN KEY (loader_test11) } .
462          q{ REFERENCES loader_test11 (id11) }),
463     );
464
465     my @statements_inline_rels = (
466         qq{
467             CREATE TABLE loader_test12 (
468                 id INTEGER NOT NULL PRIMARY KEY,
469                 id2 VARCHAR(8) NOT NULL UNIQUE,
470                 dat VARCHAR(8) NOT NULL UNIQUE
471             ) $self->{innodb}
472         },
473
474         q{ INSERT INTO loader_test12 (id,id2,dat) VALUES (1,'aaa','bbb') },
475
476         qq{
477             CREATE TABLE loader_test13 (
478                 id INTEGER NOT NULL PRIMARY KEY REFERENCES loader_test12,
479                 loader_test12 VARCHAR(8) NOT NULL REFERENCES loader_test12 (id2),
480                 dat VARCHAR(8) REFERENCES loader_test12 (dat)
481             ) $self->{innodb}
482         },
483
484         (q{ INSERT INTO loader_test13 (id,loader_test12,dat) } .
485          q{ VALUES (1,'aaa','bbb') }),
486     );
487
488
489     my @statements_implicit_rels = (
490         qq{
491             CREATE TABLE loader_test14 (
492                 id INTEGER NOT NULL PRIMARY KEY,
493                 dat VARCHAR(8)
494             ) $self->{innodb}
495         },
496  
497         q{ INSERT INTO loader_test14 (id,dat) VALUES (123,'aaa') },
498
499         qq{
500             CREATE TABLE loader_test15 (
501                 id INTEGER NOT NULL PRIMARY KEY,
502                 loader_test14 INTEGER NOT NULL,
503                 FOREIGN KEY (loader_test14) REFERENCES loader_test14
504             ) $self->{innodb}
505         },
506
507         q{ INSERT INTO loader_test15 (id,loader_test14) VALUES (1,123) },
508    );
509
510     $self->drop_tables;
511
512     $self->{created} = 1;
513
514     my $dbh = $self->dbconnect(1);
515
516     # Silence annoying but harmless postgres "NOTICE:  CREATE TABLE..."
517     local $SIG{__WARN__} = sub {
518         my $msg = shift;
519         print STDERR $msg unless $msg =~ m{^NOTICE:\s+CREATE TABLE};
520     };
521
522     $dbh->do($_) for (@statements);
523     unless($self->{skip_rels}) {
524         # hack for now, since DB2 doesn't like inline comments, and we need
525         # to test one for mysql, which works on everyone else...
526         # this all needs to be refactored anyways.
527         if($self->{vendor} =~ /DB2/i) {
528             @statements_reltests = map { s/--.*\n//; $_ } @statements_reltests;
529         }
530         $dbh->do($_) for (@statements_reltests);
531         unless($self->{vendor} =~ /sqlite/i) {
532             $dbh->do($_) for (@statements_advanced);
533         }
534         unless($self->{no_inline_rels}) {
535             $dbh->do($_) for (@statements_inline_rels);
536         }
537         unless($self->{no_implicit_rels}) {
538             $dbh->do($_) for (@statements_implicit_rels);
539         }
540     }
541     $dbh->disconnect();
542 }
543
544 sub drop_tables {
545     my $self = shift;
546
547     return unless $self->{created};
548
549     my @tables = qw/
550         loader_test1
551         loader_test2
552     /;
553
554     my @tables_reltests = qw/
555         loader_test4
556         loader_test3
557         loader_test6
558         loader_test5
559         loader_test8
560         loader_test7
561         loader_test9
562     /;
563
564     my @tables_advanced = qw/
565         loader_test11
566         loader_test10
567     /;
568
569     my @tables_inline_rels = qw/
570         loader_test13
571         loader_test12
572     /;
573
574     my @tables_implicit_rels = qw/
575         loader_test15
576         loader_test14
577     /;
578
579     my $drop_fk_mysql =
580         q{ALTER TABLE loader_test10 DROP FOREIGN KEY loader_test11_fk;};
581
582     my $drop_fk =
583         q{ALTER TABLE loader_test10 DROP CONSTRAINT loader_test11_fk;};
584
585     my $dbh = $self->dbconnect(0);
586
587     unless($self->{skip_rels}) {
588         $dbh->do("DROP TABLE $_") for (@tables_reltests);
589         unless($self->{vendor} =~ /sqlite/i) {
590             if($self->{vendor} =~ /mysql/i) {
591                 $dbh->do($drop_fk_mysql);
592             }
593             else {
594                 $dbh->do($drop_fk);
595             }
596             $dbh->do("DROP TABLE $_") for (@tables_advanced);
597         }
598         unless($self->{no_inline_rels}) {
599             $dbh->do("DROP TABLE $_") for (@tables_inline_rels);
600         }
601         unless($self->{no_implicit_rels}) {
602             $dbh->do("DROP TABLE $_") for (@tables_implicit_rels);
603         }
604     }
605     $dbh->do("DROP TABLE $_") for (@tables);
606     $dbh->disconnect;
607 }
608
609 sub DESTROY { shift->drop_tables; }
610
611 1;