lib/Test/Valgrind/Action.pm

   1 package Test::Valgrind::Action;
   2
   3 use strict;
   4 use warnings;
   5
   6 =head1 NAME
   7
   8 Test::Valgrind::Action - Base class for Test::Valgrind actions.
   9
  10 =head1 VERSION
  11
  12 Version 1.10
  13
  14 =cut
  15
  16 our $VERSION = '1.10';
  17
  18 =head1 DESCRIPTION
  19
  20 This class is the base for L<Test::Valgrind> actions.
  21
  22 Actions are called each time a tool encounter an error and decide what to do with it (for example passing or failing tests).
  23
  24 =cut
  25
  26 use base qw/Test::Valgrind::Component Test::Valgrind::Carp/;
  27
  28 =head1 METHODS
  29
  30 =head2 C<< new action => $action >>
  31
  32 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.
  33 The class represented by C<$action> must inherit this class.
  34
  35 =cut
  36
  37 sub new {
  38  my $class = shift;
  39  $class = ref($class) || $class;
  40
  41  my %args = @_;
  42
  43  if ($class eq __PACKAGE__) {
  44   my $action = delete $args{action} || 'Test';
  45   $action =~ s/[^\w:]//g;
  46   $action = __PACKAGE__ . "::$action" if $action !~ /::/;
  47   $class->_croak("Couldn't load action $action: $@")
  48                                                unless eval "require $action; 1";
  49   return $action->new(%args);
  50  }
  51
  52  $class->SUPER::new(@_);
  53 }
  54
  55 =head2 C<do_suppressions>
  56
  57 Indicates if the action wants C<valgrind> to run in suppression-generating mode or in analysis mode.
  58
  59 =cut
  60
  61 sub do_suppressions { 0 }
  62
  63 =head2 C<start $session>
  64
  65 Called when the C<$session> starts.
  66
  67 Defaults to set L<Test::Valgrind::Component/started>.
  68
  69 =head2 C<report $session, $report>
  70
  71 Invoked each time the C<valgrind> process attached to the C<$session> spots an error.
  72 C<$report> is a L<Test::Valgrind::Report> object describing the error.
  73
  74 Defaults to check L<Test::Valgrind::Component/started>.
  75
  76 =cut
  77
  78 sub report {
  79  my ($self) = @_;
  80
  81  $self->_croak('Action isn\'t started') unless $self->started;
  82
  83  return;
  84 }
  85
  86 =head2 C<abort $session, $msg>
  87
  88 Triggered when the C<$session> has to interrupt the action.
  89
  90 Defaults to croak.
  91
  92 =cut
  93
  94 sub abort { $_[0]->_croak($_[2]) }
  95
  96 =head2 C<finish $session>
  97
  98 Called when the C<$session> finishes.
  99
 100 Defaults to clear L<Test::Valgrind::Component/started>.
 101
 102 =head2 C<status $session>
 103
 104 Returns the status code corresponding to the last run of the action.
 105
 106 =cut
 107
 108 sub status {
 109  my ($self, $sess) = @_;
 110
 111  my $started = $self->started;
 112
 113  $self->_croak("Action was never started") unless defined $started;
 114  $self->_croak("Action is still running")  if $started;
 115
 116  return;
 117 }
 118
 119 =head1 SEE ALSO
 120
 121 L<Test::Valgrind>, L<Test::Valgrind::Component>, L<Test::Valgrind::Session>.
 122
 123 =head1 AUTHOR
 124
 125 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
 126
 127 You can contact me by mail or on C<irc.perl.org> (vincent).
 128
 129 =head1 BUGS
 130
 131 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>.
 132 I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
 133
 134 =head1 SUPPORT
 135
 136 You can find documentation for this module with the perldoc command.
 137
 138     perldoc Test::Valgrind::Action
 139
 140 =head1 COPYRIGHT & LICENSE
 141
 142 Copyright 2009 Vincent Pit, all rights reserved.
 143
 144 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
 145
 146 =cut
 147
 148 1; # End of Test::Valgrind::Action