.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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 >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
.\"
.\" 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 "Plack::Test::AnyEvent 3pm"
.TH Plack::Test::AnyEvent 3pm "2022-12-09" "perl v5.36.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"
Plack::Test::AnyEvent \- Run Plack::Test on AnyEvent\-based PSGI applications
.SH "VERSION"
.IX Header "VERSION"
version 0.08
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use HTTP::Request::Common;
\&  use Plack::Test;
\&
\&  $Plack::Test::Impl = \*(AqAnyEvent\*(Aq; # or \*(AqAE\*(Aq for short
\&
\&  test_psgi $app, sub {
\&    my ( $cb ) = @_;
\&
\&    my $res = $cb\->(GET \*(Aq/streaming\-response\*(Aq);
\&    is $res\->header(\*(AqTransfer\-Encoding\*(Aq), \*(Aqchunked\*(Aq;
\&    $res\->on_content_received(sub {
\&        my ( $content ) = @_;
\&
\&        # test chunk of streaming response
\&    });
\&    $res\->recv;
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This Plack::Test implementation allows you to easily test your
AnyEvent\-based \s-1PSGI\s0 applications.  Normally, Plack::Test::MockHTTP
or Plack::Test::Server work fine for this, but this implementation comes
in handy when you'd like to test your streaming results as they come in, or
if your application uses long-polling.  For non-streaming requests, you can
use this module exactly like Plack::Test::MockHTTP; otherwise, you can set
up a content handler and call \f(CW\*(C`$res\->recv\*(C'\fR.  The event loop will then
run until the \s-1PSGI\s0 application closes its writer handle or until your test
client calls \f(CW\*(C`send\*(C'\fR on the response.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.SS "test_psgi"
.IX Subsection "test_psgi"
This function behaves almost identically to \*(L"test_psgi\*(R" in Plack::Test; the
main difference is that the returned response object supports a few additional
methods on top of those normally found in an HTTP::Response object:
.PP
\fI\f(CI$res\fI\->recv\fR
.IX Subsection "$res->recv"
.PP
Calls \f(CW\*(C`recv\*(C'\fR on an internal AnyEvent condition variable.  Use this after you
get the response object to run the event loop.
.PP
\fI\f(CI$res\fI\->send\fR
.IX Subsection "$res->send"
.PP
Calls \f(CW\*(C`send\*(C'\fR on an internal AnyEvent condition variable.  Use this to stop
the event loop when you're done testing.
.PP
\fI\f(CI$res\fI\->on_content_received($cb)\fR
.IX Subsection "$res->on_content_received($cb)"
.PP
Sets a callback to be called when a chunk is received from the application.
A single argument is passed to the callback; namely, the chunk itself.
.SH "EXCEPTION HANDLING"
.IX Header "EXCEPTION HANDLING"
As of version 0.02, this module handles uncaught exceptions thrown by your code.
If the exception occurs before your \s-1PSGI\s0 application returns a response, or
directly in the response subroutine ref (if you return a subroutine as your
application's response), \f(CW$cb\fR will propagate the exception.  Otherwise,
the exception is propagated by \f(CW\*(C`$res\->recv\*(C'\fR.  Here's an example:
.PP
.Vb 2
\&  my $app = sub {
\&    die \*(Aqthrown by $cb\*(Aq;
\&
\&    return sub {
\&        my ( $respond ) = @_;
\&
\&        die \*(Aqstill thrown by $cb\*(Aq;
\&
\&        if($streaming) {
\&            my $writer = $respond\->([
\&                200,
\&                [\*(AqContent\-Type\*(Aq => \*(Aqtext/plain\*(Aq],
\&            ]);
\&
\&            die \*(Aqstill thrown by $cb\*(Aq;
\&
\&            my $timer;
\&            $timer = AnyEvent\->timer(
\&                after => 2,
\&                cb    => sub {
\&                    die \*(Aqthrown by $res\->recv\*(Aq;
\&                    $writer\->write("Ok");
\&                    $writer\->close;
\&                    undef $timer;
\&                },
\&            );
\&        } else {
\&            $respond\->([
\&                200,
\&                [\*(AqContent\-Type\*(Aq => \*(Aqtext/plain\*(Aq],
\&                [\*(AqOk\*(Aq],
\&            ]);
\&
\&            die \*(Aqstill thrown by $cb\*(Aq;
\&        }
\&    };
\&  };
\&
\&  test_psgi $app, sub {
\&    my ( $cb ) = @_;
\&
\&    my $res = $cb\->(GET \*(Aq/\*(Aq);
\&
\&    $res\->on_content_received(sub {
\&        ...
\&    });
\&
\&    $res\->recv;
\&  };
.Ve
.PP
Note: The exception handling code may or may not work with your event loop.
Please run the tests in this distribution with
\&\*(L"\s-1PERL_ANYEVENT_MODEL\*(R"\s0 in AnyEvent set to see if it works with your event loop
of choice.  Patches will be accepted to accommodate loops, as long as it
doesn't break known good ones.  The known good event loops are:
.IP "Default" 4
.IX Item "Default"
.PD 0
.IP "Cocoa" 4
.IX Item "Cocoa"
.IP "\s-1EV\s0" 4
.IX Item "EV"
.IP "Event" 4
.IX Item "Event"
.IP "Glib" 4
.IX Item "Glib"
.IP "Perl" 4
.IX Item "Perl"
.PD
.PP
This list isn't exclusive; ie. just because your event loop isn't on this list
doesn't mean it doesn't work.  Also, even if your event loop doesn't pass
the exception tests, the general usage of this module (testing requests,
handling streaming results and long polling) should work on any AnyEvent loop.
Just don't throw any uncaught exceptions =).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
AnyEvent, Plack, Plack::Test
.SH "AUTHOR"
.IX Header "AUTHOR"
Rob Hoelz <rob@hoelz.ro>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2017 by Rob Hoelz.
.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.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests on the bugtracker website
<https://github.com/hoelzro/plack\-test\-anyevent/issues>
.PP
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.