/usr/share/perl5/Test/NoWarnings.pm is in libtest-nowarnings-perl 1.04-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 | package Test::NoWarnings;
use 5.006;
use strict;
use warnings;
use Carp ();
use Exporter ();
use Test::Builder ();
use Test::NoWarnings::Warning ();
use vars qw( $VERSION @EXPORT_OK @ISA $do_end_test );
BEGIN {
$VERSION = '1.04';
@ISA = 'Exporter';
@EXPORT_OK = qw(
clear_warnings
had_no_warnings
warnings
);
# Do we add the warning test at the end?
$do_end_test = 0;
}
my $TEST = Test::Builder->new;
my $PID = $$;
my @WARNINGS = ();
my $EARLY = 0;
$SIG{__WARN__} = make_catcher(\@WARNINGS);
sub import {
$do_end_test = 1;
if ( grep { $_ eq ':early' } @_ ) {
@_ = grep { $_ ne ':early' } @_;
$EARLY = 1;
}
goto &Exporter::import;
}
# the END block must be after the "use Test::Builder" to make sure it runs
# before Test::Builder's end block
# only run the test if there have been other tests
END {
had_no_warnings() if $do_end_test;
}
sub make_warning {
local $SIG{__WARN__};
my $msg = shift;
my $warning = Test::NoWarnings::Warning->new;
$warning->setMessage($msg);
$warning->fillTest($TEST);
$warning->fillTrace(__PACKAGE__);
$Carp::Internal{__PACKAGE__.""}++;
local $Carp::CarpLevel = $Carp::CarpLevel + 1;
$warning->fillCarp($msg);
$Carp::Internal{__PACKAGE__.""}--;
return $warning;
}
# this make a subroutine which can be used in $SIG{__WARN__}
# it takes one argument, a ref to an array
# it will push the details of the warning onto the end of the array.
sub make_catcher {
my $array = shift;
return sub {
my $msg = shift;
# Generate the warning
$Carp::Internal{__PACKAGE__.""}++;
push(@$array, make_warning($msg));
$Carp::Internal{__PACKAGE__.""}--;
# Show the diag early rather than at the end
if ( $EARLY ) {
$TEST->diag( $array->[-1]->toString );
}
return $msg;
};
}
sub had_no_warnings {
return 0 if $$ != $PID;
local $SIG{__WARN__};
my $name = shift || "no warnings";
my $ok;
my $diag;
if ( @WARNINGS == 0 ) {
$ok = 1;
} else {
$ok = 0;
$diag = "There were " . scalar(@WARNINGS) . " warning(s)\n";
unless ( $EARLY ) {
$diag .= join "----------\n", map { $_->toString } @WARNINGS;
}
}
$TEST->ok($ok, $name) || $TEST->diag($diag);
return $ok;
}
sub clear_warnings {
local $SIG{__WARN__};
@WARNINGS = ();
}
sub warnings {
local $SIG{__WARN__};
return @WARNINGS;
}
sub builder {
local $SIG{__WARN__};
if ( @_ ) {
$TEST = shift;
}
return $TEST;
}
1;
__END__
=pod
=head1 NAME
Test::NoWarnings - Make sure you didn't emit any warnings while testing
=head1 SYNOPSIS
For scripts that have no plan
use Test::NoWarnings;
that's it, you don't need to do anything else
For scripts that look like
use Test::More tests => x;
change to
use Test::More tests => x + 1;
use Test::NoWarnings;
=head1 DESCRIPTION
In general, your tests shouldn't produce warnings. This modules causes any
warnings to be captured and stored. It automatically adds an extra test that
will run when your script ends to check that there were no warnings. If
there were any warings, the test will give a "not ok" and diagnostics of
where, when and what the warning was, including a stack trace of what was
going on when the it occurred.
If some of your tests B<are supposed to> produce warnings then you should be
capturing and checking them with L<Test::Warn>, that way L<Test::NoWarnings>
will not see them and so not complain.
The test is run by an C<END> block in Test::NoWarnings. It will not be run
when any forked children exit.
=head1 USAGE
Simply by using the module, you automatically get an extra test at the end
of your script that checks that no warnings were emitted. So just stick
use Test::NoWarnings;
at the top of your script and continue as normal.
If you want more control you can invoke the test manually at any time with
C<had_no_warnings>.
The warnings your test has generated so far are stored in an array. You can
look inside and clear this whenever you want with C<warnings()> and
C<clear_warnings>, however, if you are doing this sort of thing then you
probably want to use L<Test::Warn> in combination with L<Test::NoWarnings>.
=head2 use vs require
You will almost always want to do
use Test::NoWarnings
If you do a C<require> rather than a C<use>, then there will be no automatic
test at the end of your script.
=head2 Output
If warning is captured during your test then the details will output as part
of the diagnostics. You will get:
=over 2
=item o
the number and name of the test that was executed just before the warning
(if no test had been executed these will be 0 and '')
=item o
the message passed to C<warn>,
=item o
a full dump of the stack when warn was called, courtesy of the C<Carp>
module
=back
By default, all warning messages will be emitted in one block at the end of
your test script.
=head2 The :early pragma
One common complaint from people using Test::NoWarnings is that all of the
warnings are emitted in one go at the end. While this is the safest and
most correct time to emit these diagnostics, it can make debugging these
warnings difficult.
As of Test::NoWarnings 1.04 you can provide an experimental C<:early> pragma
when loading the module to force warnings to be thrown via diag at the time
that they actually occur.
use Test::NoWarnings ':early';
As this will cause the diag to be emitted against the previous test and not
the one in which the warning actually occurred it is recommended that the
pragma be turned on only for debugging and left off when not needed.
=head1 FUNCTIONS
=head2 had_no_warnings
This checks that there have been warnings emitted by your test scripts.
Usually you will not call this explicitly as it is called automatically when
your script finishes.
=head2 clear_warnings
This will clear the array of warnings that have been captured. If the array
is empty then a call to C<had_no_warnings()> will produce a pass result.
=head2 warnings
This will return the array of warnings captured so far. Each element of this
array is an object containing information about the warning. The following
methods are available on these object.
=over 2
=item *
$warn-E<gt>getMessage
Get the message that would been printed by the warning.
=item *
$warn-E<gt>getCarp
Get a stack trace of what was going on when the warning happened, this stack
trace is just a string generated by the L<Carp> module.
=item *
$warn-E<gt>getTrace
Get a stack trace object generated by the L<Devel::StackTrace> module. This
will return undef if L<Devel::StackTrace> is not installed.
=item *
$warn-E<gt>getTest
Get the number of the test that executed before the warning was emitted.
=item *
$warn-E<gt>getTestName
Get the name of the test that executed before the warning was emitted.
=back
=head1 PITFALLS
When counting your tests for the plan, don't forget to include the test that
runs automatically when your script ends.
=head1 SUPPORT
Bugs should be reported via the CPAN bug tracker at
L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-NoWarnings>
For other issues, contact the author.
=head1 HISTORY
This was previously known as L<Test::Warn::None>
=head1 SEE ALSO
L<Test::Builder>, L<Test::Warn>
=head1 AUTHORS
Fergal Daly E<lt>fergal@esatclear.ieE<gt>
Adam Kennedy E<lt>adamk@cpan.orgE<gt>
=head1 COPYRIGHT
Copyright 2003 - 2007 Fergal Daly.
Some parts copyright 2010 - 2011 Adam Kennedy.
This program is free software and comes with no warranty. It is distributed
under the LGPL license
See the file F<LGPL> included in this distribution or
F<http://www.fsf.org/licenses/licenses.html>.
=cut
|