t/23dumpmore.t

   1 use strict;
   2 use Test::More;
   3 use lib qw(t/lib);
   4 use File::Path;
   5 use IPC::Open3;
   6 use make_dbictest_db;
   7 require DBIx::Class::Schema::Loader;
   8
   9 $^O eq 'MSWin32' && plan(skip_all =>
  10 "ActiveState perl produces additional warnings, and this test uses unix paths"
  11 );
  12
  13 my $DUMP_PATH = './t/_dump';
  14
  15 sub dump_directly {
  16     my %tdata = @_;
  17
  18     my $schema_class = $tdata{classname};
  19
  20     no strict 'refs';
  21     @{$schema_class . '::ISA'} = ('DBIx::Class::Schema::Loader');
  22     $schema_class->loader_options(%{$tdata{options}});
  23
  24     my @warns;
  25     eval {
  26         local $SIG{__WARN__} = sub { push(@warns, @_) };
  27         $schema_class->connect($make_dbictest_db::dsn);
  28     };
  29     my $err = $@;
  30     $schema_class->storage->disconnect if !$err && $schema_class->storage;
  31     undef *{$schema_class};
  32
  33     is($err, $tdata{error});
  34
  35     return @warns;
  36 }
  37
  38 sub dump_dbicdump {
  39     my %tdata = @_;
  40
  41     # use $^X so we execute ./script/dbicdump with the same perl binary that the tests were executed with
  42     my @cmd = ($^X, qw(./script/dbicdump));
  43
  44     while (my ($opt, $val) = each(%{ $tdata{options} })) {
  45         push @cmd, '-o', "$opt=$val";
  46     }
  47
  48     push @cmd, $tdata{classname}, $make_dbictest_db::dsn;
  49
  50     # make sure our current @INC gets used by dbicdump
  51     local $ENV{PERL5LIB} = join ":", @INC, $ENV{PERL5LIB};
  52
  53     my ($in, $out, $err);
  54     my $pid = open3($in, $out, $err, @cmd);
  55
  56     my @warns = <$out>;
  57     waitpid($pid, 0);
  58
  59     return @warns;
  60 }
  61
  62 sub do_dump_test {
  63     my %tdata = @_;
  64
  65     $tdata{options}{dump_directory} = $DUMP_PATH;
  66     $tdata{options}{use_namespaces} ||= 0;
  67
  68     for my $dumper (\&dump_directly, \&dump_dbicdump) {
  69         test_dumps(\%tdata, $dumper->(%tdata));
  70     }
  71 }
  72
  73 sub test_dumps {
  74     my ($tdata, @warns) = @_;
  75
  76     my %tdata = %{$tdata};
  77
  78     my $schema_class = $tdata{classname};
  79     my $check_warns = $tdata{warnings};
  80     is(@warns, @$check_warns, "$schema_class warning count");
  81     for(my $i = 0; $i <= $#$check_warns; $i++) {
  82         like($warns[$i], $check_warns->[$i], "$schema_class warning $i");
  83     }
  84
  85     my $file_regexes = $tdata{regexes};
  86     my $file_neg_regexes = $tdata{neg_regexes} || {};
  87     my $schema_regexes = delete $file_regexes->{schema};
  88
  89     my $schema_path = $DUMP_PATH . '/' . $schema_class;
  90     $schema_path =~ s{::}{/}g;
  91     dump_file_like($schema_path . '.pm', @$schema_regexes);
  92     foreach my $src (keys %$file_regexes) {
  93         my $src_file = $schema_path . '/' . $src . '.pm';
  94         dump_file_like($src_file, @{$file_regexes->{$src}});
  95     }
  96     foreach my $src (keys %$file_neg_regexes) {
  97         my $src_file = $schema_path . '/' . $src . '.pm';
  98         dump_file_not_like($src_file, @{$file_neg_regexes->{$src}});
  99     }
 100 }
 101
 102 sub dump_file_like {
 103     my $path = shift;
 104     open(my $dumpfh, '<', $path) or die "Failed to open '$path': $!";
 105     my $contents = do { local $/; <$dumpfh>; };
 106     close($dumpfh);
 107     my $num = 1;
 108     like($contents, $_, "like $path " . $num++) for @_;
 109 }
 110
 111 sub dump_file_not_like {
 112     my $path = shift;
 113     open(my $dumpfh, '<', $path) or die "Failed to open '$path': $!";
 114     my $contents = do { local $/; <$dumpfh>; };
 115     close($dumpfh);
 116     my $num = 1;
 117     unlike($contents, $_, "unlike $path ". $num++) for @_;
 118 }
 119
 120 sub append_to_class {
 121     my ($class, $string) = @_;
 122     $class =~ s{::}{/}g;
 123     $class = $DUMP_PATH . '/' . $class . '.pm';
 124     open(my $appendfh, '>>', $class) or die "Failed to open '$class' for append: $!";
 125     print $appendfh $string;
 126     close($appendfh);
 127 }
 128
 129 rmtree($DUMP_PATH, 1, 1);
 130
 131 do_dump_test(
 132     classname => 'DBICTest::DumpMore::1',
 133     options => { },
 134     error => '',
 135     warnings => [
 136         qr/Dumping manual schema for DBICTest::DumpMore::1 to directory /,
 137         qr/Schema dump completed/,
 138     ],
 139     regexes => {
 140         schema => [
 141             qr/package DBICTest::DumpMore::1;/,
 142             qr/->load_classes/,
 143         ],
 144         Foo => [
 145             qr/package DBICTest::DumpMore::1::Foo;/,
 146             qr/=head1 NAME/,
 147             qr/=head1 ACCESSORS/,
 148             qr/->set_primary_key/,
 149             qr/1;\n$/,
 150         ],
 151         Bar => [
 152             qr/package DBICTest::DumpMore::1::Bar;/,
 153             qr/=head1 NAME/,
 154             qr/=head1 ACCESSORS/,
 155             qr/->set_primary_key/,
 156             qr/1;\n$/,
 157         ],
 158     },
 159 );
 160
 161 append_to_class('DBICTest::DumpMore::1::Foo',q{# XXX This is my custom content XXX});
 162
 163 do_dump_test(
 164     classname => 'DBICTest::DumpMore::1',
 165     options => { },
 166     error => '',
 167     warnings => [
 168         qr/Dumping manual schema for DBICTest::DumpMore::1 to directory /,
 169         qr/Schema dump completed/,
 170     ],
 171     regexes => {
 172         schema => [
 173             qr/package DBICTest::DumpMore::1;/,
 174             qr/->load_classes/,
 175         ],
 176         Foo => [
 177             qr/package DBICTest::DumpMore::1::Foo;/,
 178             qr/->set_primary_key/,
 179             qr/1;\n# XXX This is my custom content XXX/,
 180         ],
 181         Bar => [
 182             qr/package DBICTest::DumpMore::1::Bar;/,
 183             qr/->set_primary_key/,
 184             qr/1;\n$/,
 185         ],
 186     },
 187 );
 188
 189 do_dump_test(
 190     classname => 'DBICTest::DumpMore::1',
 191     options => { really_erase_my_files => 1 },
 192     error => '',
 193     warnings => [
 194         qr/Dumping manual schema for DBICTest::DumpMore::1 to directory /,
 195         qr/Deleting existing file /,
 196         qr/Deleting existing file /,
 197         qr/Deleting existing file /,
 198         qr/Schema dump completed/,
 199     ],
 200     regexes => {
 201         schema => [
 202             qr/package DBICTest::DumpMore::1;/,
 203             qr/->load_classes/,
 204         ],
 205         Foo => [
 206             qr/package DBICTest::DumpMore::1::Foo;/,
 207             qr/->set_primary_key/,
 208             qr/1;\n$/,
 209         ],
 210         Bar => [
 211             qr/package DBICTest::DumpMore::1::Bar;/,
 212             qr/->set_primary_key/,
 213             qr/1;\n$/,
 214         ],
 215     },
 216     neg_regexes => {
 217         Foo => [
 218             qr/# XXX This is my custom content XXX/,
 219         ],
 220     },
 221 );
 222
 223 do_dump_test(
 224     classname => 'DBICTest::DumpMore::1',
 225     options => { use_namespaces => 1, generate_pod => 0 },
 226     error => '',
 227     warnings => [
 228         qr/Dumping manual schema for DBICTest::DumpMore::1 to directory /,
 229         qr/Schema dump completed/,
 230     ],
 231     neg_regexes => {
 232         'Result/Foo' => [
 233             qr/^=/m,
 234         ],
 235     },
 236 );
 237
 238 do_dump_test(
 239     classname => 'DBICTest::DumpMore::1',
 240     options => { use_namespaces => 1 },
 241     error => '',
 242     warnings => [
 243         qr/Dumping manual schema for DBICTest::DumpMore::1 to directory /,
 244         qr/Schema dump completed/,
 245     ],
 246     regexes => {
 247         schema => [
 248             qr/package DBICTest::DumpMore::1;/,
 249             qr/->load_namespaces/,
 250         ],
 251         'Result/Foo' => [
 252             qr/package DBICTest::DumpMore::1::Result::Foo;/,
 253             qr/->set_primary_key/,
 254             qr/1;\n$/,
 255         ],
 256         'Result/Bar' => [
 257             qr/package DBICTest::DumpMore::1::Result::Bar;/,
 258             qr/->set_primary_key/,
 259             qr/1;\n$/,
 260         ],
 261     },
 262 );
 263
 264 do_dump_test(
 265     classname => 'DBICTest::DumpMore::1',
 266     options => { use_namespaces => 1,
 267                  result_namespace => 'Res',
 268                  resultset_namespace => 'RSet',
 269                  default_resultset_class => 'RSetBase',
 270              },
 271     error => '',
 272     warnings => [
 273         qr/Dumping manual schema for DBICTest::DumpMore::1 to directory /,
 274         qr/Schema dump completed/,
 275     ],
 276     regexes => {
 277         schema => [
 278             qr/package DBICTest::DumpMore::1;/,
 279             qr/->load_namespaces/,
 280             qr/result_namespace => 'Res'/,
 281             qr/resultset_namespace => 'RSet'/,
 282             qr/default_resultset_class => 'RSetBase'/,
 283         ],
 284         'Res/Foo' => [
 285             qr/package DBICTest::DumpMore::1::Res::Foo;/,
 286             qr/->set_primary_key/,
 287             qr/1;\n$/,
 288         ],
 289         'Res/Bar' => [
 290             qr/package DBICTest::DumpMore::1::Res::Bar;/,
 291             qr/->set_primary_key/,
 292             qr/1;\n$/,
 293         ],
 294     },
 295 );
 296
 297 do_dump_test(
 298     classname => 'DBICTest::DumpMore::1',
 299     options => { use_namespaces => 1,
 300                  result_namespace => '+DBICTest::DumpMore::1::Res',
 301                  resultset_namespace => 'RSet',
 302                  default_resultset_class => 'RSetBase',
 303                  result_base_class => 'My::ResultBaseClass',
 304                  schema_base_class => 'My::SchemaBaseClass',
 305              },
 306     error => '',
 307     warnings => [
 308         qr/Dumping manual schema for DBICTest::DumpMore::1 to directory /,
 309         qr/Schema dump completed/,
 310     ],
 311     regexes => {
 312         schema => [
 313             qr/package DBICTest::DumpMore::1;/,
 314             qr/->load_namespaces/,
 315             qr/result_namespace => '\+DBICTest::DumpMore::1::Res'/,
 316             qr/resultset_namespace => 'RSet'/,
 317             qr/default_resultset_class => 'RSetBase'/,
 318             qr/use base 'My::SchemaBaseClass'/,
 319         ],
 320         'Res/Foo' => [
 321             qr/package DBICTest::DumpMore::1::Res::Foo;/,
 322             qr/use base 'My::ResultBaseClass'/,
 323             qr/->set_primary_key/,
 324             qr/1;\n$/,
 325         ],
 326         'Res/Bar' => [
 327             qr/package DBICTest::DumpMore::1::Res::Bar;/,
 328             qr/use base 'My::ResultBaseClass'/,
 329             qr/->set_primary_key/,
 330             qr/1;\n$/,
 331         ],
 332     },
 333 );
 334
 335 done_testing;
 336
 337 END { rmtree($DUMP_PATH, 1, 1); }