1 package Test::Valgrind::Session;
8 Test::Valgrind::Session - Test::Valgrind session object.
16 our $VERSION = '1.15';
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 regen_def_supp => $regen_def_supp,
45 no_def_supp => $no_def_supp,
46 allow_no_supp => $allow_no_supp,
47 extra_supps => \@extra_supps,
50 The package constructor, which takes several options :
56 All the directories from C<@search_dirs> will have F<valgrind> appended to create a list of candidates for the C<valgrind> executable.
58 Defaults to the current C<PATH> environment variable.
62 If a simple scalar C<$valgrind> is passed as the value to C<'valgrind'>, it will be the only candidate.
63 C<@search_dirs> will then be ignored.
65 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>.
69 C<$min_version> specifies the minimal C<valgrind> version required.
70 The constructor will croak if it's not able to find an adequate C<valgrind> from the supplied candidates list and search path.
76 If C<$regen_def_supp> is true, the default suppression file associated with the tool and the command will be forcefully regenerated.
82 If C<$no_def_supp> is true, C<valgrind> won't read the default suppression file associated with the tool and the command.
88 If C<$allow_no_supp> is true, the command will always be run into C<valgrind> even if no appropriate suppression file is available.
94 C<$extra_supps> is a reference to an array of optional suppression files that will be passed to C<valgrind>.
104 $class = ref($class) || $class;
109 my $vg = delete $args{valgrind};
110 if (defined $vg and not ref $vg) {
113 push @paths, @$vg if $vg and ref $vg eq 'ARRAY';
114 my $dirs = delete $args{search_dirs};
115 $dirs = [ File::Spec->path ] unless $dirs;
116 push @paths, map File::Spec->catfile($_, 'valgrind'), @$dirs
117 if ref $dirs eq 'ARRAY';
119 $class->_croak('Empty valgrind candidates list') unless @paths;
121 my $min_version = delete $args{min_version};
122 defined and not ref and $_ = version->new($_) for $min_version;
124 my ($valgrind, $version);
127 my $ver = qx/$_ --version/;
128 if ($ver =~ /^valgrind-(\d+(\.\d+)*)/) {
130 $version = version->new($1);
131 next if $version < $min_version;
139 $class->_croak('No appropriate valgrind executable could be found')
140 unless defined $valgrind;
142 my $extra_supps = delete $args{extra_supps};
143 $extra_supps = [ ] unless $extra_supps and ref $extra_supps eq 'ARRAY';
144 @$extra_supps = grep { defined && -f $_ && -r _ } @$extra_supps;
147 valgrind => $valgrind,
149 regen_def_supp => delete($args{regen_def_supp}),
150 no_def_supp => delete($args{no_def_supp}),
151 allow_no_supp => delete($args{allow_no_supp}),
152 extra_supps => $extra_supps,
158 my $valgrind_path = $tvs->valgrind;
160 The path to the selected C<valgrind> executable.
164 my $valgrind_version = $tvs->version;
166 The L<version> object associated to the selected C<valgrind>.
173 my $version = $self->{version};
174 $self->{version} = $version = version->new($version) unless ref $version;
179 =head2 C<regen_def_supp>
181 my $regen_def_supp = $tvs->regen_def_supp;
183 Read-only accessor for the C<regen_def_supp> option.
187 =head2 C<no_def_supp>
189 my $no_def_supp = $tvs->no_def_supp;
191 Read-only accessor for the C<no_def_supp> option.
193 =head2 C<allow_no_supp>
195 my $allow_no_supp = $tvs->allow_no_supp;
197 Read-only accessor for the C<allow_no_supp> option.
201 eval "sub $_ { \$_[0]->{$_} }" for qw<
208 =head2 C<extra_supps>
210 my @extra_supps = $tvs->extra_supps;
212 Read-only accessor for the C<extra_supps> option.
216 sub extra_supps { @{$_[0]->{extra_supps} || []} }
226 Runs the command C<$command> through C<valgrind> with the tool C<$tool>, which will report to the action C<$action>.
228 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.
238 my $guard = Test::Valgrind::Session::Guard->new(sub { $self->finish });
240 $self->_run($args{command});
244 my ($self, $cmd) = @_;
246 if ($cmd->isa('Test::Valgrind::Command::Aggregate')) {
247 $self->_run($_) for $cmd->commands;
251 $self->command($cmd);
253 $self->report($self->report_class->new_diag(
254 'Using valgrind ' . $self->version . ' located at ' . $self->valgrind
257 my $env = $self->command->env($self);
260 if ($self->do_suppressions) {
261 push @supp_args, '--gen-suppressions=all';
263 if (!$self->no_def_supp) {
264 my $def_supp = $self->def_supp_file;
266 if ($self->regen_def_supp and -e $def_supp) {
267 1 while unlink $def_supp;
270 if (defined $def_supp and not -e $def_supp) {
271 $self->report($self->report_class->new_diag(
272 'Generating suppressions' . ($forced ? ' (forced)' : '') . '...'
274 require Test::Valgrind::Suppressions;
275 Test::Valgrind::Suppressions->generate(
277 command => $self->command,
280 $self->_croak('Couldn\'t generate suppressions') unless -e $def_supp;
281 $self->report($self->report_class->new_diag(
282 "Suppressions for this perl stored in $def_supp"
286 my @supp_files = grep {
287 -e $_ and $self->command->check_suppressions_file($_)
288 } $self->suppressions;
289 if (@supp_files > 1) {
290 my $files_list = join "\n", map " $_", @supp_files;
291 $self->report($self->report_class->new_diag(
292 "Using suppressions from:\n$files_list"
294 } elsif (@supp_files) {
295 $self->report($self->report_class->new_diag(
296 "Using suppressions from $supp_files[0]"
298 } elsif ($self->allow_no_supp) {
299 $self->report($self->report_class->new_diag("No suppressions used"));
301 $self->_croak("No compatible suppressions available");
303 @supp_args = map "--suppressions=$_", @supp_files;
306 pipe my $vrdr, my $vwtr or $self->_croak("pipe(\$vrdr, \$vwtr): $!");
308 my $oldfh = select $vrdr;
314 $self->_croak("fork(): $!") unless defined $pid;
319 eval { setpgrp(0, 0) };
321 close $vrdr or $self->_croak("close(\$vrdr): $!");
322 fcntl $vwtr, Fcntl::F_SETFD(), 0
323 or $self->_croak("fcntl(\$vwtr, F_SETFD, 0): $!");
327 $self->tool->args($self),
329 $self->parser->args($self, $vwtr),
330 $self->command->args($self),
333 # $self->report($self->report_class->new_diag("@args"));
335 exec { $args[0] } @args or $self->_croak("exec @args: $!");
338 local $SIG{INT} = sub {
339 kill -(POSIX::SIGKILL()) => $pid;
344 close $vwtr or $self->_croak("close(\$vwtr): $!");
346 $self->parser->parse($self, $vrdr);
348 $self->{exit_code} = (waitpid($pid, 0) == $pid) ? $? >> 8 : 255;
350 close $vrdr or $self->_croak("close(\$vrdr): $!");
355 sub Test::Valgrind::Session::Guard::new { bless \($_[1]), $_[0] }
357 sub Test::Valgrind::Session::Guard::DESTROY { ${$_[0]}->() }
361 Read-only accessor for the C<action> associated to the current run.
365 Read-only accessor for the C<tool> associated to the current run.
369 Read-only accessor for the C<parser> associated to the current tool.
373 Read-only accessor for the C<command> associated to the current run.
379 @members = qw<action tool command parser>;
381 eval "sub $_ { \@_ <= 1 ? \$_[0]->{$_} : (\$_[0]->{$_} = \$_[1]) }";
386 =head2 C<do_suppressions>
388 Forwards to C<< ->action->do_suppressions >>.
392 sub do_suppressions { $_[0]->action->do_suppressions }
394 =head2 C<parser_class>
396 Calls C<< ->tool->parser_class >> with the current session object as the unique argument.
400 sub parser_class { $_[0]->tool->parser_class($_[0]) }
402 =head2 C<report_class>
404 Calls C<< ->tool->report_class >> with the current session object as the unique argument.
408 sub report_class { $_[0]->tool->report_class($_[0]) }
410 =head2 C<def_supp_file>
412 Returns an absolute path to the default suppression file associated to the current session.
414 C<undef> will be returned as soon as any of C<< ->command->suppressions_tag >> or C<< ->tool->suppressions_tag >> are also C<undef>.
415 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 >>.
422 my $tool_tag = $self->tool->suppressions_tag($self);
423 return unless defined $tool_tag;
425 my $cmd_tag = $self->command->suppressions_tag($self);
426 return unless defined $cmd_tag;
428 require File::HomeDir; # So that it's not needed at configure time.
430 return File::Spec->catfile(
431 File::HomeDir->my_home,
436 "$tool_tag-$cmd_tag.supp",
440 =head2 C<suppressions>
442 my @suppressions = $tvs->suppressions;
444 Returns the list of all the suppressions that will be passed to C<valgrind>.
445 Honors L</no_def_supp> and L</extra_supps>.
453 unless ($self->no_def_supp) {
454 my $def_supp = $self->def_supp_file;
455 push @supps, $def_supp if defined $def_supp;
457 push @supps, $self->extra_supps;
470 Starts the action and tool associated to the current run.
471 It's automatically called at the beginning of L</run>.
480 for (qw<action tool command>) {
481 my $base = 'Test::Valgrind::' . ucfirst;
482 my $value = $args{$_};
483 $self->_croak("Invalid $_") unless Scalar::Util::blessed($value)
484 and $value->isa($base);
488 delete @{$self}{qw<last_status exit_code>};
490 $self->tool->start($self);
491 $self->parser($self->parser_class->new)->start($self);
492 $self->action->start($self);
501 Forwards to C<< ->action->abort >> after unshifting the session object to the argument list.
508 $self->action->abort($self, @_);
513 $tvs->report($report);
515 Forwards to C<< ->action->report >> after unshifting the session object to the argument list.
520 my ($self, $report) = @_;
522 return unless defined $report;
524 for my $handler (qw<tool command>) {
525 $report = $self->$handler->filter($self, $report);
526 return unless defined $report;
529 $self->action->report($self, $report);
536 Finishes the action and tool associated to the current run.
537 It's automatically called at the end of L</run>.
544 my $action = $self->action;
546 $action->finish($self);
547 $self->parser->finish($self);
548 $self->tool->finish($self);
550 my $status = $action->status($self);
551 $self->{last_status} = defined $status ? $status : $self->{exit_code};
553 $self->$_(undef) for @members;
560 my $status = $tvs->status;
562 Returns the status code of the last run of the session.
566 sub status { $_[0]->{last_status} }
570 L<Test::Valgrind>, L<Test::Valgrind::Action>, L<Test::Valgrind::Command>, L<Test::Valgrind::Tool>, L<Test::Valgrind::Parser>.
572 L<version>, L<File::HomeDir>.
576 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
578 You can contact me by mail or on C<irc.perl.org> (vincent).
582 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>.
583 I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
587 You can find documentation for this module with the perldoc command.
589 perldoc Test::Valgrind::Session
591 =head1 COPYRIGHT & LICENSE
593 Copyright 2009,2010,2011,2013,2015 Vincent Pit, all rights reserved.
595 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
599 1; # End of Test::Valgrind::Session