X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits%2FDBIx-Class.git;a=blobdiff_plain;f=t%2Flib%2FDBICTest.pm;h=50bd6635a471143de5a0f1ae8ae8133d59749848;hp=8203e60c296c99984185f59469829c0ea5b712ef;hb=a258bfc74fbfe145ee5e4d98f74f52b3f8a7174e;hpb=510ca9120ab2fea50a0852ee4ed6a13735ed7ebc

diff --git a/t/lib/DBICTest.pm b/t/lib/DBICTest.pm
old mode 100755
new mode 100644
index 8203e60..50bd663
--- a/t/lib/DBICTest.pm
+++ b/t/lib/DBICTest.pm
@@ -1,169 +1,410 @@
-package DBICTest;
+package # hide from PAUSE 
+    DBICTest;
 
 use strict;
 use warnings;
-use base qw/DBIx::Class::Core/;
+use DBICTest::AuthorCheck;
+use DBICTest::Schema;
+use Carp;
 
-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";
-
-__PACKAGE__->connection("dbi:SQLite:${db_file}");
-
-my $dbh = __PACKAGE__->_get_dbh;
-
-my $sql = <<EOSQL;
-CREATE TABLE artist (artistid INTEGER NOT NULL PRIMARY KEY, name VARCHAR);
-
-CREATE TABLE cd (cdid INTEGER NOT NULL PRIMARY KEY, artist INTEGER NOT NULL,
-                     title VARCHAR, year VARCHAR);
-
-CREATE TABLE liner_notes (liner_id INTEGER NOT NULL PRIMARY KEY, notes VARCHAR);
-
-CREATE TABLE track (trackid INTEGER NOT NULL PRIMARY KEY, cd INTEGER NOT NULL,
-                       position INTEGER NOT NULL, title VARCHAR);
-
-CREATE TABLE tags (tagid INTEGER NOT NULL PRIMARY KEY, cd INTEGER NOT NULL,
-                      tag VARCHAR);
-
-CREATE TABLE twokeys (artist INTEGER NOT NULL, cd INTEGER NOT NULL,
-                      PRIMARY KEY (artist, cd) );
-
-CREATE TABLE onekey (id INTEGER NOT NULL PRIMARY KEY,
-                      artist INTEGER NOT NULL, cd INTEGER NOT NULL );
-
-INSERT INTO artist (artistid, name) VALUES (1, 'Caterwauler McCrae');
-
-INSERT INTO artist (artistid, name) VALUES (2, 'Random Boy Band');
-
-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 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->has_a(cd => 'SweetTest::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->has_a(cd => 'SweetTest::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('trackid');
-
-#DBICTest::CD->has_many(tracks => 'SweetTest::Track');
-#DBICTest::CD->has_many(tags => 'SweetTest::Tag');
-#DBICTest::CD->has_a(artist => 'SweetTest::Artist');
-
-#DBICTest::CD->might_have(liner_notes => 'SweetTest::LinerNotes' => qw/notes/);
-
-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->has_many(cds => 'SweetTest::CD');
-#DBICTest::Artist->has_many(twokeys => 'SweetTest::TwoKeys');
-#DBICTest::Artist->has_many(onekeys => 'SweetTest::OneKey');
-
-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->has_a(artist => 'SweetTest::Artist');
-#DBICTest::TwoKeys->has_a(cd => 'SweetTest::CD');
-
-package DBICTest::OneKey;
-
-use base 'DBICTest';
-
-DBICTest::OneKey->table('onekey');
-DBICTest::OneKey->add_columns(qw/id artist cd/);
-DBICTest::TwoKeys->set_primary_key('id');
+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,
+    storage_type=>'::DBI::Replicated',
+    storage_type_args=>{
+      balancer_type=>'DBIx::Class::Storage::DBI::Replicated::Balancer::Random'
+    },
+  );
+
+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 has_custom_dsn {
+    return $ENV{"DBICTEST_DSN"} ? 1:0;
+}
+
+sub _sqlite_dbfilename {
+    return "t/var/DBIxClass.db";
+}
+
+sub _sqlite_dbname {
+    my $self = shift;
+    my %args = @_;
+    return $self->_sqlite_dbfilename if $args{sqlite_use_file} or $ENV{"DBICTEST_SQLITE_USE_FILE"};
+    return ":memory:";
+}
+
+sub _database {
+    my $self = shift;
+    my %args = @_;
+
+    if ($ENV{DBICTEST_DSN}) {
+      return (
+        (map { $ENV{"DBICTEST_${_}"} || '' } qw/DSN DBUSER DBPASS/),
+        { AutoCommit => 1, %args },
+      );
+    }
+    my $db_file = $self->_sqlite_dbname(%args);
+
+    for ($db_file, "${db_file}-journal") {
+      next unless -e $_;
+      unlink ($_) or carp (
+        "Unable to unlink existing test database file $_ ($!), creation of fresh database / further tests may fail!\n"
+      );
+    }
+
+    mkdir("t/var") unless -d "t/var";
+
+    return ("dbi:SQLite:${db_file}", '', '', {
+      AutoCommit => 1,
+
+      # this is executed on every connect, and thus installs a disconnect/DESTROY
+      # guard for every new $dbh
+      on_connect_do => sub {
+        my $storage = shift;
+        my $dbh = $storage->_get_dbh;
+
+        # no fsync on commit
+        $dbh->do ('PRAGMA synchronous = OFF');
+
+        # set a *DBI* disconnect callback, to make sure the physical SQLite
+        # file is still there (i.e. the test does not attempt to delete
+        # an open database, which fails on Win32)
+        if (-e $db_file and my $orig_inode = (stat($db_file))[1] ) {
+
+          my $failed_once;
+          my $connected = 1;
+          my $cb = sub {
+            return if $failed_once;
+
+            my $event = shift;
+            if ($event eq 'connect') {
+              # this is necessary in case we are disconnected and connected again, all within the same $dbh object
+              $connected = 1;
+              return;
+            }
+            elsif ($event eq 'disconnect') {
+              $connected = 0;
+            }
+            elsif ($event eq 'DESTROY' and ! $connected ) {
+              return;
+            }
+
+            my $fail_reason;
+            if (! -e $db_file) {
+              $fail_reason = 'is missing';
+            }
+            else {
+              my $cur_inode = (stat($db_file))[1];
+
+              $fail_reason ||= sprintf 'was recreated (inode %s vs %s)', ($orig_inode, $cur_inode)
+                if $orig_inode != $cur_inode;
+            }
+
+            if ($fail_reason) {
+              $failed_once++;
+
+              require Test::Builder;
+              my $t = Test::Builder->new;
+              local $Test::Builder::Level = $Test::Builder::Level + 1;
+
+              $t->ok (0,
+                  "$db_file $fail_reason before $event of DBI handle - a strong indicator that "
+                . 'the SQLite file was tampered with while still being open. This action would '
+                . 'fail massively if running under Win32, hence DBICTest makes sure it fails '
+                . 'on any OS :)'
+              );
+            }
+
+            return; # this empty return is a DBI requirement
+          };
+          $dbh->{Callbacks} = {
+            connect => sub { $cb->('connect') },
+            disconnect => sub { $cb->('disconnect') },
+            DESTROY => sub { $cb->('DESTROY') },
+          };
+        }
+      },
+      %args,
+    });
+}
+
+sub init_schema {
+    my $self = shift;
+    my %args = @_;
+
+    my $schema;
+
+    if ($args{compose_connection}) {
+      $schema = DBICTest::Schema->compose_connection(
+                  'DBICTest', $self->_database(%args)
+                );
+    } 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(%args));
+    }
+
+    if ( !$args{no_deploy} ) {
+        __PACKAGE__->deploy_schema( $schema, $args{deploy_args} );
+        __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;
+    my $args = shift || {};
+
+    if ($ENV{"DBICTEST_SQLT_DEPLOY"}) { 
+        $schema->deploy($args);
+    } else {
+        open IN, "t/lib/sqlite.sql";
+        my $sql;
+        { local $/ = undef; $sql = <IN>; }
+        close IN;
+        for my $chunk ( split (/;\s*\n+/, $sql) ) {
+          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
+            $schema->storage->dbh_do(sub { $_[1]->do($chunk) }) or print "Error on SQL: $chunk\n";
+          }
+        }
+    }
+    return;
+}
+
+=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('Genre', [
+      [qw/genreid name/],
+      [qw/1       emo  /],
+    ]);
+
+    $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 genreid/ ],
+        [ 1, 1, "Spoonful of bees", 1999, 1 ],
+        [ 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, undef, 'root' ],
+        [ 2, 1, 'foo'  ],
+        [ 3, 2, 'bar'  ],
+        [ 6, 2, 'blop' ],
+        [ 4, 3, 'baz'  ],
+        [ 5, 4, 'quux' ],
+        [ 7, 3, '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 varchar_date varchar_datetime skip_inflation/ ],
+        [ 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'],
+    ]);
+
+    $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('TypedObject', [
+        [ qw/objectid type value/ ],
+        [ 1, "pointy", "Awl" ],
+        [ 2, "round", "Bearing" ],
+        [ 3, "pointy", "Knife" ],
+        [ 4, "pointy", "Tooth" ],
+        [ 5, "round", "Head" ],
+    ]);
+    $schema->populate('CollectionObject', [
+        [ qw/collection object/ ],
+        [ 1, 1 ],
+        [ 1, 2 ],
+        [ 1, 3 ],
+        [ 2, 4 ],
+        [ 2, 5 ],
+    ]);
+
+    $schema->populate('Owners', [
+        [ qw/id name/ ],
+        [ 1, "Newton" ],
+        [ 2, "Waltham" ],
+    ]);
+
+    $schema->populate('BooksInLibrary', [
+        [ qw/id owner title source price/ ],
+        [ 1, 1, "Programming Perl", "Library", 23 ],
+        [ 2, 1, "Dynamical Systems", "Library",  37 ],
+        [ 3, 2, "Best Recipe Cookbook", "Library", 65 ],
+    ]);
+}
 
 1;