Laravel Packages

Assert DOM Elements in Laravel Tests

Published
Assert DOM Elements in Laravel Tests image

The Laravel DOM Assertions package by René Sinnbeck adds document object model (DOM) assertion helpers to Laravel's TestResponse class:

This package provides some extra assertion helpers to use in HTTP Tests. If you have ever needed more control over your view assertions than assertSee, assertSeeInOrder, assertSeeText, assertSeeTextInOrder, assertDontSee, and assertDontSeeText then this is the package for you.

The package's README has an example of asserting a navigation menu to ensure the correct li element has an active class, but also ensure the "Home" li element does not:

$this->get(route('about'))
    ->assertOk()
    ->assertElementExists('nav > ul', function(AssertElement $ul) {
        $ul->contains('li', [
            'class' => 'active',
            'text' => 'About'
        ]);
        $ul->doesntContain('li', [
            'class' => 'active',
            'text' => 'Home'
        ]);
    });

The snippet illustrates the granular control provided by this package, including testing DOM elements, nested elements, forms, and more. At the time of the writing, this package's main assertions include:

  • Assert if an element exists
  • Assert if an element has a given attribute
  • Assert if an element contains in another element
  • Assert that an element does not contain another element
  • Find an element to process further assertions
  • Assert if a form exists
  • Assert that a form has a CSRF token
  • Assert for select options

You can learn more about this package, get full installation instructions, and view the source code on GitHub.

As a side note, this package's source code has an example of using the macroable mixin method to add multiple macro methods into another object from a service provider, which might be a helpful inspiration for others writing packages for Laravel.

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Sponsored

laravelcloud logo
Laravel Cloud

Easily create and manage your servers and deploy your Laravel applications in seconds.

Visit Laravel Cloud

The latest

View all →
Slow Job Alerts and Replica Commit IDs in Laravel 13.40 image

Slow Job Alerts and Replica Commit IDs in Laravel 13.40

Read article
Flock: A Free, Native Herd Alternative for Laravel image

Flock: A Free, Native Herd Alternative for Laravel

Read article
Live Props for Real-Time Updates in Inertia.js v3.11 image

Live Props for Real-Time Updates in Inertia.js v3.11

Read article
Cooldown Dependency Policy now in Composer 2.11 image

Cooldown Dependency Policy now in Composer 2.11

Read article
Email Sending and Testing for Laravel in One Account image

Email Sending and Testing for Laravel in One Account

Read article
Decide with Jev: Tie Every AI Check to the Exact Draft image

Decide with Jev: Tie Every AI Check to the Exact Draft

Read article