Test::Mojo - Testing Mojo!
use Test::More; use Test::Mojo; my $t = Test::Mojo->new('MyApp'); # HTML/XML $t->get_ok('/welcome')->status_is(200)->text_is('div#message' => 'Hello!'); # JSON $t->post_ok('/search.json' => form => {q => 'Perl'}) ->status_is(200) ->header_is('Server' => 'Mojolicious (Perl)') ->header_isnt('X-Bender' => 'Bite my shiny metal ass!') ->json_is('/results/4/title' => 'Perl rocks!'); # WebSocket $t->websocket_ok('/echo') ->send_ok('hello') ->message_ok ->message_is('echo: hello') ->finish_ok; done_testing();
Test::Mojo is a collection of testing helpers for everyone developing Mojo and Mojolicious applications.
Test::Mojo implements the following attributes.
my $msg = $t->message; $t = $t->message([text => $bytes]);
Current WebSocket message.
# Test custom message $t->message([binary => $bytes]) ->json_message_has('/foo/bar') ->json_message_hasnt('/bar') ->json_message_is('/foo/baz' => {yada => [1, 2, 3]});
my $bool = $t->success; $t = $t->success($bool);
True if the last test was successful.
# Build custom tests my $location_is = sub { my ($t, $value, $desc) = @_; $desc ||= "Location: $value"; local $Test::Builder::Level = $Test::Builder::Level + 1; return $t->success(is($t->tx->res->headers->location, $value, $desc)); }; $t->get_ok('/') ->status_is(302) ->$location_is('http://mojolicio.us') ->or(sub { diag 'Must have been Joel!' });
my $tx = $t->tx; $t = $t->tx(Mojo::Transaction::HTTP->new);
Current transaction, usually a Mojo::Transaction::HTTP object.
# More specific tests is $t->tx->res->json->{foo}, 'bar', 'right value'; ok $t->tx->res->content->is_multipart, 'multipart content'; # Test custom transactions $t->tx($t->tx->previous)->status_is(302)->header_like(Location => qr/foo/);
my $ua = $t->ua; $t = $t->ua(Mojo::UserAgent->new);
User agent used for testing, defaults to a Mojo::UserAgent object.
# Allow redirects $t->ua->max_redirects(10); # Use absolute URL for request with Basic authentication my $url = $t->ua->server->url->userinfo('sri:secr3t')->path('/secrets.json'); $t->post_ok($url => json => {limit => 10}) ->status_is(200) ->json_is('/1/content', 'Mojo rocks!'); # Customize all transactions (including followed redirects) $t->ua->on(start => sub { my ($ua, $tx) = @_; $tx->req->headers->accept_language('en-US'); });
Test::Mojo inherits all methods from Mojo::Base and implements the following new ones.
my $app = $t->app; $t = $t->app(MyApp->new);
Access application with "app" in Mojo::UserAgent.
# Change log level $t->app->log->level('fatal'); # Test application directly is $t->app->defaults->{foo}, 'bar', 'right value'; ok $t->app->routes->find('echo')->is_websocket, 'WebSocket route'; # Change application behavior $t->app->hook(before_dispatch => sub { my $c = shift; $c->render(text => 'This request did not reach the router.') if $c->req->url->path->contains('/user'); }); # Extract additional information my $stash; $t->app->hook(after_dispatch => sub { $stash = shift->stash });
$t = $t->content_is('working!'); $t = $t->content_is('working!', 'right content');
Check response content for exact match after retrieving it from "text" in Mojo::Message.
$t = $t->content_isnt('working!'); $t = $t->content_isnt('working!', 'different content');
Opposite of "content_is".
$t = $t->content_like(qr/working!/); $t = $t->content_like(qr/working!/, 'right content');
Check response content for similar match after retrieving it from "text" in Mojo::Message.
$t = $t->content_unlike(qr/working!/); $t = $t->content_unlike(qr/working!/, 'different content');
Opposite of "content_like".
$t = $t->content_type_is('text/html'); $t = $t->content_type_is('text/html', 'right content type');
Check response Content-Type header for exact match.
Content-Type
$t = $t->content_type_isnt('text/html'); $t = $t->content_type_isnt('text/html', 'different content type');
Opposite of "content_type_is".
$t = $t->content_type_like(qr/text/); $t = $t->content_type_like(qr/text/, 'right content type');
Check response Content-Type header for similar match.
$t = $t->content_type_unlike(qr/text/); $t = $t->content_type_unlike(qr/text/, 'different content type');
Opposite of "content_type_like".
$t = $t->delete_ok('/foo'); $t = $t->delete_ok('/foo' => {DNT => 1} => 'Hi!'); $t = $t->delete_ok('/foo' => {DNT => 1} => form => {a => 'b'}); $t = $t->delete_ok('/foo' => {DNT => 1} => json => {a => 'b'});
Perform a DELETE request and check for transport errors, takes the same arguments as "delete" in Mojo::UserAgent, except for the callback.
$t = $t->element_exists('div.foo[x=y]'); $t = $t->element_exists('html head title', 'has a title');
Checks for existence of the CSS selectors first matching HTML/XML element with Mojo::DOM.
$t = $t->element_exists_not('div.foo[x=y]'); $t = $t->element_exists_not('html head title', 'has no title');
Opposite of "element_exists".
$t = $t->finish_ok; $t = $t->finish_ok(1000); $t = $t->finish_ok(1003 => 'Cannot accept data!');
Close WebSocket connection gracefully.
$t = $t->finished_ok(1000);
Wait for WebSocket connection to be closed gracefully and check status.
$t = $t->get_ok('/foo'); $t = $t->get_ok('/foo' => {DNT => 1} => 'Hi!'); $t = $t->get_ok('/foo' => {DNT => 1} => form => {a => 'b'}); $t = $t->get_ok('/foo' => {DNT => 1} => json => {a => 'b'});
Perform a GET request and check for transport errors, takes the same arguments as "get" in Mojo::UserAgent, except for the callback.
# Run tests against remote host $t->get_ok('http://mojolicio.us/perldoc')->status_is(200);
$t = $t->head_ok('/foo'); $t = $t->head_ok('/foo' => {DNT => 1} => 'Hi!'); $t = $t->head_ok('/foo' => {DNT => 1} => form => {a => 'b'}); $t = $t->head_ok('/foo' => {DNT => 1} => json => {a => 'b'});
Perform a HEAD request and check for transport errors, takes the same arguments as "head" in Mojo::UserAgent, except for the callback.
$t = $t->header_is(Expect => 'fun'); $t = $t->header_is(Expect => 'fun', 'right header');
Check response header for exact match.
$t = $t->header_isnt(Expect => 'fun'); $t = $t->header_isnt(Expect => 'fun', 'different header');
Opposite of "header_is".
$t = $t->header_like(Expect => qr/fun/); $t = $t->header_like(Expect => qr/fun/, 'right header');
Check response header for similar match.
$t = $t->header_like(Expect => qr/fun/); $t = $t->header_like(Expect => qr/fun/, 'different header');
Opposite of "header_like".
$t = $t->json_has('/foo'); $t = $t->json_has('/minibar', 'has a minibar');
Check if JSON response contains a value that can be identified using the given JSON Pointer with Mojo::JSON::Pointer.
$t = $t->json_hasnt('/foo'); $t = $t->json_hasnt('/minibar', 'no minibar');
Opposite of "json_has".
$t = $t->json_is({foo => [1, 2, 3]}); $t = $t->json_is({foo => [1, 2, 3]}, 'right content'); $t = $t->json_is('/foo' => [1, 2, 3]); $t = $t->json_is('/foo/1' => 2, 'right value');
Check the value extracted from JSON response using the given JSON Pointer with Mojo::JSON::Pointer, which defaults to the root value if it is omitted.
$t = $t->json_message_has('/foo'); $t = $t->json_message_has('/minibar', 'has a minibar');
Check if JSON WebSocket message contains a value that can be identified using the given JSON Pointer with Mojo::JSON::Pointer.
$t = $t->json_message_hasnt('/foo'); $t = $t->json_message_hasnt('/minibar', 'no minibar');
Opposite of "json_message_has".
$t = $t->json_message_is({foo => [1, 2, 3]}); $t = $t->json_message_is({foo => [1, 2, 3]}, 'right content'); $t = $t->json_message_is('/foo' => [1, 2, 3]); $t = $t->json_message_is('/foo/1' => 2, 'right value');
Check the value extracted from JSON WebSocket message using the given JSON Pointer with Mojo::JSON::Pointer, which defaults to the root value if it is omitted.
$t = $t->message_is({binary => $bytes}); $t = $t->message_is({text => $bytes}); $t = $t->message_is('working!'); $t = $t->message_is('working!', 'right message');
Check WebSocket message for exact match.
$t = $t->message_isnt({binary => $bytes}); $t = $t->message_isnt({text => $bytes}); $t = $t->message_isnt('working!'); $t = $t->message_isnt('working!', 'different message');
Opposite of "message_is".
$t = $t->message_like({binary => qr/$bytes/}); $t = $t->message_like({text => qr/$bytes/}); $t = $t->message_like(qr/working!/); $t = $t->message_like(qr/working!/, 'right message');
Check WebSocket message for similar match.
$t = $t->message_ok; $t = $t->message_ok('got a message');
Wait for next WebSocket message to arrive.
# Wait for message and perform multiple tests on it $t->websocket_ok('/time') ->message_ok ->message_like(qr/\d+/) ->message_unlike(qr/\w+/) ->finish_ok;
$t = $t->message_unlike({binary => qr/$bytes/}); $t = $t->message_unlike({text => qr/$bytes/}); $t = $t->message_unlike(qr/working!/); $t = $t->message_unlike(qr/working!/, 'different message');
Opposite of "message_like".
my $t = Test::Mojo->new; my $t = Test::Mojo->new('MyApp'); my $t = Test::Mojo->new(MyApp->new);
Construct a new Test::Mojo object.
$t = $t->options_ok('/foo'); $t = $t->options_ok('/foo' => {DNT => 1} => 'Hi!'); $t = $t->options_ok('/foo' => {DNT => 1} => form => {a => 'b'}); $t = $t->options_ok('/foo' => {DNT => 1} => json => {a => 'b'});
Perform a OPTIONS request and check for transport errors, takes the same arguments as "options" in Mojo::UserAgent, except for the callback.
$t = $t->or(sub {...});
Invoke callback if the value of "success" is false.
# Diagnostics $t->get_ok('/bad')->or(sub { diag 'Must have been Glen!' }) ->status_is(200)->or(sub { diag $t->tx->res->dom->at('title')->text });
$t = $t->patch_ok('/foo'); $t = $t->patch_ok('/foo' => {DNT => 1} => 'Hi!'); $t = $t->patch_ok('/foo' => {DNT => 1} => form => {a => 'b'}); $t = $t->patch_ok('/foo' => {DNT => 1} => json => {a => 'b'});
Perform a PATCH request and check for transport errors, takes the same arguments as "patch" in Mojo::UserAgent, except for the callback.
$t = $t->post_ok('/foo'); $t = $t->post_ok('/foo' => {DNT => 1} => 'Hi!'); $t = $t->post_ok('/foo' => {DNT => 1} => form => {a => 'b'}); $t = $t->post_ok('/foo' => {DNT => 1} => json => {a => 'b'});
Perform a POST request and check for transport errors, takes the same arguments as "post" in Mojo::UserAgent, except for the callback.
# Test file upload $t->post_ok('/upload' => form => {foo => {content => 'bar'}}) ->status_is(200); # Test JSON API $t->post_ok('/hello.json' => json => {hello => 'world'}) ->status_is(200) ->json_is({bye => 'world'});
$t = $t->put_ok('/foo'); $t = $t->put_ok('/foo' => {DNT => 1} => 'Hi!'); $t = $t->put_ok('/foo' => {DNT => 1} => form => {a => 'b'}); $t = $t->put_ok('/foo' => {DNT => 1} => json => {a => 'b'});
Perform a PUT request and check for transport errors, takes the same arguments as "put" in Mojo::UserAgent, except for the callback.
$t = $t->request_ok(Mojo::Transaction::HTTP->new);
Perform request and check for transport errors.
# Request with custom method my $tx = $t->ua->build_tx(FOO => '/test.json' => json => {foo => 1}); $t->request_ok($tx)->status_is(200)->json_is({success => 1}); # WebSocket handshake without extensions my $tx = $t->ua->build_websocket_tx('/foo'); $tx->req->headers->remove('Sec-WebSocket-Extensions'); $t->request_ok($tx)->message_ok->message_is('bar')->finish_ok;
$t = $t->reset_session;
Reset user agent session.
$t = $t->send_ok({binary => $bytes}); $t = $t->send_ok({text => $bytes}); $t = $t->send_ok({json => {test => [1, 2, 3]}}); $t = $t->send_ok([$fin, $rsv1, $rsv2, $rsv3, $op, $payload]); $t = $t->send_ok($chars); $t = $t->send_ok($chars, 'sent successfully');
Send message or frame via WebSocket.
# Send JSON object as "Text" message $t->websocket_ok('/echo.json') ->send_ok({json => {test => 'I ♥ Mojolicious!'}}) ->message_ok ->json_message_is('/test' => 'I ♥ Mojolicious!') ->finish_ok;
$t = $t->status_is(200); $t = $t->status_is(200, 'right status');
Check response status for exact match.
$t = $t->status_isnt(200); $t = $t->status_isnt(200, 'different status');
Opposite of "status_is".
$t = $t->text_is('div.foo[x=y]' => 'Hello!'); $t = $t->text_is('html head title' => 'Hello!', 'right title');
Checks text content of the CSS selectors first matching HTML/XML element for exact match with Mojo::DOM.
$t = $t->text_isnt('div.foo[x=y]' => 'Hello!'); $t = $t->text_isnt('html head title' => 'Hello!', 'different title');
Opposite of "text_is".
$t = $t->text_like('div.foo[x=y]' => qr/Hello/); $t = $t->text_like('html head title' => qr/Hello/, 'right title');
Checks text content of the CSS selectors first matching HTML/XML element for similar match with Mojo::DOM.
$t = $t->text_unlike('div.foo[x=y]' => qr/Hello/); $t = $t->text_unlike('html head title' => qr/Hello/, 'different title');
Opposite of "text_like".
$t = $t->websocket_ok('/echo'); $t = $t->websocket_ok('/echo' => {DNT => 1} => ['v1.proto']);
Open a WebSocket connection with transparent handshake, takes the same arguments as "websocket" in Mojo::UserAgent, except for the callback.
Mojolicious, Mojolicious::Guides, http://mojolicio.us.
To install Mojolicious, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Mojolicious
CPAN shell
perl -MCPAN -e shell install Mojolicious
For more information on module installation, please visit the detailed CPAN module installation guide.