X-Git-Url: http://git.vpit.fr/?p=perl%2Fmodules%2FTest-Leaner.git;a=blobdiff_plain;f=lib%2FTest%2FLeaner.pm;h=6f90cef1ae4663704ee01802d81ea66c00693396;hp=bc62c0c54fef6228b760371bcafb425cb47fe642;hb=653bd706f7c17c61e34d98e6fcaed75861b2f7d7;hpb=67d7b560467f2d6b762eeee33aa07e0dba290f2b

diff --git a/lib/Test/Leaner.pm b/lib/Test/Leaner.pm
index bc62c0c..6f90cef 100644
--- a/lib/Test/Leaner.pm
+++ b/lib/Test/Leaner.pm
@@ -37,7 +37,7 @@ Its functions behave the same as their L<Test::More> counterparts, except for th
 =item *
 
 Stringification isn't forced on the test operands.
-However, L</ok> honors C<'bool'> overloading, L</is> honors C<'eq'> overloading and L</cmp_ok> honors whichever overloading category corresponds to the specified operator.
+However, L</ok> honors C<'bool'> overloading, L</is> and L</is_deeply> honor C<'eq'> overloading (and just that one) and L</cmp_ok> honors whichever overloading category corresponds to the specified operator.
 
 =item *
 
@@ -45,18 +45,37 @@ L</pass>, L</fail>, L</ok>, L</is>, L</isnt>, L</like>, L</unlike> and L</cmp_ok
 
 =item *
 
+L</like> and L</unlike> don't special case regular expressions that are passed as C<'/.../'> strings.
+A string regexp argument is always treated as a the source of the regexp, making C<like $text, $rx> and C<like $text, qr[$rx]> equivalent to each other and to C<cmp_ok $text, '=~', $rx> (and likewise for C<unlike>).
+
+=item *
+
 L</cmp_ok> throws an exception if the given operator isn't a valid Perl binary operator (except C<'='> and variants).
 It also tests in scalar context, so C<'..'> will be treated as the flip-flop operator and not the range operator.
 
 =item *
 
+L</is_deeply> doesn't guard for memory cycles.
+If the two first arguments present parallel memory cycles, the test may result in an infinite loop.
+
+=item *
+
+The tests don't output any kind of default diagnostic in case of failure ; the rationale being that if you have a large number of tests and a lot of them are failing, then you don't want to be flooded by diagnostics.
+
+=item *
+
 C<use_ok>, C<require_ok>, C<can_ok>, C<isa_ok>, C<new_ok>, C<subtest>, C<explain>, C<TODO> blocks and C<todo_skip> are not implemented.
 
+=item *
+
+L<Test::Leaner> depends on L<Scalar::Util>, while L<Test::More> does not.
+
 =back
 
 =cut
 
-use Exporter ();
+use Exporter     ();
+use Scalar::Util ();
 
 BEGIN {
  if ($] >= 5.008 and $INC{'threads.pm'}) {
@@ -79,6 +98,119 @@ my ($TAP_STREAM, $DIAG_STREAM);
 
 my ($plan, $test, $failed, $no_diag, $done_testing);
 
+our @EXPORT = qw<
+ plan
+ skip
+ done_testing
+ pass
+ fail
+ ok
+ is
+ isnt
+ like
+ unlike
+ cmp_ok
+ is_deeply
+ diag
+ note
+ BAIL_OUT
+>;
+
+=head1 ENVIRONMENT
+
+=head2 C<PERL_TEST_LEANER_USES_TEST_MORE>
+
+If this environment variable is set, L<Test::Leaner> will replace its functions by those from L<Test::More>.
+Moreover, the symbols that are imported you C<use Test::Leaner> will be those from L<Test::More>, but you can still only import the symbols originally defined in L<Test::Leaner> (hence the functions from L<Test::More> that are not implemented in L<Test::Leaner> will not be imported).
+If your version of L<Test::More> is too old and doesn't have some symbols (like L</note> or L</done_testing>), they will be replaced in L<Test::Leaner> by croaking stubs.
+
+This may be useful if your L<Test::Leaner>-based test script fails and you want extra diagnostics.
+
+=cut
+
+sub _handle_import_args {
+ my @imports;
+
+ my $i = 0;
+ while ($i <= $#_) {
+  my $item = $_[$i];
+  my $splice;
+  if (defined $item) {
+   if ($item eq 'import') {
+    push @imports, @{ $_[$i+1] };
+    $splice  = 2;
+   } elsif ($item eq 'no_diag') {
+    lock $plan if THREADSAFE;
+    $no_diag = 1;
+    $splice  = 1;
+   }
+  }
+  if ($splice) {
+   splice @_, $i, $splice;
+  } else {
+   ++$i;
+  }
+ }
+
+ return @imports;
+}
+
+if ($ENV{PERL_TEST_LEANER_USES_TEST_MORE}) {
+ require Test::More;
+
+ my $leaner_stash = \%Test::Leaner::;
+ my $more_stash   = \%Test::More::;
+
+ my %valid_imports;
+
+ for (@EXPORT) {
+  my $replacement = exists $more_stash->{$_} ? *{$more_stash->{$_}}{CODE}
+                                             : undef;
+  if (defined $replacement) {
+   $valid_imports{$_} = 1;
+  } else {
+   $replacement = sub {
+    @_ = ("$_ is not implemented in this version of Test::More");
+    goto &croak;
+   };
+  }
+  no warnings 'redefine';
+  $leaner_stash->{$_} = $replacement;
+ }
+
+ my $import = sub {
+  shift;
+  my @imports = &_handle_import_args;
+  @imports = @EXPORT unless @imports;
+  my @test_more_imports;
+  for (@imports) {
+   if ($valid_imports{$_}) {
+    push @test_more_imports, $_;
+   } else {
+    my $pkg = caller;
+    no strict 'refs';
+    *{$pkg."::$_"} = $leaner_stash->{$_};
+   }
+  }
+  my $test_more_import = 'Test::More'->can('import');
+  @_ = (
+   'Test::More',
+   @_,
+   import => \@test_more_imports,
+  );
+  {
+   lock $plan if THREADSAFE;
+   push @_, 'no_diag' if $no_diag;
+  }
+  goto $test_more_import;
+ };
+
+ no warnings 'redefine';
+ *import = $import;
+
+ return 1;
+}
+
 sub NO_PLAN  () { -1 }
 sub SKIP_ALL () { -2 }
 
@@ -96,13 +228,21 @@ BEGIN {
 
 sub carp {
  my $level = 1 + ($Test::Builder::Level || 0);
- my ($file, $line) = (caller $level)[1, 2];
+ my @caller;
+ do {
+  @caller = caller $level--;
+ } while (!@caller and $level >= 0);
+ my ($file, $line) = @caller[1, 2];
  warn @_, " at $file line $line.\n";
 }
 
 sub croak {
  my $level = 1 + ($Test::Builder::Level || 0);
- my ($file, $line) = (caller $level)[1, 2];
+ my @caller;
+ do {
+  @caller = caller $level--;
+ } while (!@caller and $level >= 0);
+ my ($file, $line) = @caller[1, 2];
  die @_, " at $file line $line.\n";
 }
 
@@ -118,6 +258,8 @@ The following functions from L<Test::More> are implemented and exported by defau
 
 =head2 C<< plan [ tests => $count | 'no_plan' | skip_all => $reason ] >>
 
+See L<Test::More/plan>.
+
 =cut
 
 sub plan {
@@ -163,47 +305,10 @@ sub plan {
  return 1;
 }
 
-our @EXPORT = qw<
- plan
- skip
- done_testing
- pass
- fail
- ok
- is
- isnt
- cmp_ok
- like
- unlike
- diag
- note
- BAIL_OUT
->;
-
 sub import {
  my $class = shift;
 
- my @imports;
- my $i = 0;
- while ($i <= $#_) {
-  my $item = $_[$i];
-  my $splice;
-  if (defined $item) {
-   if ($item eq 'import') {
-    push @imports, @{ $_[$i+1] };
-    $splice  = 2;
-   } elsif ($item eq 'no_diag') {
-    lock $plan if THREADSAFE;
-    $no_diag = 1;
-    $splice  = 1;
-   }
-  }
-  if ($splice) {
-   splice @_, $i, $splice;
-  } else {
-   ++$i;
-  }
- }
+ my @imports = &_handle_import_args;
 
  if (@_) {
   local $Test::Builder::Level = ($Test::Builder::Level || 0) + 1;
@@ -216,6 +321,8 @@ sub import {
 
 =head2 C<< skip $reason => $count >>
 
+See L<Test::More/skip>.
+
 =cut
 
 sub skip {
@@ -251,6 +358,8 @@ sub skip {
 
 =head2 C<done_testing [ $count ]>
 
+See L<Test::More/done_testing>.
+
 =cut
 
 sub done_testing {
@@ -282,6 +391,8 @@ sub done_testing {
 
 =head2 C<ok $ok [, $desc ]>
 
+See L<Test::More/ok>.
+
 =cut
 
 sub ok ($;$) {
@@ -309,6 +420,8 @@ sub ok ($;$) {
 
 =head2 C<pass [ $desc ]>
 
+See L<Test::More/pass>.
+
 =cut
 
 sub pass (;$) {
@@ -318,6 +431,8 @@ sub pass (;$) {
 
 =head2 C<fail [ $desc ]>
 
+See L<Test::More/fail>.
+
 =cut
 
 sub fail (;$) {
@@ -327,6 +442,8 @@ sub fail (;$) {
 
 =head2 C<is $got, $expected [, $desc ]>
 
+See L<Test::More/is>.
+
 =cut
 
 sub is ($$;$) {
@@ -341,6 +458,8 @@ sub is ($$;$) {
 
 =head2 C<isnt $got, $expected [, $desc ]>
 
+See L<Test::More/isnt>.
+
 =cut
 
 sub isnt ($$;$) {
@@ -426,8 +545,12 @@ IS_BINOP
 
 =head2 C<like $got, $regexp_expected [, $desc ]>
 
+See L<Test::More/like>.
+
 =head2 C<unlike $got, $regexp_expected, [, $desc ]>
 
+See L<Test::More/unlike>.
+
 =cut
 
 {
@@ -438,6 +561,8 @@ IS_BINOP
 
 =head2 C<cmp_ok $got, $op, $expected [, $desc ]>
 
+See L<Test::More/cmp_ok>.
+
 =cut
 
 sub cmp_ok ($$$;$) {
@@ -451,6 +576,99 @@ sub cmp_ok ($$$;$) {
  goto $handler;
 }
 
+=head2 C<is_deeply $got, $expected [, $desc ]>
+
+See L<Test::More/is_deeply>.
+
+=cut
+
+sub _deep_ref_check {
+ my ($x, $y, $ry) = @_;
+
+ no warnings qw<numeric uninitialized>;
+
+ if ($ry eq 'ARRAY') {
+  return 0 unless $#$x == $#$y;
+
+  my ($ex, $ey);
+  for (0 .. $#$y) {
+   $ex = $x->[$_];
+   $ey = $y->[$_];
+
+   # Inline the beginning of _deep_check
+   return 0 if defined $ex xor defined $ey;
+
+   next if not(ref $ex xor ref $ey) and $ex eq $ey;
+
+   $ry = Scalar::Util::reftype($ey);
+   return 0 if Scalar::Util::reftype($ex) ne $ry;
+
+   return 0 unless $ry and _deep_ref_check($ex, $ey, $ry);
+  }
+
+  return 1;
+ } elsif ($ry eq 'HASH') {
+  return 0 unless keys(%$x) == keys(%$y);
+
+  my ($ex, $ey);
+  for (keys %$y) {
+   return 0 unless exists $x->{$_};
+   $ex = $x->{$_};
+   $ey = $y->{$_};
+
+   # Inline the beginning of _deep_check
+   return 0 if defined $ex xor defined $ey;
+
+   next if not(ref $ex xor ref $ey) and $ex eq $ey;
+
+   $ry = Scalar::Util::reftype($ey);
+   return 0 if Scalar::Util::reftype($ex) ne $ry;
+
+   return 0 unless $ry and _deep_ref_check($ex, $ey, $ry);
+  }
+
+  return 1;
+ } elsif ($ry eq 'SCALAR' or $ry eq 'REF') {
+  return _deep_check($$x, $$y);
+ }
+
+ return 0;
+}
+
+sub _deep_check {
+ my ($x, $y) = @_;
+
+ no warnings qw<numeric uninitialized>;
+
+ return 0 if defined $x xor defined $y;
+
+ # Try object identity/eq overloading first. It also covers the case where
+ # $x and $y are both undefined.
+ # If either $x or $y is overloaded but none has eq overloading, the test will
+ # break at that point.
+ return 1 if not(ref $x xor ref $y) and $x eq $y;
+
+ # Test::More::is_deeply happily breaks encapsulation if the objects aren't
+ # overloaded.
+ my $ry = Scalar::Util::reftype($y);
+ return 0 if Scalar::Util::reftype($x) ne $ry;
+
+ # Shortcut if $x and $y are both not references and failed the previous
+ # $x eq $y test.
+ return 0 unless $ry;
+
+ # We know that $x and $y are both references of type $ry, without overloading.
+ _deep_ref_check($x, $y, $ry);
+}
+
+sub is_deeply {
+ @_ = (
+  &_deep_check,
+  $_[2],
+ );
+ goto &ok;
+}
+
 sub _diag_fh {
  my $fh = shift;
 
@@ -471,6 +689,8 @@ sub _diag_fh {
 
 =head2 C<diag @text>
 
+See L<Test::More/diag>.
+
 =cut
 
 sub diag {
@@ -480,6 +700,8 @@ sub diag {
 
 =head2 C<note @text>
 
+See L<Test::More/note>.
+
 =cut
 
 sub note {
@@ -489,6 +711,8 @@ sub note {
 
 =head2 C<BAIL_OUT [ $desc ]>
 
+See L<Test::More/BAIL_OUT>.
+
 =cut
 
 sub BAIL_OUT {
@@ -517,7 +741,8 @@ END {
     $? = $failed <= 254 ? $failed : 254;
    } elsif ($plan >= 0) {
     $? = $test == $plan ? 0 : 255;
-   } elsif ($plan == NO_PLAN) {
+   }
+   if ($plan == NO_PLAN) {
     local $\;
     print $TAP_STREAM "1..$test\n";
    }
@@ -579,11 +804,16 @@ sub diag_stream (;*) {
 
 diag_stream *STDERR;
 
+=head2 C<THREADSAFE>
+
+This constant evaluates to true if and only if L<Test::Leaner> is thread-safe, i.e. when this version of C<perl> is at least 5.8, has been compiled with C<useithreads> defined, and L<threads> has been loaded B<before> L<Test::Leaner>.
+In that case, it also needs a working L<threads::shared>.
+
 =head1 DEPENDENCIES
 
 L<perl> 5.6.
 
-L<Exporter>, L<Test::More>
+L<Exporter>, L<Scalar::Util>, L<Test::More>.
 
 =head1 AUTHOR