X-Git-Url: http://git.vpit.fr/?p=perl%2Fmodules%2FTest-Valgrind.git;a=blobdiff_plain;f=README;h=c032c3013c5ce8f477ab53186a87a1eddfe7ac8c;hp=acbd863cb62d0428c47f1f438205bdac9cd089a0;hb=a3ad5e451c03ec48ca43d1d2f7761c07490b9d65;hpb=41a4b907f4846f2d35b170f517fb83ceb13f298c diff --git a/README b/README index acbd863..c032c30 100644 --- a/README +++ b/README @@ -1,65 +1,151 @@ NAME - Test::Valgrind - Test your code through valgrind. + Test::Valgrind - Generate suppressions, analyse and test any command + with valgrind. VERSION - Version 0.01 + Version 1.11 SYNOPSIS + # From the command-line + perl -MTest::Valgrind leaky.pl + + # From the command-line, snippet style + perl -MTest::Valgrind -e 'leaky()' + + # In a test file use Test::More; eval 'use Test::Valgrind'; - plan skip_all => 'Test::Valgrind is required to test your distribution with valgrind'; + plan skip_all => 'Test::Valgrind is required to test your distribution with valgrind' if $@; + leaky(); - # Code to inspect for memory leaks/errors. + # In all the test files of a directory + prove --exec 'perl -Iblib/lib -Iblib/arch -MTest::Valgrind' t/*.t DESCRIPTION - This module lets you run some code through the valgrind memory debugger, - to test it for memory errors and leaks. Just add "use Test::Valgrind" at - the beginning of the code you want to test. Behind the hood, - "Test::Valgrind::import" forks so that the child can basically "exec - 'valgrind', $^X, $0" (except that of course $0 isn't right there). The - parent then parses the report output by valgrind and pass or fail tests - accordingly. + This module is a front-end to the "Test::Valgrind::*" API that lets you + run Perl code through the "memcheck" tool of the "valgrind" memory + debugger, to test it for memory errors and leaks. If they aren't + available yet, it will first generate suppressions for the current + "perl" interpreter and store them in the portable flavour of + ~/.perl/Test-Valgrind/suppressions/$VERSION. The actual run will then + take place, and tests will be passed or failed according to the result + of the analysis. + + The complete API is much more versatile than this. It allows you to run + *any* executable under valgrind, generate the corresponding suppressions + and convert the analysis output to TAP so that it can be incorporated + into your project's testsuite. + + Due to the nature of perl's memory allocator, this module can't track + leaks of Perl objects. This includes non-mortalized scalars and memory + cycles. However, it can track leaks of chunks of memory allocated in XS + extensions with "Newx" and friends or "malloc". As such, it's + complementary to the other very good leak detectors listed in the "SEE + ALSO" section. + +METHODS + "analyse [ %options ]" + Run a "valgrind" analysis configured by %options : + + * "command => $command" + + The Test::Valgrind::Command object (or class name) to use. + + Defaults to Test::Valgrind::Command::PerlScript. + + * "tool => $tool" -CONFIGURATION - You can pass parameters to "import" as a list of key / value pairs, - where valid keys are : + The Test::Valgrind::Tool object (or class name) to use. - "supp => $file" - Also use suppressions from $file besides perl's. + Defaults to Test::Valgrind::Tool::memcheck. - "no_supp => $bool" - If true, do not use any suppressions. + * "action => $action" + + The Test::Valgrind::Action object (or class name) to use. + + Defaults to Test::Valgrind::Action::Test. + + * "file => $file" + + The file name of the script to analyse. + + Ignored if you supply your own custom "command", but mandatory + otherwise. + + * "callers => $number" - "callers => $number" Specify the maximum stack depth studied when valgrind encounters an - error. Raising this number improves granularity. Default is 50. + error. Raising this number improves granularity. + + Ignored if you supply your own custom "tool", otherwise defaults to + 12. + + * "diag => $bool" - "extra => [ @args ]" - Add @args to valgrind parameters. + If true, print the output of the test script as diagnostics. - "diag => $bool" - If true, print the raw output of valgrind as diagnostics (may be - quite verbose). + Ignored if you supply your own custom "action", otherwise defaults + to false. - "no_test => $bool" - If true, do not actually output the plan and the tests results. + * "extra_supps => \@files" + + Also use suppressions from @files besides "perl"'s. + + Defaults to empty. + + * "no_def_supp => $bool" + + If true, do not use the default suppression file. + + Defaults to false. + + "import [ %options ]" + In the parent process, "import" calls "analyse" with the arguments it + received itself - except that if no "file" option was supplied, it tries + to pick the first caller context that looks like a script. When the + analyse ends, it exits with the status that was returned. + + In the child process, it just "return"s so that the calling code is + actually run under "valgrind". + +VARIABLES + $dl_unload + When set to true, all dynamic extensions that were loaded during the + analysis will be unloaded at "END" time by "dl_unload_file" in + DynaLoader. + + Since this obfuscates error stack traces, it's disabled by default. CAVEATS - You can't use this module to test code given by the "-e" command-line - switch. This module is not really secure. It's definitely not taint - safe. That shouldn't be a problem for test files. If your tests output - to STDERR, everything will be eaten in the process. + 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 "valgrind" available will also help. + + This module is not really secure. It's definitely not taint safe. That + shouldn't be a problem for test files. + + What your tests output to "STDOUT" and "STDERR" is eaten unless you pass + the "diag" option, in which case it will be reprinted as diagnostics. DEPENDENCIES - Valgrind 3.1.0 (). + XML::Twig, version, File::HomeDir, Env::Sanctify, Perl::Destruct::Level. + +SEE ALSO + All the "Test::Valgrind::*" API, including Test::Valgrind::Command, + Test::Valgrind::Tool, Test::Valgrind::Action and + Test::Valgrind::Session. + + The valgrind(1) man page. - Carp, POSIX (core modules since perl 5) and Test::More (since 5.6.2). + Test::LeakTrace. + + Devel::Leak, Devel::LeakTrace, Devel::LeakTrace::Fast. AUTHOR Vincent Pit, "", . - You can contact me by mail or on #perl @ FreeNode (vincent or - Prof_Vince). + You can contact me by mail or on "irc.perl.org" (vincent). BUGS Please report any bugs or feature requests to "bug-test-valgrind at @@ -73,8 +159,18 @@ SUPPORT perldoc Test::Valgrind +ACKNOWLEDGEMENTS + Rafaël Garcia-Suarez, for writing and instructing me about the + existence of Perl::Destruct::Level (Elizabeth Mattijsen is a close + second). + + H.Merijn Brand, for daring to test this thing. + + All you people that showed interest in this module, which motivated me + into completely rewriting it. + COPYRIGHT & LICENSE - Copyright 2008 Vincent Pit, all rights reserved. + Copyright 2008-2009 Vincent Pit, all rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.