r12983@zaphod: kd | 2008-04-28 18:10:27 +1000

[catagits/Catalyst-Runtime.git] / lib / Catalyst / Test.pm

diff --git a/lib/Catalyst/Test.pm b/lib/Catalyst/Test.pm
index b7fdb6d..9e0db01 100644 (file)
--- a/lib/Catalyst/Test.pm
+++ b/lib/Catalyst/Test.pm
@@ -1,16 +1,15 @@
 package Catalyst::Test;
 
 use strict;
+use warnings;
 
 use Catalyst::Exception;
 use Catalyst::Utils;
-use UNIVERSAL::require;
-
-$ENV{CATALYST_ENGINE} = 'Test';
+use Class::Inspector;
 
 =head1 NAME
 
-Catalyst::Test - Test Catalyst applications
+Catalyst::Test - Test Catalyst Applications
 
 =head1 SYNOPSIS
 
@@ -22,13 +21,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 -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;
 
     sub foo : Global {
             my ( $self, $c ) = @_;
@@ -46,23 +51,38 @@ Catalyst::Test - Test Catalyst applications
 
 =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<HTTP::Request::AsCGI> or remotely if you define the CATALYST_SERVER
+environment variable.
 
-=head2 METHODS
+The </get> and </request> functions take either a URI or an L<HTTP::Request>
+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<request> 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<HTTP::Response> object.
 
-    my $res =request('foo/bar?test=1');
+    my $res = request('foo/bar?test=1');
 
 =cut
 
@@ -75,24 +95,17 @@ sub import {
     if ( $ENV{CATALYST_SERVER} ) {
         $request = sub { remote_request(@_) };
         $get     = sub { remote_request(@_)->content };
-    }
-
-    else {
-        $class->require;
-        
-        if ( $@ ) {
-            
-            my $error = $UNIVERSAL::require::ERROR;
-            
-            Catalyst::Exception->throw(
-                message => qq/Couldn't load "$class", "$error"/
-            );
+    } 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';
@@ -101,24 +114,66 @@ sub import {
     *{"$caller\::get"}     = $get;
 }
 
+=head2 local_request
+
+Simulate a request using L<HTTP::Request::AsCGI>.
+
+=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 {
 
-    require LWP::UserAgent; 
-    
-    my $request = Catalyst::Utils::request( shift(@_) );
+    require LWP::UserAgent;
 
+    my $request = Catalyst::Utils::request( shift(@_) );
     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 );
@@ -126,7 +181,7 @@ sub remote_request {
     $request->uri->port( $server->port );
     $request->uri->path( $server->path . $request->uri->path );
 
-    unless ( $agent ) {
+    unless ($agent) {
 
         $agent = LWP::UserAgent->new(
             keep_alive   => 1,
@@ -140,15 +195,14 @@ sub remote_request {
     return $agent->request($request);
 }
 
-=back 
-
 =head1 SEE ALSO
 
-L<Catalyst>.
+L<Catalyst>, L<Test::WWW::Mechanize::Catalyst>,
+L<Test::WWW::Selenium::Catalyst>, L<Test::More>, L<HTTP::Request::Common>
 
-=head1 AUTHOR
+=head1 AUTHORS
 
-Sebastian Riedel, C<sri@cpan.org>
+Catalyst Contributors, see Catalyst.pm
 
 =head1 COPYRIGHT