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=911878299bbb171cf46889788cf8686a10d523f4;hp=3ff6b4300717a5e01ca7f76d9c9ab58f2f10a49f;hb=85f0a66f2b5de7a028ed0e4960435784baff4a37;hpb=6e6df63d54966a0d06a850193dd30d16a2df4bef diff --git a/lib/Catalyst/Test.pm b/lib/Catalyst/Test.pm index 3ff6b43..9118782 100644 --- a/lib/Catalyst/Test.pm +++ b/lib/Catalyst/Test.pm @@ -1,13 +1,15 @@ package Catalyst::Test; -use Test::More; +use strict; +use warnings; +use Test::More (); use Catalyst::Exception; use Catalyst::Utils; use Class::MOP; use Sub::Exporter; -sub build_exports { +my $build_exports = sub { my ($self, $meth, $args, $defaults) = @_; my $request; @@ -28,9 +30,44 @@ sub build_exports { 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),@_); @@ -53,19 +90,23 @@ sub build_exports { return Test::More->builder->is_eq(scalar($res->content_type),@_); }, }; -} +}; -use namespace::clean; +our $default_host; { my $import = Sub::Exporter::build_exporter({ - groups => [ all => \&build_exports ], + groups => [ all => $build_exports ], into_level => 1, }); + sub import { - my ($self, $class) = @_; + my ($self, $class, $opts) = @_; $import->($self, '-all' => { class => $class }); + $opts = {} unless ref $opts eq 'HASH'; + $default_host = $opts->{default_host} if exists $opts->{default_host}; + return 1; } } @@ -80,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', [ @@ -111,6 +153,15 @@ Catalyst::Test - Test Catalyst Applications ok( get('/foo') =~ /bar/ ); + # 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/ ); + } + =head1 DESCRIPTION This module allows you to make requests to a Catalyst application either without @@ -119,12 +170,12 @@ 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. -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 METHODS -=head2 get +=head2 $content = get( ... ) Returns the content. @@ -141,13 +192,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. +Returns a 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'}); + +=head1 FUNCTIONS + +=head2 ($res, $c) = ctx_request( ... ); -=head2 local_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. @@ -159,6 +219,7 @@ sub local_request { require HTTP::Request::AsCGI; my $request = Catalyst::Utils::request( shift(@_) ); + _customize_request($request, @_); my $cgi = HTTP::Request::AsCGI->new( $request, %ENV )->setup; $class->handle_request; @@ -168,7 +229,7 @@ sub local_request { my $agent; -=head2 remote_request +=head2 $res = Catalyst::Test::remote_request( $url ); Do an actual remote request using LWP. @@ -181,6 +242,8 @@ sub remote_request { my $request = Catalyst::Utils::request( shift(@_) ); my $server = URI->new( $ENV{CATALYST_SERVER} ); + _customize_request($request, @_); + if ( $server->path =~ m|^(.+)?/$| ) { my $path = $1; $server->path("$path") if $path; # need to be quoted @@ -220,6 +283,10 @@ 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 => [], ); $agent->env_proxy; @@ -228,25 +295,34 @@ sub remote_request { return $agent->request($request); } +sub _customize_request { + my $request = shift; + my $opts = pop(@_) || {}; + $opts = {} unless ref($opts) eq 'HASH'; + if ( my $host = exists $opts->{host} ? $opts->{host} : $default_host ) { + $request->header( 'Host' => $host ); + } +} + =head2 action_ok -Fetches the given url and check that the request was successful +Fetches the given URL and check 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 check 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 check that the request was not found =head2 content_like -Fetches the given url and matches the content against it. +Fetches the given URL and matches the content against it. =head2 contenttype_is -Check for given mime type +Check for given MIME type =head1 SEE ALSO