Add built local::lib

[catagits/Gitalist.git] / local-lib5 / man / man3 / Catalyst::Test.3pm

.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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.  | will give a
.\" real vertical bar.  \*(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-|\(bv\*(Tr
.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" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" 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 "Catalyst::Test 3"
.TH Catalyst::Test 3 "2009-10-12" "perl v5.8.7" "User Contributed Perl Documentation"
.SH "NAME"
Catalyst::Test \- Test Catalyst Applications
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    # Helper
\&    script/test.pl
.Ve
.PP
.Vb 5
\&    # Tests
\&    use Catalyst::Test 'TestApp';
\&    my $content  = get('index.html');           # Content as string
\&    my $response = request('index.html');       # HTTP::Response object
\&    my($res, $c) = ctx_request('index.html');      # HTTP::Response & context object
.Ve
.PP
.Vb 5
\&    use HTTP::Request::Common;
\&    my $response = request POST '/foo', [
\&        bar => 'baz',
\&        something => 'else'
\&    ];
.Ve
.PP
.Vb 2
\&    # Run tests against a remote server
\&    CATALYST_SERVER='http://localhost:3000/' prove \-r \-l lib/ t/
.Ve
.PP
.Vb 2
\&    use Catalyst::Test 'TestApp';
\&    use Test::More tests => 1;
.Ve
.PP
.Vb 1
\&    ok( get('/foo') =~ /bar/ );
.Ve
.PP
.Vb 8
\&    # mock virtual hosts
\&    use Catalyst::Test 'MyApp', { default_host => 'myapp.com' };
\&    like( get('/whichhost'), qr/served by myapp.com/ );
\&    like( get( '/whichhost', { host => 'yourapp.com' } ), qr/served by yourapp.com/ );
\&    {
\&        local $Catalyst::Test::default_host = 'otherapp.com';
\&        like( get('/whichhost'), qr/served by otherapp.com/ );
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module allows you to make requests to a Catalyst application either without
a server, by simulating the environment of an \s-1HTTP\s0 request using
HTTP::Request::AsCGI or remotely if you define the \s-1CATALYST_SERVER\s0
environment variable. This module also adds a few Catalyst-specific
testing methods as displayed in the method section.
.PP
The get and request
functions take either a \s-1URI\s0 or an HTTP::Request object.
.SH "INLINE TESTS WILL NO LONGER WORK"
.IX Header "INLINE TESTS WILL NO LONGER WORK"
While it used to be possible to inline a whole testapp into a \f(CW\*(C`.t\*(C'\fR file for a
distribution, this will no longer work.
.PP
The convention is to place your Catalyst test apps into \f(CW\*(C`t/lib\*(C'\fR in your
distribution. E.g.: \f(CW\*(C`t/lib/TestApp.pm\*(C'\fR, \f(CW\*(C`t/lib/TestApp/Controller/Root.pm\*(C'\fR,
etc..  Multiple test apps can be used in this way.
.PP
Then write your \f(CW\*(C`.t\*(C'\fR files like so:
.PP
.Vb 6
\&    use strict;
\&    use warnings;
\&    use FindBin '$Bin';
\&    use lib "$Bin/lib";
\&    use Test::More tests => 6;
\&    use Catalyst::Test 'TestApp';
.Ve
.SH "METHODS"
.IX Header "METHODS"
.Sh "$content = get( ... )"
.IX Subsection "$content = get( ... )"
Returns the content.
.PP
.Vb 1
\&    my $content = get('foo/bar?test=1');
.Ve
.PP
Note that this method doesn't follow redirects, so to test for a
correctly redirecting page you'll need to use a combination of this
method and the request method below:
.PP
.Vb 6
\&    my $res = request('/'); # redirects to /y
\&    warn $res\->header('location');
\&    use URI;
\&    my $uri = URI\->new($res\->header('location'));
\&    is ( $uri\->path , '/y');
\&    my $content = get($uri\->path);
.Ve
.Sh "$res = request( ... );"
.IX Subsection "$res = request( ... );"
Returns an HTTP::Response object. Accepts an optional hashref for request
header configuration; currently only supports setting 'host' value.
.PP
.Vb 2
\&    my $res = request('foo/bar?test=1');
\&    my $virtual_res = request('foo/bar?test=1', {host => 'virtualhost.com'});
.Ve
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.ie n .Sh "($res, $c) = ctx_request( ... );"
.el .Sh "($res, \f(CW$c\fP) = ctx_request( ... );"
.IX Subsection "($res, $c) = ctx_request( ... );"
Works exactly like request, except it also returns the Catalyst context object,
\&\f(CW$c\fR. Note that this only works for local requests.
.ie n .Sh "$res = Catalyst::Test::local_request( $AppClass\fP, \f(CW$url );"
.el .Sh "$res = Catalyst::Test::local_request( \f(CW$AppClass\fP, \f(CW$url\fP );"
.IX Subsection "$res = Catalyst::Test::local_request( $AppClass, $url );"
Simulate a request using HTTP::Request::AsCGI.
.ie n .Sh "$res = Catalyst::Test::remote_request( $url );"
.el .Sh "$res = Catalyst::Test::remote_request( \f(CW$url\fP );"
.IX Subsection "$res = Catalyst::Test::remote_request( $url );"
Do an actual remote request using \s-1LWP\s0.
.Sh "action_ok"
.IX Subsection "action_ok"
Fetches the given \s-1URL\s0 and checks that the request was successful.
.Sh "action_redirect"
.IX Subsection "action_redirect"
Fetches the given \s-1URL\s0 and checks that the request was a redirect.
.Sh "action_notfound"
.IX Subsection "action_notfound"
Fetches the given \s-1URL\s0 and checks that the request was not found.
.ie n .Sh "content_like( $url\fP, \f(CW$regexp\fP [, \f(CW$test_name] )"
.el .Sh "content_like( \f(CW$url\fP, \f(CW$regexp\fP [, \f(CW$test_name\fP] )"
.IX Subsection "content_like( $url, $regexp [, $test_name] )"
Fetches the given \s-1URL\s0 and returns whether the content matches the regexp.
.Sh "contenttype_is"
.IX Subsection "contenttype_is"
Check for given \s-1MIME\s0 type.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Catalyst, Test::WWW::Mechanize::Catalyst,
Test::WWW::Selenium::Catalyst, Test::More, HTTP::Request::Common
.SH "AUTHORS"
.IX Header "AUTHORS"
Catalyst Contributors, see Catalyst.pm
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
This library is free software. You can redistribute it and/or modify it under
the same terms as Perl itself.