t/lib/DBICTest.pm

   1 package # hide from PAUSE
   2     DBICTest;
   3
   4 use strict;
   5 use warnings;
   6
   7 use DBICTest::Util qw( local_umask await_flock dbg DEBUG_TEST_CONCURRENCY_LOCKS );
   8 use DBICTest::Schema;
   9 use DBICTest::Util::LeakTracer qw/populate_weakregistry assert_empty_weakregistry/;
  10 use DBIx::Class::_Util 'detected_reinvoked_destructor';
  11 use Carp;
  12 use Path::Class::File ();
  13 use File::Spec;
  14 use Fcntl qw/:DEFAULT :flock/;
  15 use Config;
  16 use Scope::Guard ();
  17
  18 =head1 NAME
  19
  20 DBICTest - Library to be used by DBIx::Class test scripts
  21
  22 =head1 SYNOPSIS
  23
  24   use lib qw(t/lib);
  25   use DBICTest;
  26   use Test::More;
  27
  28   my $schema = DBICTest->init_schema();
  29
  30 =head1 DESCRIPTION
  31
  32 This module provides the basic utilities to write tests against
  33 DBIx::Class.
  34
  35 =head1 EXPORTS
  36
  37 The module does not export anything by default, nor provides individual
  38 function exports in the conventional sense. Instead the following tags are
  39 recognized:
  40
  41 =head2 :DiffSQL
  42
  43 Same as C<use SQL::Abstract::Test
  44 qw(L<is_same_sql_bind|SQL::Abstract::Test/is_same_sql_bind>
  45 L<is_same_sql|SQL::Abstract::Test/is_same_sql>
  46 L<is_same_bind|SQL::Abstract::Test/is_same_bind>)>
  47
  48 =head2 :GlobalLock
  49
  50 Some tests are very time sensitive and need to run on their own, without
  51 being disturbed by anything else grabbing CPU or disk IO. Hence why everything
  52 using C<DBICTest> grabs a shared lock, and the few tests that request a
  53 C<:GlobalLock> will ask for an exclusive one and block until they can get it.
  54
  55 =head1 METHODS
  56
  57 =head2 init_schema
  58
  59   my $schema = DBICTest->init_schema(
  60     no_deploy=>1,
  61     no_populate=>1,
  62     storage_type=>'::DBI::Replicated',
  63     storage_type_args=>{
  64       balancer_type=>'DBIx::Class::Storage::DBI::Replicated::Balancer::Random'
  65     },
  66   );
  67
  68 This method removes the test SQLite database in t/var/DBIxClass.db
  69 and then creates a new, empty database.
  70
  71 This method will call L<deploy_schema()|/deploy_schema> by default, unless the
  72 C<no_deploy> flag is set.
  73
  74 Also, by default, this method will call L<populate_schema()|/populate_schema>
  75 by default, unless the C<no_deploy> or C<no_populate> flags are set.
  76
  77 =cut
  78
  79 # see L</:GlobalLock>
  80 our ($global_lock_fh, $global_exclusive_lock);
  81 sub import {
  82     my $self = shift;
  83
  84     my $lockpath = DBICTest::RunMode->tmpdir->file('_dbictest_global.lock');
  85
  86     {
  87       my $u = local_umask(0); # so that the file opens as 666, and any user can lock
  88       sysopen ($global_lock_fh, $lockpath, O_RDWR|O_CREAT)
  89         or die "Unable to open $lockpath: $!";
  90     }
  91
  92     for my $exp (@_) {
  93         if ($exp eq ':GlobalLock') {
  94             DEBUG_TEST_CONCURRENCY_LOCKS > 1
  95               and dbg "Waiting for EXCLUSIVE global lock...";
  96
  97             await_flock ($global_lock_fh, LOCK_EX) or die "Unable to lock $lockpath: $!";
  98
  99             DEBUG_TEST_CONCURRENCY_LOCKS > 1
 100               and dbg "Got EXCLUSIVE global lock";
 101
 102             $global_exclusive_lock = 1;
 103         }
 104         elsif ($exp eq ':DiffSQL') {
 105             require SQL::Abstract::Test;
 106             my $into = caller(0);
 107             for (qw(is_same_sql_bind is_same_sql is_same_bind)) {
 108               no strict 'refs';
 109               *{"${into}::$_"} = \&{"SQL::Abstract::Test::$_"};
 110             }
 111         }
 112         else {
 113             croak "Unknown export $exp requested from $self";
 114         }
 115     }
 116
 117     unless ($global_exclusive_lock) {
 118         DEBUG_TEST_CONCURRENCY_LOCKS > 1
 119           and dbg "Waiting for SHARED global lock...";
 120
 121         await_flock ($global_lock_fh, LOCK_SH) or die "Unable to lock $lockpath: $!";
 122
 123         DEBUG_TEST_CONCURRENCY_LOCKS > 1
 124           and dbg "Got SHARED global lock";
 125     }
 126 }
 127
 128 END {
 129     # referencing here delays destruction even more
 130     if ($global_lock_fh) {
 131       DEBUG_TEST_CONCURRENCY_LOCKS > 1
 132         and dbg "Release @{[ $global_exclusive_lock ? 'EXCLUSIVE' : 'SHARED' ]} global lock (END)";
 133       1;
 134     }
 135 }
 136
 137 {
 138     my $dir = Path::Class::File->new(__FILE__)->dir->parent->subdir('var');
 139     $dir->mkpath unless -d "$dir";
 140     $dir = "$dir";
 141
 142     sub _sqlite_dbfilename {
 143         my $holder = $ENV{DBICTEST_LOCK_HOLDER} || $$;
 144         $holder = $$ if $holder == -1;
 145
 146         # useful for missing cleanup debugging
 147         #if ( $holder == $$) {
 148         #  my $x = $0;
 149         #  $x =~ s/\//#/g;
 150         #  $holder .= "-$x";
 151         #}
 152
 153         return "$dir/DBIxClass-$holder.db";
 154     }
 155
 156     END {
 157         _cleanup_dbfile();
 158     }
 159 }
 160
 161 $SIG{INT} = sub { _cleanup_dbfile(); exit 1 };
 162
 163 my $need_global_cleanup;
 164 sub _cleanup_dbfile {
 165     # cleanup if this is us
 166     if (
 167       ! $ENV{DBICTEST_LOCK_HOLDER}
 168         or
 169       $ENV{DBICTEST_LOCK_HOLDER} == -1
 170         or
 171       $ENV{DBICTEST_LOCK_HOLDER} == $$
 172     ) {
 173         if ($need_global_cleanup and my $dbh = DBICTest->schema->storage->_dbh) {
 174           $dbh->disconnect;
 175         }
 176
 177         my $db_file = _sqlite_dbfilename();
 178         unlink $_ for ($db_file, "${db_file}-journal");
 179     }
 180 }
 181
 182 sub has_custom_dsn {
 183     return $ENV{"DBICTEST_DSN"} ? 1:0;
 184 }
 185
 186 sub _sqlite_dbname {
 187     my $self = shift;
 188     my %args = @_;
 189     return $self->_sqlite_dbfilename if (
 190       defined $args{sqlite_use_file} ? $args{sqlite_use_file} : $ENV{'DBICTEST_SQLITE_USE_FILE'}
 191     );
 192     return ":memory:";
 193 }
 194
 195 sub _database {
 196     my $self = shift;
 197     my %args = @_;
 198
 199     if ($ENV{DBICTEST_DSN}) {
 200       return (
 201         (map { $ENV{"DBICTEST_${_}"} || '' } qw/DSN DBUSER DBPASS/),
 202         { AutoCommit => 1, %args },
 203       );
 204     }
 205     my $db_file = $self->_sqlite_dbname(%args);
 206
 207     for ($db_file, "${db_file}-journal") {
 208       next unless -e $_;
 209       unlink ($_) or carp (
 210         "Unable to unlink existing test database file $_ ($!), creation of fresh database / further tests may fail!"
 211       );
 212     }
 213
 214     return ("dbi:SQLite:${db_file}", '', '', {
 215       AutoCommit => 1,
 216
 217       # this is executed on every connect, and thus installs a disconnect/DESTROY
 218       # guard for every new $dbh
 219       on_connect_do => sub {
 220
 221         my $storage = shift;
 222         my $dbh = $storage->_get_dbh;
 223
 224         # no fsync on commit
 225         $dbh->do ('PRAGMA synchronous = OFF');
 226
 227         if (
 228           $ENV{DBICTEST_SQLITE_REVERSE_DEFAULT_ORDER}
 229             and
 230           # the pragma does not work correctly before libsqlite 3.7.9
 231           $storage->_server_info->{normalized_dbms_version} >= 3.007009
 232         ) {
 233           $dbh->do ('PRAGMA reverse_unordered_selects = ON');
 234         }
 235
 236         # set a *DBI* disconnect callback, to make sure the physical SQLite
 237         # file is still there (i.e. the test does not attempt to delete
 238         # an open database, which fails on Win32)
 239         if (! $storage->{master} and my $guard_cb = __mk_disconnect_guard($db_file)) {
 240           $dbh->{Callbacks} = {
 241             connect => sub { $guard_cb->('connect') },
 242             disconnect => sub { $guard_cb->('disconnect') },
 243             DESTROY => sub { &detected_reinvoked_destructor; $guard_cb->('DESTROY') },
 244           };
 245         }
 246       },
 247       %args,
 248     });
 249 }
 250
 251 sub __mk_disconnect_guard {
 252
 253   my $db_file = shift;
 254
 255   return if (
 256     # this perl leaks handles, delaying DESTROY, can't work right
 257     DBIx::Class::_ENV_::PEEPEENESS
 258       or
 259     ! -f $db_file
 260   );
 261
 262
 263   my $orig_inode = (stat($db_file))[1]
 264     or return;
 265
 266   my $clan_connect_caller = '*UNKNOWN*';
 267   my $i;
 268   while ( my ($pack, $file, $line) = caller(++$i) ) {
 269     next if $file eq __FILE__;
 270     next if $pack =~ /^DBIx::Class|^Try::Tiny/;
 271     $clan_connect_caller = "$file line $line";
 272   }
 273
 274   my $failed_once = 0;
 275   my $connected = 1;
 276
 277   return sub {
 278     return if $failed_once;
 279
 280     my $event = shift;
 281     if ($event eq 'connect') {
 282       # this is necessary in case we are disconnected and connected again, all within the same $dbh object
 283       $connected = 1;
 284       return;
 285     }
 286     elsif ($event eq 'disconnect') {
 287       $connected = 0;
 288     }
 289     elsif ($event eq 'DESTROY' and ! $connected ) {
 290       return;
 291     }
 292
 293     my $fail_reason;
 294     if (! -e $db_file) {
 295       $fail_reason = 'is missing';
 296     }
 297     else {
 298       my $cur_inode = (stat($db_file))[1];
 299
 300       if ($orig_inode != $cur_inode) {
 301         my @inodes = ($orig_inode, $cur_inode);
 302         # unless this is a fixed perl (P5RT#84590) pack/unpack before display
 303         # to match the unsigned longs returned by `stat`
 304         @inodes = map { unpack ('L', pack ('l', $_) ) } @inodes
 305           unless $Config{st_ino_size};
 306
 307         $fail_reason = sprintf
 308           'was recreated (initially inode %s, now %s)',
 309           @inodes
 310         ;
 311       }
 312     }
 313
 314     if ($fail_reason) {
 315       $failed_once++;
 316
 317       require Test::Builder;
 318       my $t = Test::Builder->new;
 319       local $Test::Builder::Level = $Test::Builder::Level + 3;
 320       $t->ok (0,
 321         "$db_file originally created at $clan_connect_caller $fail_reason before $event "
 322       . 'of DBI handle - a strong indicator that the database file was tampered with while '
 323       . 'still being open. This action would fail massively if running under Win32, hence '
 324       . 'we make sure it fails on any OS :)'
 325       );
 326     }
 327
 328     return; # this empty return is a DBI requirement
 329   };
 330 }
 331
 332 my $weak_registry = {};
 333
 334 sub init_schema {
 335     my $self = shift;
 336     my %args = @_;
 337
 338     my $schema;
 339
 340     if (
 341       $ENV{DBICTEST_VIA_REPLICATED} &&=
 342         ( !$args{storage_type} && !defined $args{sqlite_use_file} )
 343     ) {
 344       $args{storage_type} = ['::DBI::Replicated', { balancer_type => '::Random' }];
 345       $args{sqlite_use_file} = 1;
 346     }
 347
 348     my @dsn = $self->_database(%args);
 349
 350     if ($args{compose_connection}) {
 351       $need_global_cleanup = 1;
 352       $schema = DBICTest::Schema->compose_connection(
 353                   'DBICTest', @dsn
 354                 );
 355     } else {
 356       $schema = DBICTest::Schema->compose_namespace('DBICTest');
 357     }
 358
 359     if( $args{storage_type}) {
 360       $schema->storage_type($args{storage_type});
 361     }
 362
 363     if ( !$args{no_connect} ) {
 364       $schema->connection(@dsn);
 365
 366       $schema->storage->connect_replicants(\@dsn)
 367         if $ENV{DBICTEST_VIA_REPLICATED};
 368     }
 369
 370     if ( !$args{no_deploy} ) {
 371         __PACKAGE__->deploy_schema( $schema, $args{deploy_args} );
 372         __PACKAGE__->populate_schema( $schema )
 373          if( !$args{no_populate} );
 374     }
 375
 376     populate_weakregistry ( $weak_registry, $schema->storage )
 377       if $INC{'Test/Builder.pm'} and $schema->storage;
 378
 379     return $schema;
 380 }
 381
 382 END {
 383   # Make sure we run after any cleanup in other END blocks
 384   push @{ B::end_av()->object_2svref }, sub {
 385     assert_empty_weakregistry($weak_registry, 'quiet');
 386   };
 387 }
 388
 389 =head2 deploy_schema
 390
 391   DBICTest->deploy_schema( $schema );
 392
 393 This method does one of two things to the schema.  It can either call
 394 the experimental $schema->deploy() if the DBICTEST_SQLT_DEPLOY environment
 395 variable is set, otherwise the default is to read in the t/lib/sqlite.sql
 396 file and execute the SQL within. Either way you end up with a fresh set
 397 of tables for testing.
 398
 399 =cut
 400
 401 sub deploy_schema {
 402     my $self = shift;
 403     my $schema = shift;
 404     my $args = shift || {};
 405
 406     my $guard;
 407     if ( ($ENV{TRAVIS}||'') eq 'true' and my $old_dbg = $schema->storage->debug ) {
 408       $guard = Scope::Guard->new(sub { $schema->storage->debug($old_dbg) });
 409       $schema->storage->debug(0);
 410     }
 411
 412     if ($ENV{"DBICTEST_SQLT_DEPLOY"}) {
 413         $schema->deploy($args);
 414     } else {
 415         my $filename = Path::Class::File->new(__FILE__)->dir
 416           ->file('sqlite.sql')->stringify;
 417         my $sql = do { local (@ARGV, $/) = $filename ; <> };
 418         for my $chunk ( split (/;\s*\n+/, $sql) ) {
 419           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
 420             $schema->storage->dbh_do(sub { $_[1]->do($chunk) }) or print "Error on SQL: $chunk\n";
 421           }
 422         }
 423     }
 424     return;
 425 }
 426
 427 =head2 populate_schema
 428
 429   DBICTest->populate_schema( $schema );
 430
 431 After you deploy your schema you can use this method to populate
 432 the tables with test data.
 433
 434 =cut
 435
 436 sub populate_schema {
 437     my $self = shift;
 438     my $schema = shift;
 439
 440     my $guard;
 441     if ( ($ENV{TRAVIS}||'') eq 'true' and my $old_dbg = $schema->storage->debug ) {
 442       $guard = Scope::Guard->new(sub { $schema->storage->debug($old_dbg) });
 443       $schema->storage->debug(0);
 444     }
 445
 446     $schema->populate('Genre', [
 447       [qw/genreid name/],
 448       [qw/1       emo  /],
 449     ]);
 450
 451     $schema->populate('Artist', [
 452         [ qw/artistid name/ ],
 453         [ 1, 'Caterwauler McCrae' ],
 454         [ 2, 'Random Boy Band' ],
 455         [ 3, 'We Are Goth' ],
 456     ]);
 457
 458     $schema->populate('CD', [
 459         [ qw/cdid artist title year genreid/ ],
 460         [ 1, 1, "Spoonful of bees", 1999, 1 ],
 461         [ 2, 1, "Forkful of bees", 2001 ],
 462         [ 3, 1, "Caterwaulin' Blues", 1997 ],
 463         [ 4, 2, "Generic Manufactured Singles", 2001 ],
 464         [ 5, 3, "Come Be Depressed With Us", 1998 ],
 465     ]);
 466
 467     $schema->populate('LinerNotes', [
 468         [ qw/liner_id notes/ ],
 469         [ 2, "Buy Whiskey!" ],
 470         [ 4, "Buy Merch!" ],
 471         [ 5, "Kill Yourself!" ],
 472     ]);
 473
 474     $schema->populate('Tag', [
 475         [ qw/tagid cd tag/ ],
 476         [ 1, 1, "Blue" ],
 477         [ 2, 2, "Blue" ],
 478         [ 3, 3, "Blue" ],
 479         [ 4, 5, "Blue" ],
 480         [ 5, 2, "Cheesy" ],
 481         [ 6, 4, "Cheesy" ],
 482         [ 7, 5, "Cheesy" ],
 483         [ 8, 2, "Shiny" ],
 484         [ 9, 4, "Shiny" ],
 485     ]);
 486
 487     $schema->populate('TwoKeys', [
 488         [ qw/artist cd/ ],
 489         [ 1, 1 ],
 490         [ 1, 2 ],
 491         [ 2, 2 ],
 492     ]);
 493
 494     $schema->populate('FourKeys', [
 495         [ qw/foo bar hello goodbye sensors/ ],
 496         [ 1, 2, 3, 4, 'online' ],
 497         [ 5, 4, 3, 6, 'offline' ],
 498     ]);
 499
 500     $schema->populate('OneKey', [
 501         [ qw/id artist cd/ ],
 502         [ 1, 1, 1 ],
 503         [ 2, 1, 2 ],
 504         [ 3, 2, 2 ],
 505     ]);
 506
 507     $schema->populate('SelfRef', [
 508         [ qw/id name/ ],
 509         [ 1, 'First' ],
 510         [ 2, 'Second' ],
 511     ]);
 512
 513     $schema->populate('SelfRefAlias', [
 514         [ qw/self_ref alias/ ],
 515         [ 1, 2 ]
 516     ]);
 517
 518     $schema->populate('ArtistUndirectedMap', [
 519         [ qw/id1 id2/ ],
 520         [ 1, 2 ]
 521     ]);
 522
 523     $schema->populate('Producer', [
 524         [ qw/producerid name/ ],
 525         [ 1, 'Matt S Trout' ],
 526         [ 2, 'Bob The Builder' ],
 527         [ 3, 'Fred The Phenotype' ],
 528     ]);
 529
 530     $schema->populate('CD_to_Producer', [
 531         [ qw/cd producer/ ],
 532         [ 1, 1 ],
 533         [ 1, 2 ],
 534         [ 1, 3 ],
 535     ]);
 536
 537     $schema->populate('TreeLike', [
 538         [ qw/id parent name/ ],
 539         [ 1, undef, 'root' ],
 540         [ 2, 1, 'foo'  ],
 541         [ 3, 2, 'bar'  ],
 542         [ 6, 2, 'blop' ],
 543         [ 4, 3, 'baz'  ],
 544         [ 5, 4, 'quux' ],
 545         [ 7, 3, 'fong'  ],
 546     ]);
 547
 548     $schema->populate('Track', [
 549         [ qw/trackid cd  position title/ ],
 550         [ 4, 2, 1, "Stung with Success"],
 551         [ 5, 2, 2, "Stripy"],
 552         [ 6, 2, 3, "Sticky Honey"],
 553         [ 7, 3, 1, "Yowlin"],
 554         [ 8, 3, 2, "Howlin"],
 555         [ 9, 3, 3, "Fowlin"],
 556         [ 10, 4, 1, "Boring Name"],
 557         [ 11, 4, 2, "Boring Song"],
 558         [ 12, 4, 3, "No More Ideas"],
 559         [ 13, 5, 1, "Sad"],
 560         [ 14, 5, 2, "Under The Weather"],
 561         [ 15, 5, 3, "Suicidal"],
 562         [ 16, 1, 1, "The Bees Knees"],
 563         [ 17, 1, 2, "Apiary"],
 564         [ 18, 1, 3, "Beehind You"],
 565     ]);
 566
 567     $schema->populate('Event', [
 568         [ qw/id starts_at created_on varchar_date varchar_datetime skip_inflation/ ],
 569         [ 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'],
 570     ]);
 571
 572     $schema->populate('Link', [
 573         [ qw/id url title/ ],
 574         [ 1, '', 'aaa' ]
 575     ]);
 576
 577     $schema->populate('Bookmark', [
 578         [ qw/id link/ ],
 579         [ 1, 1 ]
 580     ]);
 581
 582     $schema->populate('Collection', [
 583         [ qw/collectionid name/ ],
 584         [ 1, "Tools" ],
 585         [ 2, "Body Parts" ],
 586     ]);
 587
 588     $schema->populate('TypedObject', [
 589         [ qw/objectid type value/ ],
 590         [ 1, "pointy", "Awl" ],
 591         [ 2, "round", "Bearing" ],
 592         [ 3, "pointy", "Knife" ],
 593         [ 4, "pointy", "Tooth" ],
 594         [ 5, "round", "Head" ],
 595     ]);
 596     $schema->populate('CollectionObject', [
 597         [ qw/collection object/ ],
 598         [ 1, 1 ],
 599         [ 1, 2 ],
 600         [ 1, 3 ],
 601         [ 2, 4 ],
 602         [ 2, 5 ],
 603     ]);
 604
 605     $schema->populate('Owners', [
 606         [ qw/id name/ ],
 607         [ 1, "Newton" ],
 608         [ 2, "Waltham" ],
 609     ]);
 610
 611     $schema->populate('BooksInLibrary', [
 612         [ qw/id owner title source price/ ],
 613         [ 1, 1, "Programming Perl", "Library", 23 ],
 614         [ 2, 1, "Dynamical Systems", "Library",  37 ],
 615         [ 3, 2, "Best Recipe Cookbook", "Library", 65 ],
 616     ]);
 617 }
 618
 619 1;