package Catalyst::Test;
use strict;
-use UNIVERSAL::require;
-use IO::File;
-use HTTP::Request;
-use HTTP::Response;
-use Socket;
-use URI;
+use warnings;
+use Test::More ();
+
+use Plack::Test;
+use Catalyst::Exception;
+use Catalyst::Utils;
+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;
-require Catalyst;
+ $request = sub { local_request( $app, @_ ) };
+ }
-my $class;
-$ENV{CATALYST_ENGINE} = 'CGI';
-$ENV{CATALYST_TEST} = 1;
+ 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
-Catalyst::Test - Test Catalyst applications
+Catalyst::Test - Test Catalyst Applications
=head1 SYNOPSIS
# Helper
- script/cgi-server.pl
- script/server.pl
script/test.pl
# 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'
+ ];
- # Request
- perl -MCatalyst::Test=MyApp -e1 index.html
+ # Run tests against a remote server
+ CATALYST_SERVER='http://localhost:3000/' prove -r -l lib/ t/
+
+ use Catalyst::Test 'TestApp';
+ use Test::More tests => 1;
- # Server
- perl -MCatalyst::Test=MyApp -e1 3000
+ 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
-Test Catalyst applications.
+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. This module also adds a few Catalyst-specific
+testing methods as displayed in the method section.
+
+The L<get|/"$content = get( ... )"> and L<request|/"$res = request( ... );">
+functions take either a URI or an L<HTTP::Request> object.
+
+=head1 INLINE TESTS WILL NO LONGER WORK
+
+While it used to be possible to inline a whole testapp into a C<.t> file for a
+distribution, this will no longer work.
+
+The convention is to place your L<Catalyst> test apps into C<t/lib> in your
+distribution. E.g.: C<t/lib/TestApp.pm>, C<t/lib/TestApp/Controller/Root.pm>,
+etc.. Multiple test apps can be used in this way.
+
+Then write your C<.t> files like so:
+
+ use strict;
+ use warnings;
+ use FindBin '$Bin';
+ use lib "$Bin/lib";
+ use Test::More tests => 6;
+ use Catalyst::Test 'TestApp';
-=head2 METHODS
+=head1 METHODS
-=head3 get
+=head2 $content = get( ... )
Returns the content.
my $content = get('foo/bar?test=1');
-=head3 request
+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<request|/"$res = request( ... );"> method below:
-Returns a C<HTTP::Response> object.
+ my $res = request('/'); # redirects to /y
+ warn $res->header('location');
+ use URI;
+ my $uri = URI->new($res->header('location'));
+ is ( $uri->path , '/y');
+ my $content = get($uri->path);
- my $res =request('foo/bar?test=1');
+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
+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
+
+=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
-{
- no warnings;
- CHECK {
- if ( ( caller(0) )[1] eq '-e' ) {
- if ( $ARGV[0] =~ /^\d+$/ ) { server( $ARGV[0] ) }
- else { print request( $ARGV[0] || 'http://localhost' )->content }
- }
- }
+sub local_request {
+ 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) ] );
+ }
+
+ $ret = $resp;
+ };
+
+ return $ret;
}
-sub import {
- my $self = shift;
- if ( $class = shift ) {
- $class->require;
- unless ( $INC{'Test/Builder.pm'} ) {
- die qq/Couldn't load "$class", "$@"/ if $@;
+my $agent;
+
+=head2 $res = Catalyst::Test::remote_request( $url );
+
+Do an actual remote request using LWP.
+
+=cut
+
+sub remote_request {
+
+ require LWP::UserAgent;
+
+ 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
+ }
+
+ # the request path needs to be sanitised if $server is using a
+ # non-root path due to potential overlap between request path and
+ # response path.
+ if ($server->path) {
+ # 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 /
+ if (@rp) {
+ foreach my $sp (@sp) {
+ $sp eq $rp[0] ? shift @rp : last
+ }
+ }
+ $request->uri->path(join '/', @rp);
+
+ if ( $add_trailing ) {
+ $request->uri->path( $request->uri->path . '/' );
}
- my $caller = caller(0);
- no strict 'refs';
- *{"$caller\::request"} = \&request;
- *{"$caller\::get"} = sub { request(@_)->content };
}
+
+ $request->uri->scheme( $server->scheme );
+ $request->uri->host( $server->host );
+ $request->uri->port( $server->port );
+ $request->uri->path( $server->path . $request->uri->path );
+
+ unless ($agent) {
+
+ $agent = LWP::UserAgent->new(
+ 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;
+ }
+
+ return $agent->request($request);
}
-sub request {
+sub _customize_request {
my $request = shift;
- unless ( ref $request ) {
- $request = URI->new( $request, 'http' );
+ 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 );
}
- unless ( ref $request eq 'HTTP::Request' ) {
- $request = HTTP::Request->new( 'GET', $request );
- }
- local ( *STDIN, *STDOUT );
- my %clean = %ENV;
- my $output = '';
- $ENV{CONTENT_TYPE} ||= $request->header('Content-Type') || '';
- $ENV{CONTENT_LENGTH} ||= $request->header('Content-Length') || '';
- $ENV{GATEWAY_INTERFACE} ||= 'CGI/1.1';
- $ENV{HTTP_USER_AGENT} ||= 'Catalyst';
- $ENV{HTTP_HOST} ||= $request->uri->host || 'localhost';
- $ENV{QUERY_STRING} ||= $request->uri->query || '';
- $ENV{REQUEST_METHOD} ||= $request->method;
- $ENV{SCRIPT_NAME} ||= $request->uri->path || '/';
- $ENV{SERVER_NAME} ||= $request->uri->host || 'localhost';
- $ENV{SERVER_PORT} ||= $request->uri->port;
- $ENV{SERVER_PROTOCOL} ||= 'HTTP/1.1';
-
- for my $field ( $request->header_field_names ) {
- if ( $field =~ /^Content-(Length|Type)$/ ) {
- next;
- }
- $field =~ s/-/_/g;
- $ENV{ 'HTTP_' . uc($field) } = $request->header($field);
- }
- if ( $request->content_length ) {
- my $body = IO::File->new_tmpfile;
- $body->print( $request->content ) or die $!;
- $body->seek( 0, SEEK_SET ) or die $!;
- open( STDIN, "<&=", $body->fileno )
- or die("Failed to dup \$body: $!");
+
+ if (my $extra = $opts->{extra_env}) {
+ @{ $extra_env }{keys %{ $extra }} = values %{ $extra };
}
- open( STDOUT, '>', \$output );
- $class->handler;
- %ENV = %clean;
- return HTTP::Response->parse($output);
}
-=head3 server
+=head2 action_ok
-Starts a testserver.
+Fetches the given URL and checks that the request was successful.
- Catalyst::Test::server(3000);
+=head2 action_redirect
-=cut
+Fetches the given URL and checks that the request was a redirect.
-sub server {
- my ( $port, $script ) = @_;
-
- # Listen
- my $tcp = getprotobyname('tcp');
- socket( HTTPDaemon, PF_INET, SOCK_STREAM, $tcp ) or die $!;
- setsockopt( HTTPDaemon, SOL_SOCKET, SO_REUSEADDR, pack( "l", 1 ) )
- or warn $!;
- bind( HTTPDaemon, sockaddr_in( $port, INADDR_ANY ) ) or die $!;
- listen( HTTPDaemon, SOMAXCONN ) or die $!;
-
- print "You can connect to your server at http://localhost:$port\n";
-
- # Process
- my %clean = %ENV;
- for ( ; accept( Remote, HTTPDaemon ) ; close Remote ) {
- *STDIN = *Remote;
- *STDOUT = *Remote;
- my $remote_sockaddr = getpeername(STDIN);
- my ( undef, $iaddr ) = sockaddr_in($remote_sockaddr);
- my $peername = gethostbyaddr( $iaddr, AF_INET ) || "localhost";
- my $peeraddr = inet_ntoa($iaddr) || "127.0.0.1";
- my $local_sockaddr = getsockname(STDIN);
- my ( undef, $localiaddr ) = sockaddr_in($local_sockaddr);
- my $localname = gethostbyaddr( $localiaddr, AF_INET ) || 'localhost';
- my $localaddr = inet_ntoa($localiaddr) || '127.0.0.1';
- my $chunk;
-
- while ( sysread( STDIN, my $buff, 1 ) ) {
- last if $buff eq "\n";
- $chunk .= $buff;
- }
- my ( $method, $request_uri, $proto, undef ) = split /\s+/, $chunk;
- my ( $file, undef, $query_string ) =
- ( $request_uri =~ /([^?]*)(\?(.*))?/ );
- last if ( $method !~ /^(GET|POST|HEAD)$/ );
- %ENV = %clean;
-
- $chunk = '';
- while ( sysread( STDIN, my $buff, 1 ) ) {
- if ( $buff eq "\n" ) {
- $chunk =~ s/[\r\l\n\s]+$//;
- if ( $chunk =~ /^([\w\-]+): (.+)/i ) {
- my $tag = uc($1);
- $tag =~ s/^COOKIES$/COOKIE/;
- my $val = $2;
- $tag =~ s/-/_/g;
- $tag = "HTTP_" . $tag
- unless ( grep /^$tag$/, qw(CONTENT_LENGTH CONTENT_TYPE) );
- if ( $ENV{$tag} ) { $ENV{$tag} .= "; $val" }
- else { $ENV{$tag} = $val }
- }
- last if $chunk =~ /^$/;
- $chunk = '';
- }
- else { $chunk .= $buff }
- }
- $ENV{SERVER_PROTOCOL} = $proto;
- $ENV{SERVER_PORT} = $port;
- $ENV{SERVER_NAME} = $localname;
- $ENV{SERVER_URL} = "http://$localname:$port/";
- $ENV{PATH_INFO} = $file;
- $ENV{REQUEST_URI} = $request_uri;
- $ENV{REQUEST_METHOD} = $method;
- $ENV{REMOTE_ADDR} = $peeraddr;
- $ENV{REMOTE_HOST} = $peername;
- $ENV{QUERY_STRING} = $query_string || '';
- $ENV{CONTENT_TYPE} ||= 'multipart/form-data';
- $ENV{SERVER_SOFTWARE} ||= "Catalyst/$Catalyst::VERSION";
- $script ? print STDOUT `$script` : $class->run;
- }
-}
+=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<Catalyst>.
+L<Catalyst>, L<Test::WWW::Mechanize::Catalyst>,
+L<Test::WWW::Selenium::Catalyst>, L<Test::More>, L<HTTP::Request::Common>
-=head1 AUTHOR
+=head1 AUTHORS
-Sebastian Riedel, C<sri@cpan.org>
+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
projects / catagits/Catalyst-Runtime.git / blobdiff