1 package Test::Valgrind::Session;
8 Test::Valgrind::Session - Test::Valgrind session object.
16 our $VERSION = '1.13';
20 This class supervises the execution of the C<valgrind> process.
21 It also acts as a dispatcher between the different components.
28 use Fcntl (); # F_SETFD
29 use POSIX (); # SIGKILL
33 use base qw<Test::Valgrind::Carp>;
39 my $tvs = Test::Valgrind::Session->new(
40 search_dirs => \@search_dirs,
41 valgrind => $valgrind, # One candidate
42 valgrind => \@valgrind, # Several candidates
43 min_version => $min_version,
44 no_def_supp => $no_def_supp,
45 extra_supps => \@extra_supps,
48 The package constructor, which takes several options :
54 All the directories from C<@search_dirs> will have F<valgrind> appended to create a list of candidates for the C<valgrind> executable.
56 Defaults to the current C<PATH> environment variable.
60 If a simple scalar C<$valgrind> is passed as the value to C<'valgrind'>, it will be the only candidate.
61 C<@search_dirs> will then be ignored.
63 If an array refernce C<\@valgrind> is passed, its values will be I<prepended> to the list of the candidates resulting from C<@search_dirs>.
67 C<$min_version> specifies the minimal C<valgrind> version required.
68 The constructor will croak if it's not able to find an adequate C<valgrind> from the supplied candidates list and search path.
74 If C<$no_def_supp> is false, C<valgrind> won't read the default suppression file associated with the tool and the command.
80 C<$extra_supps> is a reference to an array of optional suppression files that will be passed to C<valgrind>.
90 $class = ref($class) || $class;
95 my $vg = delete $args{valgrind};
96 if (defined $vg and not ref $vg) {
99 push @paths, @$vg if $vg and ref $vg eq 'ARRAY';
100 my $dirs = delete $args{search_dirs};
101 $dirs = [ File::Spec->path ] unless $dirs;
102 push @paths, map File::Spec->catfile($_, 'valgrind'), @$dirs
103 if ref $dirs eq 'ARRAY';
105 $class->_croak('Empty valgrind candidates list') unless @paths;
107 my $min_version = delete $args{min_version};
108 defined and not ref and $_ = version->new($_) for $min_version;
110 my ($valgrind, $version);
113 my $ver = qx/$_ --version/;
114 if ($ver =~ /^valgrind-(\d+(\.\d+)*)/) {
116 $version = version->new($1);
117 next if $version < $min_version;
125 $class->_croak('No appropriate valgrind executable could be found')
126 unless defined $valgrind;
128 my $extra_supps = delete $args{extra_supps};
129 $extra_supps = [ ] unless $extra_supps and ref $extra_supps eq 'ARRAY';
130 @$extra_supps = grep { defined && -f $_ && -r _ } @$extra_supps;
133 valgrind => $valgrind,
135 no_def_supp => delete($args{no_def_supp}),
136 extra_supps => $extra_supps,
142 my $valgrind_path = $tvs->valgrind;
144 The path to the selected C<valgrind> executable.
148 my $valgrind_version = $tvs->version;
150 The L<version> object associated to the selected C<valgrind>.
157 my $version = $self->{version};
158 $self->{version} = $version = version->new($version) unless ref $version;
163 =head2 C<no_def_supp>
165 my $no_def_supp = $tvs->no_def_supp;
167 Read-only accessor for the C<no_def_supp> option.
171 eval "sub $_ { \$_[0]->{$_} }" for qw<valgrind no_def_supp>;
173 =head2 C<extra_supps>
175 my @extra_supps = $tvs->extra_supps;
177 Read-only accessor for the C<extra_supps> option.
181 sub extra_supps { @{$_[0]->{extra_supps} || []} }
191 Runs the command C<$command> through C<valgrind> with the tool C<$tool>, which will report to the action C<$action>.
193 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.
203 my $guard = Test::Valgrind::Session::Guard->new(sub { $self->finish });
205 $self->_run($args{command});
209 my ($self, $cmd) = @_;
211 if ($cmd->isa('Test::Valgrind::Command::Aggregate')) {
212 $self->_run($_) for $cmd->commands;
216 $self->command($cmd);
218 $self->report($self->report_class->new_diag(
219 'Using valgrind ' . $self->version . ' located at ' . $self->valgrind
222 my $env = $self->command->env($self);
225 if ($self->do_suppressions) {
226 push @supp_args, '--gen-suppressions=all';
227 } elsif (not $self->no_def_supp) {
228 my $def_supp = $self->def_supp_file;
229 if (defined $def_supp and not -e $def_supp) {
230 $self->report($self->report_class->new_diag(
231 "Generating suppressions..."
233 require Test::Valgrind::Suppressions;
234 Test::Valgrind::Suppressions->generate(
236 command => $self->command,
239 $self->_croak('Couldn\'t generate suppressions') unless -e $def_supp;
240 $self->report($self->report_class->new_diag(
241 "Suppressions for this perl stored in $def_supp"
244 for ($self->suppressions) {
246 $self->report($self->report_class->new_diag("Using suppression file $_"));
247 push @supp_args, "--suppressions=$_";
251 pipe my $vrdr, my $vwtr or $self->_croak("pipe(\$vrdr, \$vwtr): $!");
253 my $oldfh = select $vrdr;
259 $self->_croak("fork(): $!") unless defined $pid;
263 close $vrdr or $self->_croak("close(\$vrdr): $!");
264 fcntl $vwtr, Fcntl::F_SETFD(), 0
265 or $self->_croak("fcntl(\$vwtr, F_SETFD, 0): $!");
269 $self->tool->args($self),
271 $self->parser->args($self, $vwtr),
272 $self->command->args($self),
275 # $self->report($self->report_class->new_diag("@args"));
277 exec { $args[0] } @args or $self->_croak("exec @args: $!");
280 local $SIG{INT} = sub {
281 kill -(POSIX::SIGKILL()) => $pid;
286 close $vwtr or $self->_croak("close(\$vwtr): $!");
288 $self->parser->parse($self, $vrdr);
290 $self->{exit_code} = (waitpid($pid, 0) == $pid) ? $? >> 8 : 255;
292 close $vrdr or $self->_croak("close(\$vrdr): $!");
297 sub Test::Valgrind::Session::Guard::new { bless \($_[1]), $_[0] }
299 sub Test::Valgrind::Session::Guard::DESTROY { ${$_[0]}->() }
303 Read-only accessor for the C<action> associated to the current run.
307 Read-only accessor for the C<tool> associated to the current run.
311 Read-only accessor for the C<parser> associated to the current tool.
315 Read-only accessor for the C<command> associated to the current run.
321 @members = qw<action tool command parser>;
323 eval "sub $_ { \@_ <= 1 ? \$_[0]->{$_} : (\$_[0]->{$_} = \$_[1]) }";
328 =head2 C<do_suppressions>
330 Forwards to C<< ->action->do_suppressions >>.
334 sub do_suppressions { $_[0]->action->do_suppressions }
336 =head2 C<parser_class>
338 Calls C<< ->tool->parser_class >> with the current session object as the unique argument.
342 sub parser_class { $_[0]->tool->parser_class($_[0]) }
344 =head2 C<report_class>
346 Calls C<< ->tool->report_class >> with the current session object as the unique argument.
350 sub report_class { $_[0]->tool->report_class($_[0]) }
352 =head2 C<def_supp_file>
354 Returns an absolute path to the default suppression file associated to the current session.
356 C<undef> will be returned as soon as any of C<< ->command->suppressions_tag >> or C<< ->tool->suppressions_tag >> are also C<undef>.
357 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 >>.
364 my $tool_tag = $self->tool->suppressions_tag($self);
365 return unless defined $tool_tag;
367 my $cmd_tag = $self->command->suppressions_tag($self);
368 return unless defined $cmd_tag;
370 require File::HomeDir; # So that it's not needed at configure time.
372 return File::Spec->catfile(
373 File::HomeDir->my_home,
378 "$tool_tag-$cmd_tag.supp",
382 =head2 C<suppressions>
384 my @suppressions = $tvs->suppressions;
386 Returns the list of all the suppressions that will be passed to C<valgrind>.
387 Honors L</no_def_supp> and L</extra_supps>.
395 unless ($self->no_def_supp) {
396 my $def_supp = $self->def_supp_file;
397 push @supps, $def_supp if defined $def_supp;
399 push @supps, $self->extra_supps;
412 Starts the action and tool associated to the current run.
413 It's automatically called at the beginning of L</run>.
422 for (qw<action tool command>) {
423 my $base = 'Test::Valgrind::' . ucfirst;
424 my $value = $args{$_};
425 $self->_croak("Invalid $_") unless Scalar::Util::blessed($value)
426 and $value->isa($base);
430 delete @{$self}{qw<last_status exit_code>};
432 $self->tool->start($self);
433 $self->parser($self->parser_class->new)->start($self);
434 $self->action->start($self);
443 Forwards to C<< ->action->abort >> after unshifting the session object to the argument list.
450 $self->action->abort($self, @_);
455 $tvs->report($report);
457 Forwards to C<< ->action->report >> after unshifting the session object to the argument list.
462 my ($self, $report) = @_;
464 return unless defined $report;
466 for my $handler (qw<tool command>) {
467 $report = $self->$handler->filter($self, $report);
468 return unless defined $report;
471 $self->action->report($self, $report);
478 Finishes the action and tool associated to the current run.
479 It's automatically called at the end of L</run>.
486 my $action = $self->action;
488 $action->finish($self);
489 $self->parser->finish($self);
490 $self->tool->finish($self);
492 my $status = $action->status($self);
493 $self->{last_status} = defined $status ? $status : $self->{exit_code};
495 $self->$_(undef) for @members;
502 my $status = $tvs->status;
504 Returns the status code of the last run of the session.
508 sub status { $_[0]->{last_status} }
512 L<Test::Valgrind>, L<Test::Valgrind::Action>, L<Test::Valgrind::Command>, L<Test::Valgrind::Tool>, L<Test::Valgrind::Parser>.
514 L<version>, L<File::HomeDir>.
518 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
520 You can contact me by mail or on C<irc.perl.org> (vincent).
524 Please report any bugs or feature requests to C<bug-test-valgrind at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Valgrind>.
525 I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
529 You can find documentation for this module with the perldoc command.
531 perldoc Test::Valgrind::Session
533 =head1 COPYRIGHT & LICENSE
535 Copyright 2009,2010,2011,2013 Vincent Pit, all rights reserved.
537 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
541 1; # End of Test::Valgrind::Session