1 package Test::Valgrind::Action;
8 Test::Valgrind::Action - Base class for Test::Valgrind actions.
16 our $VERSION = '1.13';
20 This class is the base for L<Test::Valgrind> actions.
22 Actions are called each time a tool encounter an error and decide what to do with it (for example passing or failing tests).
26 use base qw<Test::Valgrind::Component Test::Valgrind::Carp>;
32 my $tva = Test::Valgrind::Action->new(action => $action);
34 Creates a new action object of type C<$action> by requiring and redispatching the method call to the module named C<$action> if it contains C<'::'> or to C<Test::Valgrind::Action::$action> otherwise.
35 The class represented by C<$action> must inherit this class.
41 $class = ref($class) || $class;
45 if ($class eq __PACKAGE__) {
46 my $action = delete $args{action} || 'Test';
47 $action =~ s/[^\w:]//g;
48 $action = __PACKAGE__ . "::$action" if $action !~ /::/;
49 $class->_croak("Couldn't load action $action: $@")
50 unless eval "require $action; 1";
51 return $action->new(%args);
54 $class->SUPER::new(@_);
57 =head2 C<do_suppressions>
59 Indicates if the action wants C<valgrind> to run in suppression-generating mode or in analysis mode.
63 sub do_suppressions { 0 }
67 $tva->start($session);
69 Called when the C<$session> starts.
71 Defaults to set L<Test::Valgrind::Component/started>.
75 $tva->report($session, $report);
77 Invoked each time the C<valgrind> process attached to the C<$session> spots an error.
78 C<$report> is a L<Test::Valgrind::Report> object describing the error.
80 Defaults to check L<Test::Valgrind::Component/started>.
87 $self->_croak('Action isn\'t started') unless $self->started;
94 $tva->abort($session, $msg);
96 Triggered when the C<$session> has to interrupt the action.
102 sub abort { $_[0]->_croak($_[2]) }
106 $tva->finish($session);
108 Called when the C<$session> finishes.
110 Defaults to clear L<Test::Valgrind::Component/started>.
114 $tva->status($session);
116 Returns the status code corresponding to the last run of the action.
121 my ($self, $sess) = @_;
123 my $started = $self->started;
125 $self->_croak("Action was never started") unless defined $started;
126 $self->_croak("Action is still running") if $started;
133 L<Test::Valgrind>, L<Test::Valgrind::Component>, L<Test::Valgrind::Session>.
137 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
139 You can contact me by mail or on C<irc.perl.org> (vincent).
143 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>.
144 I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
148 You can find documentation for this module with the perldoc command.
150 perldoc Test::Valgrind::Action
152 =head1 COPYRIGHT & LICENSE
154 Copyright 2009,2010,2011 Vincent Pit, all rights reserved.
156 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
160 1; # End of Test::Valgrind::Action