[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;

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
    use Config;
    local $ENV{PERL5LIB} = join $Config{path_sep}, @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, generate_pod => 0 },
    error => '',
    warnings => [
        qr/Dumping manual schema for DBICTest::DumpMore::1 to directory /,
        qr/Schema dump completed/,
    ],
    neg_regexes => {
        'Result/Foo' => [
            qr/^=/m,
        ],
    },
);

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
a4187fdf	9	my $DUMP_PATH = './t/_dump';
605fcea8	10
ff746964	11	sub dump_directly {
a4187fdf	12	my %tdata = @_;
605fcea8	13
a4187fdf	14	my $schema_class = $tdata{classname};
605fcea8	15
	16	no strict 'refs';
	17	@{$schema_class . '::ISA'} = ('DBIx::Class::Schema::Loader');
ff746964	18	$schema_class->loader_options(%{$tdata{options}});
605fcea8	19
a4187fdf	20	my @warns;
605fcea8	21	eval {
a4187fdf	22	local $SIG{__WARN__} = sub { push(@warns, @_) };
605fcea8	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};
a4187fdf	28
	29	is($err, $tdata{error});
	30
ff746964	31	return @warns;
	32	}
	33
	34	sub dump_dbicdump {
	35	my %tdata = @_;
	36
17ca645f	37	# use $^X so we execute ./script/dbicdump with the same perl binary that the tests were executed with
17ca645f	38	my @cmd = ($^X, qw(./script/dbicdump));
ff746964	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
17ca645f	46	# make sure our current @INC gets used by dbicdump
f1059ad4	47	use Config;
f1059ad4	48	local $ENV{PERL5LIB} = join $Config{path_sep}, @INC, $ENV{PERL5LIB};
17ca645f	49
ff746964	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;
f22644d7	63	$tdata{options}{use_namespaces} \|\|= 0;
ff746964	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};
a4187fdf	76	my $check_warns = $tdata{warnings};
ff746964	77	is(@warns, @$check_warns, "$schema_class warning count");
a4187fdf	78	for(my $i = 0; $i <= $#$check_warns; $i++) {
ff746964	79	like($warns[$i], $check_warns->[$i], "$schema_class warning $i");
a4187fdf	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	}
605fcea8	97	}
605fcea8	98
a4187fdf	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);
ff746964	104	my $num = 1;
ff746964	105	like($contents, $_, "like $path " . $num++) for @_;
a4187fdf	106	}
605fcea8	107
a4187fdf	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);
ff746964	113	my $num = 1;
ff746964	114	unlike($contents, $_, "unlike $path ". $num++) for @_;
605fcea8	115	}
605fcea8	116
a4187fdf	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;/,
fbcfebdd	143	qr/=head1 NAME/,
fbcfebdd	144	qr/=head1 ACCESSORS/,
a4187fdf	145	qr/->set_primary_key/,
	146	qr/1;\n$/,
	147	],
	148	Bar => [
	149	qr/package DBICTest::DumpMore::1::Bar;/,
fbcfebdd	150	qr/=head1 NAME/,
fbcfebdd	151	qr/=head1 ACCESSORS/,
a4187fdf	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	);
605fcea8	185
a4187fdf	186	do_dump_test(
a4187fdf	187	classname => 'DBICTest::DumpMore::1',
28b4691d	188	options => { really_erase_my_files => 1 },
a4187fdf	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	],
492dce8d	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	],
a4187fdf	232	},
a4187fdf	233	);
605fcea8	234
f44ecc2f	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',
9c9c2f2b	300	result_base_class => 'My::ResultBaseClass',
9c9c2f2b	301	schema_base_class => 'My::SchemaBaseClass',
f44ecc2f	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'/,
9c9c2f2b	315	qr/use base 'My::SchemaBaseClass'/,
f44ecc2f	316	],
	317	'Res/Foo' => [
	318	qr/package DBICTest::DumpMore::1::Res::Foo;/,
9c9c2f2b	319	qr/use base 'My::ResultBaseClass'/,
f44ecc2f	320	qr/->set_primary_key/,
	321	qr/1;\n$/,
	322	],
	323	'Res/Bar' => [
	324	qr/package DBICTest::DumpMore::1::Res::Bar;/,
9c9c2f2b	325	qr/use base 'My::ResultBaseClass'/,
f44ecc2f	326	qr/->set_primary_key/,
	327	qr/1;\n$/,
	328	],
	329	},
	330	);
	331
d27f2b7b	332	done_testing;
d27f2b7b	333
a4187fdf	334	END { rmtree($DUMP_PATH, 1, 1); }