t/lib/DBICTest.pm

   1 package # hide from PAUSE
   2     DBICTest;
   3
   4 use strict;
   5 use warnings;
   6 use DBICTest::AuthorCheck;
   7 use DBICTest::Schema;
   8
   9 =head1 NAME
  10
  11 DBICTest - Library to be used by DBIx::Class test scripts.
  12
  13 =head1 SYNOPSIS
  14
  15   use lib qw(t/lib);
  16   use DBICTest;
  17   use Test::More;
  18
  19   my $schema = DBICTest->init_schema();
  20
  21 =head1 DESCRIPTION
  22
  23 This module provides the basic utilities to write tests against
  24 DBIx::Class.
  25
  26 =head1 METHODS
  27
  28 =head2 init_schema
  29
  30   my $schema = DBICTest->init_schema(
  31     no_deploy=>1,
  32     no_populate=>1,
  33     storage_type=>'::DBI::Replicated',
  34     storage_type_args=>{
  35         balancer_type=>'DBIx::Class::Storage::DBI::Replicated::Balancer::Random'
  36     },
  37   );
  38
  39 This method removes the test SQLite database in t/var/DBIxClass.db
  40 and then creates a new, empty database.
  41
  42 This method will call deploy_schema() by default, unless the
  43 no_deploy flag is set.
  44
  45 Also, by default, this method will call populate_schema() by
  46 default, unless the no_deploy or no_populate flags are set.
  47
  48 =cut
  49
  50 sub has_custom_dsn {
  51         return $ENV{"DBICTEST_DSN"} ? 1:0;
  52 }
  53
  54 sub _sqlite_dbfilename {
  55     return "t/var/DBIxClass.db";
  56 }
  57
  58 sub _sqlite_dbname {
  59     my $self = shift;
  60     my %args = @_;
  61     return $self->_sqlite_dbfilename if $args{sqlite_use_file} or $ENV{"DBICTEST_SQLITE_USE_FILE"};
  62         return ":memory:";
  63 }
  64
  65 sub _database {
  66     my $self = shift;
  67     my %args = @_;
  68     my $db_file = $self->_sqlite_dbname(%args);
  69
  70     unlink($db_file) if -e $db_file;
  71     unlink($db_file . "-journal") if -e $db_file . "-journal";
  72     mkdir("t/var") unless -d "t/var";
  73
  74     my $dsn = $ENV{"DBICTEST_DSN"} || "dbi:SQLite:${db_file}";
  75     my $dbuser = $ENV{"DBICTEST_DBUSER"} || '';
  76     my $dbpass = $ENV{"DBICTEST_DBPASS"} || '';
  77
  78     my @connect_info = ($dsn, $dbuser, $dbpass, { AutoCommit => 1, %args });
  79
  80     return @connect_info;
  81 }
  82
  83 sub init_schema {
  84     my $self = shift;
  85     my %args = @_;
  86
  87     my $schema;
  88
  89     if ($args{compose_connection}) {
  90       $schema = DBICTest::Schema->compose_connection(
  91                   'DBICTest', $self->_database(%args)
  92                 );
  93     } else {
  94       $schema = DBICTest::Schema->compose_namespace('DBICTest');
  95     }
  96     if( $args{storage_type}) {
  97         $schema->storage_type($args{storage_type});
  98     }
  99     if ( !$args{no_connect} ) {
 100       $schema = $schema->connect($self->_database(%args));
 101       $schema->storage->on_connect_do(['PRAGMA synchronous = OFF'])
 102        unless $self->has_custom_dsn;
 103     }
 104     if ( !$args{no_deploy} ) {
 105         __PACKAGE__->deploy_schema( $schema, $args{deploy_args} );
 106         __PACKAGE__->populate_schema( $schema )
 107          if( !$args{no_populate} );
 108     }
 109     return $schema;
 110 }
 111
 112 =head2 deploy_schema
 113
 114   DBICTest->deploy_schema( $schema );
 115
 116 This method does one of two things to the schema.  It can either call
 117 the experimental $schema->deploy() if the DBICTEST_SQLT_DEPLOY environment
 118 variable is set, otherwise the default is to read in the t/lib/sqlite.sql
 119 file and execute the SQL within. Either way you end up with a fresh set
 120 of tables for testing.
 121
 122 =cut
 123
 124 sub deploy_schema {
 125     my $self = shift;
 126     my $schema = shift;
 127     my $args = shift || {};
 128
 129     if ($ENV{"DBICTEST_SQLT_DEPLOY"}) {
 130         $schema->deploy($args);
 131     } else {
 132         open IN, "t/lib/sqlite.sql";
 133         my $sql;
 134         { local $/ = undef; $sql = <IN>; }
 135         close IN;
 136         for my $chunk ( split (/;\s*\n+/, $sql) ) {
 137           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
 138             $schema->storage->dbh->do($chunk) or print "Error on SQL: $chunk\n";
 139           }
 140         }
 141     }
 142     return;
 143 }
 144
 145 =head2 populate_schema
 146
 147   DBICTest->populate_schema( $schema );
 148
 149 After you deploy your schema you can use this method to populate
 150 the tables with test data.
 151
 152 =cut
 153
 154 sub populate_schema {
 155     my $self = shift;
 156     my $schema = shift;
 157
 158     $schema->populate('Artist', [
 159         [ qw/artistid name/ ],
 160         [ 1, 'Caterwauler McCrae' ],
 161         [ 2, 'Random Boy Band' ],
 162         [ 3, 'We Are Goth' ],
 163     ]);
 164
 165     $schema->populate('CD', [
 166         [ qw/cdid artist title year/ ],
 167         [ 1, 1, "Spoonful of bees", 1999 ],
 168         [ 2, 1, "Forkful of bees", 2001 ],
 169         [ 3, 1, "Caterwaulin' Blues", 1997 ],
 170         [ 4, 2, "Generic Manufactured Singles", 2001 ],
 171         [ 5, 3, "Come Be Depressed With Us", 1998 ],
 172     ]);
 173
 174     $schema->populate('LinerNotes', [
 175         [ qw/liner_id notes/ ],
 176         [ 2, "Buy Whiskey!" ],
 177         [ 4, "Buy Merch!" ],
 178         [ 5, "Kill Yourself!" ],
 179     ]);
 180
 181     $schema->populate('Tag', [
 182         [ qw/tagid cd tag/ ],
 183         [ 1, 1, "Blue" ],
 184         [ 2, 2, "Blue" ],
 185         [ 3, 3, "Blue" ],
 186         [ 4, 5, "Blue" ],
 187         [ 5, 2, "Cheesy" ],
 188         [ 6, 4, "Cheesy" ],
 189         [ 7, 5, "Cheesy" ],
 190         [ 8, 2, "Shiny" ],
 191         [ 9, 4, "Shiny" ],
 192     ]);
 193
 194     $schema->populate('TwoKeys', [
 195         [ qw/artist cd/ ],
 196         [ 1, 1 ],
 197         [ 1, 2 ],
 198         [ 2, 2 ],
 199     ]);
 200
 201     $schema->populate('FourKeys', [
 202         [ qw/foo bar hello goodbye sensors/ ],
 203         [ 1, 2, 3, 4, 'online' ],
 204         [ 5, 4, 3, 6, 'offline' ],
 205     ]);
 206
 207     $schema->populate('OneKey', [
 208         [ qw/id artist cd/ ],
 209         [ 1, 1, 1 ],
 210         [ 2, 1, 2 ],
 211         [ 3, 2, 2 ],
 212     ]);
 213
 214     $schema->populate('SelfRef', [
 215         [ qw/id name/ ],
 216         [ 1, 'First' ],
 217         [ 2, 'Second' ],
 218     ]);
 219
 220     $schema->populate('SelfRefAlias', [
 221         [ qw/self_ref alias/ ],
 222         [ 1, 2 ]
 223     ]);
 224
 225     $schema->populate('ArtistUndirectedMap', [
 226         [ qw/id1 id2/ ],
 227         [ 1, 2 ]
 228     ]);
 229
 230     $schema->populate('Producer', [
 231         [ qw/producerid name/ ],
 232         [ 1, 'Matt S Trout' ],
 233         [ 2, 'Bob The Builder' ],
 234         [ 3, 'Fred The Phenotype' ],
 235     ]);
 236
 237     $schema->populate('CD_to_Producer', [
 238         [ qw/cd producer/ ],
 239         [ 1, 1 ],
 240         [ 1, 2 ],
 241         [ 1, 3 ],
 242     ]);
 243
 244     $schema->populate('TreeLike', [
 245         [ qw/id parent name/ ],
 246         [ 1, undef, 'root' ],
 247         [ 2, 1, 'foo'  ],
 248         [ 3, 2, 'bar'  ],
 249         [ 6, 2, 'blop' ],
 250         [ 4, 3, 'baz'  ],
 251         [ 5, 4, 'quux' ],
 252         [ 7, 3, 'fong'  ],
 253     ]);
 254
 255     $schema->populate('Track', [
 256         [ qw/trackid cd  position title/ ],
 257         [ 4, 2, 1, "Stung with Success"],
 258         [ 5, 2, 2, "Stripy"],
 259         [ 6, 2, 3, "Sticky Honey"],
 260         [ 7, 3, 1, "Yowlin"],
 261         [ 8, 3, 2, "Howlin"],
 262         [ 9, 3, 3, "Fowlin"],
 263         [ 10, 4, 1, "Boring Name"],
 264         [ 11, 4, 2, "Boring Song"],
 265         [ 12, 4, 3, "No More Ideas"],
 266         [ 13, 5, 1, "Sad"],
 267         [ 14, 5, 2, "Under The Weather"],
 268         [ 15, 5, 3, "Suicidal"],
 269         [ 16, 1, 1, "The Bees Knees"],
 270         [ 17, 1, 2, "Apiary"],
 271         [ 18, 1, 3, "Beehind You"],
 272     ]);
 273
 274     $schema->populate('Event', [
 275         [ qw/id starts_at created_on varchar_date varchar_datetime skip_inflation/ ],
 276         [ 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'],
 277     ]);
 278
 279     $schema->populate('Link', [
 280         [ qw/id url title/ ],
 281         [ 1, '', 'aaa' ]
 282     ]);
 283
 284     $schema->populate('Bookmark', [
 285         [ qw/id link/ ],
 286         [ 1, 1 ]
 287     ]);
 288
 289     $schema->populate('Collection', [
 290         [ qw/collectionid name/ ],
 291         [ 1, "Tools" ],
 292         [ 2, "Body Parts" ],
 293     ]);
 294
 295     $schema->populate('TypedObject', [
 296         [ qw/objectid type value/ ],
 297         [ 1, "pointy", "Awl" ],
 298         [ 2, "round", "Bearing" ],
 299         [ 3, "pointy", "Knife" ],
 300         [ 4, "pointy", "Tooth" ],
 301         [ 5, "round", "Head" ],
 302     ]);
 303     $schema->populate('CollectionObject', [
 304         [ qw/collection object/ ],
 305         [ 1, 1 ],
 306         [ 1, 2 ],
 307         [ 1, 3 ],
 308         [ 2, 4 ],
 309         [ 2, 5 ],
 310     ]);
 311
 312     $schema->populate('Owners', [
 313         [ qw/id name/ ],
 314         [ 1, "Newton" ],
 315         [ 2, "Waltham" ],
 316     ]);
 317
 318     $schema->populate('BooksInLibrary', [
 319         [ qw/id owner title source price/ ],
 320         [ 1, 1, "Programming Perl", "Library", 23 ],
 321         [ 2, 1, "Dynamical Systems", "Library",  37 ],
 322         [ 3, 2, "Best Recipe Cookbook", "Library", 65 ],
 323     ]);
 324 }
 325
 326 1;