X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FTest.pm;h=e524840aec7ad6b6800e43a477b9240ffa0e2e40;hp=9f2f7bed59a65a2798d308fa2a03aa2444b983ab;hb=9c74923de2304b8c8f0a7a2faa0854ad9b4d3a92;hpb=f4c0f6f787fe962604cf62cf7ad7c87f0c59b673 diff --git a/lib/Catalyst/Test.pm b/lib/Catalyst/Test.pm index 9f2f7be..e524840 100644 --- a/lib/Catalyst/Test.pm +++ b/lib/Catalyst/Test.pm @@ -2,10 +2,133 @@ package Catalyst::Test; use strict; use warnings; +use Test::More (); +use Plack::Test; use Catalyst::Exception; use Catalyst::Utils; -use Class::Inspector; +use Class::MOP; +use Sub::Exporter; +use Carp; + +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 { 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; + + my $app = $class->psgi_app; + + $request = sub { local_request( $app, @_ ) }; + } + + 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 $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. + + 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, $ctx ); + }; + + 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) = @_; + 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}; + return 1; + } +} =head1 NAME @@ -18,38 +141,65 @@ Catalyst::Test - Test Catalyst Applications # 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 -r -l lib/ t/ - # Tests with inline apps need to use Catalyst::Engine::Test - package TestApp; + use Catalyst::Test 'TestApp'; + use Test::More tests => 1; - use Catalyst; + ok( get('/foo') =~ /bar/ ); - sub foo : Global { - my ( $self, $c ) = @_; - $c->res->output('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/ ); } - __PACKAGE__->setup(); +=head1 DESCRIPTION - package main; +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 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. - use Test::More tests => 1; - use Catalyst::Test 'TestApp'; +The L and L +functions take either a URI or an L object. - ok( get('/foo') =~ /bar/ ); +=head1 INLINE TESTS WILL NO LONGER WORK -=head1 DESCRIPTION +While it used to be possible to inline a whole testapp into a C<.t> file for a +distribution, this will no longer work. -Test Catalyst Applications. +The convention is to place your L test apps into C in your +distribution. E.g.: C, C, +etc.. Multiple test apps can be used in this way. -=head2 METHODS +Then write your C<.t> files like so: -=head2 get + 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( ... ) Returns the content. @@ -57,7 +207,7 @@ Returns the content. 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 method below: +method and the L method below: my $res = request('/'); # redirects to /y warn $res->header('location'); @@ -66,62 +216,71 @@ method and the L method below: is ( $uri->path , '/y'); my $content = get($uri->path); -=head2 request +Note also that the content is returned as raw bytes, without any attempt +to decode it into characters. -Returns a C object. +=head2 $res = request( ... ); - my $res = request('foo/bar?test=1'); +Returns an L object. Accepts an optional hashref for request +header configuration; currently only supports setting 'host' value. -=cut - -sub import { - my $self = shift; - my $class = shift; + my $res = request('foo/bar?test=1'); + my $virtual_res = request('foo/bar?test=1', {host => 'virtualhost.com'}); - my ( $get, $request ); +=head1 FUNCTIONS - 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; +=head2 ($res, $c) = ctx_request( ... ); - $request = sub { local_request( $class, @_ ) }; - $get = sub { local_request( $class, @_ )->content }; - } +Works exactly like L, except it also returns the Catalyst context object, +C<$c>. Note that this only works for local requests. - no strict 'refs'; - my $caller = caller(0); - *{"$caller\::request"} = $request; - *{"$caller\::get"} = $get; -} +=head2 $res = Catalyst::Test::local_request( $AppClass, $url ); -=head2 local_request +Simulate a request using L. =cut sub local_request { - my $class = shift; - - require HTTP::Request::AsCGI; - - my $request = Catalyst::Utils::request( shift(@_) ); - 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; -=head2 remote_request +=head2 $res = Catalyst::Test::remote_request( $url ); Do an actual remote request using LWP. @@ -134,8 +293,11 @@ sub remote_request { my $request = Catalyst::Utils::request( shift(@_) ); my $server = URI->new( $ENV{CATALYST_SERVER} ); + _customize_request($request, @_); + if ( $server->path =~ m|^(.+)?/$| ) { - $server->path("$1"); # need to be quoted + my $path = $1; + $server->path("$path") if $path; # need to be quoted } # the request path needs to be sanitised if $server is using a @@ -145,7 +307,7 @@ sub remote_request { # 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 / @@ -155,7 +317,7 @@ sub remote_request { } } $request->uri->path(join '/', @rp); - + if ( $add_trailing ) { $request->uri->path( $request->uri->path . '/' ); } @@ -172,6 +334,10 @@ sub remote_request { 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; @@ -180,17 +346,52 @@ sub remote_request { return $agent->request($request); } +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 checks that the request was successful. + +=head2 action_redirect + +Fetches the given URL and checks that the request was a redirect. + +=head2 action_notfound + +Fetches the given URL and checks that the request was not found. + +=head2 content_like( $url, $regexp [, $test_name] ) + +Fetches the given URL and returns whether the content matches the regexp. + +=head2 contenttype_is + +Check for given MIME type. + =head1 SEE ALSO -L. +L, L, +L, L, L -=head1 AUTHOR +=head1 AUTHORS -Sebastian Riedel, C +Catalyst Contributors, see Catalyst.pm =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