README

   1 NAME
   2     Test::Valgrind - Test Perl code through valgrind.
   3
   4 VERSION
   5     Version 0.03
   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 CONFIGURATION
  28     You can pass parameters to "import" as a list of key / value pairs,
  29     where valid keys are :
  30
  31     "supp => $file"
  32         Also use suppressions from $file besides perl's.
  33
  34     "no_supp => $bool"
  35         If true, do not use any suppressions.
  36
  37     "callers => $number"
  38         Specify the maximum stack depth studied when valgrind encounters an
  39         error. Raising this number improves granularity. Default is 50.
  40
  41     "extra => [ @args ]"
  42         Add @args to valgrind parameters.
  43
  44     "diag => $bool"
  45         If true, print the raw output of valgrind as diagnostics (may be
  46         quite verbose).
  47
  48     "no_test => $bool"
  49         If true, do not actually output the plan and the tests results.
  50
  51 CAVEATS
  52     You can't use this module to test code given by the "-e" command-line
  53     switch.
  54
  55     Results will most likely be better if your perl is built with debugging
  56     enabled. Using the latest valgrind available will also help.
  57
  58     This module is not really secure. It's definitely not taint safe. That
  59     shouldn't be a problem for test files.
  60
  61     If your tests output to STDERR, everything will be eaten in the process.
  62     In particular, running this module against test files will obliterate
  63     their original test results.
  64
  65 DEPENDENCIES
  66     Valgrind 3.1.0 (<http://valgrind.org>).
  67
  68     Carp, POSIX (core modules since perl 5) and Test::More (since 5.6.2).
  69
  70     Perl::Destruct::Level.
  71
  72 AUTHOR
  73     Vincent Pit, "<perl at profvince.com>", <http://www.profvince.com>.
  74
  75     You can contact me by mail or on #perl @ FreeNode (vincent or
  76     Prof_Vince).
  77
  78 BUGS
  79     Please report any bugs or feature requests to "bug-test-valgrind at
  80     rt.cpan.org", or through the web interface at
  81     <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Valgrind>. I will
  82     be notified, and then you'll automatically be notified of progress on
  83     your bug as I make changes.
  84
  85 SUPPORT
  86     You can find documentation for this module with the perldoc command.
  87
  88         perldoc Test::Valgrind
  89
  90 ACKNOWLEDGEMENTS
  91     Rafaël Garcia-Suarez, for writing and instructing me about the
  92     existence of Perl::Destruct::Level (Elizabeth Mattijsen is a close
  93     second).
  94
  95     H.Merijn Brand, for daring to test this thing.
  96
  97 COPYRIGHT & LICENSE
  98     Copyright 2008 Vincent Pit, all rights reserved.
  99
 100     This program is free software; you can redistribute it and/or modify it
 101     under the same terms as Perl itself.
 102