t/lib/DBICTest.pm

   1 package # hide from PAUSE
   2     DBICTest;
   3
   4 use strict;
   5 use warnings;
   6 use DBICTest::Schema;
   7
   8 =head1 NAME
   9
  10 DBICTest - Library to be used by DBIx::Class test scripts.
  11
  12 =head1 SYNOPSIS
  13
  14   use lib qw(t/lib);
  15   use DBICTest;
  16   use Test::More;
  17
  18   my $schema = DBICTest->init_schema();
  19
  20 =head1 DESCRIPTION
  21
  22 This module provides the basic utilities to write tests against
  23 DBIx::Class.
  24
  25 =head1 METHODS
  26
  27 =head2 init_schema
  28
  29   my $schema = DBICTest->init_schema(
  30     no_deploy=>1,
  31     no_populate=>1,
  32   );
  33
  34 This method removes the test SQLite database in t/var/DBIxClass.db
  35 and then creates a new, empty database.
  36
  37 This method will call deploy_schema() by default, unless the
  38 no_deploy flag is set.
  39
  40 Also, by default, this method will call populate_schema() by
  41 default, unless the no_deploy or no_populate flags are set.
  42
  43 =cut
  44
  45 sub init_schema {
  46     my $self = shift;
  47     my %args = @_;
  48     my $db_file = "t/var/DBIxClass.db";
  49
  50     unlink($db_file) if -e $db_file;
  51     unlink($db_file . "-journal") if -e $db_file . "-journal";
  52     mkdir("t/var") unless -d "t/var";
  53
  54     my $dsn = $ENV{"DBICTEST_DSN"} || "dbi:SQLite:${db_file}";
  55     my $dbuser = $ENV{"DBICTEST_DBUSER"} || '';
  56     my $dbpass = $ENV{"DBICTEST_DBPASS"} || '';
  57
  58     my $schema = DBICTest::Schema->compose_connection('DBICTest' => $dsn, $dbuser, $dbpass);
  59     $schema->storage->on_connect_do(['PRAGMA synchronous = OFF']);
  60     if ( !$args{no_deploy} ) {
  61         __PACKAGE__->deploy_schema( $schema );
  62         __PACKAGE__->populate_schema( $schema ) if( !$args{no_populate} );
  63     }
  64     return $schema;
  65 }
  66
  67 =head2 deploy_schema
  68
  69   DBICTest->deploy_schema( $schema );
  70
  71 This method does one of two things to the schema.  It can either call
  72 the experimental $schema->deploy() if the DBICTEST_SQLT_DEPLOY environment
  73 variable is set, otherwise the default is to read in the t/lib/sqlite.sql
  74 file and execute the SQL within. Either way you end up with a fresh set
  75 of tables for testing.
  76
  77 =cut
  78
  79 sub deploy_schema {
  80     my $self = shift;
  81     my $schema = shift;
  82
  83     if ($ENV{"DBICTEST_SQLT_DEPLOY"}) {
  84         return $schema->deploy();
  85     } else {
  86         open IN, "t/lib/sqlite.sql";
  87         my $sql;
  88         { local $/ = undef; $sql = <IN>; }
  89         close IN;
  90         $schema->storage->dbh->do($_) for split(/;\n/, $sql);
  91     }
  92 }
  93
  94 =head2 populate_schema
  95
  96   DBICTest->populate_schema( $schema );
  97
  98 After you deploy your schema you can use this method to populate
  99 the tables with test data.
 100
 101 =cut
 102
 103 sub populate_schema {
 104     my $self = shift;
 105     my $schema = shift;
 106
 107     $schema->populate('Label', [
 108         [ qw/labelid name/ ],
 109         [ 1, 'Acme Records' ],
 110     ]);
 111
 112     $schema->populate('Agent', [
 113         [ qw/agentid label name/ ],
 114         [ 1, 1, 'Ted' ],
 115     ]);
 116
 117     $schema->populate('Artist', [
 118         [ qw/artistid agent name/ ],
 119         [ 1, 1, 'Caterwauler McCrae' ],
 120         [ 2, 1, 'Random Boy Band' ],
 121         [ 3, 1, 'We Are Goth' ],
 122     ]);
 123
 124     $schema->populate('CD', [
 125         [ qw/cdid artist title year/ ],
 126         [ 1, 1, "Spoonful of bees", 1999 ],
 127         [ 2, 1, "Forkful of bees", 2001 ],
 128         [ 3, 1, "Caterwaulin' Blues", 1997 ],
 129         [ 4, 2, "Generic Manufactured Singles", 2001 ],
 130         [ 5, 3, "Come Be Depressed With Us", 1998 ],
 131     ]);
 132
 133     $schema->populate('LinerNotes', [
 134         [ qw/liner_id notes/ ],
 135         [ 2, "Buy Whiskey!" ],
 136         [ 4, "Buy Merch!" ],
 137         [ 5, "Kill Yourself!" ],
 138     ]);
 139
 140     $schema->populate('Tag', [
 141         [ qw/tagid cd tag/ ],
 142         [ 1, 1, "Blue" ],
 143         [ 2, 2, "Blue" ],
 144         [ 3, 3, "Blue" ],
 145         [ 4, 5, "Blue" ],
 146         [ 5, 2, "Cheesy" ],
 147         [ 6, 4, "Cheesy" ],
 148         [ 7, 5, "Cheesy" ],
 149         [ 8, 2, "Shiny" ],
 150         [ 9, 4, "Shiny" ],
 151     ]);
 152
 153     $schema->populate('TwoKeys', [
 154         [ qw/artist cd/ ],
 155         [ 1, 1 ],
 156         [ 1, 2 ],
 157         [ 2, 2 ],
 158     ]);
 159
 160     $schema->populate('FourKeys', [
 161         [ qw/foo bar hello goodbye sensors/ ],
 162         [ 1, 2, 3, 4, 'online' ],
 163         [ 5, 4, 3, 6, 'offline' ],
 164     ]);
 165
 166     $schema->populate('OneKey', [
 167         [ qw/id artist cd/ ],
 168         [ 1, 1, 1 ],
 169         [ 2, 1, 2 ],
 170         [ 3, 2, 2 ],
 171     ]);
 172
 173     $schema->populate('SelfRef', [
 174         [ qw/id name/ ],
 175         [ 1, 'First' ],
 176         [ 2, 'Second' ],
 177     ]);
 178
 179     $schema->populate('SelfRefAlias', [
 180         [ qw/self_ref alias/ ],
 181         [ 1, 2 ]
 182     ]);
 183
 184     $schema->populate('ArtistUndirectedMap', [
 185         [ qw/id1 id2/ ],
 186         [ 1, 2 ]
 187     ]);
 188
 189     $schema->populate('Producer', [
 190         [ qw/producerid name/ ],
 191         [ 1, 'Matt S Trout' ],
 192         [ 2, 'Bob The Builder' ],
 193         [ 3, 'Fred The Phenotype' ],
 194     ]);
 195
 196     $schema->populate('CD_to_Producer', [
 197         [ qw/cd producer/ ],
 198         [ 1, 1 ],
 199         [ 1, 2 ],
 200         [ 1, 3 ],
 201     ]);
 202
 203     $schema->populate('TreeLike', [
 204         [ qw/id parent name/ ],
 205         [ 1, 0, 'foo'  ],
 206         [ 2, 1, 'bar'  ],
 207         [ 5, 1, 'blop' ],
 208         [ 3, 2, 'baz'  ],
 209         [ 4, 3, 'quux' ],
 210         [ 6, 2, 'fong'  ],
 211     ]);
 212
 213     $schema->populate('Track', [
 214         [ qw/trackid cd  position title/ ],
 215         [ 4, 2, 1, "Stung with Success"],
 216         [ 5, 2, 2, "Stripy"],
 217         [ 6, 2, 3, "Sticky Honey"],
 218         [ 7, 3, 1, "Yowlin"],
 219         [ 8, 3, 2, "Howlin"],
 220         [ 9, 3, 3, "Fowlin"],
 221         [ 10, 4, 1, "Boring Name"],
 222         [ 11, 4, 2, "Boring Song"],
 223         [ 12, 4, 3, "No More Ideas"],
 224         [ 13, 5, 1, "Sad"],
 225         [ 14, 5, 2, "Under The Weather"],
 226         [ 15, 5, 3, "Suicidal"],
 227         [ 16, 1, 1, "The Bees Knees"],
 228         [ 17, 1, 2, "Apiary"],
 229         [ 18, 1, 3, "Beehind You"],
 230     ]);
 231
 232     $schema->populate('Event', [
 233         [ qw/id starts_at created_on/ ],
 234         [ 1, '2006-04-25 22:24:33', '2006-06-22 21:00:05'],
 235     ]);
 236
 237     $schema->populate('Link', [
 238         [ qw/id title/ ],
 239         [ 1, 'aaa' ]
 240     ]);
 241
 242     $schema->populate('Bookmark', [
 243         [ qw/id link/ ],
 244         [ 1, 1 ]
 245     ]);
 246 }
 247
 248 1;