.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "CommandResult 3pm"
.TH CommandResult 3pm 2025-09-28 "Lire 2.1.1" "LogReport's Lire Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Lire::Test::CommandResult \- Object used to report the results of shell commands
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Lire::Test::FunctionalTestCase;
\&
\&  my $result = $self\->lire_run( "echo Test" );
\&  print $result\->status();
\&  print $result\->stdout();
\&  print $result\->stderr();
\&
\&  print scalar $result\->sent_mail(), " emails were sent.\en";
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Lire::Test::ComandResult objects are used to report the results
of shell commands run through \fBLire::Test::FunctionalTestCase::lire_run()\fR.
.SS \fBcommand()\fP
.IX Subsection "command()"
Returns the shell command that was run. This is the complete command line
which was interpreated by the shell.
.SS \fBstatus()\fP
.IX Subsection "status()"
Returns the command result status. (What is usually contained in $?).
.SS \fBstdout()\fP
.IX Subsection "stdout()"
Returns what was output on stdout while executing the command.
.SS \fBstderr()\fP
.IX Subsection "stderr()"
Returns what was output on stderr while executing the command.
.SS \fBsent_mail()\fP
.IX Subsection "sent_mail()"
Returns in an array reference the message that were sent out during
this command run. The element of this array are hash reference
containing two keys:
.IP recipients 4
.IX Item "recipients"
An array reference containing the recipients as passed on the command
line to sendmail.
.IP message 4
.IX Item "message"
The email which was sent. This is the complete text of the email. This
is what was passed to sendmail via STDIN.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBLire::Test::FunctionaLTestCase\fR\|(3pm)
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR CommandResult.pm,v 1.6 2006/07/23 13:16:31 vanbaal Exp $
.SH AUTHOR
.IX Header "AUTHOR"
Francis J. Lacoste <flacoste@logreport.org>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2003 Stichting LogReport Foundation LogReport@LogReport.org
.PP
This file is part of Lire.
.PP
Lire is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program (see COPYING); if not, check with
http://www.gnu.org/copyleft/gpl.html.