Test::Mojo(3)

📦

version 9.480.0 · 13 versions

9.480.0 · opensuse-leap 16.0 (latest)
9.22 · epel 9
9.39 · epel 10
9.45 · alpine 3.24
9.48 · ubuntu stonking
9.41 · fedora 43
9.22 · ubuntu jammy
9.48 · fedora 43, fedora 44
9.42 · fedora 44
9.35 · ubuntu noble
9.31 · debian bookworm
9.42 · ubuntu resolute
9.39 · debian trixie, ubuntu questing

💖 NAME 💖

Test::Mojo(3) — User Contributed Perl Documentation — Testing Mojo

Okay so bestie, welcome to Test::Mojo, the testing era of Mojo. 💅

✨ SYNOPSIS ✨

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!')
  ->json_like('/results/7/title' => qr/Perl/);

# WebSocket
$t->websocket_ok('/echo')
  ->send_ok('hello')
  ->message_ok
  ->message_is('echo: hello')
  ->finish_ok;

# Server-Sent Events (SSE)
$t->get_sse_ok('/events')
  ->status_is(200)
  ->sse_ok
  ->sse_type_is('message')
  ->sse_text_is('hello mojo')
  ->sse_finish_ok;

done_testing();

🦋 DESCRIPTION 🦋

Test::Mojo is a test user agent based on Mojo::UserAgent, and you’ll usually use it together with Test::More to test Mojolicious applications. Literally just run your tests with prove.

$ prove -l -v
$ prove -l -v t/foo.t

If it is not already defined, the MOJO_LOG_LEVEL environment variable will be set to trace or fatal, depending on the value of the HARNESS_IS_VERBOSE environment variable. And to make testing HTTPS/WSS web services easier, insecure in Mojo::UserAgent will be activated by default for ua.

See Mojolicious::Guides::Testing for more. 🫶

🎀 ATTRIBUTES 🎀

Test::Mojo implements the following attributes.

🌸 handler

my $cb = $t->handler;
$t     = $t->handler(sub {...});

A callback to connect Test::Mojo with Test::More.

$t->handler(sub ($name, @args) {
  return Test::More->can($name)->(@args);
});

🌸 message

my $msg = $t->message;
$t      = $t->message([text => $bytes]);

Current WebSocket message, represented as an array reference containing the frame type and payload.

# More specific tests
use Mojo::JSON qw(decode_json);
my $hash = decode_json $t->message->[1];
is ref $hash, 'HASH', 'right reference';
is $hash->{foo}, 'bar', 'right value';

# 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]});

🌸 sse

my $event = $t->sse;
$t        = $t->sse({type => 'message', text => 'working!'});

Current Server-Sent Event (SSE), represented as a hash reference. Note that this attribute is EXPERIMENTAL and may change without warning! 😭

🌸 success

my $bool = $t->success;
$t       = $t->success($bool);

True if the last test was successful.

# Build custom tests
my $location_is = sub ($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('https://mojolicious.org')
  ->or(sub { diag 'Must have been Joel!' });

🌸 tx

my $tx = $t->tx;
$t     = $t->tx(Mojo::Transaction::HTTP->new);

Current transaction, usually a Mojo::Transaction::HTTP or Mojo::Transaction::WebSocket object.

# More specific tests
is $t->tx->res->json->{foo}, 'bar', 'right value';
ok $t->tx->res->content->is_multipart, 'multipart content';
is $t->tx->previous->res->code, 302, 'right status';

🌸 ua

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);
$t->get_ok('/redirect')->status_is(200)->content_like(qr/redirected/);

# Switch protocol from HTTP to HTTPS
$t->ua->server->url('https');
$t->get_ok('/secure')->status_is(200)->content_like(qr/secure/);

# 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 ($ua, $tx) { $tx->req->headers->accept_language('en-US') });
$t->get_ok('/hello')->status_is(200)->content_like(qr/Howdy/);

🔥 METHODS 🔥

Test::Mojo inherits all methods from Mojo::Base and implements the following new ones.

👑 app

my $app = $t->app;
$t      = $t->app(Mojolicious->new);

Access application with app in Mojo::UserAgent::Server.

# 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';
my $c = $t->app->build_controller;
ok $c->render(template => 'foo'), 'rendering was successful';
is $c->res->status, 200, 'right status';
is $c->res->body, 'Foo!', 'right content';

# Change application behavior
$t->app->hook(before_dispatch => sub ($c) {
  $c->render(text => 'This request did not reach the router.') if $c->req->url->path->contains('/user');
});
$t->get_ok('/user')->status_is(200)->content_like(qr/not reach the router/);

# Extract additional information
my $stash;
$t->app->hook(after_dispatch => sub ($c) { $stash = $c->stash });
$t->get_ok('/hello')->status_is(200);
is $stash->{foo}, 'bar', 'right value';

👑 attr_is

$t = $t->attr_is('img.cat', 'alt', 'Grumpy cat');
$t = $t->attr_is('img.cat', 'alt', 'Grumpy cat', 'right alt text');

Checks text content of attribute with attr in Mojo::DOM at the CSS selectors first matching HTML/XML element for exact match with at in Mojo::DOM.

👑 attr_isnt

$t = $t->attr_isnt('img.cat', 'alt', 'Calm cat');
$t = $t->attr_isnt('img.cat', 'alt', 'Calm cat', 'different alt text');

Opposite of attr_is.

👑 attr_like

$t = $t->attr_like('img.cat', 'alt', qr/Grumpy/);
$t = $t->attr_like('img.cat', 'alt', qr/Grumpy/, 'right alt text');

Checks text content of attribute with attr in Mojo::DOM at the CSS selectors first matching HTML/XML element for similar match with at in Mojo::DOM.

👑 attr_unlike

$t = $t->attr_unlike('img.cat', 'alt', qr/Calm/);
$t = $t->attr_unlike('img.cat', 'alt', qr/Calm/, 'different alt text');

Opposite of attr_like.

👑 content_is

$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.

👑 content_isnt

$t = $t->content_isnt('working!');
$t = $t->content_isnt('working!', 'different content');

Opposite of content_is.

👑 content_like

$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.

👑 content_type_is

$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_isnt

$t = $t->content_type_isnt('text/html');
$t = $t->content_type_isnt('text/html', 'different content type');

Opposite of content_type_is.

👑 content_type_like

$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.

👑 content_type_unlike

$t = $t->content_type_unlike(qr/text/);
$t = $t->content_type_unlike(qr/text/, 'different content type');

Opposite of content_type_like.

👑 content_unlike

$t = $t->content_unlike(qr/working!/);
$t = $t->content_unlike(qr/working!/, 'different content');

Opposite of content_like.

👑 delete_ok

$t = $t->delete_ok('http://example.com/foo');
$t = $t->delete_ok('/foo');
$t = $t->delete_ok('/foo' => {Accept => '*/*'} => 'Content!');
$t = $t->delete_ok('/foo' => {Accept => '*/*'} => form => {a => 'b'});
$t = $t->delete_ok('/foo' => {Accept => '*/*'} => 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.

👑 element_count_is

$t = $t->element_count_is('div.foo[x=y]', 5);
$t = $t->element_count_is('html body div', 30, 'thirty elements');

Checks the number of HTML/XML elements matched by the CSS selector with find in Mojo::DOM.

👑 element_exists

$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 at in Mojo::DOM.

# Check attribute values
$t->get_ok('/login')
  ->element_exists('label[for=email]')
  ->element_exists('input[name=email][type=text][value*="example.com"]')
  ->element_exists('label[for=pass]')
  ->element_exists('input[name=pass][type=password]')
  ->element_exists('input[type=submit][value]');

👑 element_exists_not

$t = $t->element_exists_not('div.foo[x=y]');
$t = $t->element_exists_not('html head title', 'has no title');

Opposite of element_exists.

👑 finish_ok

$t = $t->finish_ok;
$t = $t->finish_ok(1000);
$t = $t->finish_ok(1003 => 'Cannot accept data!');

Close WebSocket connection gracefully.

👑 finished_ok

$t = $t->finished_ok(1000);

Wait for WebSocket connection to be closed gracefully and check status.

👑 get_ok

$t = $t->get_ok('http://example.com/foo');
$t = $t->get_ok('/foo');
$t = $t->get_ok('/foo' => {Accept => '*/*'} => 'Content!');
$t = $t->get_ok('/foo' => {Accept => '*/*'} => form => {a => 'b'});
$t = $t->get_ok('/foo' => {Accept => '*/*'} => 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('https://docs.mojolicious.org')->status_is(200);

# Use relative URL for request with Basic authentication
$t->get_ok('//sri:secr3t@/secrets.json')
  ->status_is(200)
  ->json_is('/1/content', 'Mojo rocks!');

# Run additional tests on the transaction
$t->get_ok('/foo')->status_is(200);
is $t->tx->res->dom->at('input')->val, 'whatever', 'right value';

`get_sse_ok`

$t = $t->get_sse_ok('http://example.com/events');
$t = $t->get_sse_ok('/events');
$t = $t->get_sse_ok('/events' => {Accept => 'text/event-stream'} => 'Content!');
$t = $t->get_sse_ok('/events' => {Accept => 'text/event-stream'} => form => {a => 'b'});
$t = $t->get_sse_ok('/events' => {Accept => 'text/event-stream'} => json => {a => 'b'});

Bestie, this one fires off a GET request to open up a Server-Sent Events (SSE) connection. It takes the exact same arguments as get in Mojo::UserAgent, minus the callback 💅

⚠️ Heads up: this method is EXPERIMENTAL and may change without warning! Like, do not build your whole personality around it 😭

`head_ok`

$t = $t->head_ok('http://example.com/foo');
$t = $t->head_ok('/foo');
$t = $t->head_ok('/foo' => {Accept => '*/*'} => 'Content!');
$t = $t->head_ok('/foo' => {Accept => '*/*'} => form => {a => 'b'});
$t = $t->head_ok('/foo' => {Accept => '*/*'} => json => {a => 'b'});

Does a HEAD request and checks for transport errors. Same arguments as head in Mojo::UserAgent, except for the callback ✨

`header_exists`

$t = $t->header_exists('ETag');
$t = $t->header_exists('ETag', 'header exists');

Checks whether a response header exists. That's it, that's the whole vibe 🎀

`header_exists_not`

$t = $t->header_exists_not('ETag');
$t = $t->header_exists_not('ETag', 'header is missing');

Literally the opposite of header_exists — it wants the header to be gone 🙈

`header_is`

$t = $t->header_is(ETag => '"abc321"');
$t = $t->header_is(ETag => '"abc321"', 'right header');

Checks a response header for an exact match. Character for character, no vibes-based guessing 💅

`header_isnt`

$t = $t->header_isnt(Etag => '"abc321"');
$t = $t->header_isnt(ETag => '"abc321"', 'different header');

The opposite of header_is, aka: this header better not be that exact thing 🌸

`header_like`

$t = $t->header_like(ETag => qr/abc/);
$t = $t->header_like(ETag => qr/abc/, 'right header');

Checks a response header for a similar match, regex style ✨

`header_unlike`

$t = $t->header_unlike(ETag => qr/abc/);
$t = $t->header_unlike(ETag => qr/abc/, 'different header');

Opposite of header_like — the regex should bounce right off 🦋

`json_has`

$t = $t->json_has('/foo');
$t = $t->json_has('/minibar', 'has a minibar');

Checks whether the JSON response contains a value you can point at with the given JSON Pointer using Mojo::JSON::Pointer 🔍

`json_hasnt`

$t = $t->json_hasnt('/foo');
$t = $t->json_hasnt('/minibar', 'no minibar');

Opposite of json_has. No minibar. None. Zero. Not found 💀

`json_is`

$t = $t->json_is({foo => [1, 2, 3]});
$t = $t->json_is('/foo' => [1, 2, 3]);
$t = $t->json_is('/foo/1' => 2, 'right value');

Checks the value you pull out of the JSON response using the given JSON Pointer with Mojo::JSON::Pointer. If you omit the pointer it just defaults to the root value, easy 🫶

# Use an empty JSON Pointer to test the whole JSON response with a test description
$t->json_is('' => {foo => [1, 2, 3]}, 'right object');

`json_like`

$t = $t->json_like('/foo/1' => qr/^\d+$/);
$t = $t->json_like('/foo/1' => qr/^\d+$/, 'right value');

Checks a value extracted from the JSON response using the given JSON Pointer with Mojo::JSON::Pointer — but for a similar match this time 👑

`json_message_has`

$t = $t->json_message_has('/foo');
$t = $t->json_message_has('/minibar', 'has a minibar');

Checks whether a JSON WebSocket message contains a value identifiable via the given JSON Pointer with Mojo::JSON::Pointer 🦋

`json_message_hasnt`

$t = $t->json_message_hasnt('/foo');
$t = $t->json_message_hasnt('/minibar', 'no minibar');

Opposite of json_message_has — that value is simply not invited to the party 🙈

`json_message_is`

$t = $t->json_message_is({foo => [1, 2, 3]});
$t = $t->json_message_is('/foo' => [1, 2, 3]);
$t = $t->json_message_is('/foo/1' => 2, 'right value');

Checks the value extracted from a JSON WebSocket message using the given JSON Pointer with Mojo::JSON::Pointer, which defaults to the root value if you leave it out ✨

`json_message_like`

$t = $t->json_message_like('/foo/1' => qr/^\d+$/);
$t = $t->json_message_like('/foo/1' => qr/^\d+$/, 'right value');

Checks the value extracted from a JSON WebSocket message using the given JSON Pointer with Mojo::JSON::Pointer, for a similar match 🌸

`json_message_unlike`

$t = $t->json_message_unlike('/foo/1' => qr/^\d+$/);
$t = $t->json_message_unlike('/foo/1' => qr/^\d+$/, 'different value');

Opposite of json_message_like, obviously 💅

`json_unlike`

$t = $t->json_unlike('/foo/1' => qr/^\d+$/);
$t = $t->json_unlike('/foo/1' => qr/^\d+$/, 'different value');

Opposite of json_like. The regex stays unmatched and honestly? Iconic 🎀

`message_is`

$t = $t->message_is({binary => $bytes});
$t = $t->message_is({text   => $bytes});
$t = $t->message_is('working!');
$t = $t->message_is('working!', 'right message');

Checks a WebSocket message for an exact match — binary, text, or a plain string, your call 💖

`message_isnt`

$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. Different message, different vibe 🦋

`message_like`

$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');

Checks a WebSocket message for a similar match, regex girlies rise 🔥

`message_ok`

$t = $t->message_ok;
$t = $t->message_ok('got a message');

Waits for the next WebSocket message to arrive. Patience is a whole skill ngl 🧚

# 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;

`message_unlike`

$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 — the message should absolutely not match, no cap 💀

`new`

my $t = Test::Mojo->new;
my $t = Test::Mojo->new('MyApp');
my $t = Test::Mojo->new('MyApp', {foo => 'bar'});
my $t = Test::Mojo->new(Mojo::File->new('/path/to/myapp.pl'));
my $t = Test::Mojo->new(Mojo::File->new('/path/to/myapp.pl'), {foo => 'bar'});
my $t = Test::Mojo->new(MyApp->new);
my $t = Test::Mojo->new(MyApp->new, {foo => 'bar'});

Constructs a brand-new Test::Mojo object, main character energy only 👑

Besides a class name or a Mojo::File object pointing at your application script, you can also hand it a hash reference full of configuration values that'll be used to override the application configuration. And listen — the special configuration value config_override will get set in config in Mojolicious too, which is what you use to disable configuration plugins like Mojolicious::Plugin::Config, Mojolicious::Plugin::JSONConfig and Mojolicious::Plugin::NotYAMLConfig for tests ✨

# Load application script relative to the "t" directory
use Mojo::File qw(curfile);
my $t = Test::Mojo->new(curfile->dirname->sibling('myapp.pl'));

`options_ok`

$t = $t->options_ok('http://example.com/foo');
$t = $t->options_ok('/foo');
$t = $t->options_ok('/foo' => {Accept => '*/*'} => 'Content!');
$t = $t->options_ok('/foo' => {Accept => '*/*'} => form => {a => 'b'});
$t = $t->options_ok('/foo' => {Accept => '*/*'} => json => {a => 'b'});

Performs an OPTIONS request and checks for transport errors. Same arguments as options in Mojo::UserAgent, except for the callback 💖

`or`

$t = $t->or(sub {...});

Runs your callback if the value of success is false. Basically the "okay but if that flopped, do this instead" button 🫶

# 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 });

`patch_ok`

$t = $t->patch_ok('http://example.com/foo');
$t = $t->patch_ok('/foo');
$t = $t->patch_ok('/foo' => {Accept => '*/*'} => 'Content!');
$t = $t->patch_ok('/foo' => {Accept => '*/*'} => form => {a => 'b'});
$t = $t->patch_ok('/foo' => {Accept => '*/*'} => json => {a => 'b'});

Performs a PATCH request and checks for transport errors. Same arguments as patch in Mojo::UserAgent, except for the callback 🦋

`post_ok`

$t = $t->post_ok('http://example.com/foo');
$t = $t->post_ok('/foo');
$t = $t->post_ok('/foo' => {Accept => '*/*'} => 'Content!');
$t = $t->post_ok('/foo' => {Accept => '*/*'} => form => {a => 'b'});
$t = $t->post_ok('/foo' => {Accept => '*/*'} => json => {a => 'b'});

Performs a POST request and checks for transport errors. Same arguments as post in Mojo::UserAgent, except for the callback 🔥

# Test file upload
my $upload = {foo => {content => 'bar', filename => 'baz.txt'}};
$t->post_ok('/upload' => form => $upload)->status_is(200);

# Test JSON API
$t->post_ok('/hello.json' => json => {hello => 'world'})
  ->status_is(200)
  ->json_is({bye => 'world'});

`post_sse_ok`

$t = $t->post_sse_ok('http://example.com/events');
$t = $t->post_sse_ok('/events');
$t = $t->post_sse_ok('/events' => {Accept => 'text/event-stream'} => 'Content!');
$t = $t->post_sse_ok('/events' => {Accept => 'text/event-stream'} => form => {a => 'b'});
$t = $t->post_sse_ok('/events' => {Accept => 'text/event-stream'} => json => {a => 'b'});

Performs a POST request to establish a Server-Sent Events (SSE) connection. Takes the same arguments as post in Mojo::UserAgent, except for the callback 💅

⚠️ Again: this method is EXPERIMENTAL and may change without warning! Don't get attached 😭

`put_ok`

$t = $t->put_ok('http://example.com/foo');
$t = $t->put_ok('/foo');
$t = $t->put_ok('/foo' => {Accept => '*/*'} => 'Content!');
$t = $t->put_ok('/foo' => {Accept => '*/*'} => form => {a => 'b'});
$t = $t->put_ok('/foo' => {Accept => '*/*'} => json => {a => 'b'});

Performs a PUT request and checks for transport errors. Same arguments as put in Mojo::UserAgent, except for the callback 🌸

`query_ok`

$t = $t->query_ok('http://example.com/foo');
$t = $t->query_ok('/foo');
$t = $t->query_ok('/foo' => {Accept => '*/*'} => 'Content!');
$t = $t->query_ok('/foo' => {Accept => '*/*'} => form => {a => 'b'});
$t = $t->query_ok('/foo' => {Accept => '*/*'} => json => {a => 'b'});

Performs a QUERY request and checks for transport errors. Same arguments as query in Mojo::UserAgent, except for the callback ⭐

`request_ok`

$t = $t->request_ok(Mojo::Transaction::HTTP->new);

Performs a request and checks for transport errors. This is the one where you build the transaction yourself and hit go 🚀

# 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});

# Request with custom cookie
my $tx = $t->ua->build_tx(GET => '/account');
$tx->req->cookies({name => 'user', value => 'sri'});
$t->request_ok($tx)->status_is(200)->text_is('head > title' => 'Hello sri');

# Custom WebSocket handshake
my $tx = $t->ua->build_websocket_tx('/foo');
$tx->req->headers->remove('User-Agent');
$t->request_ok($tx)->message_ok->message_is('bar')->finish_ok;

`reset_session`

$t = $t->reset_session;

Resets the user agent session. Fresh start, clean slate, new era 🎀

send_ok — send a message or a frame over the WebSocket, and obviously it slays 💅

$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');

Sends a message or a frame through the WebSocket, bestie. That's it, that's the vibe ✨

# 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;

sse_finish_ok — close the Server-Sent Events connection for real 🫶

$t = $t->sse_finish_ok;

Closes the Server-Sent Events connection. Heads up though: this method is EXPERIMENTAL and may change without warning! 😭

sse_finished_ok — hang around until the Server-Sent Events connection is closed ⏳

$t = $t->sse_finished_ok;

Waits for the Server-Sent Events connection to actually be closed. And yes, also EXPERIMENTAL and may change without warning, no cap.

sse_ok — wait for the next Server-Sent Event to show up 🎀

$t = $t->sse_ok;
$t = $t->sse_ok('got an event');

Waits for the next Server-Sent Event to arrive. EXPERIMENTAL and may change without warning, iykyk.

sse_id_is — vibe check the Server-Sent Event id for an exact match 🔍

$t = $t->sse_id_is(123);
$t = $t->sse_id_is(123, 'right id');

Checks the Server-Sent Event id for an exact match. EXPERIMENTAL — may change without warning, bestie.

sse_id_isnt — the opposite of sse_id_is, obvi 🙅‍♀️

$t = $t->sse_id_isnt(123);
$t = $t->sse_id_isnt(123, 'different id');

Literally the opposite of sse_id_is. Also EXPERIMENTAL and may change without warning!

sse_text_is — check the Server-Sent Event text for an exact match 💖

$t = $t->sse_text_is('working!');
$t = $t->sse_text_is('working!', 'right text');

Checks the Server-Sent Event text for an exact match. EXPERIMENTAL, may change without warning ✨

sse_text_isnt — opposite of sse_text_is 🌸

$t = $t->sse_text_isnt('working!');
$t = $t->sse_text_isnt('working!', 'different text');

The opposite of sse_text_is, periodt. EXPERIMENTAL and may change without warning!

sse_text_like — check the Server-Sent Event text against a regex 🦋

$t = $t->sse_text_like(qr/working/);
$t = $t->sse_text_like(qr/working/, 'right text');

Checks the Server-Sent Event text for an exact match. Yep, the original says "exact match" here too, we're not gonna pretend otherwise 😭 EXPERIMENTAL and may change without warning!

sse_text_unlike — opposite of sse_text_like 💀

$t = $t->sse_text_unlike(qr/working/);
$t = $t->sse_text_unlike(qr/working/, 'different text');

The opposite of sse_text_like. EXPERIMENTAL and may change without warning, ngl.

sse_type_is — exact-match check on the Server-Sent Event type ✨

$t = $t->sse_type_is('message');
$t = $t->sse_type_is('message', 'right type');

Checks the Server-Sent Event type for an exact match. EXPERIMENTAL, may change without warning!

sse_type_isnt — opposite of sse_type_is 🧚

$t = $t->sse_type_isnt('message');
$t = $t->sse_type_isnt('message', 'different type');

The opposite of sse_type_is. EXPERIMENTAL and may change without warning!

status_is — exact-match the response status, main character energy 👑

$t = $t->status_is(200);
$t = $t->status_is(200, 'right status');

Checks the response status for an exact match. Chef's kiss.

status_isnt — opposite of status_is 🙈

$t = $t->status_isnt(200);
$t = $t->status_isnt(200, 'different status');

The opposite of status_is. Iconic.

test — the plumbing that makes all the other checks happen 🔧

$t = $t->test('is', 'first value', 'second value', 'right value');

Calls Test::More functions through handler, and it's what implements the Test::Mojo roles. The result gets stashed in success. Lowkey the backbone of this whole thing, fr fr.

text_is — exact-match the text content of the first matching element 🎀

$t = $t->text_is('div.foo[x=y]' => 'Hello!');
$t = $t->text_is('html head title' => 'Hello!', 'right title');

Checks the text content of the first HTML/XML element matched by the CSS selector for an exact match, using at in Mojo::DOM. Slay.

text_isnt — opposite of text_is 💅

$t = $t->text_isnt('div.foo[x=y]' => 'Hello!');
$t = $t->text_isnt('html head title' => 'Hello!', 'different title');

The opposite of text_is, no cap.

text_like — regex-match the text content of the first matching element 🦋

$t = $t->text_like('div.foo[x=y]' => qr/Hello/);
$t = $t->text_like('html head title' => qr/Hello/, 'right title');

Checks the text content of the first HTML/XML element matched by the CSS selector for a similar match, using at in Mojo::DOM. Yes bestie, "similar" — that's the word it uses.

text_unlike — opposite of text_like ⭐

$t = $t->text_unlike('div.foo[x=y]' => qr/Hello/);
$t = $t->text_unlike('html head title' => qr/Hello/, 'different title');

The opposite of text_like. Periodt.

websocket_ok — open a WebSocket connection with a transparent handshake 🔥

$t = $t->websocket_ok('http://example.com/echo');
$t = $t->websocket_ok('/echo');
$t = $t->websocket_ok('/echo' => {DNT => 1} => ['v1.proto']);

Opens a WebSocket connection with a transparent handshake. It takes the same arguments as websocket in Mojo::UserAgent — except for the callback, which is not a thing here. Obsessed.

# WebSocket with permessage-deflate compression
$t->websocket_ok('/' => {'Sec-WebSocket-Extensions' => 'permessage-deflate'})
  ->send_ok('y' x 50000)
  ->message_ok
  ->message_is('z' x 50000)
  ->finish_ok;

🌈 SEE ALSO 🌈

Mojolicious
Mojolicious::Guides
<https://mojolicious.org>

And that's a wrap, bestie 🎀 This page is Test::Mojo(3), from perl v5.42.0, dated 2026-07-15 — go forth and test your WebSockets and SSE streams like the absolute icon you are 💜✨

📦 where this page comes from

opensuse-leap 16.0: perl-Mojolicious 9.480.0-bp160.2.1 · Artistic-2.0
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on 2026-11-04: a language model's rewrite of the original, under its terms