-package DBICTest;
+package # hide from PAUSE
+ DBICTest;
use strict;
use warnings;
-use base qw/DBIx::Class::Core/;
-use DateTime;
+use DBICTest::Schema;
-my $db_file = "t/var/DBIxClass.db";
+=head1 NAME
-unlink($db_file) if -e $db_file;
-unlink($db_file . "-journal") if -e $db_file . "-journal";
-mkdir("t/var") unless -d "t/var";
+DBICTest - Library to be used by DBIx::Class test scripts.
-__PACKAGE__->connection("dbi:SQLite:${db_file}");
+=head1 SYNOPSIS
-my $dbh = __PACKAGE__->_get_dbh;
+ use lib qw(t/lib);
+ use DBICTest;
+ use Test::More;
+
+ my $schema = DBICTest->init_schema();
-my $sql = <<EOSQL;
-CREATE TABLE artist (artistid INTEGER NOT NULL PRIMARY KEY, name VARCHAR);
+=head1 DESCRIPTION
-CREATE TABLE cd (cdid INTEGER NOT NULL PRIMARY KEY, artist INTEGER NOT NULL,
- title VARCHAR, year VARCHAR);
+This module provides the basic utilities to write tests against
+DBIx::Class.
-CREATE TABLE liner_notes (liner_id INTEGER NOT NULL PRIMARY KEY, notes VARCHAR);
+=head1 METHODS
+
+=head2 init_schema
-CREATE TABLE track (trackid INTEGER NOT NULL PRIMARY KEY, cd INTEGER NOT NULL,
- position INTEGER NOT NULL, title VARCHAR);
+ my $schema = DBICTest->init_schema(
+ no_deploy=>1,
+ no_populate=>1,
+ storage_type=>'::DBI::Replicated',
+ storage_type_args=>{
+ balancer_type=>'DBIx::Class::Storage::DBI::Replicated::Balancer::Random'
+ },
+ );
-CREATE TABLE tags (tagid INTEGER NOT NULL PRIMARY KEY, cd INTEGER NOT NULL,
- tag VARCHAR);
+This method removes the test SQLite database in t/var/DBIxClass.db
+and then creates a new, empty database.
-CREATE TABLE twokeys (artist INTEGER NOT NULL, cd INTEGER NOT NULL,
- PRIMARY KEY (artist, cd) );
+This method will call deploy_schema() by default, unless the
+no_deploy flag is set.
-CREATE TABLE fourkeys (foo INTEGER NOT NULL, bar INTEGER NOT NULL,
- hello INTEGER NOT NULL, goodbye INTEGER NOT NULL,
- PRIMARY KEY (foo, bar, hello, goodbye) );
+Also, by default, this method will call populate_schema() by
+default, unless the no_deploy or no_populate flags are set.
-CREATE TABLE onekey (id INTEGER NOT NULL PRIMARY KEY,
- artist INTEGER NOT NULL, cd INTEGER NOT NULL );
+=cut
-INSERT INTO artist (artistid, name) VALUES (1, 'Caterwauler McCrae');
+sub has_custom_dsn {
+ return $ENV{"DBICTEST_DSN"} ? 1:0;
+}
-INSERT INTO artist (artistid, name) VALUES (2, 'Random Boy Band');
+sub _sqlite_dbfilename {
+ return "t/var/DBIxClass.db";
+}
-INSERT INTO artist (artistid, name) VALUES (3, 'We Are Goth');
-
-INSERT INTO cd (cdid, artist, title, year)
- VALUES (1, 1, "Spoonful of bees", 1999);
-
-INSERT INTO cd (cdid, artist, title, year)
- VALUES (2, 1, "Forkful of bees", 2001);
-
-INSERT INTO cd (cdid, artist, title, year)
- VALUES (3, 1, "Caterwaulin' Blues", 1997);
-
-INSERT INTO cd (cdid, artist, title, year)
- VALUES (4, 2, "Generic Manufactured Singles", 2001);
-
-INSERT INTO cd (cdid, artist, title, year)
- VALUES (5, 3, "Come Be Depressed With Us", 1998);
-
-INSERT INTO liner_notes (liner_id, notes)
- VALUES (2, "Buy Whiskey!");
-
-INSERT INTO liner_notes (liner_id, notes)
- VALUES (4, "Buy Merch!");
-
-INSERT INTO liner_notes (liner_id, notes)
- VALUES (5, "Kill Yourself!");
-
-INSERT INTO tags (tagid, cd, tag) VALUES (1, 1, "Blue");
-
-INSERT INTO tags (tagid, cd, tag) VALUES (2, 2, "Blue");
-
-INSERT INTO tags (tagid, cd, tag) VALUES (3, 3, "Blue");
-
-INSERT INTO tags (tagid, cd, tag) VALUES (4, 5, "Blue");
-
-INSERT INTO tags (tagid, cd, tag) VALUES (5, 2, "Cheesy");
-
-INSERT INTO tags (tagid, cd, tag) VALUES (6, 4, "Cheesy");
-
-INSERT INTO tags (tagid, cd, tag) VALUES (7, 5, "Cheesy");
-
-INSERT INTO tags (tagid, cd, tag) VALUES (8, 2, "Shiny");
-
-INSERT INTO tags (tagid, cd, tag) VALUES (9, 4, "Shiny");
-
-INSERT INTO twokeys (artist, cd) VALUES (1, 1);
-
-INSERT INTO twokeys (artist, cd) VALUES (1, 2);
-
-INSERT INTO twokeys (artist, cd) VALUES (2, 2);
-
-INSERT INTO fourkeys (foo, bar, hello, goodbye) VALUES (1, 2, 3, 4);
-
-INSERT INTO fourkeys (foo, bar, hello, goodbye) VALUES (5, 4, 3, 6);
-
-INSERT INTO onekey (id, artist, cd) VALUES (1, 1, 1);
-
-INSERT INTO onekey (id, artist, cd) VALUES (2, 1, 2);
-
-INSERT INTO onekey (id, artist, cd) VALUES (3, 2, 2);
-EOSQL
-
-$dbh->do($_) for split(/\n\n/, $sql);
-
-package DBICTest::LinerNotes;
-
-use base 'DBICTest';
-
-DBICTest::LinerNotes->table('liner_notes');
-DBICTest::LinerNotes->add_columns(qw/liner_id notes/);
-DBICTest::LinerNotes->set_primary_key('liner_id');
-
-package DBICTest::Tag;
-
-use base 'DBICTest';
-
-DBICTest::Tag->table('tags');
-DBICTest::Tag->add_columns(qw/tagid cd tag/);
-DBICTest::Tag->set_primary_key('tagid');
-DBICTest::Tag->add_relationship(
- cd => 'DBICTest::CD',
- { 'foreign.cdid' => 'self.cd' }
-);
-
-package DBICTest::Track;
-
-use base 'DBICTest';
-
-DBICTest::Track->table('track');
-DBICTest::Track->add_columns(qw/trackid cd position title/);
-DBICTest::Track->set_primary_key('trackid');
-DBICTest::Track->add_relationship(
- cd => 'DBICTest::CD',
- { 'foreign.cdid' => 'self.cd' }
-);
-
-package DBICTest::CD;
-
-use base 'DBICTest';
-
-DBICTest::CD->table('cd');
-DBICTest::CD->add_columns(qw/cdid artist title year/);
-DBICTest::CD->set_primary_key('cdid');
-DBICTest::CD->add_relationship(
- artist => 'DBICTest::Artist',
- { 'foreign.artistid' => 'self.artist' }
-);
-DBICTest::CD->add_relationship(
- tracks => 'DBICTest::Track',
- { 'foreign.cd' => 'self.cdid' }
-);
-DBICTest::CD->add_relationship(
- tags => 'DBICTest::Tag',
- { 'foreign.cd' => 'self.cdid' }
-);
-#DBICTest::CD->might_have(liner_notes => 'DBICTest::LinerNotes' => qw/notes/);
-DBICTest::CD->inflate_column( 'year',
- { inflate => sub { DateTime->new( year => shift ) },
- deflate => sub { shift->year } }
-);
-
-package DBICTest::Artist;
-
-use base 'DBICTest';
-
-DBICTest::Artist->table('artist');
-DBICTest::Artist->add_columns(qw/artistid name/);
-DBICTest::Artist->set_primary_key('artistid');
-DBICTest::Artist->add_relationship(
- cds => 'DBICTest::CD',
- { 'foreign.artist' => 'self.artistid' },
- { order_by => 'year' }
-);
-DBICTest::Artist->add_relationship(
- twokeys => 'DBICTest::TwoKeys',
- { 'foreign.artist' => 'self.artistid' }
-);
-DBICTest::Artist->add_relationship(
- onekeys => 'DBICTest::OneKey',
- { 'foreign.artist' => 'self.artistid' }
-);
-
-package DBICTest::OneKey;
-
-use base 'DBICTest';
-
-DBICTest::OneKey->table('onekey');
-DBICTest::OneKey->add_columns(qw/id artist cd/);
-DBICTest::OneKey->set_primary_key('id');
-
-package DBICTest::TwoKeys;
-
-use base 'DBICTest';
-
-DBICTest::TwoKeys->table('twokeys');
-DBICTest::TwoKeys->add_columns(qw/artist cd/);
-DBICTest::TwoKeys->set_primary_key(qw/artist cd/);
-DBICTest::TwoKeys->add_relationship(
- artist => 'DBICTest::Artist',
- { 'foreign.artistid' => 'self.artist' }
-);
-DBICTest::TwoKeys->add_relationship(
- cd => 'DBICTest::CD',
- { 'foreign.cdid' => 'self.cd' }
-);
-
-package DBICTest::FourKeys;
-
-use base 'DBICTest';
-
-DBICTest::FourKeys->table('fourkeys');
-DBICTest::FourKeys->add_columns(qw/foo bar hello goodbye/);
-DBICTest::FourKeys->set_primary_key(qw/foo bar hello goodbye/);
+sub _database {
+ my $self = shift;
+ my $db_file = $self->_sqlite_dbfilename;
+
+ unlink($db_file) if -e $db_file;
+ unlink($db_file . "-journal") if -e $db_file . "-journal";
+ mkdir("t/var") unless -d "t/var";
+
+ my $dsn = $ENV{"DBICTEST_DSN"} || "dbi:SQLite:${db_file}";
+ my $dbuser = $ENV{"DBICTEST_DBUSER"} || '';
+ my $dbpass = $ENV{"DBICTEST_DBPASS"} || '';
+
+ my @connect_info = ($dsn, $dbuser, $dbpass, { AutoCommit => 1 });
+
+ return @connect_info;
+}
+
+sub init_schema {
+ my $self = shift;
+ my %args = @_;
+
+ my $schema;
+
+ if ($args{compose_connection}) {
+ $schema = DBICTest::Schema->compose_connection(
+ 'DBICTest', $self->_database
+ );
+ } else {
+ $schema = DBICTest::Schema->compose_namespace('DBICTest');
+ }
+ if( $args{storage_type}) {
+ $schema->storage_type($args{storage_type});
+ }
+ if ( !$args{no_connect} ) {
+ $schema = $schema->connect($self->_database);
+ $schema->storage->on_connect_do(['PRAGMA synchronous = OFF']);
+ }
+ if ( !$args{no_deploy} ) {
+ __PACKAGE__->deploy_schema( $schema );
+ __PACKAGE__->populate_schema( $schema ) if( !$args{no_populate} );
+ }
+ return $schema;
+}
+
+=head2 deploy_schema
+
+ DBICTest->deploy_schema( $schema );
+
+This method does one of two things to the schema. It can either call
+the experimental $schema->deploy() if the DBICTEST_SQLT_DEPLOY environment
+variable is set, otherwise the default is to read in the t/lib/sqlite.sql
+file and execute the SQL within. Either way you end up with a fresh set
+of tables for testing.
+
+=cut
+
+sub deploy_schema {
+ my $self = shift;
+ my $schema = shift;
+
+ if ($ENV{"DBICTEST_SQLT_DEPLOY"}) {
+ return $schema->deploy();
+ } else {
+ open IN, "t/lib/sqlite.sql";
+ my $sql;
+ { local $/ = undef; $sql = <IN>; }
+ close IN;
+ ($schema->storage->dbh->do($_) || print "Error on SQL: $_\n") for split(/;\n/, $sql);
+ }
+}
+
+=head2 populate_schema
+
+ DBICTest->populate_schema( $schema );
+
+After you deploy your schema you can use this method to populate
+the tables with test data.
+
+=cut
+
+sub populate_schema {
+ my $self = shift;
+ my $schema = shift;
+
+ $schema->populate('Artist', [
+ [ qw/artistid name/ ],
+ [ 1, 'Caterwauler McCrae' ],
+ [ 2, 'Random Boy Band' ],
+ [ 3, 'We Are Goth' ],
+ ]);
+
+ $schema->populate('CD', [
+ [ qw/cdid artist title year/ ],
+ [ 1, 1, "Spoonful of bees", 1999 ],
+ [ 2, 1, "Forkful of bees", 2001 ],
+ [ 3, 1, "Caterwaulin' Blues", 1997 ],
+ [ 4, 2, "Generic Manufactured Singles", 2001 ],
+ [ 5, 3, "Come Be Depressed With Us", 1998 ],
+ ]);
+
+ $schema->populate('LinerNotes', [
+ [ qw/liner_id notes/ ],
+ [ 2, "Buy Whiskey!" ],
+ [ 4, "Buy Merch!" ],
+ [ 5, "Kill Yourself!" ],
+ ]);
+
+ $schema->populate('Tag', [
+ [ qw/tagid cd tag/ ],
+ [ 1, 1, "Blue" ],
+ [ 2, 2, "Blue" ],
+ [ 3, 3, "Blue" ],
+ [ 4, 5, "Blue" ],
+ [ 5, 2, "Cheesy" ],
+ [ 6, 4, "Cheesy" ],
+ [ 7, 5, "Cheesy" ],
+ [ 8, 2, "Shiny" ],
+ [ 9, 4, "Shiny" ],
+ ]);
+
+ $schema->populate('TwoKeys', [
+ [ qw/artist cd/ ],
+ [ 1, 1 ],
+ [ 1, 2 ],
+ [ 2, 2 ],
+ ]);
+
+ $schema->populate('FourKeys', [
+ [ qw/foo bar hello goodbye sensors/ ],
+ [ 1, 2, 3, 4, 'online' ],
+ [ 5, 4, 3, 6, 'offline' ],
+ ]);
+
+ $schema->populate('OneKey', [
+ [ qw/id artist cd/ ],
+ [ 1, 1, 1 ],
+ [ 2, 1, 2 ],
+ [ 3, 2, 2 ],
+ ]);
+
+ $schema->populate('SelfRef', [
+ [ qw/id name/ ],
+ [ 1, 'First' ],
+ [ 2, 'Second' ],
+ ]);
+
+ $schema->populate('SelfRefAlias', [
+ [ qw/self_ref alias/ ],
+ [ 1, 2 ]
+ ]);
+
+ $schema->populate('ArtistUndirectedMap', [
+ [ qw/id1 id2/ ],
+ [ 1, 2 ]
+ ]);
+
+ $schema->populate('Producer', [
+ [ qw/producerid name/ ],
+ [ 1, 'Matt S Trout' ],
+ [ 2, 'Bob The Builder' ],
+ [ 3, 'Fred The Phenotype' ],
+ ]);
+
+ $schema->populate('CD_to_Producer', [
+ [ qw/cd producer/ ],
+ [ 1, 1 ],
+ [ 1, 2 ],
+ [ 1, 3 ],
+ ]);
+
+ $schema->populate('TreeLike', [
+ [ qw/id parent name/ ],
+ [ 1, 0, 'foo' ],
+ [ 2, 1, 'bar' ],
+ [ 5, 1, 'blop' ],
+ [ 3, 2, 'baz' ],
+ [ 4, 3, 'quux' ],
+ [ 6, 2, 'fong' ],
+ ]);
+
+ $schema->populate('Track', [
+ [ qw/trackid cd position title/ ],
+ [ 4, 2, 1, "Stung with Success"],
+ [ 5, 2, 2, "Stripy"],
+ [ 6, 2, 3, "Sticky Honey"],
+ [ 7, 3, 1, "Yowlin"],
+ [ 8, 3, 2, "Howlin"],
+ [ 9, 3, 3, "Fowlin"],
+ [ 10, 4, 1, "Boring Name"],
+ [ 11, 4, 2, "Boring Song"],
+ [ 12, 4, 3, "No More Ideas"],
+ [ 13, 5, 1, "Sad"],
+ [ 14, 5, 2, "Under The Weather"],
+ [ 15, 5, 3, "Suicidal"],
+ [ 16, 1, 1, "The Bees Knees"],
+ [ 17, 1, 2, "Apiary"],
+ [ 18, 1, 3, "Beehind You"],
+ ]);
+
+ $schema->populate('Event', [
+ [ qw/id starts_at created_on/ ],
+ [ 1, '2006-04-25 22:24:33', '2006-06-22 21:00:05'],
+ ]);
+
+ $schema->populate('Link', [
+ [ qw/id url title/ ],
+ [ 1, '', 'aaa' ]
+ ]);
+
+ $schema->populate('Bookmark', [
+ [ qw/id link/ ],
+ [ 1, 1 ]
+ ]);
+
+ $schema->populate('Collection', [
+ [ qw/collectionid name/ ],
+ [ 1, "Tools" ],
+ [ 2, "Body Parts" ],
+ ]);
+
+ $schema->populate('CollectionObject', [
+ [ qw/collection object/ ],
+ [ 1, 1 ],
+ [ 1, 2 ],
+ [ 1, 3 ],
+ [ 2, 4 ],
+ [ 2, 5 ],
+ ]);
+
+ $schema->populate('TypedObject', [
+ [ qw/objectid type value/ ],
+ [ 1, "pointy", "Awl" ],
+ [ 2, "round", "Bearing" ],
+ [ 3, "pointy", "Knife" ],
+ [ 4, "pointy", "Tooth" ],
+ [ 5, "round", "Head" ],
+ ]);
+
+ $schema->populate('Owners', [
+ [ qw/ownerid name/ ],
+ [ 1, "Newton" ],
+ [ 2, "Waltham" ],
+ ]);
+
+ $schema->populate('BooksInLibrary', [
+ [ qw/id owner title source/ ],
+ [ 1, 1, "Programming Perl", "Library" ],
+ [ 2, 1, "Dynamical Systems", "Library" ],
+ [ 3, 2, "Best Recipe Cookbook", "Library" ],
+ ]);
+}
1;
projects / dbsrgits/DBIx-Class.git / blobdiff