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=023b8e51c1f7ec58b0f97131ead9c5687e68862a;hb=85f0a66f2b5de7a028ed0e4960435784baff4a37;hpb=68eb5874bcda8eed45d92481248a77533944671a diff --git a/lib/Catalyst/Test.pm b/lib/Catalyst/Test.pm index 023b8e5..9118782 100644 --- a/lib/Catalyst/Test.pm +++ b/lib/Catalyst/Test.pm @@ -1,16 +1,118 @@ package Catalyst::Test; use strict; +use warnings; +use Test::More (); use Catalyst::Exception; use Catalyst::Utils; -use UNIVERSAL::require; +use Class::MOP; +use Sub::Exporter; -$ENV{CATALYST_ENGINE} = 'Test'; +my $build_exports = sub { + my ($self, $meth, $args, $defaults) = @_; + + my $request; + my $class = $args->{class}; + + if ( $ENV{CATALYST_SERVER} ) { + $request = sub { remote_request(@_) }; + } elsif (! $class) { + $request = sub { Catalyst::Exception->throw("Must specify a test app: use Catalyst::Test 'TestApp'") }; + } else { + unless (Class::MOP::is_class_loaded($class)) { + Class::MOP::load_class($class); + } + $class->import; + + $request = sub { local_request( $class, @_ ) }; + } + + 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, + ctx_request => $ctx_request, + content_like => sub { + my $action = shift; + return Test::More->builder->like($get->($action),@_); + }, + action_ok => sub { + my $action = shift; + return Test::More->builder->ok($request->($action)->is_success, @_); + }, + action_redirect => sub { + my $action = shift; + return Test::More->builder->ok($request->($action)->is_redirect,@_); + }, + action_notfound => sub { + my $action = shift; + return Test::More->builder->is_eq($request->($action)->code,404,@_); + }, + contenttype_is => sub { + my $action = shift; + my $res = $request->($action); + return Test::More->builder->is_eq(scalar($res->content_type),@_); + }, + }; +}; + +our $default_host; + +{ + my $import = Sub::Exporter::build_exporter({ + groups => [ all => $build_exports ], + into_level => 1, + }); + + + sub import { + 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; + } +} =head1 NAME -Catalyst::Test - Test Catalyst applications +Catalyst::Test - Test Catalyst Applications =head1 SYNOPSIS @@ -19,8 +121,15 @@ 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', [ + bar => 'baz', + something => 'else' + ]; # Run tests against a remote server CATALYST_SERVER='http://localhost:3000/' prove -r -l lib/ t/ @@ -28,7 +137,7 @@ Catalyst::Test - Test Catalyst applications # Tests with inline apps need to use Catalyst::Engine::Test package TestApp; - use Catalyst qw[-Engine=Test]; + use Catalyst; sub foo : Global { my ( $self, $c ) = @_; @@ -39,61 +148,88 @@ Catalyst::Test - Test Catalyst applications package main; - use Test::More tests => 1; use Catalyst::Test 'TestApp'; + use Test::More tests => 1; 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 -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. -=head2 METHODS +The L and L functions take either a URI or an L +object. -=over 4 +=head1 METHODS -=item get +=head2 $content = get( ... ) Returns the content. my $content = get('foo/bar?test=1'); -=item request +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 L method below: + + 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); + +=head2 $res = request( ... ); + +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( ... ); -Returns a C object. +Works exactly like L, except it also returns the Catalyst context object, +C<$c>. Note that this only works for local requests. - my $res =request('foo/bar?test=1'); +=head2 $res = Catalyst::Test::local_request( $AppClass, $url ); + +Simulate a request using L. =cut -sub import { - my $self = shift; +sub local_request { my $class = shift; - my ( $get, $request ); - - if ( $ENV{CATALYST_SERVER} ) { - $request = sub { remote_request(@_) }; - $get = sub { remote_request(@_)->content }; - } + require HTTP::Request::AsCGI; - else { - $class->require; - $class->import; + my $request = Catalyst::Utils::request( shift(@_) ); + _customize_request($request, @_); + my $cgi = HTTP::Request::AsCGI->new( $request, %ENV )->setup; - $request = sub { $class->run(@_) }; - $get = sub { $class->run(@_)->content }; - } + $class->handle_request; - no strict 'refs'; - my $caller = caller(0); - *{"$caller\::request"} = $request; - *{"$caller\::get"} = $get; + return $cgi->restore->response; } my $agent; -=item remote_request +=head2 $res = Catalyst::Test::remote_request( $url ); Do an actual remote request using LWP. @@ -104,11 +240,36 @@ sub remote_request { require LWP::UserAgent; my $request = Catalyst::Utils::request( shift(@_) ); + my $server = URI->new( $ENV{CATALYST_SERVER} ); - my $server = URI->new( $ENV{CATALYST_SERVER} ); + _customize_request($request, @_); if ( $server->path =~ m|^(.+)?/$| ) { - $server->path("$1"); # need to be quoted + my $path = $1; + $server->path("$path") if $path; # need to be quoted + } + + # the request path needs to be sanitised if $server is using a + # non-root path due to potential overlap between request path and + # response path. + if ($server->path) { + # 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 / + if (@rp) { + foreach my $sp (@sp) { + $sp eq $rp[0] ? shift @rp : last + } + } + $request->uri->path(join '/', @rp); + + if ( $add_trailing ) { + $request->uri->path( $request->uri->path . '/' ); + } } $request->uri->scheme( $server->scheme ); @@ -122,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; @@ -130,15 +295,43 @@ sub remote_request { return $agent->request($request); } -=back +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 + +=head2 action_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 + +=head2 content_like + +Fetches the given URL and matches the content against it. + +=head2 contenttype_is + +Check for given MIME type =head1 SEE ALSO -L. +L, L, +L, L, L -=head1 AUTHOR +=head1 AUTHORS -Sebastian Riedel, C +Catalyst Contributors, see Catalyst.pm =head1 COPYRIGHT