use warnings;
use Test::More ();
+use Plack::Test;
use Catalyst::Exception;
use Catalyst::Utils;
use Class::MOP;
use Sub::Exporter;
+use Carp;
my $build_exports = sub {
my ($self, $meth, $args, $defaults) = @_;
if ( $ENV{CATALYST_SERVER} ) {
$request = sub { remote_request(@_) };
- } elsif (! $class) {
- $request = sub { Catalyst::Exception->throw("Must specify a test app: use Catalyst::Test 'TestApp'") };
+ } elsif (!$class) {
+ $request = sub { croak "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 $app = $class->psgi_app;
+
+ $request = sub { local_request( $app, @_ ) };
}
my $get = sub { $request->(@_)->content };
my $ctx_request = sub {
- my $me = ref $self || $self;
+ 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;
+ 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.
- no warnings 'redefine';
- my $dispatch = Catalyst->can('dispatch');
- local *Catalyst::dispatch = sub {
- $c = shift;
- $dispatch->( $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 = $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 both values
- return ( $res, $c );
+ return ( $res, $ctx );
};
return {
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};
# 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 L<get|/"$content = get( ... )"> and L<request|/"$res = request( ... );">
+functions take either a URI or an L<HTTP::Request> object.
+
+=head1 INLINE TESTS WILL NO LONGER WORK
-The </get> and </request> functions take either a URI or an L<HTTP::Request>
-object.
+While it used to be possible to inline a whole testapp into a C<.t> file for a
+distribution, this will no longer work.
-=head2 METHODS
+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( ... )
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);
+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');
=head2 ($res, $c) = ctx_request( ... );
-Works exactly like C<Catalyst::Test::request>, except it also returns the
-catalyst context object, C<$c>. Note that this only works for local requests.
+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.
=head2 $res = Catalyst::Test::local_request( $AppClass, $url );
=cut
sub local_request {
- my $class = shift;
-
- require HTTP::Request::AsCGI;
-
- my $request = Catalyst::Utils::request( shift(@_) );
- _customize_request($request, @_);
- my $cgi = HTTP::Request::AsCGI->new( $request, %ENV )->setup;
+ my $app = shift;
+
+ my $request = Catalyst::Utils::request(shift);
+ my %extra_env;
+ _customize_request($request, \%extra_env, @_);
+
+ my $ret;
+ test_psgi
+ app => sub { $app->({ %{ $_[0] }, %extra_env }) },
+ client => sub {
+ my $resp = shift->($request);
+
+ # 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.
+
+ require HTML::HeadParser;
+
+ 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;
+
+ $parser->parse( $resp->content );
+ my $h = $parser->header;
+ for my $f ( $h->header_field_names ) {
+ $resp->init_header( $f, [ $h->header($f) ] );
+ }
- $class->handle_request;
+ $ret = $resp;
+ };
- return $cgi->restore->response;
+ return $ret;
}
my $agent;
# 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 => [],
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
-Fetches the given url and check that the request was successful
+Fetches the given URL and checks 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 checks 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 checks that the request was not found.
+
+=head2 content_like( $url, $regexp [, $test_name] )
-=head2 content_like
+Fetches the given URL and returns whether the content matches the regexp.
-Fetches the given url and matches the content against it.
+=head2 contenttype_is
-=head2 contenttype_is
-
-Check for given mime type
+Check for given MIME type.
=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.
=cut
projects / catagits/Catalyst-Runtime.git / blobdiff