=head1 VERSION
-Version 1.00
+Version 1.14
=cut
-our $VERSION = '1.00';
+our $VERSION = '1.14';
=head1 DESCRIPTION
=cut
-# All these modules are required at configure time.
+use File::Spec ();
+use Scalar::Util ();
-BEGIN {
- require File::Spec;
- require Scalar::Util;
-
- require Fcntl; # F_SETFD
- require POSIX; # SIGKILL
+use Fcntl (); # F_SETFD
+use POSIX (); # SIGKILL
- require version;
-}
+use version ();
-use base qw/Test::Valgrind::Carp/;
-
-use Test::Valgrind::Report;
+use base qw<Test::Valgrind::Carp>;
=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,
+ 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.
my %args = @_;
my @paths;
- my $vg = delete $args{vg};
+ my $vg = delete $args{valgrind};
if (defined $vg and not ref $vg) {
@paths = ($vg);
} else {
next unless -x;
my $ver = qx/$_ --version/;
if ($ver =~ /^valgrind-(\d+(\.\d+)*)/) {
- $version = version->new($1);
- next if $min_version and $version < $min_version;
+ if ($min_version) {
+ $version = version->new($1);
+ next if $version < $min_version;
+ } else {
+ $version = $1;
+ }
$valgrind = $_;
last;
}
@$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}),
+ 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
+
+sub version {
+ my ($self) = @_;
+
+ my $version = $self->{version};
+ $self->{version} = $version = version->new($version) unless ref $version;
+
+ 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.
=cut
-eval "sub $_ { \$_[0]->{$_} }" for qw/valgrind version no_def_supp/;
+eval "sub $_ { \$_[0]->{$_} }" for qw<valgrind regen_def_supp no_def_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>.
+If the command is a L<Test::Valgrind::Command::Aggregate> object, the action and the tool will be initialized once before running all the aggregated commands.
+
=cut
sub run {
my $self = shift;
- $self->start(@_);
- my $guard = bless sub { $self->finish } => 'Test::Valgrind::Session::Guard';
+ my %args = @_;
+
+ $self->start(%args);
+ my $guard = Test::Valgrind::Session::Guard->new(sub { $self->finish });
+
+ $self->_run($args{command});
+}
- $self->report(Test::Valgrind::Report->new_diag(
+sub _run {
+ my ($self, $cmd) = @_;
+
+ if ($cmd->isa('Test::Valgrind::Command::Aggregate')) {
+ $self->_run($_) for $cmd->commands;
+ return;
+ }
+
+ $self->command($cmd);
+
+ $self->report($self->report_class->new_diag(
'Using valgrind ' . $self->version . ' located at ' . $self->valgrind
));
my @supp_args;
if ($self->do_suppressions) {
push @supp_args, '--gen-suppressions=all';
- } else {
- my @supps;
- if (not $self->no_def_supp) {
- my $def_supp = $self->def_supp_file;
- if (defined $def_supp and not -e $def_supp) {
- $self->report(Test::Valgrind::Report->new_diag("Generating suppressions..."));
- 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(Test::Valgrind::Report->new_diag("Suppressions for this perl stored in $def_supp"));
- }
+ } elsif (not $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"
+ ));
+ }
+ for ($self->suppressions) {
+ next unless -e $_;
+ $self->report($self->report_class->new_diag("Using suppression file $_"));
+ push @supp_args, "--suppressions=$_";
}
- push @supp_args, '--suppressions=' . $_ for $self->suppressions;
}
pipe my $vrdr, my $vwtr or $self->_croak("pipe(\$vrdr, \$vwtr): $!");
my @args = (
$self->valgrind,
- '--log-fd=' . fileno($vwtr),
$self->tool->args($self),
@supp_args,
+ $self->parser->args($self, $vwtr),
$self->command->args($self),
);
-# $self->report(Test::Valgrind::Report->new_diag("@args"));
+# $self->report($self->report_class->new_diag("@args"));
exec { $args[0] } @args or $self->_croak("exec @args: $!");
}
close $vwtr or $self->_croak("close(\$vwtr): $!");
- $self->tool->parse($self, $vrdr);
+ $self->parser->parse($self, $vrdr);
$self->{exit_code} = (waitpid($pid, 0) == $pid) ? $? >> 8 : 255;
return;
}
-sub Test::Valgrind::Session::Guard::DESTROY { $_[0]->() }
+sub Test::Valgrind::Session::Guard::new { bless \($_[1]), $_[0] }
+
+sub Test::Valgrind::Session::Guard::DESTROY { ${$_[0]}->() }
=head2 C<action>
Read-only accessor for the C<tool> associated to the current run.
+=head2 C<parser>
+
+Read-only accessor for the C<parser> associated to the current tool.
+
=head2 C<command>
Read-only accessor for the C<command> associated to the current run.
my @members;
BEGIN {
- @members = qw/action tool command/;
+ @members = qw<action tool command parser>;
for (@members) {
eval "sub $_ { \@_ <= 1 ? \$_[0]->{$_} : (\$_[0]->{$_} = \$_[1]) }";
die if $@;
sub do_suppressions { $_[0]->action->do_suppressions }
+=head2 C<parser_class>
+
+Calls C<< ->tool->parser_class >> with the current session object as the unique argument.
+
+=cut
+
+sub parser_class { $_[0]->tool->parser_class($_[0]) }
+
=head2 C<report_class>
-Calls C<< ->action->report_class >> with the current session object as the sole argument.
+Calls C<< ->tool->report_class >> with the current session object as the unique argument.
=cut
=head2 C<def_supp_file>
Returns an absolute path to the default suppression file associated to the current session.
-C<undef> will be returned as soon as any of C<< ->tool->suppressions_tag >> or C<< ->tool->suppressions_tag >> are also C<undef>.
+
+C<undef> will be returned as soon as any of C<< ->command->suppressions_tag >> or C<< ->tool->suppressions_tag >> are also C<undef>.
Otherwise, the file part of the name is builded by joining those two together, and the directory part is roughly F<< File::HomeDir->my_home / .perl / Test-Valgrind / suppressions / $VERSION >>.
=cut
=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>.
my %args = @_;
- for (@members) {
+ for (qw<action tool command>) {
my $base = 'Test::Valgrind::' . ucfirst;
my $value = $args{$_};
$self->_croak("Invalid $_") unless Scalar::Util::blessed($value)
$self->$_($args{$_})
}
- delete @{$self}{qw/last_status exit_code/};
+ delete @{$self}{qw<last_status exit_code>};
$self->tool->start($self);
+ $self->parser($self->parser_class->new)->start($self);
$self->action->start($self);
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.
sub abort {
my $self = shift;
+
$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.
=cut
sub report {
- my $self = shift;
- $self->action->report($self, @_);
+ my ($self, $report) = @_;
+
+ return unless defined $report;
+
+ for my $handler (qw<tool command>) {
+ $report = $self->$handler->filter($self, $report);
+ return unless defined $report;
+ }
+
+ $self->action->report($self, $report);
}
=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>.
my ($self) = @_;
my $action = $self->action;
+
$action->finish($self);
+ $self->parser->finish($self);
$self->tool->finish($self);
my $status = $action->status($self);
=head2 C<status>
+ my $status = $tvs->status;
+
Returns the status code of the last run of the session.
=cut
=head1 SEE ALSO
-L<Test::Valgrind>, L<Test::Valgrind::Action>, L<Test::Valgrind::Tool>, L<Test::Valgrind::Command>.
+L<Test::Valgrind>, L<Test::Valgrind::Action>, L<Test::Valgrind::Command>, L<Test::Valgrind::Tool>, L<Test::Valgrind::Parser>.
L<version>, L<File::HomeDir>.
=head1 COPYRIGHT & LICENSE
-Copyright 2009 Vincent Pit, all rights reserved.
+Copyright 2009,2010,2011,2013 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