use strict;
use warnings;
-use base qw/Test::Builder::Module Exporter/;
-use Data::Dumper;
+use base qw(Test::Builder::Module Exporter);
use Test::Builder;
+use Test::Deep ();
use SQL::Abstract::Tree;
-our @EXPORT_OK = qw/&is_same_sql_bind &is_same_sql &is_same_bind
- &eq_sql_bind &eq_sql &eq_bind
- $case_sensitive $sql_differ/;
+our @EXPORT_OK = qw(
+ is_same_sql_bind is_same_sql is_same_bind
+ eq_sql_bind eq_sql eq_bind dumper diag_where
+ $case_sensitive $sql_differ
+);
my $sqlat = SQL::Abstract::Tree->new;
our $case_sensitive = 0;
our $parenthesis_significant = 0;
+our $order_by_asc_significant = 0;
+
our $sql_differ; # keeps track of differing portion between SQLs
our $tb = __PACKAGE__->builder;
+sub _unpack_arrayrefref {
+
+ my @args;
+ for (1,2) {
+ my $chunk = shift @_;
+
+ if ( ref $chunk eq 'REF' and ref $$chunk eq 'ARRAY' ) {
+ my ($sql, @bind) = @$$chunk;
+ push @args, ($sql, \@bind);
+ }
+ else {
+ push @args, $chunk, shift @_;
+ }
+
+ }
+
+ # maybe $msg and ... stuff
+ push @args, @_;
+
+ @args;
+}
+
sub is_same_sql_bind {
- my ($sql1, $bind_ref1, $sql2, $bind_ref2, $msg) = @_;
+ my ($sql1, $bind_ref1, $sql2, $bind_ref2, $msg) = &_unpack_arrayrefref;
# compare
my $same_sql = eq_sql($sql1, $sql2);
my ($sql1, $sql2, $msg) = @_;
# compare
- my $same_sql = eq_sql($sql1, $sql2);
+ my $same_sql = eq_sql($sql1, $sql2);
# call Test::Builder::ok
my $ret = $tb->ok($same_sql, $msg);
return $ret;
}
-sub _sql_differ_diag {
- my ($sql1, $sql2) = @_;
+sub dumper {
+ # FIXME
+ # if we save the instance, we will end up with $VARx references
+ # no time to figure out how to avoid this (Deepcopy is *not* an option)
+ require Data::Dumper;
+ Data::Dumper->new([])->Terse(1)->Indent(1)->Useqq(1)->Deparse(1)->Quotekeys(0)->Sortkeys(1)->Maxdepth(0)
+ ->Values([@_])->Dump;
+}
+
+sub diag_where{
+ $tb->diag( "Search term:\n" . &dumper );
+}
- $tb->diag("SQL expressions differ\n"
- ." got: $sql1\n"
- ."expected: $sql2\n"
- ."differing in :\n$sql_differ\n"
- );
+sub _sql_differ_diag {
+ my $sql1 = shift || '';
+ my $sql2 = shift || '';
+
+ $tb->${\( $tb->in_todo ? 'note' : 'diag')} (
+ "SQL expressions differ\n"
+ ." got: $sql1\n"
+ ."want: $sql2\n"
+ ."\nmismatch around\n$sql_differ\n"
+ );
}
sub _bind_differ_diag {
my ($bind_ref1, $bind_ref2) = @_;
- $tb->diag("BIND values differ\n"
- ." got: " . Dumper($bind_ref1)
- ."expected: " . Dumper($bind_ref2)
- );
+ $tb->${\( $tb->in_todo ? 'note' : 'diag')} (
+ "BIND values differ " . dumper({ got => $bind_ref1, want => $bind_ref2 })
+ );
}
sub eq_sql_bind {
- my ($sql1, $bind_ref1, $sql2, $bind_ref2) = @_;
+ my ($sql1, $bind_ref1, $sql2, $bind_ref2) = &_unpack_arrayrefref;
return eq_sql($sql1, $sql2) && eq_bind($bind_ref1, $bind_ref2);
}
-sub eq_bind {
- my ($bind_ref1, $bind_ref2) = @_;
-
- local $Data::Dumper::Useqq = 1;
- local $Data::Dumper::Sortkeys = 1;
-
- return Dumper($bind_ref1) eq Dumper($bind_ref2);
-}
+sub eq_bind { goto &Test::Deep::eq_deeply };
sub eq_sql {
my ($sql1, $sql2) = @_;
$sqlat->_parenthesis_unroll($_) for $left, $right;
}
+ # unroll ASC order by's
+ unless ($order_by_asc_significant) {
+ $sqlat->_strip_asc_from_order_by($_) for $left, $right;
+ }
+
if ( $left->[0] ne $right->[0] ) {
$sql_differ = sprintf "OP [$left->[0]] != [$right->[0]] in\nleft: %s\nright: %s\n",
$sqlat->unparse($left),
A lot of effort goes into distinguishing significant from
non-significant parenthesis, including AND/OR operator associativity.
Currently this module does not support commutativity and more
-intelligent transformations like Morgan laws, etc.
+intelligent transformations like L<De Morgan's laws
+|http://en.wikipedia.org/wiki/De_Morgan's_laws>, etc.
-For a good overview of what this test framework is capable of refer
+For a good overview of what this test framework is currently capable of refer
to C<t/10test.t>
=head1 FUNCTIONS
=head2 is_same_sql_bind
- is_same_sql_bind($given_sql, \@given_bind,
- $expected_sql, \@expected_bind, $test_msg);
-
-Compares given and expected pairs of C<($sql, \@bind)>, and calls
-L<Test::Builder/ok> on the result, with C<$test_msg> as message. If the test
-fails, a detailed diagnostic is printed. For clients which use L<Test::More>,
-this is the one of the three functions (L</is_same_sql_bind>, L</is_same_sql>,
-L</is_same_bind>) that needs to be imported.
+ is_same_sql_bind(
+ $given_sql, \@given_bind,
+ $expected_sql, \@expected_bind,
+ $test_msg
+ );
+
+ is_same_sql_bind(
+ \[$given_sql, @given_bind],
+ \[$expected_sql, @expected_bind],
+ $test_msg
+ );
+
+ is_same_sql_bind(
+ $dbic_rs->as_query
+ $expected_sql, \@expected_bind,
+ $test_msg
+ );
+
+Compares given and expected pairs of C<($sql, \@bind)> by unpacking C<@_>
+as shown in the examples above and passing the arguments to L</eq_sql> and
+L</eq_bind>. Calls L<Test::Builder/ok> with the combined result, with
+C<$test_msg> as message.
+If the test fails, a detailed diagnostic is printed.
=head2 is_same_sql
- is_same_sql($given_sql, $expected_sql, $test_msg);
+ is_same_sql(
+ $given_sql,
+ $expected_sql,
+ $test_msg
+ );
-Compares given and expected SQL statements, and calls L<Test::Builder/ok> on
-the result, with C<$test_msg> as message. If the test fails, a detailed
-diagnostic is printed. For clients which use L<Test::More>, this is the one of
-the three functions (L</is_same_sql_bind>, L</is_same_sql>, L</is_same_bind>)
-that needs to be imported.
+Compares given and expected SQL statements via L</eq_sql>, and calls
+L<Test::Builder/ok> on the result, with C<$test_msg> as message.
+If the test fails, a detailed diagnostic is printed.
=head2 is_same_bind
- is_same_bind(\@given_bind, \@expected_bind, $test_msg);
+ is_same_bind(
+ \@given_bind,
+ \@expected_bind,
+ $test_msg
+ );
-Compares given and expected bind values, and calls L<Test::Builder/ok> on the
-result, with C<$test_msg> as message. If the test fails, a detailed diagnostic
-is printed. For clients which use L<Test::More>, this is the one of the three
-functions (L</is_same_sql_bind>, L</is_same_sql>, L</is_same_bind>) that needs
-to be imported.
+Compares given and expected bind values via L</eq_bind>, and calls
+L<Test::Builder/ok> on the result, with C<$test_msg> as message.
+If the test fails, a detailed diagnostic is printed.
=head2 eq_sql_bind
- my $is_same = eq_sql_bind($given_sql, \@given_bind,
- $expected_sql, \@expected_bind);
+ my $is_same = eq_sql_bind(
+ $given_sql, \@given_bind,
+ $expected_sql, \@expected_bind,
+ );
-Compares given and expected pairs of C<($sql, \@bind)>. Similar to
-L</is_same_sql_bind>, but it just returns a boolean value and does not print
-diagnostics or talk to L<Test::Builder>.
+ my $is_same = eq_sql_bind(
+ \[$given_sql, @given_bind],
+ \[$expected_sql, @expected_bind],
+ );
+
+ my $is_same = eq_sql_bind(
+ $dbic_rs->as_query
+ $expected_sql, \@expected_bind,
+ );
+
+Unpacks C<@_> depending on the given arguments and calls L</eq_sql> and
+L</eq_bind>, returning their combined result.
=head2 eq_sql
parenthesis. Useful while testing C<IN (( x ))> vs C<IN ( x )>.
Defaults to false;
+=head2 $order_by_asc_significant
+
+If true SQL comparison will consider C<ORDER BY foo ASC> and
+C<ORDER BY foo> to be different. Default is false;
+
=head2 $sql_differ
When L</eq_sql> returns false, the global variable
C<$sql_differ> contains the SQL portion
where a difference was encountered.
-
=head1 SEE ALSO
L<SQL::Abstract>, L<Test::More>, L<Test::Builder>.
=head1 AUTHORS
-Laurent Dami, E<lt>laurent.dami AT etat geneve chE<gt>
+Laurent Dami <laurent.dami AT etat geneve ch>
Norbert Buchmuller <norbi@nix.hu>
projects / dbsrgits/SQL-Abstract.git / blobdiff