1 package Test::Valgrind::Action;
8 Test::Valgrind::Action - Base class for Test::Valgrind actions.
16 our $VERSION = '1.16';
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 Test::Valgrind::Util;
28 use base qw<Test::Valgrind::Component Test::Valgrind::Carp>;
34 my $tva = Test::Valgrind::Action->new(action => $action);
36 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.
37 The class represented by C<$action> must inherit this class.
43 $class = ref($class) || $class;
47 if ($class eq __PACKAGE__) {
48 my ($action, $msg) = Test::Valgrind::Util::validate_subclass(
49 $args{action} || 'Test',
51 $class->_croak($msg) unless defined $action;
52 return $action->new(%args);
55 $class->SUPER::new(@_);
58 =head2 C<do_suppressions>
60 Indicates if the action wants C<valgrind> to run in suppression-generating mode or in analysis mode.
64 sub do_suppressions { 0 }
68 $tva->start($session);
70 Called when the C<$session> starts.
72 Defaults to set L<Test::Valgrind::Component/started>.
76 $tva->report($session, $report);
78 Invoked each time the C<valgrind> process attached to the C<$session> spots an error.
79 C<$report> is a L<Test::Valgrind::Report> object describing the error.
81 Defaults to check L<Test::Valgrind::Component/started>.
88 $self->_croak('Action isn\'t started') unless $self->started;
95 $tva->abort($session, $msg);
97 Triggered when the C<$session> has to interrupt the action.
103 sub abort { $_[0]->_croak($_[2]) }
107 $tva->finish($session);
109 Called when the C<$session> finishes.
111 Defaults to clear L<Test::Valgrind::Component/started>.
115 $tva->status($session);
117 Returns the status code corresponding to the last run of the action.
122 my ($self, $sess) = @_;
124 my $started = $self->started;
126 $self->_croak("Action was never started") unless defined $started;
127 $self->_croak("Action is still running") if $started;
134 L<Test::Valgrind>, L<Test::Valgrind::Component>, L<Test::Valgrind::Session>.
138 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
140 You can contact me by mail or on C<irc.perl.org> (vincent).
144 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>.
145 I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
149 You can find documentation for this module with the perldoc command.
151 perldoc Test::Valgrind::Action
153 =head1 COPYRIGHT & LICENSE
155 Copyright 2009,2010,2011,2013,2015 Vincent Pit, all rights reserved.
157 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
161 1; # End of Test::Valgrind::Action