1 package Catalyst::Test;
7 use Catalyst::Exception;
12 my $build_exports = sub {
13 my ($self, $meth, $args, $defaults) = @_;
16 my $class = $args->{class};
18 if ( $ENV{CATALYST_SERVER} ) {
19 $request = sub { remote_request(@_) };
21 $request = sub { Catalyst::Exception->throw("Must specify a test app: use Catalyst::Test 'TestApp'") };
23 unless (Class::MOP::is_class_loaded($class)) {
24 Class::MOP::load_class($class);
28 $request = sub { local_request( $class, @_ ) };
31 my $get = sub { $request->(@_)->content };
33 my $ctx_request = sub {
34 my $me = ref $self || $self;
36 ### throw an exception if ctx_request is being used against a remote
38 Catalyst::Exception->throw("$me only works with local requests, not remote")
39 if $ENV{CATALYST_SERVER};
41 ### check explicitly for the class here, or the Cat->meta call will blow
43 Catalyst::Exception->throw("Must specify a test app: use Catalyst::Test 'TestApp'") unless $class;
45 ### place holder for $c after the request finishes; reset every time
46 ### requests are done.
49 ### hook into 'dispatch' -- the function gets called after all plugins
50 ### have done their work, and it's an easy place to capture $c.
52 my $meta = Class::MOP::get_metaclass_by_name($class);
54 $meta->add_after_method_modifier( "dispatch", sub {
57 $meta->make_immutable( replace_constructor => 1 );
58 Class::C3::reinitialize(); # Fixes RT#46459, I've failed to write a test for how/why, but it does.
59 ### do the request; C::T::request will know about the class name, and
60 ### we've already stopped it from doing remote requests above.
61 my $res = $request->( @_ );
63 ### return both values
70 ctx_request => $ctx_request,
73 return Test::More->builder->like($get->($action),@_);
77 return Test::More->builder->ok($request->($action)->is_success, @_);
79 action_redirect => sub {
81 return Test::More->builder->ok($request->($action)->is_redirect,@_);
83 action_notfound => sub {
85 return Test::More->builder->is_eq($request->($action)->code,404,@_);
87 contenttype_is => sub {
89 my $res = $request->($action);
90 return Test::More->builder->is_eq(scalar($res->content_type),@_);
98 my $import = Sub::Exporter::build_exporter({
99 groups => [ all => $build_exports ],
105 my ($self, $class, $opts) = @_;
107 qq{Importing Catalyst::Test without an application name is deprecated:\n
108 Instead of saying: use Catalyst::Test;
109 say: use Catalyst::Test (); # If you don't want to import a test app right now.
110 or say: use Catalyst::Test 'MyApp'; # If you do want to import a test app.\n\n})
112 $import->($self, '-all' => { class => $class });
113 $opts = {} unless ref $opts eq 'HASH';
114 $default_host = $opts->{default_host} if exists $opts->{default_host};
121 Catalyst::Test - Test Catalyst Applications
129 use Catalyst::Test 'TestApp';
130 my $content = get('index.html'); # Content as string
131 my $response = request('index.html'); # HTTP::Response object
132 my($res, $c) = ctx_request('index.html'); # HTTP::Response & context object
134 use HTTP::Request::Common;
135 my $response = request POST '/foo', [
140 # Run tests against a remote server
141 CATALYST_SERVER='http://localhost:3000/' prove -r -l lib/ t/
143 use Catalyst::Test 'TestApp';
144 use Test::More tests => 1;
146 ok( get('/foo') =~ /bar/ );
149 use Catalyst::Test 'MyApp', { default_host => 'myapp.com' };
150 like( get('/whichhost'), qr/served by myapp.com/ );
151 like( get( '/whichhost', { host => 'yourapp.com' } ), qr/served by yourapp.com/ );
153 local $Catalyst::Test::default_host = 'otherapp.com';
154 like( get('/whichhost'), qr/served by otherapp.com/ );
159 This module allows you to make requests to a Catalyst application either without
160 a server, by simulating the environment of an HTTP request using
161 L<HTTP::Request::AsCGI> or remotely if you define the CATALYST_SERVER
162 environment variable. This module also adds a few Catalyst-specific
163 testing methods as displayed in the method section.
165 The L<get|/"$content = get( ... )"> and L<request|/"$res = request( ... );">
166 functions take either a URI or an L<HTTP::Request> object.
168 =head1 INLINE TESTS WILL NO LONGER WORK
170 While it used to be possible to inline a whole testapp into a C<.t> file for a
171 distribution, this will no longer work.
173 The convention is to place your L<Catalyst> test apps into C<t/lib> in your
174 distribution. E.g.: C<t/lib/TestApp.pm>, C<t/lib/TestApp/Controller/Root.pm>,
175 etc.. Multiple test apps can be used in this way.
177 Then write your C<.t> files like so:
183 use Test::More tests => 6;
184 use Catalyst::Test 'TestApp';
188 =head2 $content = get( ... )
192 my $content = get('foo/bar?test=1');
194 Note that this method doesn't follow redirects, so to test for a
195 correctly redirecting page you'll need to use a combination of this
196 method and the L<request|/"$res = request( ... );"> method below:
198 my $res = request('/'); # redirects to /y
199 warn $res->header('location');
201 my $uri = URI->new($res->header('location'));
202 is ( $uri->path , '/y');
203 my $content = get($uri->path);
205 Note also that the content is returned as raw bytes, without any attempt
206 to decode it into characters.
208 =head2 $res = request( ... );
210 Returns an L<HTTP::Response> object. Accepts an optional hashref for request
211 header configuration; currently only supports setting 'host' value.
213 my $res = request('foo/bar?test=1');
214 my $virtual_res = request('foo/bar?test=1', {host => 'virtualhost.com'});
218 =head2 ($res, $c) = ctx_request( ... );
220 Works exactly like L<request|/"$res = request( ... );">, except it also returns the Catalyst context object,
221 C<$c>. Note that this only works for local requests.
223 =head2 $res = Catalyst::Test::local_request( $AppClass, $url );
225 Simulate a request using L<HTTP::Request::AsCGI>.
232 require HTTP::Request::AsCGI;
234 my $request = Catalyst::Utils::request( shift(@_) );
235 _customize_request($request, @_);
236 my $cgi = HTTP::Request::AsCGI->new( $request, %ENV )->setup;
238 $class->handle_request( env => \%ENV );
240 my $response = $cgi->restore->response;
241 $response->request( $request );
247 =head2 $res = Catalyst::Test::remote_request( $url );
249 Do an actual remote request using LWP.
255 require LWP::UserAgent;
257 my $request = Catalyst::Utils::request( shift(@_) );
258 my $server = URI->new( $ENV{CATALYST_SERVER} );
260 _customize_request($request, @_);
262 if ( $server->path =~ m|^(.+)?/$| ) {
264 $server->path("$path") if $path; # need to be quoted
267 # the request path needs to be sanitised if $server is using a
268 # non-root path due to potential overlap between request path and
271 # If request path is '/', we have to add a trailing slash to the
273 my $add_trailing = $request->uri->path eq '/';
275 my @sp = split '/', $server->path;
276 my @rp = split '/', $request->uri->path;
277 shift @sp;shift @rp; # leading /
279 foreach my $sp (@sp) {
280 $sp eq $rp[0] ? shift @rp : last
283 $request->uri->path(join '/', @rp);
285 if ( $add_trailing ) {
286 $request->uri->path( $request->uri->path . '/' );
290 $request->uri->scheme( $server->scheme );
291 $request->uri->host( $server->host );
292 $request->uri->port( $server->port );
293 $request->uri->path( $server->path . $request->uri->path );
297 $agent = LWP::UserAgent->new(
302 # work around newer LWP max_redirect 0 bug
303 # http://rt.cpan.org/Ticket/Display.html?id=40260
304 requests_redirectable => [],
310 return $agent->request($request);
313 sub _customize_request {
315 my $opts = pop(@_) || {};
316 $opts = {} unless ref($opts) eq 'HASH';
317 if ( my $host = exists $opts->{host} ? $opts->{host} : $default_host ) {
318 $request->header( 'Host' => $host );
324 Fetches the given URL and checks that the request was successful.
326 =head2 action_redirect
328 Fetches the given URL and checks that the request was a redirect.
330 =head2 action_notfound
332 Fetches the given URL and checks that the request was not found.
334 =head2 content_like( $url, $regexp [, $test_name] )
336 Fetches the given URL and returns whether the content matches the regexp.
338 =head2 contenttype_is
340 Check for given MIME type.
344 L<Catalyst>, L<Test::WWW::Mechanize::Catalyst>,
345 L<Test::WWW::Selenium::Catalyst>, L<Test::More>, L<HTTP::Request::Common>
349 Catalyst Contributors, see Catalyst.pm
353 This library is free software. You can redistribute it and/or modify it under
354 the same terms as Perl itself.