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