Nagios:...tResult(3)

💖 NAME 💖

okay so welcome to the Nagios::Plugin::ExitResult manual page, section 3, coming at you from the User Contributed Perl Documentation besties 💅. This class is a helper class for returning both output and return codes when testing. That’s the whole NAME vibe: output + return codes, testing time, no cap ✨.

✨ SYNOPSIS ✨

Here’s the little code moment, literally copy-paste energy:

use Test::More;
use Nagios::Plugin::Functions;

# In a test file somewhere
Nagios::Plugin::Functions::_fake_exit(1);

# Later ...
$e = nagios_exit( CRITICAL, 'aiiii ...' );
print $e->message;
print $e->return_code;

# NP::ExitResult also stringifies to the message output
like(nagios_exit( WARNING, 'foobar'), qr/^foo/, 'matches!');

ok so quick translation: in a test file somewhere you’ve got Nagios::Plugin::Functions::_fake_exit(1), then later nagios_exit( CRITICAL, 'aiiii ...' ) hands you $e, and you can print $e->message and $e->return_code. Also: NP::ExitResult stringifies to the message output, so that like(nagios_exit( WARNING, 'foobar'), qr/^foo/, 'matches!') match is a slay 🌈.

🦋 DESCRIPTION 🦋

Nagios::Plugin::ExitResult is a tiny helper class intended for use when testing other Nagios::Plugin modules. A Nagios::Plugin::ExitResult object is returned by nagios_exit() and friends when Nagios::Plugin::Functions::_fake_exit has been set, instead of doing a conventional print + exit. It’s giving test-helper main character energy, not full program energy 🌸.

👑 AUTHOR 👑

Author credit goes to: Gavin Carr , <gavin@openfusion.com.au> 🫶.

🎀 COPYRIGHT AND LICENSE 🎀

Copyright (C) 2006 by Nagios Plugin Development Team.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

That’s the whole page, bestie 💖. Signing off with perl v5.42.0, dated 2024-03-04, and the Nagios:...tResult(3) footer. Bye bye, go test something iconic 👑✨