1 package Catalyst::Test;
8 use Catalyst::Exception;
14 my $build_exports = sub {
15 my ($self, $meth, $args, $defaults) = @_;
18 my $class = $args->{class};
20 if ( $ENV{CATALYST_SERVER} ) {
21 $request = sub { remote_request(@_) };
23 $request = sub { croak "Must specify a test app: use Catalyst::Test 'TestApp'"; }
25 unless (Class::MOP::is_class_loaded($class)) {
26 Class::MOP::load_class($class);
30 $request = sub { local_request( $class, @_ ) };
33 my $get = sub { $request->(@_)->content };
35 my $ctx_request = sub {
36 my $me = ref $self || $self;
38 ### throw an exception if ctx_request is being used against a remote
40 Catalyst::Exception->throw("$me only works with local requests, not remote")
41 if $ENV{CATALYST_SERVER};
43 ### check explicitly for the class here, or the Cat->meta call will blow
45 Catalyst::Exception->throw("Must specify a test app: use Catalyst::Test 'TestApp'") unless $class;
47 ### place holder for $c after the request finishes; reset every time
48 ### requests are done.
51 ### hook into 'dispatch' -- the function gets called after all plugins
52 ### have done their work, and it's an easy place to capture $c.
54 my $meta = Class::MOP::get_metaclass_by_name($class);
56 $meta->add_after_method_modifier( "dispatch", sub {
57 $ctx_closed_over = shift;
59 $meta->make_immutable( replace_constructor => 1 );
60 Class::C3::reinitialize(); # Fixes RT#46459, I've failed to write a test for how/why, but it does.
61 ### do the request; C::T::request will know about the class name, and
62 ### we've already stopped it from doing remote requests above.
63 my $res = $request->( @_ );
65 # Make sure not to leave a reference $ctx hanging around.
66 # This means that the context will go out of scope as soon as the
67 # caller disposes of it, rather than waiting till the next time
68 # that ctx_request is called. This can be important if your $ctx
69 # ends up with a reference to a shared resource or lock (for example)
70 # which you want to clean up in test teardown - if the $ctx is still
71 # closed over then you're stuffed...
72 my $ctx = $ctx_closed_over;
73 undef $ctx_closed_over;
75 ### return both values
76 return ( $res, $ctx );
82 ctx_request => $ctx_request,
85 return Test::More->builder->like($get->($action),@_);
89 return Test::More->builder->ok($request->($action)->is_success, @_);
91 action_redirect => sub {
93 return Test::More->builder->ok($request->($action)->is_redirect,@_);
95 action_notfound => sub {
97 return Test::More->builder->is_eq($request->($action)->code,404,@_);
99 contenttype_is => sub {
101 my $res = $request->($action);
102 return Test::More->builder->is_eq(scalar($res->content_type),@_);
110 my $import = Sub::Exporter::build_exporter({
111 groups => [ all => $build_exports ],
117 my ($self, $class, $opts) = @_;
119 qq{Importing Catalyst::Test without an application name is deprecated:\n
120 Instead of saying: use Catalyst::Test;
121 say: use Catalyst::Test (); # If you don't want to import a test app right now.
122 or say: use Catalyst::Test 'MyApp'; # If you do want to import a test app.\n\n})
124 $import->($self, '-all' => { class => $class });
125 $opts = {} unless ref $opts eq 'HASH';
126 $default_host = $opts->{default_host} if exists $opts->{default_host};
133 Catalyst::Test - Test Catalyst Applications
141 use Catalyst::Test 'TestApp';
142 my $content = get('index.html'); # Content as string
143 my $response = request('index.html'); # HTTP::Response object
144 my($res, $c) = ctx_request('index.html'); # HTTP::Response & context object
146 use HTTP::Request::Common;
147 my $response = request POST '/foo', [
152 # Run tests against a remote server
153 CATALYST_SERVER='http://localhost:3000/' prove -r -l lib/ t/
155 use Catalyst::Test 'TestApp';
156 use Test::More tests => 1;
158 ok( get('/foo') =~ /bar/ );
161 use Catalyst::Test 'MyApp', { default_host => 'myapp.com' };
162 like( get('/whichhost'), qr/served by myapp.com/ );
163 like( get( '/whichhost', { host => 'yourapp.com' } ), qr/served by yourapp.com/ );
165 local $Catalyst::Test::default_host = 'otherapp.com';
166 like( get('/whichhost'), qr/served by otherapp.com/ );
171 This module allows you to make requests to a Catalyst application either without
172 a server, by simulating the environment of an HTTP request using
173 L<HTTP::Request::AsCGI> or remotely if you define the CATALYST_SERVER
174 environment variable. This module also adds a few Catalyst-specific
175 testing methods as displayed in the method section.
177 The L<get|/"$content = get( ... )"> and L<request|/"$res = request( ... );">
178 functions take either a URI or an L<HTTP::Request> object.
180 =head1 INLINE TESTS WILL NO LONGER WORK
182 While it used to be possible to inline a whole testapp into a C<.t> file for a
183 distribution, this will no longer work.
185 The convention is to place your L<Catalyst> test apps into C<t/lib> in your
186 distribution. E.g.: C<t/lib/TestApp.pm>, C<t/lib/TestApp/Controller/Root.pm>,
187 etc.. Multiple test apps can be used in this way.
189 Then write your C<.t> files like so:
195 use Test::More tests => 6;
196 use Catalyst::Test 'TestApp';
200 =head2 $content = get( ... )
204 my $content = get('foo/bar?test=1');
206 Note that this method doesn't follow redirects, so to test for a
207 correctly redirecting page you'll need to use a combination of this
208 method and the L<request|/"$res = request( ... );"> method below:
210 my $res = request('/'); # redirects to /y
211 warn $res->header('location');
213 my $uri = URI->new($res->header('location'));
214 is ( $uri->path , '/y');
215 my $content = get($uri->path);
217 Note also that the content is returned as raw bytes, without any attempt
218 to decode it into characters.
220 =head2 $res = request( ... );
222 Returns an L<HTTP::Response> object. Accepts an optional hashref for request
223 header configuration; currently only supports setting 'host' value.
225 my $res = request('foo/bar?test=1');
226 my $virtual_res = request('foo/bar?test=1', {host => 'virtualhost.com'});
230 =head2 ($res, $c) = ctx_request( ... );
232 Works exactly like L<request|/"$res = request( ... );">, except it also returns the Catalyst context object,
233 C<$c>. Note that this only works for local requests.
235 =head2 $res = Catalyst::Test::local_request( $AppClass, $url );
237 Simulate a request using L<HTTP::Request::AsCGI>.
244 my $app = ref($class) eq "CODE" ? $class : $class->_finalized_psgi_app;
246 my $request = Catalyst::Utils::request(shift);
248 _customize_request($request, \%extra_env, @_);
252 app => sub { $app->({ %{ $_[0] }, %extra_env }) },
254 my $psgi_app = shift;
256 my $resp = $psgi_app->($request);
258 # HTML head parsing based on LWP::UserAgent
260 # This is not just horrible and possibly broken, but also really
261 # doesn't belong here. Whoever wants this should be working on
262 # getting it into Plack::Test, or make a middleware out of it, or
263 # whatever. Seriously - horrible.
265 require HTML::HeadParser;
267 my $parser = HTML::HeadParser->new();
268 $parser->xml_mode(1) if $resp->content_is_xhtml;
269 $parser->utf8_mode(1) if $] >= 5.008 && $HTML::Parser::VERSION >= 3.40;
271 $parser->parse( $resp->content );
272 my $h = $parser->header;
273 for my $f ( $h->header_field_names ) {
274 $resp->init_header( $f, [ $h->header($f) ] );
285 =head2 $res = Catalyst::Test::remote_request( $url );
287 Do an actual remote request using LWP.
293 require LWP::UserAgent;
295 my $request = Catalyst::Utils::request( shift(@_) );
296 my $server = URI->new( $ENV{CATALYST_SERVER} );
298 _customize_request($request, @_);
300 if ( $server->path =~ m|^(.+)?/$| ) {
302 $server->path("$path") if $path; # need to be quoted
305 # the request path needs to be sanitised if $server is using a
306 # non-root path due to potential overlap between request path and
309 # If request path is '/', we have to add a trailing slash to the
311 my $add_trailing = $request->uri->path eq '/';
313 my @sp = split '/', $server->path;
314 my @rp = split '/', $request->uri->path;
315 shift @sp;shift @rp; # leading /
317 foreach my $sp (@sp) {
318 $sp eq $rp[0] ? shift @rp : last
321 $request->uri->path(join '/', @rp);
323 if ( $add_trailing ) {
324 $request->uri->path( $request->uri->path . '/' );
328 $request->uri->scheme( $server->scheme );
329 $request->uri->host( $server->host );
330 $request->uri->port( $server->port );
331 $request->uri->path( $server->path . $request->uri->path );
335 $agent = LWP::UserAgent->new(
340 # work around newer LWP max_redirect 0 bug
341 # http://rt.cpan.org/Ticket/Display.html?id=40260
342 requests_redirectable => [],
348 return $agent->request($request);
351 sub _customize_request {
353 my $extra_env = shift;
354 my $opts = pop(@_) || {};
355 $opts = {} unless ref($opts) eq 'HASH';
356 if ( my $host = exists $opts->{host} ? $opts->{host} : $default_host ) {
357 $request->header( 'Host' => $host );
360 if (my $extra = $opts->{extra_env}) {
361 @{ $extra_env }{keys %{ $extra }} = values %{ $extra };
367 Fetches the given URL and checks that the request was successful.
369 =head2 action_redirect
371 Fetches the given URL and checks that the request was a redirect.
373 =head2 action_notfound
375 Fetches the given URL and checks that the request was not found.
377 =head2 content_like( $url, $regexp [, $test_name] )
379 Fetches the given URL and returns whether the content matches the regexp.
381 =head2 contenttype_is
383 Check for given MIME type.
387 L<Catalyst>, L<Test::WWW::Mechanize::Catalyst>,
388 L<Test::WWW::Selenium::Catalyst>, L<Test::More>, L<HTTP::Request::Common>
392 Catalyst Contributors, see Catalyst.pm
396 This library is free software. You can redistribute it and/or modify it under
397 the same terms as Perl itself.