use warnings;
use Test::More ();
+use Plack::Test;
use Catalyst::Exception;
use Catalyst::Utils;
use Class::MOP;
use Sub::Exporter;
+use Carp 'croak', 'carp';
-sub build_exports {
- my ($self, $meth, $args, $defaults) = @_;
+sub _build_request_export {
+ my ($self, $args) = @_;
+
+ return sub { _remote_request(@_) }
+ if $args->{remote};
- 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;
+ # Here we should be failing right away, but for some stupid backcompat thing
+ # I don't quite remember we fail lazily here. Needs a proper deprecation and
+ # then removal.
+ return sub { croak "Must specify a test app: use Catalyst::Test 'TestApp'" }
+ unless $class;
- $request = sub { local_request( $class, @_ ) };
- }
+ Class::MOP::load_class($class) unless Class::MOP::is_class_loaded($class);
+ $class->import;
- my $get = sub { $request->(@_)->content };
+ return sub { _local_request( $class, @_ ) };
+}
- return {
+sub _build_get_export {
+ my ($self, $args) = @_;
+ my $request = $args->{request};
+
+ return sub { $request->(@_)->content };
+}
+sub _build_ctx_request_export {
+ my ($self, $args) = @_;
+ my ($class, $request) = @{ $args }{qw(class request)};
+
+ return sub {
+ my $me = ref $self || $self;
+
+ # fail 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 $ctx_closed_over;
+
+ # 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 = Class::MOP::get_metaclass_by_name($class);
+ $meta->make_mutable;
+ $meta->add_after_method_modifier( "dispatch", sub {
+ $ctx_closed_over = shift;
+ });
+ $meta->make_immutable( replace_constructor => 1 );
+ Class::C3::reinitialize(); # Fixes RT#46459, I've failed to write a test for how/why, but it does.
+
+ # 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 = $args->{request}->( @_ );
+
+ # Make sure not to leave a reference $ctx hanging around.
+ # This means that the context will go out of scope as soon as the
+ # caller disposes of it, rather than waiting till the next time
+ # that ctx_request is called. This can be important if your $ctx
+ # ends up with a reference to a shared resource or lock (for example)
+ # which you want to clean up in test teardown - if the $ctx is still
+ # closed over then you're stuffed...
+ my $ctx = $ctx_closed_over;
+ undef $ctx_closed_over;
+
+ return ( $res, $ctx );
+ };
+}
+
+my $build_exports = sub {
+ my ($self, $meth, $args, $defaults) = @_;
+ my $class = $args->{class};
+
+ my $request = $self->_build_request_export({
+ class => $class,
+ remote => $ENV{CATALYST_SERVER},
+ });
+
+ my $get = $self->_build_get_export({ request => $request });
+
+ my $ctx_request = $self->_build_ctx_request_export({
+ class => $class,
request => $request,
- get => $get,
+ });
+
+ return {
+ request => $request,
+ get => $get,
+ ctx_request => $ctx_request,
content_like => sub {
my $action = shift;
return Test::More->builder->like($get->($action),@_);
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,
});
sub import {
my ($self, $class, $opts) = @_;
+ Carp::carp(
+qq{Importing Catalyst::Test without an application name is deprecated:\n
+Instead of saying: use Catalyst::Test;
+say: use Catalyst::Test (); # If you don't want to import a test app right now.
+or say: use Catalyst::Test 'MyApp'; # If you do want to import a test app.\n\n})
+ unless $class;
$import->($self, '-all' => { class => $class });
$opts = {} unless ref $opts eq 'HASH';
$default_host = $opts->{default_host} if exists $opts->{default_host};
+ return 1;
}
}
# 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', [
# 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;
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.
+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.
+The L<get|/"$content = get( ... )"> and L<request|/"$res = request( ... );">
+functions take either a URI or an L<HTTP::Request> object.
-=head2 METHODS
+=head1 INLINE TESTS WILL NO LONGER WORK
-=head2 get
+While it used to be possible to inline a whole testapp into a C<.t> file for a
+distribution, this will no longer work.
+
+The convention is to place your L<Catalyst> test apps into C<t/lib> in your
+distribution. E.g.: C<t/lib/TestApp.pm>, C<t/lib/TestApp/Controller/Root.pm>,
+etc.. Multiple test apps can be used in this way.
+
+Then write your C<.t> files like so:
+
+ use strict;
+ use warnings;
+ use FindBin '$Bin';
+ use lib "$Bin/lib";
+ use Test::More tests => 6;
+ use Catalyst::Test 'TestApp';
+
+=head1 METHODS
+
+=head2 $content = get( ... )
Returns the content.
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:
+method and the L<request|/"$res = request( ... );"> method below:
my $res = request('/'); # redirects to /y
warn $res->header('location');
is ( $uri->path , '/y');
my $content = get($uri->path);
-=head2 request
+Note also that the content is returned as raw bytes, without any attempt
+to decode it into characters.
+
+=head2 $res = request( ... );
-Returns a C<HTTP::Response> object. Accepts an optional hashref for request
+Returns an 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
+=head2 ($res, $c) = ctx_request( ... );
-Simulate a request using L<HTTP::Request::AsCGI>.
+Works exactly like L<request|/"$res = request( ... );">, except it also returns the Catalyst context object,
+C<$c>. Note that this only works for local requests.
=cut
-sub local_request {
+sub _local_request {
my $class = shift;
- require HTTP::Request::AsCGI;
+ my $app = ref($class) eq "CODE" ? $class : $class->_finalized_psgi_app;
- my $request = Catalyst::Utils::request( shift(@_) );
- _customize_request($request, @_);
- my $cgi = HTTP::Request::AsCGI->new( $request, %ENV )->setup;
+ my $request = Catalyst::Utils::request(shift);
+ my %extra_env;
+ _customize_request($request, \%extra_env, @_);
- $class->handle_request;
+ my $ret;
+ test_psgi
+ app => sub { $app->({ %{ $_[0] }, %extra_env }) },
+ client => sub {
+ my $psgi_app = shift;
- return $cgi->restore->response;
-}
+ my $resp = $psgi_app->($request);
-my $agent;
+ # HTML head parsing based on LWP::UserAgent
+ #
+ # This is not just horrible and possibly broken, but also really
+ # doesn't belong here. Whoever wants this should be working on
+ # getting it into Plack::Test, or make a middleware out of it, or
+ # whatever. Seriously - horrible.
-=head2 remote_request
+ require HTML::HeadParser;
-Do an actual remote request using LWP.
+ my $parser = HTML::HeadParser->new();
+ $parser->xml_mode(1) if $resp->content_is_xhtml;
+ $parser->utf8_mode(1) if $] >= 5.008 && $HTML::Parser::VERSION >= 3.40;
-=cut
+ $parser->parse( $resp->content );
+ my $h = $parser->header;
+ for my $f ( $h->header_field_names ) {
+ $resp->init_header( $f, [ $h->header($f) ] );
+ }
-sub remote_request {
+ $ret = $resp;
+ };
+
+ return $ret;
+}
+my $agent;
+
+sub _remote_request {
require LWP::UserAgent;
my $request = Catalyst::Utils::request( shift(@_) );
# 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 /
}
}
$request->uri->path(join '/', @rp);
-
+
if ( $add_trailing ) {
$request->uri->path( $request->uri->path . '/' );
}
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 => [],
return $agent->request($request);
}
+for my $name (qw(local_request remote_request)) {
+ my $fun = sub {
+ carp <<"EOW";
+Calling Catalyst::Test::${name}() directly is deprecated.
+
+Please import Catalyst::Test into your namespace and use the provided request()
+function instead.
+EOW
+ return __PACKAGE__->can("_${name}")->(@_);
+ };
+
+ no strict 'refs';
+ *$name = $fun;
+}
+
sub _customize_request {
my $request = shift;
+ my $extra_env = shift;
my $opts = pop(@_) || {};
$opts = {} unless ref($opts) eq 'HASH';
if ( my $host = exists $opts->{host} ? $opts->{host} : $default_host ) {
$request->header( 'Host' => $host );
}
+
+ if (my $extra = $opts->{extra_env}) {
+ @{ $extra_env }{keys %{ $extra }} = values %{ $extra };
+ }
}
-=head2 action_ok
+=head2 action_ok($url [, $test_name ])
-Fetches the given url and check that the request was successful
+Fetches the given URL and checks that the request was successful. An optional
+second argument can be given to specify the name of the test.
-=head2 action_redirect
+=head2 action_redirect($url [, $test_name ])
-Fetches the given url and check that the request was a redirect
+Fetches the given URL and checks that the request was a redirect. An optional
+second argument can be given to specify the name of the test.
-=head2 action_notfound
+=head2 action_notfound($url [, $test_name ])
-Fetches the given url and check that the request was not found
+Fetches the given URL and checks that the request was not found. An optional
+second argument can be given to specify the name of the test.
-=head2 content_like
+=head2 content_like( $url, $regexp [, $test_name ] )
-Fetches the given url and matches the content against it.
+Fetches the given URL and returns whether the content matches the regexp. An
+optional third argument can be given to specify the name of the test.
-=head2 contenttype_is
-
-Check for given mime type
+=head2 contenttype_is($url, $type [, $test_name ])
+
+Verify the given URL has a content type of $type and optionally specify a test name.
=head1 SEE ALSO
=head1 COPYRIGHT
-This program is free software, you can redistribute it and/or modify it under
+This library is free software. You can redistribute it and/or modify it under
the same terms as Perl itself.
+=begin Pod::Coverage
+
+local_request
+
+remote_request
+
+=end Pod::Coverage
+
=cut
1;