1 package # hide from PAUSE
6 use DBICTest::AuthorCheck;
12 DBICTest - Library to be used by DBIx::Class test scripts.
20 my $schema = DBICTest->init_schema();
24 This module provides the basic utilities to write tests against
31 my $schema = DBICTest->init_schema(
34 storage_type=>'::DBI::Replicated',
36 balancer_type=>'DBIx::Class::Storage::DBI::Replicated::Balancer::Random'
40 This method removes the test SQLite database in t/var/DBIxClass.db
41 and then creates a new, empty database.
43 This method will call deploy_schema() by default, unless the
44 no_deploy flag is set.
46 Also, by default, this method will call populate_schema() by
47 default, unless the no_deploy or no_populate flags are set.
52 return $ENV{"DBICTEST_DSN"} ? 1:0;
55 sub _sqlite_dbfilename {
56 return "t/var/DBIxClass.db";
62 return $self->_sqlite_dbfilename if $args{sqlite_use_file} or $ENV{"DBICTEST_SQLITE_USE_FILE"};
70 if ($ENV{DBICTEST_DSN}) {
72 (map { $ENV{"DBICTEST_${_}"} || '' } qw/DSN DBUSER DBPASS/),
73 { AutoCommit => 1, %args },
76 my $db_file = $self->_sqlite_dbname(%args);
78 for ($db_file, "${db_file}-journal") {
81 "Unable to unlink existing test database file $_ ($!), creation of fresh database / further tests may fail!\n"
85 mkdir("t/var") unless -d "t/var";
87 return ("dbi:SQLite:${db_file}", '', '', {
90 # this is executed on every connect, and thus installs a disconnect/DESTROY
91 # guard for every new $dbh
92 on_connect_do => sub {
94 my $dbh = $storage->_get_dbh;
97 $dbh->do ('PRAGMA synchronous = OFF');
99 # set a *DBI* disconnect callback, to make sure the physical SQLite
100 # file is still there (i.e. the test does not attempt to delete
101 # an open database, which fails on Win32)
102 if (my $guard_cb = __mk_disconnect_guard($db_file)) {
103 $dbh->{Callbacks} = {
104 connect => sub { $guard_cb->('connect') },
105 disconnect => sub { $guard_cb->('disconnect') },
106 DESTROY => sub { $guard_cb->('DESTROY') },
114 sub __mk_disconnect_guard {
116 return unless -f $db_file;
118 my $orig_inode = (stat($db_file))[1]
121 my $clan_connect_caller = '*UNKNOWN*';
123 while ( my ($pack, $file, $line) = caller(++$i) ) {
124 next if $file eq __FILE__;
125 next if $pack =~ /^DBIx::Class|^Try::Tiny/;
126 $clan_connect_caller = "$file line $line";
133 return if $failed_once;
136 if ($event eq 'connect') {
137 # this is necessary in case we are disconnected and connected again, all within the same $dbh object
141 elsif ($event eq 'disconnect') {
144 elsif ($event eq 'DESTROY' and ! $connected ) {
150 $fail_reason = 'is missing';
153 my $cur_inode = (stat($db_file))[1];
155 if ($orig_inode != $cur_inode) {
156 # pack/unpack to match the unsigned longs returned by `stat`
157 $fail_reason = sprintf 'was recreated (initially inode %s, now %s)', (
158 map { unpack ('L', pack ('l', $_) ) } ($orig_inode, $cur_inode )
166 require Test::Builder;
167 my $t = Test::Builder->new;
168 local $Test::Builder::Level = $Test::Builder::Level + 3;
170 "$db_file originally created at $clan_connect_caller $fail_reason before $event "
171 . 'of DBI handle - a strong indicator that the database file was tampered with while '
172 . 'still being open. This action would fail massively if running under Win32, hence '
173 . 'we make sure it fails on any OS :)'
177 return; # this empty return is a DBI requirement
187 if ($args{compose_connection}) {
188 $schema = DBICTest::Schema->compose_connection(
189 'DBICTest', $self->_database(%args)
192 $schema = DBICTest::Schema->compose_namespace('DBICTest');
195 if( $args{storage_type}) {
196 $schema->storage_type($args{storage_type});
199 if ( !$args{no_connect} ) {
200 $schema = $schema->connect($self->_database(%args));
203 if ( !$args{no_deploy} ) {
204 __PACKAGE__->deploy_schema( $schema, $args{deploy_args} );
205 __PACKAGE__->populate_schema( $schema )
206 if( !$args{no_populate} );
213 DBICTest->deploy_schema( $schema );
215 This method does one of two things to the schema. It can either call
216 the experimental $schema->deploy() if the DBICTEST_SQLT_DEPLOY environment
217 variable is set, otherwise the default is to read in the t/lib/sqlite.sql
218 file and execute the SQL within. Either way you end up with a fresh set
219 of tables for testing.
226 my $args = shift || {};
228 if ($ENV{"DBICTEST_SQLT_DEPLOY"}) {
229 $schema->deploy($args);
231 open IN, "t/lib/sqlite.sql";
233 { local $/ = undef; $sql = <IN>; }
235 for my $chunk ( split (/;\s*\n+/, $sql) ) {
236 if ( $chunk =~ / ^ (?! --\s* ) \S /xm ) { # there is some real sql in the chunk - a non-space at the start of the string which is not a comment
237 $schema->storage->dbh_do(sub { $_[1]->do($chunk) }) or print "Error on SQL: $chunk\n";
244 =head2 populate_schema
246 DBICTest->populate_schema( $schema );
248 After you deploy your schema you can use this method to populate
249 the tables with test data.
253 sub populate_schema {
257 $schema->populate('Genre', [
262 $schema->populate('Artist', [
263 [ qw/artistid name/ ],
264 [ 1, 'Caterwauler McCrae' ],
265 [ 2, 'Random Boy Band' ],
266 [ 3, 'We Are Goth' ],
269 $schema->populate('CD', [
270 [ qw/cdid artist title year genreid/ ],
271 [ 1, 1, "Spoonful of bees", 1999, 1 ],
272 [ 2, 1, "Forkful of bees", 2001 ],
273 [ 3, 1, "Caterwaulin' Blues", 1997 ],
274 [ 4, 2, "Generic Manufactured Singles", 2001 ],
275 [ 5, 3, "Come Be Depressed With Us", 1998 ],
278 $schema->populate('LinerNotes', [
279 [ qw/liner_id notes/ ],
280 [ 2, "Buy Whiskey!" ],
282 [ 5, "Kill Yourself!" ],
285 $schema->populate('Tag', [
286 [ qw/tagid cd tag/ ],
298 $schema->populate('TwoKeys', [
305 $schema->populate('FourKeys', [
306 [ qw/foo bar hello goodbye sensors/ ],
307 [ 1, 2, 3, 4, 'online' ],
308 [ 5, 4, 3, 6, 'offline' ],
311 $schema->populate('OneKey', [
312 [ qw/id artist cd/ ],
318 $schema->populate('SelfRef', [
324 $schema->populate('SelfRefAlias', [
325 [ qw/self_ref alias/ ],
329 $schema->populate('ArtistUndirectedMap', [
334 $schema->populate('Producer', [
335 [ qw/producerid name/ ],
336 [ 1, 'Matt S Trout' ],
337 [ 2, 'Bob The Builder' ],
338 [ 3, 'Fred The Phenotype' ],
341 $schema->populate('CD_to_Producer', [
348 $schema->populate('TreeLike', [
349 [ qw/id parent name/ ],
350 [ 1, undef, 'root' ],
359 $schema->populate('Track', [
360 [ qw/trackid cd position title/ ],
361 [ 4, 2, 1, "Stung with Success"],
362 [ 5, 2, 2, "Stripy"],
363 [ 6, 2, 3, "Sticky Honey"],
364 [ 7, 3, 1, "Yowlin"],
365 [ 8, 3, 2, "Howlin"],
366 [ 9, 3, 3, "Fowlin"],
367 [ 10, 4, 1, "Boring Name"],
368 [ 11, 4, 2, "Boring Song"],
369 [ 12, 4, 3, "No More Ideas"],
371 [ 14, 5, 2, "Under The Weather"],
372 [ 15, 5, 3, "Suicidal"],
373 [ 16, 1, 1, "The Bees Knees"],
374 [ 17, 1, 2, "Apiary"],
375 [ 18, 1, 3, "Beehind You"],
378 $schema->populate('Event', [
379 [ qw/id starts_at created_on varchar_date varchar_datetime skip_inflation/ ],
380 [ 1, '2006-04-25 22:24:33', '2006-06-22 21:00:05', '2006-07-23', '2006-05-22 19:05:07', '2006-04-21 18:04:06'],
383 $schema->populate('Link', [
384 [ qw/id url title/ ],
388 $schema->populate('Bookmark', [
393 $schema->populate('Collection', [
394 [ qw/collectionid name/ ],
399 $schema->populate('TypedObject', [
400 [ qw/objectid type value/ ],
401 [ 1, "pointy", "Awl" ],
402 [ 2, "round", "Bearing" ],
403 [ 3, "pointy", "Knife" ],
404 [ 4, "pointy", "Tooth" ],
405 [ 5, "round", "Head" ],
407 $schema->populate('CollectionObject', [
408 [ qw/collection object/ ],
416 $schema->populate('Owners', [
422 $schema->populate('BooksInLibrary', [
423 [ qw/id owner title source price/ ],
424 [ 1, 1, "Programming Perl", "Library", 23 ],
425 [ 2, 1, "Dynamical Systems", "Library", 37 ],
426 [ 3, 2, "Best Recipe Cookbook", "Library", 65 ],