X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FTest.pm;h=3ff6b4300717a5e01ca7f76d9c9ab58f2f10a49f;hb=6e6df63d54966a0d06a850193dd30d16a2df4bef;hp=26cacf0f113e2a80b6145314a940f5061515bbed;hpb=a693340419bd7596e03694b66f1e5ab06dd9fee5;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Test.pm b/lib/Catalyst/Test.pm index 26cacf0..3ff6b43 100644 --- a/lib/Catalyst/Test.pm +++ b/lib/Catalyst/Test.pm @@ -1,16 +1,77 @@ package Catalyst::Test; -use strict; +use Test::More; use Catalyst::Exception; use Catalyst::Utils; -use UNIVERSAL::require; +use Class::MOP; +use Sub::Exporter; -$ENV{CATALYST_ENGINE} = 'Test'; +sub build_exports { + 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 }; + + return { + request => $request, + get => $get, + 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),@_); + }, + }; +} + +use namespace::clean; + +{ + my $import = Sub::Exporter::build_exporter({ + groups => [ all => \&build_exports ], + into_level => 1, + }); + + sub import { + my ($self, $class) = @_; + $import->($self, '-all' => { class => $class }); + } +} =head1 NAME -Catalyst::Test - Test Catalyst applications +Catalyst::Test - Test Catalyst Applications =head1 SYNOPSIS @@ -22,13 +83,19 @@ 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 -r -l lib/ t/ # 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,62 +106,69 @@ 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/ ); =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'); + +=head2 local_request + +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; - die if $@ && $@ !~ /^Can't locate /; - $class->import; + my $request = Catalyst::Utils::request( shift(@_) ); + 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 remote_request Do an actual remote request using LWP. @@ -105,11 +179,34 @@ 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} ); 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 ); @@ -131,15 +228,34 @@ sub remote_request { 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 =head1 SEE ALSO -L. +L, L, +L, L, L -=head1 AUTHOR +=head1 AUTHORS -Sebastian Riedel, C +Catalyst Contributors, see Catalyst.pm =head1 COPYRIGHT