1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
|
#line 1
package Test::Differences;
#line 284
our $VERSION = "0.13"; # or "0.001_001" for a dev release
$VERSION = eval $VERSION;
use Exporter;
@ISA = qw( Exporter );
@EXPORT = qw(
eq_or_diff
eq_or_diff_text
eq_or_diff_data
unified_diff
context_diff
oldstyle_diff
table_diff
);
use strict;
use Carp;
use Text::Diff;
sub _isnt_ARRAY_of_scalars {
return 1 if ref ne "ARRAY";
return scalar grep ref, @$_;
}
sub _isnt_HASH_of_scalars {
return 1 if ref ne "HASH";
return scalar grep ref, values %$_;
}
use constant ARRAY_of_scalars => "ARRAY of scalars";
use constant ARRAY_of_ARRAYs_of_scalars => "ARRAY of ARRAYs of scalars";
use constant ARRAY_of_HASHes_of_scalars => "ARRAY of HASHes of scalars";
use constant HASH_of_scalars => "HASH of scalars";
{
my $diff_style = 'Table';
my %allowed_style = map { $_ => 1 } qw/Unified Context OldStyle Table/;
sub _diff_style {
return $diff_style unless @_;
my $requested_style = shift;
unless ( $allowed_style{$requested_style} ) {
Carp::croak("Uknown style ($requested_style) requested for diff");
}
$diff_style = $requested_style;
}
}
sub unified_diff { _diff_style('Unified') }
sub context_diff { _diff_style('Context') }
sub oldstyle_diff { _diff_style('OldStyle') }
sub table_diff { _diff_style('Table') }
sub _grok_type {
local $_ = shift if @_;
return "SCALAR" unless ref;
if ( ref eq "ARRAY" ) {
return undef unless @$_;
return ARRAY_of_scalars
unless _isnt_ARRAY_of_scalars;
return ARRAY_of_ARRAYs_of_scalars
unless grep _isnt_ARRAY_of_scalars, @$_;
return ARRAY_of_HASHes_of_scalars
unless grep _isnt_HASH_of_scalars, @$_;
return 0;
}
elsif ( ref eq 'HASH' ) {
return HASH_of_scalars
unless _isnt_HASH_of_scalars($_);
return 0;
}
}
## Flatten any acceptable data structure in to an array of lines.
sub _flatten {
my $type = shift;
local $_ = shift if @_;
return [ split /^/m, _quote_str($_) ] unless ref;
croak "Can't flatten $_" unless $type;
## Copy the top level array so we don't trash the originals
my ( @recs, %hash_copy );
if ( ref $_ eq 'ARRAY' ) {
@recs = @$_;
}
elsif ( ref $_ eq 'HASH' ) {
%hash_copy = %$_;
}
else {
die "unsupported ref type";
}
if ( $type eq ARRAY_of_scalars) {
@recs = map { _quote_str($_) } @recs;
}
elsif ( $type eq ARRAY_of_ARRAYs_of_scalars ) {
## Also copy the inner arrays if need be
$_ = [@$_] for @recs;
}
elsif ( $type eq ARRAY_of_HASHes_of_scalars ) {
my %headings;
for my $rec (@recs) {
$headings{$_} = 1 for keys %$rec;
}
my @headings = sort keys %headings;
## Convert all hashes in to arrays.
for my $rec (@recs) {
$rec = [ map $rec->{$_}, @headings ],;
}
unshift @recs, \@headings;
$type = ARRAY_of_ARRAYs_of_scalars;
}
elsif ( $type eq HASH_of_scalars ) {
my @headings = sort keys %hash_copy;
@recs = ( \@headings, [ map $hash_copy{$_}, @headings ] );
$type = ARRAY_of_ARRAYs_of_scalars;
}
if ( $type eq ARRAY_of_ARRAYs_of_scalars ) {
## Quote strings
for my $rec (@recs) {
for (@$rec) {
$_ = _quote_str($_);
}
$rec = join ",", @$rec;
}
}
return \@recs;
}
sub _quote_str {
my $str = shift;
return 'undef' unless defined $str;
return $str if $str =~ /^[0-9]+$/;
$str =~ s{([\\\'])}{\\$1}g;
return "'$str'";
}
sub _identify_callers_test_package_of_choice {
## This is called at each test in case Test::Differences was used before
## the base testing modules.
## First see if %INC tells us much of interest.
my $has_builder_pm = grep $_ eq "Test/Builder.pm", keys %INC;
my $has_test_pm = grep $_ eq "Test.pm", keys %INC;
return "Test" if $has_test_pm && !$has_builder_pm;
return "Test::Builder" if !$has_test_pm && $has_builder_pm;
if ( $has_test_pm && $has_builder_pm ) {
## TODO: Look in caller's namespace for hints. For now, assume Builder.
## This should only ever be an issue if multiple test suites end
## up in memory at once.
return "Test::Builder";
}
}
my $warned_of_unknown_test_lib;
sub eq_or_diff_text { $_[3] = { data_type => "text" }; goto &eq_or_diff; }
sub eq_or_diff_data { $_[3] = { data_type => "data" }; goto &eq_or_diff; }
## This string is a cheat: it's used to see if the two arrays of values
## are identical. The stringified values are joined using this joint
## and compared using eq. This is a deep equality comparison for
## references and a shallow one for scalars.
my $joint = chr(0) . "A" . chr(1);
sub eq_or_diff {
my ( @vals, $name, $options );
$options = pop if @_ > 2 && ref $_[-1];
( $vals[0], $vals[1], $name ) = @_;
my $data_type;
$data_type = $options->{data_type} if $options;
$data_type ||= "text" unless ref $vals[0] || ref $vals[1];
$data_type ||= "data";
my @widths;
my @types = map _grok_type, @vals;
my $dump_it = !$types[0] || !$types[1];
my ( $got, $expected );
if ($dump_it) {
require Data::Dumper;
local $Data::Dumper::Indent = 1;
local $Data::Dumper::Purity = 0;
local $Data::Dumper::Terse = 1;
local $Data::Dumper::Deepcopy = 1;
local $Data::Dumper::Quotekeys = 0;
local $Data::Dumper::Sortkeys =
exists $options->{Sortkeys} ? $options->{Sortkeys} : 1;
( $got, $expected ) = map
[ split /^/, Data::Dumper::Dumper($_) ],
@vals;
}
else {
( $got, $expected ) = (
_flatten( $types[0], $vals[0] ),
_flatten( $types[1], $vals[1] )
);
}
my $caller = caller;
my $passed
= join( $joint, @$got ) eq join( $joint, @$expected );
my $diff;
unless ($passed) {
my $context;
$context = $options->{context}
if exists $options->{context};
$context = $dump_it ? 2**31 : grep( @$_ > 25, $got, $expected ) ? 3 : 25
unless defined $context;
confess "context must be an integer: '$context'\n"
unless $context =~ /\A\d+\z/;
$diff = diff $got, $expected,
{ CONTEXT => $context,
STYLE => _diff_style(),
FILENAME_A => "Got",
FILENAME_B => "Expected",
OFFSET_A => $data_type eq "text" ? 1 : 0,
OFFSET_B => $data_type eq "text" ? 1 : 0,
INDEX_LABEL => $data_type eq "text" ? "Ln" : "Elt",
};
chomp $diff;
$diff .= "\n";
}
my $which = _identify_callers_test_package_of_choice;
if ( $which eq "Test" ) {
@_
= $passed
? ( "", "", $name )
: ( "\n$diff", "No differences", $name );
goto &Test::ok;
}
elsif ( $which eq "Test::Builder" ) {
my $test = Test::Builder->new;
## TODO: Call exported_to here? May not need to because the caller
## should have imported something based on Test::Builder already.
$test->ok( $passed, $name );
$test->diag($diff) unless $passed;
}
else {
unless ($warned_of_unknown_test_lib) {
Carp::cluck
"Can't identify test lib in use, doesn't seem to be Test.pm or Test::Builder based\n";
$warned_of_unknown_test_lib = 1;
}
## Play dumb and hope nobody notices the fool drooling in the corner
if ($passed) {
print "ok\n";
}
else {
$diff =~ s/^/# /gm;
print "not ok\n", $diff;
}
}
}
#line 650
1;
|