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=65cdbd8b3cf3ec036f9d120c58ad881b406be4ca;hp=824c57797c4faf00dca8908aeff4d5a753fc91b7;hb=1a667b7c025ad99457b34ecdeb9158a3986d3946;hpb=c10563323dadc3194743c5e460840380e8c07703

diff --git a/lib/Catalyst/Test.pm b/lib/Catalyst/Test.pm
index 824c577..65cdbd8 100644
--- a/lib/Catalyst/Test.pm
+++ b/lib/Catalyst/Test.pm
@@ -1,21 +1,21 @@
 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 Moose;
+
+use Catalyst::Exception;
+use Catalyst::Utils;
+use Class::Inspector;
+
+extends 'Exporter';
+
+our @EXPORT=qw/&content_like &action_ok &action_redirect &action_notfound &contenttype_is/;
 
-my $class;
-$ENV{CATALYST_ENGINE} = 'CGI';
 
 =head1 NAME
 
-Catalyst::Test - Test Catalyst applications
+Catalyst::Test - Test Catalyst Applications
 
 =head1 SYNOPSIS
 
@@ -27,103 +27,256 @@ 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<HTTP::Request::AsCGI> 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 </get> and </request> functions take either a URI or an L<HTTP::Request>
+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<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
 
-{
-    no warnings;
-    CHECK {
-        if ( ( caller(0) )[1] eq '-e' ) {
-            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;
+
+        $request = sub { local_request( $class, @_ ) };
+        $get     = sub { local_request( $class, @_ )->content };
     }
+
+    no strict 'refs';
+    my $caller = caller(0);
+    *{"$caller\::request"} = $request;
+    *{"$caller\::get"}     = $get;
+    __PACKAGE__->export_to_level(1);
 }
 
-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 };
-    }
+=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;
 }
 
-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}       ||= '/';
-    $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
+
+=cut
+
+sub content_like {
+    my $caller=caller(0);
+    no strict 'refs';
+    my $get=*{"$caller\::get"};
+    my $action=shift;
+    return Test::More->builder->like(&$get($action),@_);
+}
+
+sub action_ok {
+    my $caller=caller(0);
+    no strict 'refs';
+    my $request=*{"$caller\::request"};
+    my $action=shift;
+    return Test::More->builder->ok(&$request($action)->is_success, @_);
+}
+
+sub action_redirect {
+    my $caller=caller(0);
+    no strict 'refs';
+    my $request=*{"$caller\::request"};
+    my $action=shift;
+    return Test::More->builder->ok(&$request($action)->is_redirect,@_);
+    
+}
+
+sub action_notfound {
+    my $caller=caller(0);
+    no strict 'refs';
+    my $request=*{"$caller\::request"};
+    my $action=shift;
+    return Test::More->builder->is_eq(&$request($action)->code,404,@_);
+
+}
+
+
+sub contenttype_is {
+    my $caller=caller(0);
+    no strict 'refs';
+    my $request=*{"$caller\::request"};
+    my $action=shift;
+    my $res=&$request($action);
+    return Test::More->builder->is_eq(scalar($res->content_type),@_);
 }
 
 =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