The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

package # hide from PAUSE
DBICTest;
use strict;
=head1 NAME
DBICTest - Library to be used by DBIx::Class test scripts.
=head1 SYNOPSIS
use lib qw(t/lib);
use DBICTest;
use Test::More;
my $schema = DBICTest->init_schema();
=head1 DESCRIPTION
This module provides the basic utilities to write tests against
DBIx::Class.
=head1 METHODS
=head2 init_schema
my $schema = DBICTest->init_schema(
no_deploy=>1,
no_populate=>1,
);
This method removes the test SQLite database in t/var/DBIxClass.db
and then creates a new, empty database.
This method will call deploy_schema() by default, unless the
no_deploy flag is set.
Also, by default, this method will call populate_schema() by
default, unless the no_deploy or no_populate flags are set.
=cut
sub init_schema {
my $self = shift;
my %args = @_;
my $db_file = "t/var/DBIxClass.db";
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 $schema = DBICTest::Schema->compose_connection('DBICTest' => $dsn, $dbuser, $dbpass);
$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($_) 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' ],
[ 3, 2, 'baz' ],
[ 4, 3, 'quux' ],
]);
$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 title/ ],
[ 1, 'aaa' ]
]);
$schema->populate('Bookmark', [
[ qw/id link/ ],
[ 1, 1 ]
]);
}
1;