1 package Test::Valgrind;
8 Test::Valgrind - Test Perl code through valgrind.
16 our $VERSION = '1.00';
20 # From the command-line
21 perl -MTest::Valgrind leaky.pl
25 eval 'use Test::Valgrind';
26 plan skip_all => 'Test::Valgrind is required to test your distribution with valgrind' if $@;
29 # In all the test files of a directory
30 prove --exec 'perl -Iblib/lib -Iblib/arch -MTest::Valgrind' t/*.t
34 This module is a front-end to the C<Test::Valgrind::*> API that lets you run Perl code through the C<memcheck> tool of the C<valgrind> memory debugger, to test it for memory errors and leaks.
35 If they aren't available yet, it will first generate suppressions for the current C<perl> interpreter and store them in the portable flavour of F<~/.perl/Test-Valgrind/suppressions/$VERSION>.
36 The actual run will then take place, and tests will be passed or failed according to the result of the analysis.
38 Due to the nature of perl's memory allocator, this module can't track leaks of Perl objects.
39 This includes non-mortalized scalars and memory cycles. However, it can track leaks of chunks of memory allocated in XS extensions with C<Newx> and friends or C<malloc>.
40 As such, it's complementary to the other very good leak detectors listed in the L</SEE ALSO> section.
44 =head2 C<analyse [ %options ]>
46 Run a C<valgrind> analysis configured by C<%options> :
52 C<< command => $command >>
54 The L<Test::Valgrind::Command> object (or class name) to use.
56 Defaults to L<Test::Valgrind::Command::PerlScript>.
62 The L<Test::Valgrind::Tool> object (or class name) to use.
64 Defaults to L<Test::Valgrind::Tool::memcheck>.
68 C<< action => $action >>
70 The L<Test::Valgrind::Action> object (or class name) to use.
72 Defaults to L<Test::Valgrind::Action::Test>.
78 The file name of the script to analyse.
80 Ignored if you supply your own custom C<command>, but mandatory otherwise.
84 C<< callers => $number >>
86 Specify the maximum stack depth studied when valgrind encounters an error.
87 Raising this number improves granularity.
89 Ignored if you supply your own custom C<tool>, otherwise defaults to C<12>.
95 If true, print the output of the test script as diagnostics.
97 Ignored if you supply your own custom C<action>, otherwise defaults to false.
101 C<< extra_supps => \@files >>
103 Also use suppressions from C<@files> besides C<perl>'s.
109 C<< no_def_supp => $bool >>
111 If true, do not use the default suppression file.
124 my $instanceof = sub {
125 require Scalar::Util;
126 Scalar::Util::blessed($_[0]) && $_[0]->isa($_[1]);
129 my $cmd = delete $args{command};
130 unless ($cmd->$instanceof('Test::Valgrind::Command')) {
131 require Test::Valgrind::Command;
132 $cmd = Test::Valgrind::Command->new(
133 command => $cmd || 'PerlScript',
134 file => delete $args{file},
135 args => [ '-MTest::Valgrind=run,1' ],
139 my $tool = delete $args{tool};
140 unless ($tool->$instanceof('Test::Valgrind::Tool')) {
141 require Test::Valgrind::Tool;
142 $tool = Test::Valgrind::Tool->new(
143 tool => $tool || 'memcheck',
144 callers => delete $args{callers},
148 my $action = delete $args{action};
149 unless ($action->$instanceof('Test::Valgrind::Action')) {
150 require Test::Valgrind::Action;
151 $action = Test::Valgrind::Action->new(
152 action => $action || 'Test',
153 diag => delete $args{diag},
157 require Test::Valgrind::Session;
159 Test::Valgrind::Session->new(
160 min_version => $tool->requires_version,
161 map { $_ => delete $args{$_} } qw/extra_supps no_def_supp/
165 $action->abort($sess, $@);
166 return $action->status($sess);
177 require Test::Valgrind::Report;
178 $action->report($sess, Test::Valgrind::Report->new_diag($@));
181 my $status = $sess->status;
182 $status = 255 unless defined $status;
187 =head2 C<import [ %options ]>
189 In the parent process, L</import> calls L</analyse> with the arguments it received itself - except that if no C<file> option was supplied, it tries to pick the highest caller context that looks like a script.
190 When the analyse finishes, it exists with the status that was returned.
192 In the child process, it just C<return>s so that the calling code is actually run under C<valgrind>.
196 # We use as little modules as possible in run mode so that they don't pollute
197 # the analysis. Hence all the requires.
203 $class = ref($class) || $class;
207 Carp::croak('Optional arguments must be passed as key => value pairs');
211 if (defined delete $args{run} or $run) {
212 require Perl::Destruct::Level;
213 Perl::Destruct::Level::set_destruct_level(3);
215 my $oldfh = select STDOUT;
223 my $file = delete $args{file};
224 unless (defined $file) {
228 $next = (caller $l++)[1];
229 last unless defined $next;
230 next if $next eq '-e'
231 or $next =~ /^\s*\(\s*eval\s*\d*\s*\)\s*$/
233 if ($next =~ /\.pm$/) {
239 unless (defined($file) or defined($file = $pm)) {
240 require Test::Builder;
241 Test::Builder->new->diag('Couldn\'t find a valid source file');
246 exit $class->analyse(
253 if ($run and eval { require DynaLoader; 1 }) {
255 DynaLoader::dl_unload_file($_) or push @rest, $_ for @DynaLoader::dl_librefs;
256 @DynaLoader::dl_librefs = @rest;
262 You can't use this module to test code given by the C<-e> command-line switch.
264 Perl 5.8 is notorious for leaking like there's no tomorrow, so the suppressions are very likely not to be very accurate on it. Anyhow, results will most likely be better if your perl is built with debugging enabled. Using the latest C<valgrind> available will also help.
266 This module is not really secure. It's definitely not taint safe. That shouldn't be a problem for test files.
268 What your tests output to C<STDOUT> and C<STDERR> is eaten unless you pass the C<diag> option, in which case it will be reprinted as diagnostics.
272 Valgrind 3.1.0 (L<http://valgrind.org>).
274 L<XML::Twig>, L<version>, L<File::HomeDir>, L<Env::Sanctify>, L<Perl::Destruct::Level>.
278 All the C<Test::Valgrind::*> API, including L<Test::Valgrind::Command>, L<Test::Valgrind::Tool>, L<Test::Valgrind::Action> and L<Test::Valgrind::Session>.
282 L<Devel::Leak>, L<Devel::LeakTrace>, L<Devel::LeakTrace::Fast>.
286 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
288 You can contact me by mail or on C<irc.perl.org> (vincent).
292 Please report any bugs or feature requests to C<bug-test-valgrind at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Valgrind>.
293 I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
297 You can find documentation for this module with the perldoc command.
299 perldoc Test::Valgrind
301 =head1 ACKNOWLEDGEMENTS
303 Rafaƫl Garcia-Suarez, for writing and instructing me about the existence of L<Perl::Destruct::Level> (Elizabeth Mattijsen is a close second).
305 H.Merijn Brand, for daring to test this thing.
307 All you people that showed interest in this module, which motivated me into completely rewriting it.
309 =head1 COPYRIGHT & LICENSE
311 Copyright 2008-2009 Vincent Pit, all rights reserved.
313 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
317 1; # End of Test::Valgrind