summaryrefslogtreecommitdiffstats
path: root/lib/Nagios
diff options
context:
space:
mode:
Diffstat (limited to 'lib/Nagios')
-rw-r--r--lib/Nagios/Plugin/ExitResult.pm67
1 files changed, 67 insertions, 0 deletions
diff --git a/lib/Nagios/Plugin/ExitResult.pm b/lib/Nagios/Plugin/ExitResult.pm
new file mode 100644
index 0000000..f059424
--- /dev/null
+++ b/lib/Nagios/Plugin/ExitResult.pm
@@ -0,0 +1,67 @@
1# Tiny helper class to return both output and return_code when testing
2
3package Nagios::Plugin::ExitResult;
4
5use strict;
6
7# Stringify to message
8use overload '""' => sub { shift->{message} };
9
10# Constructor
11sub new {
12 my $class = shift;
13 return bless { return_code => $_[0], message => $_[1] }, $class;
14}
15
16# Accessors
17sub message { shift->{message} }
18sub return_code { shift->{return_code} }
19sub code { shift->{return_code} }
20
211;
22
23__END__
24
25=head1 NAME
26
27Nagios::Plugin::ExitResult - Helper class for returning both output and
28return codes when testing.
29
30=head1 SYNOPSIS
31
32 use Test::More;
33 use Nagios::Plugin::Base;
34
35 # In a test file somewhere
36 Nagios::Plugin::Base::_fake_exit(1);
37
38 # Later ...
39 $e = nagios_exit( CRITICAL, 'aiiii ...' );
40 print $e->message;
41 print $e->return_code;
42
43 # NP::ExitResult also stringifies to the message output
44 like(nagios_exit( WARNING, 'foobar'), qr/^foo/, 'matches!');
45
46
47
48=head1 DESCRIPTION
49
50Nagios::Plugin::ExitResult is a tiny helper class intended for use
51when testing other Nagios::Plugin modules. A Nagios::Plugin::ExitResult
52object is returned by nagios_exit() and friends when
53Nagios::Plugin::Base::_fake_exit has been set, instead of doing a
54conventional print + exit.
55
56=head1 AUTHOR
57
58Gavin Carr , E<lt>gavin@openfusion.com.auE<gt>
59
60=head1 COPYRIGHT AND LICENSE
61
62Copyright (C) 2006 by Nagios Plugin Development Team
63
64This library is free software; you can redistribute it and/or modify
65it under the same terms as Perl itself.
66
67=cut