package Catalyst::Test;
use strict;
-use UNIVERSAL::require;
+use warnings;
+use Test::More ();
-$ENV{CATALYST_ENGINE} = 'Test';
+use Catalyst::Exception;
+use Catalyst::Utils;
+use Class::MOP;
+use Sub::Exporter;
+
+my $build_exports = sub {
+ my ($self, $meth, $args, $defaults) = @_;
+
+ 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;
+
+ $request = sub { local_request( $class, @_ ) };
+ }
+
+ 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,
+ ctx_request => $ctx_request,
+ content_like => sub {
+ my $action = shift;
+ return Test::More->builder->like($get->($action),@_);
+ },
+ action_ok => sub {
+ my $action = shift;
+ return Test::More->builder->ok($request->($action)->is_success, @_);
+ },
+ action_redirect => sub {
+ my $action = shift;
+ return Test::More->builder->ok($request->($action)->is_redirect,@_);
+ },
+ action_notfound => sub {
+ my $action = shift;
+ return Test::More->builder->is_eq($request->($action)->code,404,@_);
+ },
+ contenttype_is => sub {
+ my $action = shift;
+ my $res = $request->($action);
+ return Test::More->builder->is_eq(scalar($res->content_type),@_);
+ },
+ };
+};
+
+our $default_host;
+
+{
+ my $import = Sub::Exporter::build_exporter({
+ groups => [ all => $build_exports ],
+ into_level => 1,
+ });
+
+
+ sub import {
+ my ($self, $class, $opts) = @_;
+ $import->($self, '-all' => { class => $class });
+ $opts = {} unless ref $opts eq 'HASH';
+ $default_host = $opts->{default_host} if exists $opts->{default_host};
+ return 1;
+ }
+}
=head1 NAME
-Catalyst::Test - Test Catalyst applications
+Catalyst::Test - Test Catalyst Applications
=head1 SYNOPSIS
# 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', [
+ 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;
- __PACKAGE__->action(
- foo => sub {
+ sub foo : Global {
my ( $self, $c ) = @_;
$c->res->output('bar');
- }
- );
+ }
+
+ __PACKAGE__->setup();
package main;
- use Test::More tests => 1;
use Catalyst::Test 'TestApp';
+ use Test::More tests => 1;
ok( get('/foo') =~ /bar/ );
+ # mock virtual hosts
+ use Catalyst::Test 'MyApp', { default_host => 'myapp.com' };
+ like( get('/whichhost'), qr/served by myapp.com/ );
+ like( get( '/whichhost', { host => 'yourapp.com' } ), qr/served by yourapp.com/ );
+ {
+ local $Catalyst::Test::default_host = 'otherapp.com';
+ like( get('/whichhost'), qr/served by otherapp.com/ );
+ }
+
=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 L<get> and L<request> functions take either a URI or an L<HTTP::Request>
+object.
-=head2 METHODS
+=head1 METHODS
-=head3 get
+=head2 $content = 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);
-Returns a C<HTTP::Response> object.
+=head2 $res = request( ... );
- my $res =request('foo/bar?test=1');
+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'});
+
+=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>.
=cut
-sub import {
- my $self = shift;
+sub local_request {
my $class = shift;
- my ( $get, $request );
+ require HTTP::Request::AsCGI;
- if ( $ENV{CATALYST_SERVER} ) {
- $request = sub { remote_request(@_) };
- $get = sub { remote_request(@_)->content };
- }
+ my $request = Catalyst::Utils::request( shift(@_) );
+ _customize_request($request, @_);
+ my $cgi = HTTP::Request::AsCGI->new( $request, %ENV )->setup;
- else {
- $class->require;
+ $class->handle_request;
- unless ( $INC{'Test/Builder.pm'} ) {
- die qq/Couldn't load "$class", "$@"/ if $@;
- }
+ return $cgi->restore->response;
+}
- $class->import;
+my $agent;
- $request = sub { $class->run(@_) };
- $get = sub { $class->run(@_)->content };
- }
+=head2 $res = Catalyst::Test::remote_request( $url );
- no strict 'refs';
- my $caller = caller(0);
- *{"$caller\::request"} = $request;
- *{"$caller\::get"} = $get;
-}
+Do an actual remote request using LWP.
+
+=cut
sub remote_request {
- my $request = shift;
require LWP::UserAgent;
- my $remote = URI->new( $ENV{CATALYST_SERVER} );
+ my $request = Catalyst::Utils::request( shift(@_) );
+ my $server = URI->new( $ENV{CATALYST_SERVER} );
- unless ( ref $request ) {
+ _customize_request($request, @_);
- my $uri =
- ( $request =~ m/http/i )
- ? URI->new($request)
- : URI->new( 'http://localhost' . $request );
+ if ( $server->path =~ m|^(.+)?/$| ) {
+ my $path = $1;
+ $server->path("$path") if $path; # need to be quoted
+ }
- $request = $uri->canonical;
+ # 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->scheme( $remote->scheme );
- $request->host( $remote->host );
- $request->port( $remote->port );
+ $request->uri->scheme( $server->scheme );
+ $request->uri->host( $server->host );
+ $request->uri->port( $server->port );
+ $request->uri->path( $server->path . $request->uri->path );
- unless ( ref $request eq 'HTTP::Request' ) {
- $request = HTTP::Request->new( 'GET', $request );
- }
+ unless ($agent) {
- my $agent = LWP::UserAgent->new;
+ $agent = LWP::UserAgent->new(
+ 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 => [],
+ );
+
+ $agent->env_proxy;
+ }
return $agent->request($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 );
+ }
+}
+
+=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
+
=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
projects / catagits/Catalyst-Runtime.git / blobdiff