use strict;
use warnings;
+=head1 NAME
+
+Test::Leaner - A slimmer Test::More for when you favor performance over completeness.
+
+=head1 VERSION
+
+Version 0.01
+
+=cut
+
our $VERSION = '0.01';
-use Exporter ();
+=head1 SYNOPSIS
+
+ use Test::Leaner tests => 10_000;
+ for (1 .. 10_000) {
+ ...
+ is $one, 1, "checking situation $_";
+ }
+
+
+=head1 DESCRIPTION
+
+When profiling some L<Test::More>-based test script that contained about 10 000 unit tests, I realized that 60% of the time was spent in L<Test::Builder> itself, even though every single test actually involved a costly C<eval STRING>.
+
+This module aims to be a partial replacement to L<Test::More> in those situations where you want to run a large number of simple tests.
+Its functions behave the same as their L<Test::More> counterparts, except for the following differences :
+
+=over 4
+
+=item *
+
+Stringification isn't forced on the test operands.
+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 *
+
+L</pass>, L</fail>, L</ok>, L</is>, L</isnt>, L</like>, L</unlike> and L</cmp_ok> are all guaranteed to return the truth value of the test.
+
+=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 Scalar::Util ();
BEGIN {
if ($] >= 5.008 and $INC{'threads.pm'}) {
}
}
-my $TAP_STREAM = *STDOUT;
-my $DIAG_STREAM = *STDERR;
+my ($TAP_STREAM, $DIAG_STREAM);
my ($plan, $test, $failed, $no_diag, $done_testing);
BEGIN {
if (THREADSAFE) {
- threads::shared::share($_) for $plan, $test, $failed, $no_diag;
+ threads::shared::share($_) for $plan, $test, $failed, $no_diag, $done_testing;
}
lock $plan if THREADSAFE;
die @_, " at $file line $line.\n";
}
-sub sanitize_comment {
+sub _sanitize_comment {
$_[0] =~ s/\n+\z//;
$_[0] =~ s/#/\\#/g;
$_[0] =~ s/\n/\n# /g;
}
+=head1 FUNCTIONS
+
+The following functions from L<Test::More> are implemented and exported by default.
+
+=head2 C<< plan [ tests => $count | 'no_plan' | skip_all => $reason ] >>
+
+=cut
+
sub plan {
my ($key, $value) = @_;
$plan = SKIP_ALL;
$plan_str = '1..0 # SKIP';
if (defined $value) {
- sanitize_comment($value);
+ _sanitize_comment($value);
$plan_str .= " $value" if length $value;
}
} else {
croak("plan() doesn't understand @args");
}
- {
- my $fh = select $TAP_STREAM;
- $|++;
- select $fh;
- }
-
if (defined $plan_str) {
local $\;
print $TAP_STREAM "$plan_str\n";
our @EXPORT = qw<
plan
- skip_all
skip
done_testing
pass
isnt
like
unlike
+ cmp_ok
+ is_deeply
diag
note
BAIL_OUT
push @imports, @{ $_[$i+1] };
$splice = 2;
} elsif ($item eq 'no_diag') {
+ lock $plan if THREADSAFE;
$no_diag = 1;
$splice = 1;
}
goto &Exporter::import;
}
-sub skip_all {
- @_ = (skip_all => $_[0]);
- goto &plan;
-}
+=head2 C<< skip $reason => $count >>
+
+=cut
sub skip {
my ($reason, $count) = @_;
}
for (1 .. $count) {
+ ++$test;
+
my $skip_str = "ok $test # skip";
if (defined $reason) {
- sanitize_comment($reason);
+ _sanitize_comment($reason);
$skip_str .= " $reason" if length $reason;
}
local $\;
print $TAP_STREAM "$skip_str\n";
-
- $test++;
}
no warnings 'exiting';
last SKIP;
}
+=head2 C<done_testing [ $count ]>
+
+=cut
+
sub done_testing {
my ($count) = @_;
return 1;
}
+=head2 C<ok $ok [, $desc ]>
+
+=cut
+
sub ok ($;$) {
my ($ok, $desc) = @_;
++$failed;
}
if (defined $desc) {
- sanitize_comment($desc);
+ _sanitize_comment($desc);
$test_str .= " - $desc" if length $desc;
}
return $ok;
}
+=head2 C<pass [ $desc ]>
+
+=cut
+
sub pass (;$) {
unshift @_, 1;
goto &ok;
}
+=head2 C<fail [ $desc ]>
+
+=cut
+
sub fail (;$) {
unshift @_, 0;
goto &ok;
}
-my %binops;
-BEGIN {
- %binops = (
- 'or' => 'or',
- 'and' => 'and',
- 'xor' => 'xor',
-
- '||' => 'hor',
- '&&' => 'hand',
-
- 'lt' => 'lt',
- 'le' => 'le',
- 'gt' => 'gt',
- 'ge' => 'ge',
- 'eq' => 'eq',
- 'ne' => 'ne',
- 'cmp' => 'cmp',
-
- '<' => 'nlt',
- '<=' => 'nle',
- '>' => 'ngt',
- '>=' => 'nge',
- '==' => 'neq',
- '!=' => 'nne',
- '<=>' => 'ncmp',
-
- '=~' => 'like',
- '!~' => 'unlike',
- '~~' => 'smartmatch',
+=head2 C<is $got, $expected [, $desc ]>
+
+=cut
+
+sub is ($$;$) {
+ my ($got, $expected, $desc) = @_;
+ no warnings 'uninitialized';
+ @_ = (
+ (not(defined $got xor defined $expected) and $got eq $expected),
+ $desc,
);
+ goto &ok;
+}
+
+=head2 C<isnt $got, $expected [, $desc ]>
+
+=cut
- for my $op (sort keys %binops) {
- my $name = $binops{$op};
+sub isnt ($$;$) {
+ my ($got, $expected, $desc) = @_;
+ no warnings 'uninitialized';
+ @_ = (
+ ((defined $got xor defined $expected) or $got ne $expected),
+ $desc,
+ );
+ goto &ok;
+}
+
+my %binops = (
+ 'or' => 'or',
+ 'xor' => 'xor',
+ 'and' => 'and',
+
+ '||' => 'hor',
+ ('//' => 'dor') x ($] >= 5.010),
+ '&&' => 'hand',
+
+ '|' => 'bor',
+ '^' => 'bxor',
+ '&' => 'band',
+
+ 'lt' => 'lt',
+ 'le' => 'le',
+ 'gt' => 'gt',
+ 'ge' => 'ge',
+ 'eq' => 'eq',
+ 'ne' => 'ne',
+ 'cmp' => 'cmp',
+
+ '<' => 'nlt',
+ '<=' => 'nle',
+ '>' => 'ngt',
+ '>=' => 'nge',
+ '==' => 'neq',
+ '!=' => 'nne',
+ '<=>' => 'ncmp',
+
+ '=~' => 'like',
+ '!~' => 'unlike',
+ ('~~' => 'smartmatch') x ($] >= 5.010),
+
+ '+' => 'add',
+ '-' => 'substract',
+ '*' => 'multiply',
+ '/' => 'divide',
+ '%' => 'modulo',
+ '<<' => 'lshift',
+ '>>' => 'rshift',
+
+ '.' => 'concat',
+ '..' => 'flipflop',
+ '...' => 'altflipflop',
+ ',' => 'comma',
+ '=>' => 'fatcomma',
+);
+
+my %binop_handlers;
+
+sub _create_binop_handler {
+ my ($op) = @_;
+ my $name = $binops{$op};
+ croak("Operator $op not supported") unless defined $name;
+ {
local $@;
eval <<"IS_BINOP";
sub is_$name (\$\$;\$) {
- my (\$x, \$y, \$desc) = \@_;
- no warnings 'uninitialized';
- \@_ = (
- (not(defined \$x xor defined \$y) and \$x $op \$y),
- \$desc,
- );
+ my (\$got, \$expected, \$desc) = \@_;
+ \@_ = (scalar(\$got $op \$expected), \$desc);
goto &ok;
}
IS_BINOP
die $@ if $@;
}
+ $binop_handlers{$op} = do {
+ no strict 'refs';
+ \&{__PACKAGE__."::is_$name"};
+ }
}
+=head2 C<like $got, $regexp_expected [, $desc ]>
+
+=cut
+
+=head2 C<unlike $got, $regexp_expected, [, $desc ]>
+
+=cut
+
{
no warnings 'once';
- *is = \&is_eq;
- *like = \&is_like;
- *unlike = \&is_unlike;
+ *like = _create_binop_handler('=~');
+ *unlike = _create_binop_handler('!~');
}
-sub isnt ($$;$) {
- my ($x, $y, $desc) = @_;
- no warnings 'uninitialized';
+=head2 C<cmp_ok $got, $op, $expected [, $desc ]>
+
+=cut
+
+sub cmp_ok ($$$;$) {
+ my ($got, $op, $expected, $desc) = @_;
+ my $handler = $binop_handlers{$op};
+ unless ($handler) {
+ local $Test::More::Level = ($Test::More::Level || 0) + 1;
+ $handler = _create_binop_handler($op);
+ }
+ @_ = ($got, $expected, $desc);
+ goto $handler;
+}
+
+=head2 C<is_deeply $got, $expected [, $desc ]>
+
+=cut
+
+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;
+
+ if ($ry eq 'ARRAY') {
+ if ($#$x == $#$y) {
+ # Prevent vivification of deleted elements by fetching the array values.
+ my ($ex, $ey);
+ _deep_check($ex = $x->[$_], $ey = $y->[$_]) or return 0 for 0 .. $#$x;
+ return 1;
+ }
+ } elsif ($ry eq 'HASH') {
+ if (keys(%$x) == keys(%$y)) {
+ (exists $x->{$_} and _deep_check($x->{$_}, $y->{$_}))
+ or return 0 for keys %$y;
+ return 1;
+ }
+ } elsif ($ry eq 'SCALAR' or $ry eq 'REF') {
+ return _deep_check($$x, $$y);
+ }
+
+ return 0;
+};
+
+sub is_deeply {
@_ = (
- ((defined $x xor defined $y) or $x ne $y),
- $desc,
+ &_deep_check,
+ $_[2],
);
goto &ok;
}
-sub cmp_ok ($$$;$) {
- my ($x, $op, $y, $desc) = @_;
- my $name = $binops{$op};
- croak("Operator $op not supported") unless defined $name;
- @_ = ($x, $y, $desc);
- no strict 'refs';
- goto &{__PACKAGE__."is_$name"};
-}
-
sub _diag_fh {
my $fh = shift;
return if $no_diag;
my $msg = join '', map { defined($_) ? $_ : 'undef' } @_;
- sanitize_comment($msg);
+ _sanitize_comment($msg);
return unless length $msg;
local $\;
return 0;
};
+=head2 C<diag @text>
+
+=cut
+
sub diag {
unshift @_, $DIAG_STREAM;
goto &_diag_fh;
}
+=head2 C<note @text>
+
+=cut
+
sub note {
unshift @_, $TAP_STREAM;
goto &_diag_fh;
}
+=head2 C<BAIL_OUT [ $desc ]>
+
+=cut
+
sub BAIL_OUT {
my ($desc) = @_;
my $bail_out_str = 'Bail out!';
if (defined $desc) {
- sanitize_comment($desc);
+ _sanitize_comment($desc);
$bail_out_str .= " $desc" if length $desc; # Two spaces
}
}
}
+=pod
+
+L<Test::Leaner> also provides some functions of its own, which are never exported.
+
+=head2 C<tap_stream [ $fh ]>
+
+Read/write accessor for the filehandle to which the tests are outputted.
+On write, it also turns autoflush on onto C<$fh>.
+
+Note that it can only be used as a write accessor before you start any thread, as L<threads::shared> cannot reliably share filehandles.
+
+Defaults to C<STDOUT>.
+
+=cut
+
+sub tap_stream (;*) {
+ if (@_) {
+ $TAP_STREAM = $_[0];
+
+ my $fh = select $TAP_STREAM;
+ $|++;
+ select $fh;
+ }
+
+ return $TAP_STREAM;
+}
+
+tap_stream *STDOUT;
+
+=head2 C<diag_stream [ $fh ]>
+
+Read/write accessor for the filehandle to which the diagnostics are printed.
+On write, it also turns autoflush on onto C<$fh>.
+
+Just like L</tap_stream>, it can only be used as a write accessor before you start any thread, as L<threads::shared> cannot reliably share filehandles.
+
+Defaults to C<STDERR>.
+
+=cut
+
+sub diag_stream (;*) {
+ if (@_) {
+ $DIAG_STREAM = $_[0];
+
+ my $fh = select $DIAG_STREAM;
+ $|++;
+ select $fh;
+ }
+
+ return $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<Scalar::Util>, L<Test::More>.
+
+=head1 AUTHOR
+
+Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
+
+You can contact me by mail or on C<irc.perl.org> (vincent).
+
+=head1 BUGS
+
+Please report any bugs or feature requests to C<bug-test-leaner at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Leaner>.
+I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
+
+=head1 SUPPORT
+
+You can find documentation for this module with the perldoc command.
+
+ perldoc Test::Leaner
+
+=head1 COPYRIGHT & LICENSE
+
+Copyright 2010 Vincent Pit, all rights reserved.
+
+This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
+
+=cut
+
1; # End of Test::Leaner
projects / perl / modules / Test-Leaner.git / blobdiff