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=3ff6b4300717a5e01ca7f76d9c9ab58f2f10a49f;hp=45254682544e257ea535cf001ce683de1b892dd4;hb=3295c7dbc672a0d1c03f657a2a37f12f322bbece;hpb=8b4483b384270e6e6a7e78bfb2fbdbefdf7b72f4 diff --git a/lib/Catalyst/Test.pm b/lib/Catalyst/Test.pm index 4525468..3ff6b43 100644 --- a/lib/Catalyst/Test.pm +++ b/lib/Catalyst/Test.pm @@ -1,22 +1,77 @@ package Catalyst::Test; -use strict; -use UNIVERSAL::require; -use IO::File; -use HTTP::Request; -use HTTP::Response; -use Socket; -use URI; +use Test::More; -require Catalyst; +use Catalyst::Exception; +use Catalyst::Utils; +use Class::MOP; +use Sub::Exporter; -my $class; -$ENV{CATALYST_ENGINE} = 'CGI'; -$ENV{CATALYST_TEST} = 1; +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 @@ -28,103 +83,179 @@ Catalyst::Test - Test Catalyst applications request('index.html'); get('index.html'); - # Request - perl -MCatalyst::Test=MyApp -e1 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; + + sub foo : Global { + my ( $self, $c ) = @_; + $c->res->output('bar'); + } + + __PACKAGE__->setup(); + + package main; + + 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. + +The and functions take either a URI or an L +object. =head2 METHODS -=head3 get +=head2 get Returns the content. my $content = get('foo/bar?test=1'); -=head3 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 -{ - no warnings; - CHECK { - if ( ( caller(0) )[1] eq '-e' ) { - print request( $ARGV[0] || 'http://localhost' )->content; - } - } -} +sub local_request { + my $class = shift; -sub import { - my $self = shift; - if ( $class = shift ) { - $class->require; - unless ( $INC{'Test/Builder.pm'} ) { - die qq/Couldn't load "$class", "$@"/ if $@; - } - my $caller = caller(0); - no strict 'refs'; - *{"$caller\::request"} = \&request; - *{"$caller\::get"} = sub { request(@_)->content }; - } + 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; } -sub request { - my $request = shift; - unless ( ref $request ) { - $request = URI->new( $request, 'http' ); - } - unless ( ref $request eq 'HTTP::Request' ) { - $request = HTTP::Request->new( 'GET', $request ); +my $agent; + +=head2 remote_request + +Do an actual remote request using LWP. + +=cut + +sub remote_request { + + require LWP::UserAgent; + + my $request = Catalyst::Utils::request( shift(@_) ); + my $server = URI->new( $ENV{CATALYST_SERVER} ); + + if ( $server->path =~ m|^(.+)?/$| ) { + my $path = $1; + $server->path("$path") if $path; # need to be quoted } - local ( *STDIN, *STDOUT ); - my %clean = %ENV; - my $output = ''; - $ENV{CONTENT_TYPE} ||= $request->header('Content-Type') || ''; - $ENV{CONTENT_LENGTH} ||= $request->header('Content-Length') || ''; - $ENV{GATEWAY_INTERFACE} ||= 'CGI/1.1'; - $ENV{HTTP_USER_AGENT} ||= 'Catalyst'; - $ENV{HTTP_HOST} ||= $request->uri->host || 'localhost'; - $ENV{QUERY_STRING} ||= $request->uri->query || ''; - $ENV{REQUEST_METHOD} ||= $request->method; - $ENV{PATH_INFO} ||= $request->uri->path || '/'; - $ENV{SCRIPT_NAME} ||= $request->uri->path || '/'; - $ENV{SERVER_NAME} ||= $request->uri->host || 'localhost'; - $ENV{SERVER_PORT} ||= $request->uri->port; - $ENV{SERVER_PROTOCOL} ||= 'HTTP/1.1'; - - for my $field ( $request->header_field_names ) { - if ( $field =~ /^Content-(Length|Type)$/ ) { - next; + + # 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 . '/' ); } - $field =~ s/-/_/g; - $ENV{ 'HTTP_' . uc($field) } = $request->header($field); } - if ( $request->content_length ) { - my $body = IO::File->new_tmpfile; - $body->print( $request->content ) or die $!; - $body->seek( 0, SEEK_SET ) or die $!; - open( STDIN, "<&=", $body->fileno ) - or die("Failed to dup \$body: $!"); + + $request->uri->scheme( $server->scheme ); + $request->uri->host( $server->host ); + $request->uri->port( $server->port ); + $request->uri->path( $server->path . $request->uri->path ); + + unless ($agent) { + + $agent = LWP::UserAgent->new( + keep_alive => 1, + max_redirect => 0, + timeout => 60, + ); + + $agent->env_proxy; } - open( STDOUT, '>', \$output ); - $class->handler; - %ENV = %clean; - return HTTP::Response->parse($output); + + return $agent->request($request); } +=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