use_namespaces upgrade is fully tested, need to implement downgrade
[dbsrgits/DBIx-Class-Schema-Loader.git] / t / 25backcompat_v4.t
index 14491b8..e431f33 100644 (file)
@@ -1,10 +1,12 @@
 use strict;
 use warnings;
 use Test::More;
+use Test::Exception;
 use File::Path qw/rmtree make_path/;
 use Class::Unload;
 use File::Temp qw/tempfile tempdir/;
 use IO::File;
+use DBIx::Class::Schema::Loader ();
 use lib qw(t/lib);
 use make_dbictest_db2;
 
@@ -61,9 +63,24 @@ my $SCHEMA_CLASS = 'DBIXCSL_Test::Schema';
     my $external_result_dir = join '/', $temp_dir, split /::/, $SCHEMA_CLASS;
     make_path $external_result_dir;
 
+    # make external content for Result that will be singularized
     IO::File->new(">$external_result_dir/Quuxs.pm")->print(<<"EOF");
 package ${SCHEMA_CLASS}::Quuxs;
 sub a_method { 'hlagh' }
+
+__PACKAGE__->has_one('bazrel', 'DBIXCSL_Test::Schema::Bazs',
+    { 'foreign.baz_num' => 'self.baz_id' });
+
+1;
+EOF
+
+    # make external content for Result that will NOT be singularized
+    IO::File->new(">$external_result_dir/Bar.pm")->print(<<"EOF");
+package ${SCHEMA_CLASS}::Bar;
+
+__PACKAGE__->has_one('foorel', 'DBIXCSL_Test::Schema::Foos',
+    { 'foreign.fooid' => 'self.foo_id' });
+
 1;
 EOF
 
@@ -78,31 +95,152 @@ EOF
     like $warning, qr/Detected external content/i,
         'detected external content warning';
 
-    is eval { $schema->resultset('Quux')->find(1)->a_method }, 'hlagh',
+    lives_and { is $schema->resultset('Quux')->find(1)->a_method, 'hlagh' }
 'external custom content for unsingularized Result was loaded by upgraded ' .
 'dynamic Schema';
 
+    lives_and { isa_ok $schema->resultset('Quux')->find(1)->bazrel,
+        $res->{classes}{bazs} }
+        'unsingularized class names in external content are translated';
+
+    lives_and { isa_ok $schema->resultset('Bar')->find(1)->foorel,
+        $res->{classes}{foos} }
+'unsingularized class names in external content from unchanged Result class ' .
+'names are translated';
+
     run_v5_tests($res);
 
     rmtree $temp_dir;
     pop @INC;
 }
 
-# test running against v4 schema without upgrade
+# test upgraded dynamic schema with use_namespaces with external content loaded
 {
-    # write out the 0.04006 Schema.pm we have in __DATA__
-    (my $schema_dir = "$DUMP_DIR/$SCHEMA_CLASS") =~ s/::[^:]+\z//;
-    make_path $schema_dir;
-    my $schema_pm = "$schema_dir/Schema.pm";
-    open my $fh, '>', $schema_pm or die $!;
-    while (<DATA>) {
-        print $fh $_;
-    }
-    close $fh;
+    my $temp_dir = tempdir;
+    push @INC, $temp_dir;
+
+    my $external_result_dir = join '/', $temp_dir, split /::/, $SCHEMA_CLASS;
+    make_path $external_result_dir;
+
+    # make external content for Result that will be singularized
+    IO::File->new(">$external_result_dir/Quuxs.pm")->print(<<"EOF");
+package ${SCHEMA_CLASS}::Quuxs;
+sub a_method { 'hlagh' }
+
+__PACKAGE__->has_one('bazrel', 'DBIXCSL_Test::Schema::Bazs',
+    { 'foreign.baz_num' => 'self.baz_id' });
+
+1;
+EOF
+
+    # make external content for Result that will NOT be singularized
+    IO::File->new(">$external_result_dir/Bar.pm")->print(<<"EOF");
+package ${SCHEMA_CLASS}::Bar;
+
+__PACKAGE__->has_one('foorel', 'DBIXCSL_Test::Schema::Foos',
+    { 'foreign.fooid' => 'self.foo_id' });
+
+1;
+EOF
+
+    my $res = run_loader(naming => 'current', use_namespaces => 1);
+    my $schema = $res->{schema};
+
+    is scalar @{ $res->{warnings} }, 2,
+'correct nummber of warnings for upgraded dynamic schema with external ' .
+'content for unsingularized Result with use_namespaces.';
 
-    # now run the loader
-    my $res = run_loader(dump_directory => $DUMP_DIR);
     my $warning = $res->{warnings}[0];
+    like $warning, qr/Detected external content/i,
+        'detected external content warning';
+
+    lives_and { is $schema->resultset('Quux')->find(1)->a_method, 'hlagh' }
+'external custom content for unsingularized Result was loaded by upgraded ' .
+'dynamic Schema';
+
+    lives_and { isa_ok $schema->resultset('Quux')->find(1)->bazrel,
+        $res->{classes}{bazs} }
+        'unsingularized class names in external content are translated';
+
+    lives_and { isa_ok $schema->resultset('Bar')->find(1)->foorel,
+        $res->{classes}{foos} }
+'unsingularized class names in external content from unchanged Result class ' .
+'names are translated';
+
+    run_v5_tests($res);
+
+    rmtree $temp_dir;
+    pop @INC;
+}
+
+
+# test upgraded static schema with external content loaded
+{
+    my $temp_dir = tempdir;
+    push @INC, $temp_dir;
+
+    my $external_result_dir = join '/', $temp_dir, split /::/, $SCHEMA_CLASS;
+    make_path $external_result_dir;
+
+    # make external content for Result that will be singularized
+    IO::File->new(">$external_result_dir/Quuxs.pm")->print(<<"EOF");
+package ${SCHEMA_CLASS}::Quuxs;
+sub a_method { 'dongs' }
+
+__PACKAGE__->has_one('bazrel2', 'DBIXCSL_Test::Schema::Bazs',
+    { 'foreign.baz_num' => 'self.baz_id' });
+
+1;
+EOF
+
+    # make external content for Result that will NOT be singularized
+    IO::File->new(">$external_result_dir/Bar.pm")->print(<<"EOF");
+package ${SCHEMA_CLASS}::Bar;
+
+__PACKAGE__->has_one('foorel2', 'DBIXCSL_Test::Schema::Foos',
+    { 'foreign.fooid' => 'self.foo_id' });
+
+1;
+EOF
+
+    write_v4_schema_pm();
+
+    my $res = run_loader(dump_directory => $DUMP_DIR, naming => 'current');
+    my $schema = $res->{schema};
+
+    run_v5_tests($res);
+
+    lives_and { is $schema->resultset('Quux')->find(1)->a_method, 'dongs' }
+'external custom content for unsingularized Result was loaded by upgraded ' .
+'static Schema';
+
+    lives_and { isa_ok $schema->resultset('Quux')->find(1)->bazrel2,
+        $res->{classes}{bazs} }
+        'unsingularized class names in external content are translated';
+
+    lives_and { isa_ok $schema->resultset('Bar')->find(1)->foorel2,
+        $res->{classes}{foos} }
+'unsingularized class names in external content from unchanged Result class ' .
+'names are translated in static schema';
+
+    my $file = $schema->_loader->_get_dump_filename($res->{classes}{quuxs});
+    my $code = do { local ($/, @ARGV) = (undef, $file); <> };
+
+    like $code, qr/package ${SCHEMA_CLASS}::Quux;/,
+'package line translated correctly from external custom content in static dump';
+
+    like $code, qr/sub a_method { 'dongs' }/,
+'external custom content loaded into static dump correctly';
+
+    rmtree $temp_dir;
+    pop @INC;
+}
+
+# test running against v4 schema without upgrade, twice, then upgrade
+{
+    write_v4_schema_pm();
+    my $res = run_loader(dump_directory => $DUMP_DIR);
+    my $warning = $res->{warnings}[1];
 
     like $warning, qr/static schema/i,
         'static schema in backcompat mode detected';
@@ -111,7 +249,7 @@ EOF
     like $warning, qr/DBIx::Class::Schema::Loader::Manual::UpgradingFromV4/,
         'refers to upgrading doc';
 
-    is scalar @{ $res->{warnings} }, 3,
+    is scalar @{ $res->{warnings} }, 4,
         'correct number of warnings for static schema in backcompat mode';
 
     run_v4_tests($res);
@@ -125,7 +263,12 @@ EOF
         while (<>) {
             if (/DO NOT MODIFY THIS OR ANYTHING ABOVE/) {
                 print;
-                print "sub a_method { 'mtfnpy' }\n";
+                print <<EOF;
+sub a_method { 'mtfnpy' }
+
+__PACKAGE__->has_one('bazrel3', 'DBIXCSL_Test::Schema::Bazs',
+    { 'foreign.baz_num' => 'self.baz_id' });
+EOF
             }
             else {
                 print;
@@ -133,8 +276,17 @@ EOF
         }
     }
 
+    # Rerun the loader in backcompat mode to make sure it's still in backcompat
+    # mode.
+    $res = run_loader(dump_directory => $DUMP_DIR);
+    run_v4_tests($res);
+
     # now upgrade the schema
-    $res = run_loader(dump_directory => $DUMP_DIR, naming => 'current');
+    $res = run_loader(
+        dump_directory => $DUMP_DIR,
+        naming => 'current',
+        use_namespaces => 1
+    );
     $schema = $res->{schema};
 
     like $res->{warnings}[0], qr/Dumping manual schema/i,
@@ -149,6 +301,93 @@ EOF
 
     run_v5_tests($res);
 
+    (my $result_dir = "$DUMP_DIR/$SCHEMA_CLASS/Result") =~ s{::}{/}g;
+    my $result_count =()= glob "$result_dir/*";
+
+    is $result_count, 4,
+        'un-singularized results were replaced during upgrade';
+
+    # check that custom content was preserved
+    lives_and { is $schema->resultset('Quux')->find(1)->a_method, 'mtfnpy' }
+        'custom content was carried over from un-singularized Result';
+
+    lives_and { isa_ok $schema->resultset('Quux')->find(1)->bazrel3,
+        $res->{classes}{bazs} }
+        'unsingularized class names in custom content are translated';
+
+    my $file = $schema->_loader->_get_dump_filename($res->{classes}{quuxs});
+    my $code = do { local ($/, @ARGV) = (undef, $file); <> };
+
+    like $code, qr/sub a_method { 'mtfnpy' }/,
+'custom content from unsingularized Result loaded into static dump correctly';
+}
+
+# test running against v4 schema without upgrade, then upgrade with
+# use_namespaces not explicitly set
+{
+    write_v4_schema_pm();
+    my $res = run_loader(dump_directory => $DUMP_DIR);
+    my $warning = $res->{warnings}[1];
+
+    like $warning, qr/static schema/i,
+        'static schema in backcompat mode detected';
+    like $warning, qr/0.04006/,
+        'correct version detected';
+    like $warning, qr/DBIx::Class::Schema::Loader::Manual::UpgradingFromV4/,
+        'refers to upgrading doc';
+
+    is scalar @{ $res->{warnings} }, 4,
+        'correct number of warnings for static schema in backcompat mode';
+
+    run_v4_tests($res);
+
+    # add some custom content to a Result that will be replaced
+    my $schema   = $res->{schema};
+    my $quuxs_pm = $schema->_loader
+        ->_get_dump_filename($res->{classes}{quuxs});
+    {
+        local ($^I, @ARGV) = ('', $quuxs_pm);
+        while (<>) {
+            if (/DO NOT MODIFY THIS OR ANYTHING ABOVE/) {
+                print;
+                print <<EOF;
+sub a_method { 'mtfnpy' }
+
+__PACKAGE__->has_one('bazrel3', 'DBIXCSL_Test::Schema::Bazs',
+    { 'foreign.baz_num' => 'self.baz_id' });
+EOF
+            }
+            else {
+                print;
+            }
+        }
+    }
+
+    # now upgrade the schema
+    $res = run_loader(
+        dump_directory => $DUMP_DIR,
+        naming => 'current'
+    );
+    $schema = $res->{schema};
+
+    like $res->{warnings}[0], qr/load_classes/i,
+'correct warnings on upgrading static schema (with "naming" set and ' .
+'use_namespaces not set)';
+
+    like $res->{warnings}[1], qr/Dumping manual schema/i,
+'correct warnings on upgrading static schema (with "naming" set and ' .
+'use_namespaces not set)';
+
+    like $res->{warnings}[2], qr/dump completed/i,
+'correct warnings on upgrading static schema (with "naming" set and ' .
+'use_namespaces not set)';
+
+    is scalar @{ $res->{warnings} }, 3,
+'correct number of warnings on upgrading static schema (with "naming" set)'
+        or diag @{ $res->{warnings} };
+
+    run_v5_tests($res);
+
     (my $result_dir = "$DUMP_DIR/$SCHEMA_CLASS") =~ s{::}{/}g;
     my $result_count =()= glob "$result_dir/*";
 
@@ -156,8 +395,86 @@ EOF
         'un-singularized results were replaced during upgrade';
 
     # check that custom content was preserved
-    is eval { $schema->resultset('Quux')->find(1)->a_method }, 'mtfnpy',
+    lives_and { is $schema->resultset('Quux')->find(1)->a_method, 'mtfnpy' }
         'custom content was carried over from un-singularized Result';
+
+    lives_and { isa_ok $schema->resultset('Quux')->find(1)->bazrel3,
+        $res->{classes}{bazs} }
+        'unsingularized class names in custom content are translated';
+
+    my $file = $schema->_loader->_get_dump_filename($res->{classes}{quuxs});
+    my $code = do { local ($/, @ARGV) = (undef, $file); <> };
+
+    like $code, qr/sub a_method { 'mtfnpy' }/,
+'custom content from unsingularized Result loaded into static dump correctly';
+}
+
+# test upgrading a v4 schema, the check that the version string is correct
+{
+    write_v4_schema_pm();
+    run_loader(dump_directory => $DUMP_DIR);
+    my $res = run_loader(dump_directory => $DUMP_DIR, naming => 'current');
+    my $schema = $res->{schema};
+
+    my $file = $schema->_loader->_get_dump_filename($SCHEMA_CLASS);
+    my $code = do { local ($/, @ARGV) = (undef, $file); <> };
+
+    my ($dumped_ver) =
+        $code =~ /^# Created by DBIx::Class::Schema::Loader v(\S+)/m;
+
+    is $dumped_ver, $DBIx::Class::Schema::Loader::VERSION,
+        'correct version dumped after upgrade of v4 static schema';
+}
+
+# Test upgrading an already singular result with custom content that refers to
+# old class names.
+{
+    write_v4_schema_pm();
+    my $res = run_loader(dump_directory => $DUMP_DIR);
+    my $schema   = $res->{schema};
+    run_v4_tests($res);
+
+    # add some custom content to a Result that will be replaced
+    my $bar_pm = $schema->_loader
+        ->_get_dump_filename($res->{classes}{bar});
+    {
+        local ($^I, @ARGV) = ('', $bar_pm);
+        while (<>) {
+            if (/DO NOT MODIFY THIS OR ANYTHING ABOVE/) {
+                print;
+                print <<EOF;
+sub a_method { 'lalala' }
+
+__PACKAGE__->has_one('foorel3', 'DBIXCSL_Test::Schema::Foos',
+    { 'foreign.fooid' => 'self.foo_id' });
+EOF
+            }
+            else {
+                print;
+            }
+        }
+    }
+
+    # now upgrade the schema
+    $res = run_loader(dump_directory => $DUMP_DIR, naming => 'current');
+    $schema = $res->{schema};
+    run_v5_tests($res);
+
+    # check that custom content was preserved
+    lives_and { is $schema->resultset('Bar')->find(1)->a_method, 'lalala' }
+        'custom content was preserved from Result pre-upgrade';
+
+    lives_and { isa_ok $schema->resultset('Bar')->find(1)->foorel3,
+        $res->{classes}{foos} }
+'unsingularized class names in custom content from Result with unchanged ' .
+'name are translated';
+
+    my $file = $schema->_loader->_get_dump_filename($res->{classes}{bar});
+    my $code = do { local ($/, @ARGV) = (undef, $file); <> };
+
+    like $code, qr/sub a_method { 'lalala' }/,
+'custom content from Result with unchanged name loaded into static dump ' .
+'correctly';
 }
 
 done_testing;
@@ -196,7 +513,7 @@ sub run_loader {
     foreach my $source_name ($schema->sources) {
         my $table_name = $schema->source($source_name)->from;
         $monikers{$table_name} = $source_name;
-        $classes{$table_name}  = "${SCHEMA_CLASS}::${source_name}";
+        $classes{$table_name}  = $schema->source($source_name)->result_class;
     }
 
     return {
@@ -207,6 +524,32 @@ sub run_loader {
     };
 }
 
+sub write_v4_schema_pm {
+    (my $schema_dir = "$DUMP_DIR/$SCHEMA_CLASS") =~ s/::[^:]+\z//;
+    rmtree $schema_dir;
+    make_path $schema_dir;
+    my $schema_pm = "$schema_dir/Schema.pm";
+    open my $fh, '>', $schema_pm or die $!;
+    print $fh <<'EOF';
+package DBIXCSL_Test::Schema;
+
+use strict;
+use warnings;
+
+use base 'DBIx::Class::Schema';
+
+__PACKAGE__->load_classes;
+
+
+# Created by DBIx::Class::Schema::Loader v0.04006 @ 2009-12-25 01:49:25
+# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:ibIJTbfM1ji4pyD/lgSEog
+
+
+# You can replace this text with custom content, and it will be preserved on regeneration
+1;
+EOF
+}
+
 sub run_v4_tests {
     my $res = shift;
     my $schema = $res->{schema};
@@ -246,24 +589,3 @@ sub run_v5_tests {
     isa_ok eval { $baz->quux }, $res->{classes}{quuxs},
         'correct rel type and name for UNIQUE FK in current mode';
 }
-
-# a Schema.pm made with 0.04006
-
-__DATA__
-package DBIXCSL_Test::Schema;
-
-use strict;
-use warnings;
-
-use base 'DBIx::Class::Schema';
-
-__PACKAGE__->load_classes;
-
-
-# Created by DBIx::Class::Schema::Loader v0.04006 @ 2009-12-25 01:49:25
-# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:ibIJTbfM1ji4pyD/lgSEog
-
-
-# You can replace this text with custom content, and it will be preserved on regeneration
-1;
-