package Test::WWW::Mechanize::Catalyst;
-use strict;
-use warnings;
+use Moose;
use Carp qw/croak/;
require Catalyst::Test; # Do not call import
use HTML::Entities;
use Test::WWW::Mechanize;
-use base qw(Test::WWW::Mechanize);
+extends 'Test::WWW::Mechanize', 'Moose::Object';
-our $VERSION = '0.45';
+#use namespace::clean -execept => 'meta';
+
+our $VERSION = '0.56';
+our $APP_CLASS;
my $Test = Test::Builder->new();
-# the reason for the auxiliary package is that both WWW::Mechanize and
-# Catalyst::Test have a subroutine named 'request'
+has catalyst_app => (
+ is => 'ro',
+ predicate => 'has_catalyst_app',
+);
+
+has allow_external => (
+ is => 'rw',
+ isa => 'Bool',
+ default => 0
+);
+
+has host => (
+ is => 'rw',
+ isa => 'Str',
+ clearer => 'clear_host',
+ predicate => 'has_host',
+);
-our $APP_CLASS;
sub new {
- my ($class, %args) = @_;
-
- my $app;
- if (exists $args{catalyst_app}) {
- $app = $args{catalyst_app};
-
- require Class::Inspector->filename( $app )
- unless Class::Inspector->loaded( $app );
- } elsif (!defined $APP_CLASS) {
- croak 'Please provide a catalyst_app option or import Test::WWW::Mechanize::Catalyst with a class name';
- } else {
- $app = $APP_CLASS;
- }
+ my $class = shift;
+
+ my $args = ref $_[0] ? $_[0] : { @_ };
+
+ # Dont let LWP complain about options for our attributes
+ my %attr_options = map {
+ my $n = $_->init_arg;
+ defined $n && exists $args->{$n}
+ ? ( $n => delete $args->{$n} )
+ : ( );
+ } $class->meta->get_all_attributes;
+
+ my $obj = $class->SUPER::new(%$args);
+ my $self = $class->meta->new_object(
+ __INSTANCE__ => $obj,
+ ($APP_CLASS ? (catalyst_app => $APP_CLASS) : () ),
+ %attr_options
+ );
+
+ $self->BUILDALL;
+
- my $self = $class->SUPER::new(%args);
- $self->{catalyst_app} = $app;
return $self;
}
-sub allow_external {
- my ( $self, $value ) = @_;
- return $self->{allow_external} unless defined $value;
- $self->{allow_external} = $value;
+sub BUILD {
+ my ($self) = @_;
+
+ unless ($ENV{CATALYST_SERVER}) {
+ croak "catalyst_app attribute is required unless CATALYST_SERVER env variable is set"
+ unless $self->has_catalyst_app;
+ Class::MOP::load_class($self->catalyst_app)
+ unless (Class::MOP::is_class_loaded($self->catalyst_app));
+ }
}
sub _make_request {
my ( $self, $request ) = @_;
- $self->cookie_jar->add_cookie_header($request) if $self->cookie_jar;
- if ( $self->{allow_external} ) {
- unless ( $request->uri->as_string =~ m{^/}
- || $request->uri->host eq 'localhost' )
- {
- return $self->SUPER::_make_request($request);
- }
- }
-
- my $uri = $request->uri;
- if ($uri->as_string =~ m{^/}) {
- $uri->scheme('http');
- $uri->host('localhost');
- }
- my @creds = $self->get_basic_credentials( "Basic", $uri );
- $request->authorization_basic( @creds ) if @creds;
+ my $response = $self->_do_catalyst_request($request);
+ $response->header( 'Content-Base', $response->request->uri )
+ unless $response->header('Content-Base');
- my $response = Catalyst::Test::local_request($self->{catalyst_app}, $request);
- $response->header( 'Content-Base', $request->uri );
- $response->request($request);
- if ( $request->uri->as_string =~ m{^/} ) {
- $request->uri(
- URI->new( 'http://localhost:80/' . $request->uri->as_string ) );
- }
$self->cookie_jar->extract_cookies($response) if $self->cookie_jar;
# fail tests under the Catalyst debug screen
# check if that was a redirect
if ( $response->header('Location')
+ && $response->is_redirect
&& $self->redirect_ok( $request, $response ) )
{
return $response;
}
+sub _set_host_header {
+ my ( $self, $request ) = @_;
+ # If there's no Host header, set one.
+ unless ($request->header('Host')) {
+ my $host = $self->has_host
+ ? $self->host
+ : $request->uri->host;
+ $host .= ':'.$request->uri->_port if $request->uri->_port;
+ $request->header('Host', $host);
+ }
+}
+
+sub _do_catalyst_request {
+ my ($self, $request) = @_;
+
+ my $uri = $request->uri;
+ $uri->scheme('http') unless defined $uri->scheme;
+ $uri->host('localhost') unless defined $uri->host;
+
+ $request = $self->prepare_request($request);
+ $self->cookie_jar->add_cookie_header($request) if $self->cookie_jar;
+
+ # Woe betide anyone who unsets CATALYST_SERVER
+ return $self->_do_remote_request($request)
+ if $ENV{CATALYST_SERVER};
+
+ $self->_set_host_header($request);
+
+ my $res = $self->_check_external_request($request);
+ return $res if $res;
+
+ my @creds = $self->get_basic_credentials( "Basic", $uri );
+ $request->authorization_basic( @creds ) if @creds;
+
+ require Catalyst;
+ my $response = $Catalyst::VERSION >= 5.89000 ?
+ Catalyst::Test::_local_request($self->{catalyst_app}, $request) :
+ Catalyst::Test::local_request($self->{catalyst_app}, $request);
+
+
+ # LWP would normally do this, but we dont get down that far.
+ $response->request($request);
+
+ return $response
+}
+
+sub _check_external_request {
+ my ($self, $request) = @_;
+
+ # If there's no host then definatley not an external request.
+ $request->uri->can('host_port') or return;
+
+ if ( $self->allow_external && $request->uri->host_port ne 'localhost:80' ) {
+ return $self->SUPER::_make_request($request);
+ }
+ return undef;
+}
+
+sub _do_remote_request {
+ my ($self, $request) = @_;
+
+ my $res = $self->_check_external_request($request);
+ return $res if $res;
+
+ my $server = URI->new( $ENV{CATALYST_SERVER} );
+
+ 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 . '/' );
+ }
+ }
+
+ $request->uri->scheme( $server->scheme );
+ $request->uri->host( $server->host );
+ $request->uri->port( $server->port );
+ $request->uri->path( $server->path . $request->uri->path );
+ $self->_set_host_header($request);
+ return $self->SUPER::_make_request($request);
+}
+
sub import {
my ($class, $app) = @_;
+
if (defined $app) {
- require Class::Inspector->filename( $app )
- unless Class::Inspector->loaded( $app );
+ Class::MOP::load_class($app)
+ unless (Class::MOP::is_class_loaded($app));
$APP_CLASS = $app;
}
+
}
=head1 SYNOPSIS
# We're in a t/*.t test script...
+ use Test::WWW::Mechanize::Catalyst;
+
# To test a Catalyst application named 'Catty':
- use Test::WWW::Mechanize::Catalyst 'Catty';
+ my $mech = Test::WWW::Mechanize::Catalyst->new(catalyst_app => 'Catty');
- my $mech = Test::WWW::Mechanize::Catalyst->new;
$mech->get_ok("/"); # no hostname needed
is($mech->ct, "text/html");
$mech->title_is("Root", "On the root page");
$mech->content_contains("This is the root page", "Correct content");
$mech->follow_link_ok({text => 'Hello'}, "Click on Hello");
# ... and all other Test::WWW::Mechanize methods
+
+ # White label site testing
+ $mech->host("foo.com");
+ $mech->get_ok("/");
=head1 DESCRIPTION
-L<Catalyst> is an elegant MVC Web Application
-Framework. L<Test::WWW::Mechanize> is a subclass of L<WWW::Mechanize> that
-incorporates features for web application testing. The
-L<Test::WWW::Mechanize::Catalyst> module meshes the two to allow easy
-testing of L<Catalyst> applications without starting up a web server.
+L<Catalyst> is an elegant MVC Web Application Framework.
+L<Test::WWW::Mechanize> is a subclass of L<WWW::Mechanize> that incorporates
+features for web application testing. The L<Test::WWW::Mechanize::Catalyst>
+module meshes the two to allow easy testing of L<Catalyst> applications without
+needing to start up a web server.
Testing web applications has always been a bit tricky, normally
-starting a web server for your application and making real HTTP
+requiring starting a web server for your application and making real HTTP
requests to it. This module allows you to test L<Catalyst> web
-applications but does not start a server or issue HTTP
+applications but does not require a server or issue HTTP
requests. Instead, it passes the HTTP request object directly to
L<Catalyst>. Thus you do not need to use a real hostname:
"http://localhost/" will do. However, this is optional. The following
as normal Web requests - this is handy if you have an external
single sign-on system. You must set allow_external to true for this:
- $m->allow_external(1);
+ $mech->allow_external(1);
You can also test a remote server by setting the environment variable
-CATALYST_SERVER, for example:
+CATALYST_SERVER; for example:
$ CATALYST_SERVER=http://example.com/myapp prove -l t
will run the same tests on the application running at
http://example.com/myapp regardless of whether or not you specify
http:://localhost for Test::WWW::Mechanize::Catalyst.
+
+Furthermore, if you set CATALYST_SERVER, the server will be regarded
+as a remote server even if your links point to localhost. Thus, you
+can use Test::WWW::Mechanize::Catalyst to test your live webserver
+running on your local machine, if you need to test aspects of your
+deployment environment (for example, configuration options in an
+http.conf file) instead of just the Catalyst request handling.
This makes testing fast and easy. L<Test::WWW::Mechanize> provides
functions for common web testing scenarios. For example:
To use this module you must pass it the name of the application. See
the SYNOPSIS above.
-Note that Catalyst has a special developing feature: the debug
+Note that Catalyst has a special development feature: the debug
screen. By default this module will treat responses which are the
debug screen as failures. If you actually want to test debug screens,
please use:
- $m->{catalyst_debug} = 1;
+ $mech->{catalyst_debug} = 1;
An alternative to this module is L<Catalyst::Test>.
=head2 new
-Behaves like, and calls, L<WWW::Mechanize>'s C<new> method. Any parms
+Behaves like, and calls, L<WWW::Mechanize>'s C<new> method. Any params
passed in get passed to WWW::Mechanize's constructor. Note that we
need to pass the name of the Catalyst application to the "use":
as normal Web requests - this is handy if you have an external
single sign-on system. You must set allow_external to true for this:
- $m->allow_external(1);
+ $mech->allow_external(1);
+
+head2 catalyst_app
+
+The name of the Catalyst app which we are testing against. Read-only.
+
+=head2 host
+
+The host value to set the "Host:" HTTP header to, if none is present already in
+the request. If not set (default) then Catalyst::Test will set this to
+localhost:80
+
+=head2 clear_host
+
+Unset the host attribute.
+
+=head2 has_host
+
+Do we have a value set for the host attribute
=head2 $mech->get_ok($url, [ \%LWP_options ,] $desc)
=head2 $mech->title_unlike( $regex [, $desc ] )
-Tells if the title of the page matches the given regex.
+Tells if the title of the page does NOT match the given regex.
$mech->title_unlike( qr/Invoices for (.+)/
=head2 $mech->content_is( $str [, $desc ] )
-Tells if the content of the page matches the given string
+Tells if the content of the page matches the given string.
=head2 $mech->content_contains( $str [, $desc ] )
=head2 $mech->link_content_unlike( $links, $regex [, $desc ] )
-Check the current page for specified links and test the content of each
+Check the current page for specified links and test that the content of each
does not match I<$regex>. The links may be specified as a reference to
an array containing L<WWW::Mechanize::Link> objects, an array of URLs,
or a scalar URL name.
The link must be found, and then followed successfully. Otherwise,
this test fails.
-I<%parms> is a hashref containing the parms to pass to C<follow_link()>.
-Note that the parms to C<follow_link()> are a hash whereas the parms to
+I<%parms> is a hashref containing the params to pass to C<follow_link()>.
+Note that the params to C<follow_link()> are a hash whereas the parms to
this function are a hashref. You have to call this function like:
- $agent->follow_like_ok( {n=>3}, "looking for 3rd link" );
+ $agent->follow_link_ok( {n=>3}, "looking for 3rd link" );
As with other test functions, C<$comment> is optional. If it is supplied
then it will display when running the test harness in verbose mode.
successfully. The HTTP::Response object returned by follow_link()
is not available.
+=head1 CAVEATS
+
+=head2 External Redirects and allow_external
+
+If you use non-fully qualified urls in your test scripts (i.e. anything without
+a host, such as C<< ->get_ok( "/foo") >> ) and your app redirects to an
+external URL, expect to be bitten once you come back to your application's urls
+(it will try to request them on the remote server). This is due to a limitation
+in WWW::Mechanize.
+
+One workaround for this is that if you are expecting to redirect to an external
+site, clone the TWMC object and use the cloned object for the external
+redirect.
+
+
=head1 SEE ALSO
Related modules which may be of interest: L<Catalyst>,
=head1 AUTHOR
-Current Maintainer: Ash Berlin C<< <ash@cpan.org> >>
+Ash Berlin C<< <ash@cpan.org> >> (current maintiner)
-Leon Brocard, C<< <acme@astray.com> >>
+Original Author: Leon Brocard, C<< <acme@astray.com> >>
=head1 COPYRIGHT
-Copyright (C) 2005-8, Leon Brocard
+Copyright (C) 2005-9, Leon Brocard
=head1 LICENSE
projects / catagits/Test-WWW-Mechanize-Catalyst.git / blobdiff