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=926885bd4b369879c4c8dd5fac4511bf8784537c;hb=85f0a66f2b5de7a028ed0e4960435784baff4a37;hpb=7833fdfca73ff8a03769523ec85c2343a3994360 diff --git a/lib/Catalyst/Test.pm b/lib/Catalyst/Test.pm index 926885b..9118782 100644 --- a/lib/Catalyst/Test.pm +++ b/lib/Catalyst/Test.pm @@ -1,180 +1,337 @@ package Catalyst::Test; use strict; -use UNIVERSAL::require; -use HTTP::Response; -use Socket; -use URI; +use warnings; +use Test::More (); + +use Catalyst::Exception; +use Catalyst::Utils; +use Class::MOP; +use Sub::Exporter; + +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 $class; -$ENV{CATALYST_ENGINE} = 'CGI'; -$ENV{CATALYST_TEST} = 1; +{ + 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 + # Helper + script/test.pl + # 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 - # Request - perl -MCatalyst::Test=MyApp -e1 index.html + use HTTP::Request::Common; + my $response = request POST '/foo', [ + bar => 'baz', + something => 'else' + ]; - # Server - perl -MCatalyst::Test=MyApp -e1 3000 + # 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/ ); + + # 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. + +The L and L functions take either a URI or an L +object. -=head2 METHODS +=head1 METHODS -=head3 get +=head2 $content = 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 $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'}); -Returns a C object. +=head1 FUNCTIONS - my $res =request('foo/bar?test=1'); +=head2 ($res, $c) = ctx_request( ... ); + +Works exactly like L, except it also returns the Catalyst context object, +C<$c>. Note that this only works for local requests. + +=head2 $res = Catalyst::Test::local_request( $AppClass, $url ); + +Simulate a request using L. =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 local_request { + my $class = shift; -sub import { - my $self = shift; - $class = shift; - $class->require; - if ( ( caller(0) )[1] eq '-e' ) { - 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(@_) ); + _customize_request($request, @_); + my $cgi = HTTP::Request::AsCGI->new( $request, %ENV )->setup; + + $class->handle_request; -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); + return $cgi->restore->response; } -=head3 server +my $agent; -Starts a testserver. +=head2 $res = Catalyst::Test::remote_request( $url ); - 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} ); + + _customize_request($request, @_); + + 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} ||= 'multipart/form-data'; - $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); +} + +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