README

   1 NAME
   2     Test::Valgrind - Test Perl code through valgrind.
   3
   4 VERSION
   5     Version 0.07
   6
   7 SYNOPSIS
   8         use Test::More;
   9         eval 'use Test::Valgrind';
  10         plan skip_all => 'Test::Valgrind is required to test your distribution with valgrind' if $@;
  11
  12         # Code to inspect for memory leaks/errors.
  13
  14 DESCRIPTION
  15     This module lets you run some code through the valgrind memory debugger,
  16     to test it for memory errors and leaks. Just add "use Test::Valgrind" at
  17     the beginning of the code you want to test. Behind the hood,
  18     "Test::Valgrind::import" forks so that the child can basically "exec
  19     'valgrind', $^X, $0" (except that of course $0 isn't right there). The
  20     parent then parses the report output by valgrind and pass or fail tests
  21     accordingly.
  22
  23     You can also use it from the command-line to test a given script :
  24
  25         perl -MTest::Valgrind leaky.pl
  26
  27     Due to the nature of perl's memory allocator, this module can't track
  28     leaks of Perl objects. This includes non-mortalized scalars and memory
  29     cycles. However, it can track leaks of chunks of memory allocated in XS
  30     extensions with "Newx" and friends or "malloc". As such, it's
  31     complementary to the other very good leak detectors listed in the "SEE
  32     ALSO" section.
  33
  34 CONFIGURATION
  35     You can pass parameters to "import" as a list of key / value pairs,
  36     where valid keys are :
  37
  38     *   "supp => $file"
  39
  40         Also use suppressions from $file besides perl's.
  41
  42     *   "no_supp => $bool"
  43
  44         If true, do not use any suppressions.
  45
  46     *   "callers => $number"
  47
  48         Specify the maximum stack depth studied when valgrind encounters an
  49         error. Raising this number improves granularity. Default is 12.
  50
  51     *   "extra => [ @args ]"
  52
  53         Add @args to valgrind parameters.
  54
  55     *   "diag => $bool"
  56
  57         If true, print the raw output of valgrind as diagnostics (may be
  58         quite verbose).
  59
  60     *   "no_test => $bool"
  61
  62         If true, do not actually output the plan and the tests results.
  63
  64     *   "cb => sub { my ($val, $name) = @_; ...; return $passed }"
  65
  66         Specifies a subroutine to execute for each test instead of
  67         "Test::More::is". It receives the number of bytes leaked in $_[0]
  68         and the test name in $_[1], and is expected to return true if the
  69         test passed and false otherwise. Defaults to
  70
  71             sub {
  72              is($_[0], 0, $_[1]);
  73              (defined $_[0] and $_[0] == 0) : 1 : 0
  74             }
  75
  76 CAVEATS
  77     You can't use this module to test code given by the "-e" command-line
  78     switch.
  79
  80     Perl 5.8 is notorious for leaking like there's no tomorrow, so the
  81     suppressions are very likely not to be very accurate on it. Anyhow,
  82     results will most likely be better if your perl is built with debugging
  83     enabled. Using the latest valgrind available will also help.
  84
  85     This module is not really secure. It's definitely not taint safe. That
  86     shouldn't be a problem for test files.
  87
  88     What your tests output to STDOUT is eaten unless you pass the "diag"
  89     option, in which case it will be reprinted as diagnostics. STDERR is
  90     kept untouched.
  91
  92 DEPENDENCIES
  93     Valgrind 3.1.0 (<http://valgrind.org>).
  94
  95     Carp, Fcntl, POSIX (core modules since perl 5) and Test::Builder (since
  96     5.6.2).
  97
  98     Perl::Destruct::Level.
  99
 100 SEE ALSO
 101     Devel::Leak, Devel::LeakTrace, Devel::LeakTrace::Fast.
 102
 103 AUTHOR
 104     Vincent Pit, "<perl at profvince.com>", <http://www.profvince.com>.
 105
 106     You can contact me by mail or on #perl @ FreeNode (vincent or
 107     Prof_Vince).
 108
 109 BUGS
 110     Please report any bugs or feature requests to "bug-test-valgrind at
 111     rt.cpan.org", or through the web interface at
 112     <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Valgrind>. I will
 113     be notified, and then you'll automatically be notified of progress on
 114     your bug as I make changes.
 115
 116 SUPPORT
 117     You can find documentation for this module with the perldoc command.
 118
 119         perldoc Test::Valgrind
 120
 121 ACKNOWLEDGEMENTS
 122     Rafaël Garcia-Suarez, for writing and instructing me about the
 123     existence of Perl::Destruct::Level (Elizabeth Mattijsen is a close
 124     second).
 125
 126     H.Merijn Brand, for daring to test this thing.
 127
 128 COPYRIGHT & LICENSE
 129     Copyright 2008 Vincent Pit, all rights reserved.
 130
 131     This program is free software; you can redistribute it and/or modify it
 132     under the same terms as Perl itself.
 133