.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "MooX::Cmd::Tester 3pm"
.TH MooX::Cmd::Tester 3pm "2014-02-08" "perl v5.20.0" "User Contributed Perl 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"
MooX::Cmd::Tester \- MooX cli app commands tester
.SH "VERSION"
.IX Header "VERSION"
version 0.009
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use MooX::Cmd::Tester;
\&  use Test::More;
\&
\&  use MyFoo;
\&
\&  # basic tests as instance check, initialization check etc. is done there
\&  my $rv = test_cmd( MyFoo => [ command(s) option(s) ] );
\&
\&  like( $rv\->stdout, qr/operation successful/, "Command performed" );
\&  like( $rv\->stderr, qr/patient dead/, "Deal with expected command error" );
\&
\&  is_deeply( $rv\->execute_rv, \e@expected_return_values, "got what I deserve?" );
\&
\&  cmp_ok( $rv\->exit_code, "==", 0, "Command successful" );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The test coverage of most \s-1CLI\s0 apps is somewhere between poor and wretched.
With the same approach as App::Cmd::Tester comes MooX::Cmd::Tester to
ease writing tests for \s-1CLI\s0 apps.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.SS "test_cmd"
.IX Subsection "test_cmd"
.Vb 1
\&  my $rv = test_cmd( MyApp => \e@argv );
.Ve
.PP
test_cmd invokes the app with given argv as if would be invoked from
command line and captures the output, the return values and exit code.
.PP
Some minor tests are done to prove whether class matches, execute succeeds,
command_name and command_chain are not totally scrambled.
.PP
It returns an object with following attributes/accessors:
.PP
\fIapp\fR
.IX Subsection "app"
.PP
Name of package of App
.PP
\fIcmd\fR
.IX Subsection "cmd"
.PP
Name of executed (1st level) command
.PP
\fIstdout\fR
.IX Subsection "stdout"
.PP
Content of stdout
.PP
\fIstderr\fR
.IX Subsection "stderr"
.PP
Content of stderr
.PP
\fIoutput\fR
.IX Subsection "output"
.PP
Content of merged stdout and stderr
.PP
\fIerror\fR
.IX Subsection "error"
.PP
the exception thrown by running the application (if any)
.PP
\fIexecute_rv\fR
.IX Subsection "execute_rv"
.PP
return values from execute
.PP
\fIexit_code\fR
.IX Subsection "exit_code"
.PP
0 on sucess, $! when error occured and $! available, \-1 otherwise
.SS "test_cmd_ok"
.IX Subsection "test_cmd_ok"
.Vb 1
\&  my $rv = test_cmd_ok( MyApp => \e@argv );
.Ve
.PP
Runs \f(CW\*(C`test_cmd\*(C'\fR and expects it being successful \- command_name must be in
command_commands, etc.
.PP
Returns the same object \f(CW\*(C`test_cmd\*(C'\fR returns.
.PP
If an error occured, no additional test is done (behavior as \f(CW\*(C`test_cmd\*(C'\fR).
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
MooX::Cmd::Tester is \fIinspired\fR by App::Cmd::Tester from Ricardo Signes.
In fact, I resused the entire design and adopt it to the requirements of
MooX::Cmd.
.SH "AUTHOR"
.IX Header "AUTHOR"
Torsten Raudssus <torsten@raudss.us>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2013 by Torsten Raudssus.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.