=head1 VERSION
-Version 1.13
+Version 1.15
=cut
-our $VERSION = '1.13';
+our $VERSION = '1.15';
=head1 DESCRIPTION
=head1 METHODS
-=head2 C<< new search_dirs => \@search_dirs, valgrind => [ $valgrind | \@valgrind ], min_version => $min_version, no_def_supp => $no_def_supp, extra_supps => \@extra_supps >>
+=head2 C<new>
+
+ my $tvs = Test::Valgrind::Session->new(
+ search_dirs => \@search_dirs,
+ valgrind => $valgrind, # One candidate
+ valgrind => \@valgrind, # Several candidates
+ min_version => $min_version,
+ regen_def_supp => $regen_def_supp,
+ no_def_supp => $no_def_supp,
+ allow_no_supp => $allow_no_supp,
+ extra_supps => \@extra_supps,
+ );
The package constructor, which takes several options :
=item *
-If C<$no_def_supp> is false, C<valgrind> won't read the default suppression file associated with the tool and the command.
+If C<$regen_def_supp> is true, the default suppression file associated with the tool and the command will be forcefully regenerated.
+
+Defaults to false.
+
+=item *
+
+If C<$no_def_supp> is true, C<valgrind> won't read the default suppression file associated with the tool and the command.
+
+Defaults to false.
+
+=item *
+
+If C<$allow_no_supp> is true, the command will always be run into C<valgrind> even if no appropriate suppression file is available.
Defaults to false.
@$extra_supps = grep { defined && -f $_ && -r _ } @$extra_supps;
bless {
- valgrind => $valgrind,
- version => $version,
- no_def_supp => delete($args{no_def_supp}),
- extra_supps => $extra_supps,
+ valgrind => $valgrind,
+ version => $version,
+ regen_def_supp => delete($args{regen_def_supp}),
+ no_def_supp => delete($args{no_def_supp}),
+ allow_no_supp => delete($args{allow_no_supp}),
+ extra_supps => $extra_supps,
}, $class;
}
=head2 C<valgrind>
+ my $valgrind_path = $tvs->valgrind;
+
The path to the selected C<valgrind> executable.
=head2 C<version>
+ my $valgrind_version = $tvs->version;
+
The L<version> object associated to the selected C<valgrind>.
=cut
return $version;
}
+=head2 C<regen_def_supp>
+
+ my $regen_def_supp = $tvs->regen_def_supp;
+
+Read-only accessor for the C<regen_def_supp> option.
+
+=cut
+
=head2 C<no_def_supp>
+ my $no_def_supp = $tvs->no_def_supp;
+
Read-only accessor for the C<no_def_supp> option.
+=head2 C<allow_no_supp>
+
+ my $allow_no_supp = $tvs->allow_no_supp;
+
+Read-only accessor for the C<allow_no_supp> option.
+
=cut
-eval "sub $_ { \$_[0]->{$_} }" for qw<valgrind no_def_supp>;
+eval "sub $_ { \$_[0]->{$_} }" for qw<
+ valgrind
+ regen_def_supp
+ no_def_supp
+ allow_no_supp
+>;
=head2 C<extra_supps>
+ my @extra_supps = $tvs->extra_supps;
+
Read-only accessor for the C<extra_supps> option.
=cut
sub extra_supps { @{$_[0]->{extra_supps} || []} }
-=head2 C<< run action => $action, tool => $tool, command => $command >>
+=head2 C<run>
+
+ $tvs->run(
+ action => $action,
+ tool => $tool,
+ command => $command,
+ );
Runs the command C<$command> through C<valgrind> with the tool C<$tool>, which will report to the action C<$action>.
my @supp_args;
if ($self->do_suppressions) {
push @supp_args, '--gen-suppressions=all';
- } elsif (not $self->no_def_supp) {
- my $def_supp = $self->def_supp_file;
- if (defined $def_supp and not -e $def_supp) {
+ } else {
+ if (!$self->no_def_supp) {
+ my $def_supp = $self->def_supp_file;
+ my $forced;
+ if ($self->regen_def_supp and -e $def_supp) {
+ 1 while unlink $def_supp;
+ $forced = 1;
+ }
+ if (defined $def_supp and not -e $def_supp) {
+ $self->report($self->report_class->new_diag(
+ 'Generating suppressions' . ($forced ? ' (forced)' : '') . '...'
+ ));
+ require Test::Valgrind::Suppressions;
+ Test::Valgrind::Suppressions->generate(
+ tool => $self->tool,
+ command => $self->command,
+ target => $def_supp,
+ );
+ $self->_croak('Couldn\'t generate suppressions') unless -e $def_supp;
+ $self->report($self->report_class->new_diag(
+ "Suppressions for this perl stored in $def_supp"
+ ));
+ }
+ }
+ my @supp_files = grep {
+ -e $_ and $self->command->check_suppressions_file($_)
+ } $self->suppressions;
+ if (@supp_files > 1) {
+ my $files_list = join "\n", map " $_", @supp_files;
$self->report($self->report_class->new_diag(
- "Generating suppressions..."
+ "Using suppressions from:\n$files_list"
));
- require Test::Valgrind::Suppressions;
- Test::Valgrind::Suppressions->generate(
- tool => $self->tool,
- command => $self->command,
- target => $def_supp,
- );
- $self->_croak('Couldn\'t generate suppressions') unless -e $def_supp;
+ } elsif (@supp_files) {
$self->report($self->report_class->new_diag(
- "Suppressions for this perl stored in $def_supp"
+ "Using suppressions from $supp_files[0]"
));
+ } elsif ($self->allow_no_supp) {
+ $self->report($self->report_class->new_diag("No suppressions used"));
+ } else {
+ $self->_croak("No compatible suppressions available");
}
- for ($self->suppressions) {
- next unless -e $_;
- $self->report($self->report_class->new_diag("Using suppression file $_"));
- push @supp_args, "--suppressions=$_";
- }
+ @supp_args = map "--suppressions=$_", @supp_files;
}
pipe my $vrdr, my $vwtr or $self->_croak("pipe(\$vrdr, \$vwtr): $!");
=head2 C<suppressions>
+ my @suppressions = $tvs->suppressions;
+
Returns the list of all the suppressions that will be passed to C<valgrind>.
Honors L</no_def_supp> and L</extra_supps>.
=head2 C<start>
+ $tvs->start(
+ action => $action,
+ tool => $tool,
+ command => $command,
+ );
+
Starts the action and tool associated to the current run.
It's automatically called at the beginning of L</run>.
return;
}
-=head2 C<abort $msg>
+=head2 C<abort>
+
+ $tvs->abort($msg);
Forwards to C<< ->action->abort >> after unshifting the session object to the argument list.
$self->action->abort($self, @_);
}
-=head2 C<report $report>
+=head2 C<report>
+
+ $tvs->report($report);
Forwards to C<< ->action->report >> after unshifting the session object to the argument list.
=head2 C<finish>
+ $tvs->finish;
+
Finishes the action and tool associated to the current run.
It's automatically called at the end of L</run>.
=head2 C<status>
+ my $status = $tvs->status;
+
Returns the status code of the last run of the session.
=cut
=head1 COPYRIGHT & LICENSE
-Copyright 2009,2010,2011 Vincent Pit, all rights reserved.
+Copyright 2009,2010,2011,2013,2015 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.
projects / perl / modules / Test-Valgrind.git / blobdiff