X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FTest.pm;h=658f233b706447b84a9ef3e08722cf30b59bc65e;hp=2535f7683796fa57137af4dd6961a2bdcdc4b4cf;hb=536bee890cf24e0e4bcda7562e7b70cc03ca0620;hpb=e0a78010dd2d2d12cf8a693b9e0e42bc62e422cc diff --git a/lib/Catalyst/Test.pm b/lib/Catalyst/Test.pm index 2535f76..658f233 100644 --- a/lib/Catalyst/Test.pm +++ b/lib/Catalyst/Test.pm @@ -30,9 +30,44 @@ my $build_exports = sub { my $get = sub { $request->(@_)->content }; + my $ctx_request = sub { + my $me = ref $self || $self; + + ### throw an exception if ctx_request is being used against a remote + ### server + Catalyst::Exception->throw("$me only works with local requests, not remote") + if $ENV{CATALYST_SERVER}; + + ### check explicitly for the class here, or the Cat->meta call will blow + ### up in our face + Catalyst::Exception->throw("Must specify a test app: use Catalyst::Test 'TestApp'") unless $class; + + ### place holder for $c after the request finishes; reset every time + ### requests are done. + my $c; + + ### hook into 'dispatch' -- the function gets called after all plugins + ### have done their work, and it's an easy place to capture $c. + + my $meta = Catalyst->meta; + $meta->make_mutable; + $meta->add_after_method_modifier( "dispatch", sub { + $c = shift; + }); + $meta->make_immutable; + + ### do the request; C::T::request will know about the class name, and + ### we've already stopped it from doing remote requests above. + my $res = $request->( @_ ); + + ### return both values + return ( $res, $c ); + }; + return { - request => $request, - get => $get, + request => $request, + get => $get, + ctx_request => $ctx_request, content_like => sub { my $action = shift; return Test::More->builder->like($get->($action),@_); @@ -71,6 +106,7 @@ our $default_host; $import->($self, '-all' => { class => $class }); $opts = {} unless ref $opts eq 'HASH'; $default_host = $opts->{default_host} if exists $opts->{default_host}; + return 1; } } @@ -85,8 +121,9 @@ Catalyst::Test - Test Catalyst Applications # Tests use Catalyst::Test 'TestApp'; - request('index.html'); - get('index.html'); + 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 use HTTP::Request::Common; my $response = request POST '/foo', [ @@ -97,20 +134,6 @@ Catalyst::Test - Test Catalyst Applications # Run tests against a remote server CATALYST_SERVER='http://localhost:3000/' prove -r -l lib/ t/ - # Tests with inline apps need to use Catalyst::Engine::Test - package TestApp; - - use Catalyst; - - sub foo : Global { - my ( $self, $c ) = @_; - $c->res->output('bar'); - } - - __PACKAGE__->setup(); - - package main; - use Catalyst::Test 'TestApp'; use Test::More tests => 1; @@ -130,15 +153,33 @@ Catalyst::Test - Test Catalyst Applications This module allows you to make requests to a Catalyst application either without a server, by simulating the environment of an HTTP request using L or remotely if you define the CATALYST_SERVER -environment variable. This module also adds a few catalyst -specific testing methods as displayed in the method section. +environment variable. This module also adds a few Catalyst-specific +testing methods as displayed in the method section. -The and functions take either a URI or an L +The L and L functions take either a URI or an L object. -=head2 METHODS +=head1 INLINE TESTS WILL NO LONGER WORK + +While it used to be possible to inline a whole testapp into a C<.t> file for a +distribution, this will no longer work. -=head2 get +The convention is to place your L test apps into C in your +distribution. E.g.: C, C, +etc.. Multiple test apps can be used in this way. + +Then write your C<.t> files like so: + + use strict; + use warnings; + use FindBin '$Bin'; + use lib "$Bin/lib"; + use Test::More tests => 6; + use Catalyst::Test 'TestApp'; + +=head1 METHODS + +=head2 $content = get( ... ) Returns the content. @@ -155,15 +196,22 @@ method and the L method below: is ( $uri->path , '/y'); my $content = get($uri->path); -=head2 request +=head2 $res = request( ... ); -Returns a C object. Accepts an optional hashref for request +Returns an L object. Accepts an optional hashref for request header configuration; currently only supports setting 'host' value. my $res = request('foo/bar?test=1'); my $virtual_res = request('foo/bar?test=1', {host => 'virtualhost.com'}); -=head2 local_request +=head1 FUNCTIONS + +=head2 ($res, $c) = ctx_request( ... ); + +Works exactly like L, except it also returns the Catalyst context object, +C<$c>. Note that this only works for local requests. + +=head2 $res = Catalyst::Test::local_request( $AppClass, $url ); Simulate a request using L. @@ -178,14 +226,14 @@ sub local_request { _customize_request($request, @_); my $cgi = HTTP::Request::AsCGI->new( $request, %ENV )->setup; - $class->handle_request; + $class->handle_request( env => \%ENV ); return $cgi->restore->response; } my $agent; -=head2 remote_request +=head2 $res = Catalyst::Test::remote_request( $url ); Do an actual remote request using LWP. @@ -212,7 +260,7 @@ sub remote_request { # If request path is '/', we have to add a trailing slash to the # final request URI my $add_trailing = $request->uri->path eq '/'; - + my @sp = split '/', $server->path; my @rp = split '/', $request->uri->path; shift @sp;shift @rp; # leading / @@ -222,7 +270,7 @@ sub remote_request { } } $request->uri->path(join '/', @rp); - + if ( $add_trailing ) { $request->uri->path( $request->uri->path . '/' ); } @@ -239,7 +287,7 @@ sub remote_request { keep_alive => 1, max_redirect => 0, timeout => 60, - + # work around newer LWP max_redirect 0 bug # http://rt.cpan.org/Ticket/Display.html?id=40260 requests_redirectable => [], @@ -262,23 +310,23 @@ sub _customize_request { =head2 action_ok -Fetches the given url and check that the request was successful +Fetches the given URL and checks that the request was successful. =head2 action_redirect -Fetches the given url and check that the request was a redirect +Fetches the given URL and checks that the request was a redirect. =head2 action_notfound -Fetches the given url and check that the request was not found +Fetches the given URL and checks that the request was not found. + +=head2 content_like( $url, $regexp [, $test_name] ) -=head2 content_like +Fetches the given URL and returns whether the content matches the regexp. -Fetches the given url and matches the content against it. +=head2 contenttype_is -=head2 contenttype_is - -Check for given mime type +Check for given MIME type. =head1 SEE ALSO @@ -291,7 +339,7 @@ Catalyst Contributors, see Catalyst.pm =head1 COPYRIGHT -This program is free software, you can redistribute it and/or modify it under +This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself. =cut