use strict;
use warnings;
+use Test::More ();
use Catalyst::Exception;
use Catalyst::Utils;
-use Class::Inspector;
+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 $crequest = sub {
+ my $me = ref $self || $self;
+
+ ### throw an exception if crequest is being used against a remote
+ ### server
+ Catalyst::Exception->throw("$me only works with local requests, not remote")
+ if $ENV{CATALYST_SERVER};
+
+ ### 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.
+ no warnings 'redefine';
+ my $dispatch = Catalyst->can('dispatch');
+ local *Catalyst::dispatch = sub {
+ $c = shift;
+ $dispatch->( $c, @_ );
+ };
+
+ ### 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,
+ crequest => $crequest,
+ 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
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
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.
+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 $res = request( ... );
-Returns a C<HTTP::Response> object.
+Returns a C<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
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.
-=cut
-
-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;
- *{"$caller\::crequest"} = sub {
- my $me = ref $self || $self;
-
- ### throw an exception if crequest is being used against a remote
- ### server
- Catalyst::Exception->throw("$me only works with local requests, not remote")
- if $ENV{CATALYST_SERVER};
-
- ### 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.
- no warnings 'redefine';
- my $dispatch = Catalyst->can('dispatch');
- local *Catalyst::dispatch = sub {
- $c = shift;
- $dispatch->( $c, @_ );
- };
-
- ### 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 );
- };
-}
-
=head2 $res = Catalyst::Test::local_request( $AppClass, $url );
Simulate a request using L<HTTP::Request::AsCGI>.
require HTTP::Request::AsCGI;
my $request = Catalyst::Utils::request( shift(@_) );
+ _customize_request($request, @_);
my $cgi = HTTP::Request::AsCGI->new( $request, %ENV )->setup;
$class->handle_request;
my $request = Catalyst::Utils::request( shift(@_) );
my $server = URI->new( $ENV{CATALYST_SERVER} );
+ _customize_request($request, @_);
+
if ( $server->path =~ m|^(.+)?/$| ) {
my $path = $1;
$server->path("$path") if $path; # need to be quoted
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<Test::WWW::Mechanize::Catalyst>,
projects / catagits/Catalyst-Runtime.git / blobdiff