/usr/share/perl5/Test/Warn.pm is in libtest-warn-perl 0.24-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 | =head1 NAME
Test::Warn - Perl extension to test methods for warnings
=head1 SYNOPSIS
use Test::Warn;
warning_is {foo(-dri => "/")} "Unknown Parameter 'dri'", "dri != dir gives warning";
warnings_are {bar(1,1)} ["Width very small", "Height very small"];
warning_is {add(2,2)} undef, "No warnings for calc 2+2"; # or
warnings_are {add(2,2)} [], "No warnings for calc 2+2"; # what reads better :-)
warning_like {foo(-dri => "/")} qr/unknown param/i, "an unknown parameter test";
warnings_like {bar(1,1)} [qr/width.*small/i, qr/height.*small/i];
warning_is {foo()} {carped => "didn't find the right parameters"};
warnings_like {foo()} [qr/undefined/,qr/undefined/,{carped => qr/no result/i}];
warning_like {foo(undef)} 'uninitialized';
warning_like {bar(file => '/etc/passwd')} 'io';
warning_like {eval q/"$x"; $x;/}
[qw/void uninitialized/],
"some warnings at compile time";
warnings_exist {...} [qr/expected warning/], "Expected warning is thrown";
=head1 DESCRIPTION
A good style of Perl programming calls for a lot of diverse regression tests.
This module provides a few convenience methods for testing warning based-code.
If you are not already familiar with the L<Test::More> manpage,
now would be the time to go take a look.
=head2 FUNCTIONS
=over 4
=item warning_is BLOCK STRING, TEST_NAME
Tests that BLOCK gives the specified warning exactly once.
The test fails if the BLOCK warns more than once or does not warn at all.
If the string is undef,
then the tests succeeds if the BLOCK doesn't give any warning.
Another way to say that there are no warnings in the block
is C<warnings_are {foo()} [], "no warnings">.
If you want to test for a warning given by Carp
you have to write something like:
C<warning_is {carp "msg"} {carped =E<gt> 'msg'}, "Test for a carped warning">.
The test will fail if a "normal" warning is found instead of a "carped" one.
Note: C<warn "foo"> would print something like C<foo at -e line 1>.
This method ignores everything after the "at". Thus to match this warning
you would have to call C<warning_is {warn "foo"} "foo", "Foo succeeded">.
If you need to test for a warning at an exactly line,
try something like C<warning_like {warn "foo"} qr/at XYZ.dat line 5/>.
warning_is and warning_are are only aliases to the same method.
So you also could write
C<warning_is {foo()} [], "no warning"> or something similar.
I decided to give two methods the same name to improve readability.
A true value is returned if the test succeeds, false otherwise.
The test name is optional, but recommended.
=item warnings_are BLOCK ARRAYREF, TEST_NAME
Tests to see that BLOCK gives exactly the specified warnings.
The test fails if the warnings from BLOCK are not exactly the ones in ARRAYREF.
If the ARRAYREF is equal to [],
then the test succeeds if the BLOCK doesn't give any warning.
Please read also the notes to warning_is as these methods are only aliases.
If you want more than one test for carped warnings, try this:
C<warnings_are {carp "c1"; carp "c2"} {carped => ['c1','c2'];> or
C<warnings_are {foo()} ["Warning 1", {carped => ["Carp 1", "Carp 2"]}, "Warning 2"]>.
Note that C<{carped => ...}> must always be a hash ref.
=item warning_like BLOCK REGEXP, TEST_NAME
Tests that BLOCK gives exactly one warning and it can be matched by
the given regexp.
If the string is undef,
then the tests succeeds if the BLOCK doesn't give any warning.
The REGEXP is matched against the whole warning line,
which in general has the form "WARNING at __FILE__ line __LINE__".
So you can check for a warning in the file Foo.pm on line 5 with
C<warning_like {bar()} qr/at Foo.pm line 5/, "Testname">.
Perhaps it is not sensible to perform such a test;
however, you should be aware that matching on a sweeping regular expression
or similar will always pass.
Consider qr/^foo/ if you want to test for warning "foo something" in file foo.pl.
You can also write the regexp in a string as "/.../"
instead of using the qr/.../ syntax.
Note that the slashes are important in the string,
as strings without slashes are reserved for warning categories
(to match warning categories as can be seen in the perllexwarn man page).
As with C<warning_is>,
you can test for warnings via C<carp> with:
C<warning_like {bar()} {carped => qr/bar called too early/i};>
Similar to C<warning_is>/C<warnings_are>,
C<warning_like> and C<warnings_like> are only aliases to the same methods.
A true value is returned if the test succeeds, false otherwise.
The test name is optional, but recommended.
=item warning_like BLOCK STRING, TEST_NAME
Tests whether a BLOCK gives exactly one warning of the passed category.
The categories are grouped in a tree,
like it is expressed in perllexwarn.
Note that they have the hierarchical structure from perl 5.8.0,
you can access the internal hierarchy with
C<$Test::Warn::Categorization::tree>,
although it isn't recommended).
Thanks to the grouping in a tree,
it's possible to test simply for an 'io' warning,
instead of testing for a 'closed|exec|layer|newline|pipe|unopened' warning.
Note that compile-time warnings
can only be caught in an eval block. So
warning_like {eval q/"$x"; $x;/}
[qw/void uninitialized/],
"some warnings at compile time";
will work,
while it wouldn't work without the eval.
Note also that it isn't yet possible
to test for categories you created yourself with C<warnings::register>.
=item warnings_like BLOCK ARRAYREF, TEST_NAME
Tests to see that BLOCK gives exactly the number of the specified warnings
and all the warnings have to match in the defined order to the
passed regexes.
Please read also the notes to warning_like as these methods are only aliases.
Similar to C<warnings_are>,
you can test for multiple warnings via C<carp>
and for warning categories, too:
warnings_like {foo()}
[qr/bar warning/,
qr/bar warning/,
{carped => qr/bar warning/i},
'io'
],
"I hope you'll never have to write a test for so many warnings :-)";
=item warnings_exist BLOCK STRING|ARRAYREF, TEST_NAME
Same as warning_like, but will warn() all warnings that do not match the supplied regex/category,
instead of registering an error. Use this test when you just want to make sure that specific
warnings were generated, and couldn't care less if other warnings happened in the same block
of code.
warnings_exist {...} [qr/expected warning/], "Expected warning is thrown";
warnings_exist {...} ['uninitialized'], "Expected warning is thrown";
=back
=head2 EXPORT
C<warning_is>,
C<warnings_are>,
C<warning_like>,
C<warnings_like>,
C<warnings_exist> by default.
=head1 BUGS
Please note that warnings with newlines inside are very awkward.
The only sensible way to handle them is to use the C<warning_like> or
C<warnings_like> methods. The background is that there is no
really safe way to distinguish between warnings with newlines and a
stacktrace.
If a method has its own warn handler,
overwriting C<$SIG{__WARN__}>,
my test warning methods won't get these warnings.
The C<warning_like BLOCK CATEGORY, TEST_NAME> method isn't fully tested.
Please take note if you use this this calling style,
and report any bugs you find.
=head1 TODO
Improve this documentation.
The code has some parts doubled - especially in the test scripts.
This is really awkward and must be changed.
Please feel free to suggest improvements.
=head1 SEE ALSO
Have a look to the similar L<Test::Exception> module. L<Test::Trap>
=head1 THANKS
Many thanks to Adrian Howard, chromatic and Michael G. Schwern,
who have given me a lot of ideas.
=head1 AUTHOR
Janek Schleicher, E<lt>bigj AT kamelfreund.deE<gt>
=head1 COPYRIGHT AND LICENSE
Copyright 2002 by Janek Schleicher
Copyright 2007-2011 by Alexandr Ciornii, L<http://chorny.net/>
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=cut
package Test::Warn;
use 5.006;
use strict;
use warnings;
#use Array::Compare;
use Sub::Uplevel 0.12;
our $VERSION = '0.24';
require Exporter;
our @ISA = qw(Exporter);
our %EXPORT_TAGS = ( 'all' => [ qw(
@EXPORT
) ] );
our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );
our @EXPORT = qw(
warning_is warnings_are
warning_like warnings_like
warnings_exist
);
use Test::Builder;
my $Tester = Test::Builder->new;
{
no warnings 'once';
*warning_is = *warnings_are;
*warning_like = *warnings_like;
}
sub warnings_are (&$;$) {
my $block = shift;
my @exp_warning = map {_canonical_exp_warning($_)}
_to_array_if_necessary( shift() || [] );
my $testname = shift;
my @got_warning = ();
local $SIG{__WARN__} = sub {
my ($called_from) = caller(0); # to find out Carping methods
push @got_warning, _canonical_got_warning($called_from, shift());
};
uplevel 1,$block;
my $ok = _cmp_is( \@got_warning, \@exp_warning );
$Tester->ok( $ok, $testname );
$ok or _diag_found_warning(@got_warning),
_diag_exp_warning(@exp_warning);
return $ok;
}
sub warnings_like (&$;$) {
my $block = shift;
my @exp_warning = map {_canonical_exp_warning($_)}
_to_array_if_necessary( shift() || [] );
my $testname = shift;
my @got_warning = ();
local $SIG{__WARN__} = sub {
my ($called_from) = caller(0); # to find out Carping methods
push @got_warning, _canonical_got_warning($called_from, shift());
};
uplevel 1,$block;
my $ok = _cmp_like( \@got_warning, \@exp_warning );
$Tester->ok( $ok, $testname );
$ok or _diag_found_warning(@got_warning),
_diag_exp_warning(@exp_warning);
return $ok;
}
sub warnings_exist (&$;$) {
my $block = shift;
my @exp_warning = map {_canonical_exp_warning($_)}
_to_array_if_necessary( shift() || [] );
my $testname = shift;
my @got_warning = ();
local $SIG{__WARN__} = sub {
my ($called_from) = caller(0); # to find out Carping methods
my $wrn_text=shift;
my $wrn_rec=_canonical_got_warning($called_from, $wrn_text);
foreach my $wrn (@exp_warning) {
if (_cmp_got_to_exp_warning_like($wrn_rec,$wrn)) {
push @got_warning, $wrn_rec;
return;
}
}
warn $wrn_text;
};
uplevel 1,$block;
my $ok = _cmp_like( \@got_warning, \@exp_warning );
$Tester->ok( $ok, $testname );
$ok or _diag_found_warning(@got_warning),
_diag_exp_warning(@exp_warning);
return $ok;
}
sub _to_array_if_necessary {
return (ref($_[0]) eq 'ARRAY') ? @{$_[0]} : ($_[0]);
}
sub _canonical_got_warning {
my ($called_from, $msg) = @_;
my $warn_kind = $called_from eq 'Carp' ? 'carped' : 'warn';
my @warning_stack = split /\n/, $msg; # some stuff of uplevel is included
return {$warn_kind => $warning_stack[0]}; # return only the real message
}
sub _canonical_exp_warning {
my ($exp) = @_;
if (ref($exp) eq 'HASH') { # could be {carped => ...}
my $to_carp = $exp->{carped} or return; # undefined message are ignored
return (ref($to_carp) eq 'ARRAY') # is {carped => [ ..., ...] }
? map({ {carped => $_} } grep {defined $_} @$to_carp)
: +{carped => $to_carp};
}
return {warn => $exp};
}
sub _cmp_got_to_exp_warning {
my ($got_kind, $got_msg) = %{ shift() };
my ($exp_kind, $exp_msg) = %{ shift() };
return 0 if ($got_kind eq 'warn') && ($exp_kind eq 'carped');
my $cmp = $got_msg =~ /^\Q$exp_msg\E at .+ line \d+\.?$/;
return $cmp;
}
sub _cmp_got_to_exp_warning_like {
my ($got_kind, $got_msg) = %{ shift() };
my ($exp_kind, $exp_msg) = %{ shift() };
return 0 if ($got_kind eq 'warn') && ($exp_kind eq 'carped');
if (my $re = $Tester->maybe_regex($exp_msg)) { #qr// or '//'
my $cmp = $got_msg =~ /$re/;
return $cmp;
} else {
return Test::Warn::Categorization::warning_like_category($got_msg,$exp_msg);
}
}
sub _cmp_is {
my @got = @{ shift() };
my @exp = @{ shift() };
scalar @got == scalar @exp or return 0;
my $cmp = 1;
$cmp &&= _cmp_got_to_exp_warning($got[$_],$exp[$_]) for (0 .. $#got);
return $cmp;
}
sub _cmp_like {
my @got = @{ shift() };
my @exp = @{ shift() };
scalar @got == scalar @exp or return 0;
my $cmp = 1;
$cmp &&= _cmp_got_to_exp_warning_like($got[$_],$exp[$_]) for (0 .. $#got);
return $cmp;
}
sub _diag_found_warning {
foreach (@_) {
if (ref($_) eq 'HASH') {
${$_}{carped} ? $Tester->diag("found carped warning: ${$_}{carped}")
: $Tester->diag("found warning: ${$_}{warn}");
} else {
$Tester->diag( "found warning: $_" );
}
}
$Tester->diag( "didn't find a warning" ) unless @_;
}
sub _diag_exp_warning {
foreach (@_) {
if (ref($_) eq 'HASH') {
${$_}{carped} ? $Tester->diag("expected to find carped warning: ${$_}{carped}")
: $Tester->diag("expected to find warning: ${$_}{warn}");
} else {
$Tester->diag( "expected to find warning: $_" );
}
}
$Tester->diag( "didn't expect to find a warning" ) unless @_;
}
package Test::Warn::DAG_Node_Tree;
use strict;
use warnings;
use base 'Tree::DAG_Node';
sub nice_lol_to_tree {
my $class = shift;
$class->new(
{
name => shift(),
daughters => [_nice_lol_to_daughters(shift())]
});
}
sub _nice_lol_to_daughters {
my @names = @{ shift() };
my @daughters = ();
my $last_daughter = undef;
foreach (@names) {
if (ref($_) ne 'ARRAY') {
$last_daughter = Tree::DAG_Node->new({name => $_});
push @daughters, $last_daughter;
} else {
$last_daughter->add_daughters(_nice_lol_to_daughters($_));
}
}
return @daughters;
}
sub depthsearch {
my ($self, $search_name) = @_;
my $found_node = undef;
$self->walk_down({callback => sub {
my $node = shift();
$node->name eq $search_name and $found_node = $node,!"go on";
"go on with searching";
}});
return $found_node;
}
package Test::Warn::Categorization;
use Carp;
our $tree = Test::Warn::DAG_Node_Tree->nice_lol_to_tree(
all => [ 'closure',
'deprecated',
'exiting',
'glob',
'io' => [ 'closed',
'exec',
'layer',
'newline',
'pipe',
'unopened'
],
'misc',
'numeric',
'once',
'overflow',
'pack',
'portable',
'recursion',
'redefine',
'regexp',
'severe' => [ 'debugging',
'inplace',
'internal',
'malloc'
],
'signal',
'substr',
'syntax' => [ 'ambiguous',
'bareword',
'digit',
'parenthesis',
'precedence',
'printf',
'prototype',
'qw',
'reserved',
'semicolon'
],
'taint',
'threads',
'uninitialized',
'unpack',
'untie',
'utf8',
'void',
'y2k'
]
);
sub _warning_category_regexp {
my $sub_tree = $tree->depthsearch(shift()) or return;
my $re = join "|", map {$_->name} $sub_tree->leaves_under;
return qr/(?=\w)$re/;
}
sub warning_like_category {
my ($warning, $category) = @_;
my $re = _warning_category_regexp($category) or
carp("Unknown warning category '$category'"),return;
my $ok = $warning =~ /$re/;
return $ok;
}
1;
|