[dbsrgits/DBIx-Class-Schema-Loader.git] / t / 23dumpmore.t

use strict;
use Test::More;
use lib qw(t/lib);
use File::Path;
use IPC::Open3;
use make_dbictest_db;
require DBIx::Class::Schema::Loader;

$^O eq 'MSWin32' && plan(skip_all =>
"ActiveState perl produces additional warnings, and this test uses unix paths"
);

my $DUMP_PATH = './t/_dump';

sub dump_directly {
    my %tdata = @_;

    my $schema_class = $tdata{classname};

    no strict 'refs';
    @{$schema_class . '::ISA'} = ('DBIx::Class::Schema::Loader');
    $schema_class->loader_options(%{$tdata{options}});

    my @warns;
    eval {
        local $SIG{__WARN__} = sub { push(@warns, @_) };
        $schema_class->connect($make_dbictest_db::dsn);
    };
    my $err = $@;
    $schema_class->storage->disconnect if !$err && $schema_class->storage;
    undef *{$schema_class};

    is($err, $tdata{error});

    return @warns;
}

sub dump_dbicdump {
    my %tdata = @_;

    # use $^X so we execute ./script/dbicdump with the same perl binary that the tests were executed with
    my @cmd = ($^X, qw(./script/dbicdump));

    while (my ($opt, $val) = each(%{ $tdata{options} })) {
        push @cmd, '-o', "$opt=$val";
    }

    push @cmd, $tdata{classname}, $make_dbictest_db::dsn;

    # make sure our current @INC gets used by dbicdump
    local $ENV{PERL5LIB} = join ":", @INC, $ENV{PERL5LIB};

    my ($in, $out, $err);
    my $pid = open3($in, $out, $err, @cmd);

    my @warns = <$out>;
    waitpid($pid, 0);

    return @warns;
}

sub do_dump_test {
    my %tdata = @_;
    
    $tdata{options}{dump_directory} = $DUMP_PATH;
    $tdata{options}{use_namespaces} ||= 0;

    for my $dumper (\&dump_directly, \&dump_dbicdump) {
        test_dumps(\%tdata, $dumper->(%tdata));
    }
}

sub test_dumps {
    my ($tdata, @warns) = @_;

    my %tdata = %{$tdata};

    my $schema_class = $tdata{classname};
    my $check_warns = $tdata{warnings};
    is(@warns, @$check_warns, "$schema_class warning count");
    for(my $i = 0; $i <= $#$check_warns; $i++) {
        like($warns[$i], $check_warns->[$i], "$schema_class warning $i");
    }

    my $file_regexes = $tdata{regexes};
    my $file_neg_regexes = $tdata{neg_regexes} || {};
    my $schema_regexes = delete $file_regexes->{schema};
    
    my $schema_path = $DUMP_PATH . '/' . $schema_class;
    $schema_path =~ s{::}{/}g;
    dump_file_like($schema_path . '.pm', @$schema_regexes);
    foreach my $src (keys %$file_regexes) {
        my $src_file = $schema_path . '/' . $src . '.pm';
        dump_file_like($src_file, @{$file_regexes->{$src}});
    }
    foreach my $src (keys %$file_neg_regexes) {
        my $src_file = $schema_path . '/' . $src . '.pm';
        dump_file_not_like($src_file, @{$file_neg_regexes->{$src}});
    }
}

sub dump_file_like {
    my $path = shift;
    open(my $dumpfh, '<', $path) or die "Failed to open '$path': $!";
    my $contents = do { local $/; <$dumpfh>; };
    close($dumpfh);
    my $num = 1;
    like($contents, $_, "like $path " . $num++) for @_;
}

sub dump_file_not_like {
    my $path = shift;
    open(my $dumpfh, '<', $path) or die "Failed to open '$path': $!";
    my $contents = do { local $/; <$dumpfh>; };
    close($dumpfh);
    my $num = 1;
    unlike($contents, $_, "unlike $path ". $num++) for @_;
}

sub append_to_class {
    my ($class, $string) = @_;
    $class =~ s{::}{/}g;
    $class = $DUMP_PATH . '/' . $class . '.pm';
    open(my $appendfh, '>>', $class) or die "Failed to open '$class' for append: $!";
    print $appendfh $string;
    close($appendfh);
}

rmtree($DUMP_PATH, 1, 1);

do_dump_test(
    classname => 'DBICTest::DumpMore::1',
    options => { },
    error => '',
    warnings => [
        qr/Dumping manual schema for DBICTest::DumpMore::1 to directory /,
        qr/Schema dump completed/,
    ],
    regexes => {
        schema => [
            qr/package DBICTest::DumpMore::1;/,
            qr/->load_classes/,
        ],
        Foo => [
            qr/package DBICTest::DumpMore::1::Foo;/,
            qr/=head1 NAME/,
            qr/=head1 ACCESSORS/,
            qr/->set_primary_key/,
            qr/1;\n$/,
        ],
        Bar => [
            qr/package DBICTest::DumpMore::1::Bar;/,
            qr/=head1 NAME/,
            qr/=head1 ACCESSORS/,
            qr/->set_primary_key/,
            qr/1;\n$/,
        ],
    },
);

append_to_class('DBICTest::DumpMore::1::Foo',q{# XXX This is my custom content XXX});

do_dump_test(
    classname => 'DBICTest::DumpMore::1',
    options => { },
    error => '',
    warnings => [
        qr/Dumping manual schema for DBICTest::DumpMore::1 to directory /,
        qr/Schema dump completed/,
    ],
    regexes => {
        schema => [
            qr/package DBICTest::DumpMore::1;/,
            qr/->load_classes/,
        ],
        Foo => [
            qr/package DBICTest::DumpMore::1::Foo;/,
            qr/->set_primary_key/,
            qr/1;\n# XXX This is my custom content XXX/,
        ],
        Bar => [
            qr/package DBICTest::DumpMore::1::Bar;/,
            qr/->set_primary_key/,
            qr/1;\n$/,
        ],
    },
);

do_dump_test(
    classname => 'DBICTest::DumpMore::1',
    options => { really_erase_my_files => 1 },
    error => '',
    warnings => [
        qr/Dumping manual schema for DBICTest::DumpMore::1 to directory /,
        qr/Deleting existing file /,
        qr/Deleting existing file /,
        qr/Deleting existing file /,
        qr/Schema dump completed/,
    ],
    regexes => {
        schema => [
            qr/package DBICTest::DumpMore::1;/,
            qr/->load_classes/,
        ],
        Foo => [
            qr/package DBICTest::DumpMore::1::Foo;/,
            qr/->set_primary_key/,
            qr/1;\n$/,
        ],
        Bar => [
            qr/package DBICTest::DumpMore::1::Bar;/,
            qr/->set_primary_key/,
            qr/1;\n$/,
        ],
    },
    neg_regexes => {
        Foo => [
            qr/# XXX This is my custom content XXX/,
        ],
    },
);

do_dump_test(
    classname => 'DBICTest::DumpMore::1',
    options => { use_namespaces => 1 },
    error => '',
    warnings => [
        qr/Dumping manual schema for DBICTest::DumpMore::1 to directory /,
        qr/Schema dump completed/,
    ],
    regexes => {
        schema => [
            qr/package DBICTest::DumpMore::1;/,
            qr/->load_namespaces/,
        ],
        'Result/Foo' => [
            qr/package DBICTest::DumpMore::1::Result::Foo;/,
            qr/->set_primary_key/,
            qr/1;\n$/,
        ],
        'Result/Bar' => [
            qr/package DBICTest::DumpMore::1::Result::Bar;/,
            qr/->set_primary_key/,
            qr/1;\n$/,
        ],
    },
);

do_dump_test(
    classname => 'DBICTest::DumpMore::1',
    options => { use_namespaces => 1,
                 result_namespace => 'Res',
                 resultset_namespace => 'RSet',
                 default_resultset_class => 'RSetBase',
             },
    error => '',
    warnings => [
        qr/Dumping manual schema for DBICTest::DumpMore::1 to directory /,
        qr/Schema dump completed/,
    ],
    regexes => {
        schema => [
            qr/package DBICTest::DumpMore::1;/,
            qr/->load_namespaces/,
            qr/result_namespace => 'Res'/,
            qr/resultset_namespace => 'RSet'/,
            qr/default_resultset_class => 'RSetBase'/,
        ],
        'Res/Foo' => [
            qr/package DBICTest::DumpMore::1::Res::Foo;/,
            qr/->set_primary_key/,
            qr/1;\n$/,
        ],
        'Res/Bar' => [
            qr/package DBICTest::DumpMore::1::Res::Bar;/,
            qr/->set_primary_key/,
            qr/1;\n$/,
        ],
    },
);

do_dump_test(
    classname => 'DBICTest::DumpMore::1',
    options => { use_namespaces => 1,
                 result_namespace => '+DBICTest::DumpMore::1::Res',
                 resultset_namespace => 'RSet',
                 default_resultset_class => 'RSetBase',
                 result_base_class => 'My::ResultBaseClass',
                 schema_base_class => 'My::SchemaBaseClass',
             },
    error => '',
    warnings => [
        qr/Dumping manual schema for DBICTest::DumpMore::1 to directory /,
        qr/Schema dump completed/,
    ],
    regexes => {
        schema => [
            qr/package DBICTest::DumpMore::1;/,
            qr/->load_namespaces/,
            qr/result_namespace => '\+DBICTest::DumpMore::1::Res'/,
            qr/resultset_namespace => 'RSet'/,
            qr/default_resultset_class => 'RSetBase'/,
            qr/use base 'My::SchemaBaseClass'/,
        ],
        'Res/Foo' => [
            qr/package DBICTest::DumpMore::1::Res::Foo;/,
            qr/use base 'My::ResultBaseClass'/,
            qr/->set_primary_key/,
            qr/1;\n$/,
        ],
        'Res/Bar' => [
            qr/package DBICTest::DumpMore::1::Res::Bar;/,
            qr/use base 'My::ResultBaseClass'/,
            qr/->set_primary_key/,
            qr/1;\n$/,
        ],
    },
);

done_testing;

END { rmtree($DUMP_PATH, 1, 1); }
Commit	Line	Data
605fcea8	1	use strict;
	2	use Test::More;
	3	use lib qw(t/lib);
	4	use File::Path;
ff746964	5	use IPC::Open3;
605fcea8	6	use make_dbictest_db;
	7	require DBIx::Class::Schema::Loader;
	8
d27f2b7b	9	$^O eq 'MSWin32' && plan(skip_all =>
	10	"ActiveState perl produces additional warnings, and this test uses unix paths"
	11	);
605fcea8	12
a4187fdf	13	my $DUMP_PATH = './t/_dump';
605fcea8	14
ff746964	15	sub dump_directly {
a4187fdf	16	my %tdata = @_;
605fcea8	17
a4187fdf	18	my $schema_class = $tdata{classname};
605fcea8	19
	20	no strict 'refs';
	21	@{$schema_class . '::ISA'} = ('DBIx::Class::Schema::Loader');
ff746964	22	$schema_class->loader_options(%{$tdata{options}});
605fcea8	23
a4187fdf	24	my @warns;
605fcea8	25	eval {
a4187fdf	26	local $SIG{__WARN__} = sub { push(@warns, @_) };
605fcea8	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};
a4187fdf	32
	33	is($err, $tdata{error});
	34
ff746964	35	return @warns;
	36	}
	37
	38	sub dump_dbicdump {
	39	my %tdata = @_;
	40
17ca645f	41	# use $^X so we execute ./script/dbicdump with the same perl binary that the tests were executed with
17ca645f	42	my @cmd = ($^X, qw(./script/dbicdump));
ff746964	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
17ca645f	50	# make sure our current @INC gets used by dbicdump
	51	local $ENV{PERL5LIB} = join ":", @INC, $ENV{PERL5LIB};
	52
ff746964	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;
f22644d7	66	$tdata{options}{use_namespaces} \|\|= 0;
ff746964	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};
a4187fdf	79	my $check_warns = $tdata{warnings};
ff746964	80	is(@warns, @$check_warns, "$schema_class warning count");
a4187fdf	81	for(my $i = 0; $i <= $#$check_warns; $i++) {
ff746964	82	like($warns[$i], $check_warns->[$i], "$schema_class warning $i");
a4187fdf	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	}
605fcea8	100	}
605fcea8	101
a4187fdf	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);
ff746964	107	my $num = 1;
ff746964	108	like($contents, $_, "like $path " . $num++) for @_;
a4187fdf	109	}
605fcea8	110
a4187fdf	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);
ff746964	116	my $num = 1;
ff746964	117	unlike($contents, $_, "unlike $path ". $num++) for @_;
605fcea8	118	}
605fcea8	119
a4187fdf	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;/,
fbcfebdd	146	qr/=head1 NAME/,
fbcfebdd	147	qr/=head1 ACCESSORS/,
a4187fdf	148	qr/->set_primary_key/,
	149	qr/1;\n$/,
	150	],
	151	Bar => [
	152	qr/package DBICTest::DumpMore::1::Bar;/,
fbcfebdd	153	qr/=head1 NAME/,
fbcfebdd	154	qr/=head1 ACCESSORS/,
a4187fdf	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	);
605fcea8	188
a4187fdf	189	do_dump_test(
a4187fdf	190	classname => 'DBICTest::DumpMore::1',
28b4691d	191	options => { really_erase_my_files => 1 },
a4187fdf	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	);
605fcea8	222
f44ecc2f	223	do_dump_test(
	224	classname => 'DBICTest::DumpMore::1',
	225	options => { use_namespaces => 1 },
	226	error => '',
	227	warnings => [
	228	qr/Dumping manual schema for DBICTest::DumpMore::1 to directory /,
	229	qr/Schema dump completed/,
	230	],
	231	regexes => {
	232	schema => [
	233	qr/package DBICTest::DumpMore::1;/,
	234	qr/->load_namespaces/,
	235	],
	236	'Result/Foo' => [
	237	qr/package DBICTest::DumpMore::1::Result::Foo;/,
	238	qr/->set_primary_key/,
	239	qr/1;\n$/,
	240	],
	241	'Result/Bar' => [
	242	qr/package DBICTest::DumpMore::1::Result::Bar;/,
	243	qr/->set_primary_key/,
	244	qr/1;\n$/,
	245	],
	246	},
	247	);
	248
	249	do_dump_test(
	250	classname => 'DBICTest::DumpMore::1',
	251	options => { use_namespaces => 1,
	252	result_namespace => 'Res',
	253	resultset_namespace => 'RSet',
	254	default_resultset_class => 'RSetBase',
	255	},
	256	error => '',
	257	warnings => [
	258	qr/Dumping manual schema for DBICTest::DumpMore::1 to directory /,
	259	qr/Schema dump completed/,
	260	],
	261	regexes => {
	262	schema => [
	263	qr/package DBICTest::DumpMore::1;/,
	264	qr/->load_namespaces/,
	265	qr/result_namespace => 'Res'/,
	266	qr/resultset_namespace => 'RSet'/,
	267	qr/default_resultset_class => 'RSetBase'/,
	268	],
	269	'Res/Foo' => [
	270	qr/package DBICTest::DumpMore::1::Res::Foo;/,
	271	qr/->set_primary_key/,
	272	qr/1;\n$/,
	273	],
	274	'Res/Bar' => [
	275	qr/package DBICTest::DumpMore::1::Res::Bar;/,
	276	qr/->set_primary_key/,
	277	qr/1;\n$/,
	278	],
	279	},
	280	);
	281
	282	do_dump_test(
	283	classname => 'DBICTest::DumpMore::1',
	284	options => { use_namespaces => 1,
	285	result_namespace => '+DBICTest::DumpMore::1::Res',
	286	resultset_namespace => 'RSet',
287	default_resultset_class => 'RSetBase',
9c9c2f2b	288	result_base_class => 'My::ResultBaseClass',
9c9c2f2b	289	schema_base_class => 'My::SchemaBaseClass',
f44ecc2f	290	},
	291	error => '',
	292	warnings => [
	293	qr/Dumping manual schema for DBICTest::DumpMore::1 to directory /,
	294	qr/Schema dump completed/,
	295	],
	296	regexes => {
	297	schema => [
	298	qr/package DBICTest::DumpMore::1;/,
	299	qr/->load_namespaces/,
	300	qr/result_namespace => '\+DBICTest::DumpMore::1::Res'/,
	301	qr/resultset_namespace => 'RSet'/,
	302	qr/default_resultset_class => 'RSetBase'/,
9c9c2f2b	303	qr/use base 'My::SchemaBaseClass'/,
f44ecc2f	304	],
	305	'Res/Foo' => [
	306	qr/package DBICTest::DumpMore::1::Res::Foo;/,
9c9c2f2b	307	qr/use base 'My::ResultBaseClass'/,
f44ecc2f	308	qr/->set_primary_key/,
	309	qr/1;\n$/,
	310	],
	311	'Res/Bar' => [
	312	qr/package DBICTest::DumpMore::1::Res::Bar;/,
9c9c2f2b	313	qr/use base 'My::ResultBaseClass'/,
f44ecc2f	314	qr/->set_primary_key/,
	315	qr/1;\n$/,
	316	],
	317	},
	318	);
	319
d27f2b7b	320	done_testing;
d27f2b7b	321
a4187fdf	322	END { rmtree($DUMP_PATH, 1, 1); }