Doc, add new upgrading caveat, and start what works on Moose docs for lack of a bette...

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

diff --git a/lib/Catalyst/Test.pm b/lib/Catalyst/Test.pm
index 9791b24..9118782 100644 (file)
--- a/lib/Catalyst/Test.pm
+++ b/lib/Catalyst/Test.pm
@@ -2,14 +2,14 @@ package Catalyst::Test;
 
 use strict;
 use warnings;
-use Test::More;
+use Test::More ();
 
 use Catalyst::Exception;
 use Catalyst::Utils;
 use Class::MOP;
 use Sub::Exporter;
 
-sub build_exports {
+my $build_exports = sub {
     my ($self, $meth, $args, $defaults) = @_;
 
     my $request;
@@ -30,9 +30,44 @@ sub build_exports {
 
     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,
+        request      => $request,
+        get          => $get,
+        ctx_request  => $ctx_request,
         content_like => sub {
             my $action = shift;
             return Test::More->builder->like($get->($action),@_);
@@ -55,14 +90,13 @@ sub build_exports {
             return Test::More->builder->is_eq(scalar($res->content_type),@_);
         },
     };
-}
+};
 
-use namespace::clean;
 our $default_host;
 
 {
     my $import = Sub::Exporter::build_exporter({
-        groups => [ all => \&build_exports ],
+        groups => [ all => $build_exports ],
         into_level => 1,
     });
 
@@ -70,8 +104,9 @@ our $default_host;
     sub import {
         my ($self, $class, $opts) = @_;
         $import->($self, '-all' => { class => $class });
-        $opts ||= {};
+        $opts = {} unless ref $opts eq 'HASH';
         $default_host = $opts->{default_host} if exists $opts->{default_host};
+        return 1;
     }
 }
 
@@ -86,8 +121,9 @@ Catalyst::Test - Test Catalyst Applications
 
     # 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
 
     use HTTP::Request::Common;
     my $response = request POST '/foo', [
@@ -134,12 +170,12 @@ 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>
+The L<get> and L<request> functions take either a URI or an L<HTTP::Request>
 object.
 
-=head2 METHODS
+=head1 METHODS
 
-=head2 get
+=head2 $content = get( ... )
 
 Returns the content.
 
@@ -156,15 +192,22 @@ method and the L<request> method below:
     is ( $uri->path , '/y');
     my $content = get($uri->path);
 
-=head2 request
+=head2 $res = request( ... );
 
-Returns a C<HTTP::Response> object. Accepts an optional hashref for request
+Returns a L<HTTP::Response> 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'});
 
-=head2 local_request
+=head1 FUNCTIONS
+
+=head2 ($res, $c) = ctx_request( ... );
+
+Works exactly like L<request>, 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<HTTP::Request::AsCGI>.
 
@@ -186,7 +229,7 @@ sub local_request {
 
 my $agent;
 
-=head2 remote_request
+=head2 $res = Catalyst::Test::remote_request( $url );
 
 Do an actual remote request using LWP.
 
@@ -255,6 +298,7 @@ sub remote_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 );
     }
@@ -262,23 +306,23 @@ sub _customize_request {
 
 =head2 action_ok
 
-Fetches the given url and check that the request was successful
+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
+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
+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.
+Fetches the given URL and matches the content against it.
 
 =head2 contenttype_is 
     
-Check for given mime type
+Check for given MIME type
 
 =head1 SEE ALSO