use Catalyst::Utils;
use Class::MOP;
use Sub::Exporter;
-use Carp;
+use Carp 'croak', 'carp';
-my $build_exports = sub {
- my ($self, $meth, $args, $defaults) = @_;
+sub _build_request_export {
+ my ($self, $args) = @_;
+
+ return sub { _remote_request(@_) }
+ if $args->{remote};
- 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;
+ # Here we should be failing right away, but for some stupid backcompat thing
+ # I don't quite remember we fail lazily here. Needs a proper deprecation and
+ # then removal.
+ return sub { croak "Must specify a test app: use Catalyst::Test 'TestApp'" }
+ unless $class;
- my $app = $class->psgi_app;
+ Class::MOP::load_class($class) unless Class::MOP::is_class_loaded($class);
+ $class->import;
- $request = sub { local_request( $app, @_ ) };
- }
+ return sub { _local_request( $class, @_ ) };
+}
+
+sub _build_get_export {
+ my ($self, $args) = @_;
+ my $request = $args->{request};
- my $get = sub { $request->(@_)->content };
+ return sub { $request->(@_)->content };
+}
+sub _build_ctx_request_export {
+ my ($self, $args) = @_;
+ my ($class, $request) = @{ $args }{qw(class request)};
- my $ctx_request = sub {
+ return sub {
my $me = ref $self || $self;
- ### throw an exception if ctx_request is being used against a remote
- ### server
+ # fail 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
+ # 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.
+ # 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 {
- $c = shift;
+ $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->( @_ );
- ### return both values
- return ( $res, $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 = $args->{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 ( $res, $ctx );
};
+}
+
+my $build_exports = sub {
+ my ($self, $meth, $args, $defaults) = @_;
+ my $class = $args->{class};
+
+ my $request = $self->_build_request_export({
+ class => $class,
+ remote => $ENV{CATALYST_SERVER},
+ });
+
+ my $get = $self->_build_get_export({ request => $request });
+
+ my $ctx_request = $self->_build_ctx_request_export({
+ class => $class,
+ request => $request,
+ });
return {
request => $request,
is ( $uri->path , '/y');
my $content = get($uri->path);
+Note also that the content is returned as raw bytes, without any attempt
+to decode it into characters.
+
=head2 $res = request( ... );
Returns an L<HTTP::Response> object. Accepts an optional hashref for request
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|/"$res = 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 local_request {
- my $app = shift;
+sub _local_request {
+ my $class = shift;
+
+ my $app = ref($class) eq "CODE" ? $class : $class->_finalized_psgi_app;
my $request = Catalyst::Utils::request(shift);
my %extra_env;
my $ret;
test_psgi
app => sub { $app->({ %{ $_[0] }, %extra_env }) },
- client => sub { $ret = shift->($request) };
+ client => sub {
+ my $psgi_app = shift;
- return $ret;
-}
+ my $resp = $psgi_app->($request);
-my $agent;
+ # 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.
-=head2 $res = Catalyst::Test::remote_request( $url );
+ require HTML::HeadParser;
-Do an actual remote request using LWP.
+ 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;
-=cut
+ $parser->parse( $resp->content );
+ my $h = $parser->header;
+ for my $f ( $h->header_field_names ) {
+ $resp->init_header( $f, [ $h->header($f) ] );
+ }
+
+ $ret = $resp;
+ };
+
+ return $ret;
+}
-sub remote_request {
+my $agent;
+sub _remote_request {
require LWP::UserAgent;
my $request = Catalyst::Utils::request( shift(@_) );
return $agent->request($request);
}
+for my $name (qw(local_request remote_request)) {
+ my $fun = sub {
+ carp <<"EOW";
+Calling Catalyst::Test::${name}() directly is deprecated.
+
+Please import Catalyst::Test into your namespace and use the provided request()
+function instead.
+EOW
+ return __PACKAGE__->can("_${name}")->(@_);
+ };
+
+ no strict 'refs';
+ *$name = $fun;
+}
+
sub _customize_request {
my $request = shift;
my $extra_env = shift;
}
}
-=head2 action_ok
+=head2 action_ok($url [, $test_name ])
-Fetches the given URL and checks that the request was successful.
+Fetches the given URL and checks that the request was successful. An optional
+second argument can be given to specify the name of the test.
-=head2 action_redirect
+=head2 action_redirect($url [, $test_name ])
-Fetches the given URL and checks that the request was a redirect.
+Fetches the given URL and checks that the request was a redirect. An optional
+second argument can be given to specify the name of the test.
-=head2 action_notfound
+=head2 action_notfound($url [, $test_name ])
-Fetches the given URL and checks that the request was not found.
+Fetches the given URL and checks that the request was not found. An optional
+second argument can be given to specify the name of the test.
-=head2 content_like( $url, $regexp [, $test_name] )
+=head2 content_like( $url, $regexp [, $test_name ] )
-Fetches the given URL and returns whether the content matches the regexp.
+Fetches the given URL and returns whether the content matches the regexp. An
+optional third argument can be given to specify the name of the test.
-=head2 contenttype_is
+=head2 contenttype_is($url, $type [, $test_name ])
-Check for given MIME type.
+Verify the given URL has a content type of $type and optionally specify a test name.
=head1 SEE ALSO
This library is free software. You can redistribute it and/or modify it under
the same terms as Perl itself.
+=begin Pod::Coverage
+
+local_request
+
+remote_request
+
+=end Pod::Coverage
+
=cut
1;