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=65cdbd8b3cf3ec036f9d120c58ad881b406be4ca;hp=10d5c3ea6335cd97100c0c28c1899b8c525a1883;hb=1a667b7c025ad99457b34ecdeb9158a3986d3946;hpb=9ffadf88044260afc4dfb058cbfc08a3b0a803f0 diff --git a/lib/Catalyst/Test.pm b/lib/Catalyst/Test.pm index 10d5c3e..65cdbd8 100644 --- a/lib/Catalyst/Test.pm +++ b/lib/Catalyst/Test.pm @@ -1,13 +1,21 @@ package Catalyst::Test; -use strict; -use UNIVERSAL::require; +use Test::More; + +use Moose; + +use Catalyst::Exception; +use Catalyst::Utils; +use Class::Inspector; + +extends 'Exporter'; + +our @EXPORT=qw/&content_like &action_ok &action_redirect &action_notfound &contenttype_is/; -$ENV{CATALYST_ENGINE} = 'Test'; =head1 NAME -Catalyst::Test - Test Catalyst applications +Catalyst::Test - Test Catalyst Applications =head1 SYNOPSIS @@ -19,47 +27,69 @@ Catalyst::Test - Test Catalyst applications request('index.html'); get('index.html'); + 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 -l lib/ t/ + CATALYST_SERVER='http://localhost:3000/' prove -r -l lib/ t/ # Tests with inline apps need to use Catalyst::Engine::Test package TestApp; - use Catalyst qw[-Engine=Test]; + use Catalyst; - __PACKAGE__->action( - foo => sub { + sub foo : Global { my ( $self, $c ) = @_; $c->res->output('bar'); - } - ); + } + + __PACKAGE__->setup(); package main; - use Test::More tests => 1; use Catalyst::Test 'TestApp'; + use Test::More tests => 1; ok( get('/foo') =~ /bar/ ); =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 and functions take either a URI or an L +object. -=over 4 +=head2 METHODS -=item get +=head2 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 request Returns a C object. - my $res =request('foo/bar?test=1'); + my $res = request('foo/bar?test=1'); =cut @@ -72,60 +102,86 @@ sub import { if ( $ENV{CATALYST_SERVER} ) { $request = sub { remote_request(@_) }; $get = sub { remote_request(@_)->content }; - } - - else { - $class->require; - my $error = $UNIVERSAL::require::ERROR; - die qq/Couldn't load "$class", "$error"/ if $error; - - unless ( $INC{'Test/Builder.pm'} ) { - die qq/Couldn't load "$class", "$@"/ if $@; + } elsif (! $class) { + $request = sub { Catalyst::Exception->throw("Must specify a test app: use Catalyst::Test 'TestApp'") }; + $get = $request; + } else { + unless( Class::Inspector->loaded( $class ) ) { + require Class::Inspector->filename( $class ); } - $class->import; - $request = sub { $class->run(@_) }; - $get = sub { $class->run(@_)->content }; + $request = sub { local_request( $class, @_ ) }; + $get = sub { local_request( $class, @_ )->content }; } no strict 'refs'; my $caller = caller(0); *{"$caller\::request"} = $request; *{"$caller\::get"} = $get; + __PACKAGE__->export_to_level(1); +} + +=head2 local_request + +Simulate a request using L. + +=cut + +sub local_request { + my $class = shift; + + require HTTP::Request::AsCGI; + + my $request = Catalyst::Utils::request( shift(@_) ); + my $cgi = HTTP::Request::AsCGI->new( $request, %ENV )->setup; + + $class->handle_request; + + return $cgi->restore->response; } my $agent; -=item remote_request +=head2 remote_request -Do an actual remote rquest using LWP. +Do an actual remote request using LWP. =cut sub remote_request { - my $request = shift; require LWP::UserAgent; - unless ( ref $request ) { - - my $uri = - ( $request =~ m/http/i ) - ? URI->new($request) - : URI->new( 'http://localhost' . $request ); + my $request = Catalyst::Utils::request( shift(@_) ); + my $server = URI->new( $ENV{CATALYST_SERVER} ); - $request = $uri->canonical; - } - - unless ( ref $request eq 'HTTP::Request' ) { - $request = HTTP::Request->new( 'GET', $request ); + if ( $server->path =~ m|^(.+)?/$| ) { + my $path = $1; + $server->path("$path") if $path; # need to be quoted } - my $server = URI->new( $ENV{CATALYST_SERVER} ); - - if ( $server->path =~ m|^(.+)?/$| ) { - $server->path("$1"); # 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 ); @@ -134,28 +190,93 @@ sub remote_request { $request->uri->path( $server->path . $request->uri->path ); unless ($agent) { - $agent = LWP::UserAgent->new( - # cookie_jar => {}, + $agent = LWP::UserAgent->new( keep_alive => 1, max_redirect => 0, timeout => 60, ); + $agent->env_proxy; } return $agent->request($request); } -=back +=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 + +=cut + +sub content_like { + my $caller=caller(0); + no strict 'refs'; + my $get=*{"$caller\::get"}; + my $action=shift; + return Test::More->builder->like(&$get($action),@_); +} + +sub action_ok { + my $caller=caller(0); + no strict 'refs'; + my $request=*{"$caller\::request"}; + my $action=shift; + return Test::More->builder->ok(&$request($action)->is_success, @_); +} + +sub action_redirect { + my $caller=caller(0); + no strict 'refs'; + my $request=*{"$caller\::request"}; + my $action=shift; + return Test::More->builder->ok(&$request($action)->is_redirect,@_); + +} + +sub action_notfound { + my $caller=caller(0); + no strict 'refs'; + my $request=*{"$caller\::request"}; + my $action=shift; + return Test::More->builder->is_eq(&$request($action)->code,404,@_); + +} + + +sub contenttype_is { + my $caller=caller(0); + no strict 'refs'; + my $request=*{"$caller\::request"}; + my $action=shift; + my $res=&$request($action); + return Test::More->builder->is_eq(scalar($res->content_type),@_); +} =head1 SEE ALSO -L. +L, L, +L, L, L -=head1 AUTHOR +=head1 AUTHORS -Sebastian Riedel, C +Catalyst Contributors, see Catalyst.pm =head1 COPYRIGHT