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=f3d4de32c725214d47ee8263235b6c5edd61ea97;hp=58be1924b3146e5b1633a85cf55f13e2578ee49c;hb=2eb2c42f2faef472cecd3788573d4872943334b6;hpb=fc7ec1d96ee55d1bf42af3abce155ecb717b9e2b diff --git a/lib/Catalyst/Test.pm b/lib/Catalyst/Test.pm index 58be192..f3d4de3 100644 --- a/lib/Catalyst/Test.pm +++ b/lib/Catalyst/Test.pm @@ -1,180 +1,212 @@ package Catalyst::Test; use strict; -use UNIVERSAL::require; -use HTTP::Response; -use Socket; -use URI; +use warnings; -my $class; -$ENV{CATALYST_ENGINE} = 'CGI'; -$ENV{CATALYST_TEST} = 1; +use Catalyst::Exception; +use Catalyst::Utils; +use Class::Inspector; =head1 NAME -Catalyst::Test - Test Catalyst applications +Catalyst::Test - Test Catalyst Applications =head1 SYNOPSIS + # Helper + script/test.pl + # Tests use Catalyst::Test 'TestApp'; 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'); + } - # Server - perl -MCatalyst::Test=MyApp -e1 3000 + __PACKAGE__->setup(); + + package main; + + use Test::More tests => 1; + use Catalyst::Test 'TestApp'; + + 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. + +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'); =cut -{ - no warnings; - CHECK { - if ( ( caller(0) )[1] eq '-e' ) { - if ( $ARGV[0] =~ /^\d+$/ ) { server( $ARGV[0] ) } - else { print request( $ARGV[0] || 'http://localhost' )->content } +sub import { + my $self = shift; + my $class = shift; + + my ( $get, $request ); + + if ( $ENV{CATALYST_SERVER} ) { + $request = sub { remote_request(@_) }; + $get = sub { remote_request(@_)->content }; + } 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; -sub import { - my $self = shift; - $class = shift; - $class->require; - if ( ( caller(0) )[1] eq '-e' ) { - die qq/Couldn't load "$class", "$@"/ if $@; + $request = sub { local_request( $class, @_ ) }; + $get = sub { local_request( $class, @_ )->content }; } - my $caller = caller(0); + no strict 'refs'; - *{"$caller\::request"} = \&request; - *{"$caller\::get"} = sub { request(@_)->content }; + my $caller = caller(0); + *{"$caller\::request"} = $request; + *{"$caller\::get"} = $get; } -sub request { - my $uri = shift; - local *STDOUT; - my $output = ''; - open STDOUT, '>', \$output; - $uri = URI->new($uri); - my %clean = %ENV; - $ENV{REQUEST_METHOD} ||= 'GET'; - $ENV{HTTP_HOST} ||= $uri->authority || 'localhost'; - $ENV{SCRIPT_NAME} ||= $uri->path || '/'; - $ENV{QUERY_STRING} ||= $uri->query || ''; - $ENV{CONTENT_TYPE} ||= 'text/plain'; - $class->handler; - %ENV = %clean; - return HTTP::Response->parse($output); +=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; } -=head3 server +my $agent; -Starts a testserver. +=head2 remote_request - Catalyst::Test::server(3000); +Do an actual remote request using LWP. =cut -sub server { - my $port = shift; - - # Listen - my $tcp = getprotobyname('tcp'); - socket( HTTPDaemon, PF_INET, SOCK_STREAM, $tcp ) or die $!; - setsockopt( HTTPDaemon, SOL_SOCKET, SO_REUSEADDR, pack( "l", 1 ) ) - or warn $!; - bind( HTTPDaemon, sockaddr_in( $port, INADDR_ANY ) ) or die $!; - listen( HTTPDaemon, SOMAXCONN ) or die $!; - - print "You can connect to your server at http://localhost:$port\n"; - - # Process - my %clean = %ENV; - for ( ; accept( Remote, HTTPDaemon ) ; close Remote ) { - *STDIN = *Remote; - *STDOUT = *Remote; - my $remote_sockaddr = getpeername(STDIN); - my ( undef, $iaddr ) = sockaddr_in($remote_sockaddr); - my $peername = gethostbyaddr( $iaddr, AF_INET ) || "localhost"; - my $peeraddr = inet_ntoa($iaddr) || "127.0.0.1"; - my $local_sockaddr = getsockname(STDIN); - my ( undef, $localiaddr ) = sockaddr_in($local_sockaddr); - my $localname = gethostbyaddr( $localiaddr, AF_INET ) || 'localhost'; - my $localaddr = inet_ntoa($localiaddr) || '127.0.0.1'; - my $chunk; - - while ( sysread( STDIN, my $buff, 1 ) ) { - last if $buff eq "\n"; - $chunk .= $buff; - } - my ( $method, $request_uri, $proto, undef ) = split /\s+/, $chunk; - my ( $file, undef, $query_string ) = - ( $request_uri =~ /([^?]*)(\?(.*))?/ ); - last if ( $method !~ /^(GET|POST|HEAD)$/ ); - %ENV = %clean; - - $chunk = ''; - while ( sysread( STDIN, my $buff, 1 ) ) { - if ( $buff eq "\n" ) { - $chunk =~ s/[\r\l\n\s]+$//; - if ( $chunk =~ /^([\w\-]+): (.+)/i ) { - my $tag = uc($1); - $tag =~ s/^COOKIES$/COOKIE/; - my $val = $2; - $tag =~ s/-/_/g; - $tag = "HTTP_" . $tag - unless ( grep /^$tag$/, qw(CONTENT_LENGTH CONTENT_TYPE) ); - if ( $ENV{$tag} ) { $ENV{$tag} .= "; $val" } - else { $ENV{$tag} = $val } - } - last if $chunk =~ /^$/; - $chunk = ''; +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 + } + + # 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 } - else { $chunk .= $buff } } - $ENV{SERVER_PROTOCOL} = $proto; - $ENV{SERVER_PORT} = $port; - $ENV{SERVER_NAME} = $localname; - $ENV{SERVER_URL} = "http://$localname:$port/"; - $ENV{PATH_INFO} = $file; - $ENV{REQUEST_URI} = $request_uri; - $ENV{REQUEST_METHOD} = $method; - $ENV{REMOTE_ADDR} = $peeraddr; - $ENV{REMOTE_HOST} = $peername; - $ENV{QUERY_STRING} = $query_string || ''; - $ENV{CONTENT_TYPE} ||= 'text/plain'; - $ENV{SERVER_SOFTWARE} ||= "Catalyst/$Catalyst::VERSION"; - $class->run; + $request->uri->path(join '/', @rp); + + if ( $add_trailing ) { + $request->uri->path( $request->uri->path . '/' ); + } + } + + $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, + + # work around newer LWP max_redirect 0 bug + # http://rt.cpan.org/Ticket/Display.html?id=40260 + requests_redirectable => [], + ); + + $agent->env_proxy; } + + return $agent->request($request); } =head1 SEE ALSO -L. +L, L, +L, L, L -=head1 AUTHOR +=head1 AUTHORS -Sebastian Riedel, C +Catalyst Contributors, see Catalyst.pm =head1 COPYRIGHT