Write Tabular Assertions with Pest and PHPUnit

Last updated on by

Write Tabular Assertions with Pest and PHPUnit image

Spatie recently released a tabular-assertions package you can use to write tabular assertions with Pest or PHPUnit. Inspired by Jest's test.each table syntax (i.e., "table as a data provider"), "Tabular assertions allow you to describe data in a Markdown table-like format and compare it to the actual data":

test('it compares a table', function () {
$order = Order::factory()
->addItem('Pen', 2)
->addItem('Paper', 1)
->addItem('Pencil', 5)
->create();
 
expect($order->items)->toMatchTable('
| #id | #order_id | name | quantity |
| #1 | #1 | Pen | 2 |
| #2 | #1 | Paper | 1 |
| #3 | #1 | Pencil | 5 |
');
});

This package works with both Pest and PHPUnit, and you'll notice the immediate benefit of formatting tabular data in a way that is immediately readable. In my experiments with this package thus far, writing assertions for datasets in this way also feels fun. Some of the main features this package will bring to your test suite include the following:

  • Hand-write expectations in an easy-to-read tabular format
  • Error messages are clear
  • Works for both Pest and PHPUnit
  • Supports custom assertions
  • Support for dynamic values

You can learn more about this package, get full installation instructions, and view the source code on GitHub. If you'd like to learn more about the background of this package, the author, Sebastian De Deyne, wrote about Introducing tabular assertions.

Paul Redmond photo

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

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

image
Laravel Forge

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

Visit Laravel Forge
Laravel Forge logo

Laravel Forge

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

Laravel Forge
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
No Compromises logo

No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project. ⬧ Flat rate of $7500/mo. ⬧ No lengthy sales process. ⬧ No contracts. ⬧ 100% money back guarantee.

No Compromises
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
LoadForge logo

LoadForge

Easy, affordable load testing and stress tests for websites, APIs and databases.

LoadForge
Paragraph logo

Paragraph

Manage your Laravel app as if it was a CMS – edit any text on any page or in any email without touching Blade or language files.

Paragraph
Lucky Media logo

Lucky Media

Bespoke software solutions built for your business. We ♥ Laravel

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
Bacancy - Staff Augmentation logo

Bacancy - Staff Augmentation

Leave your web app development hustles to the leading IT Staff Augmentation Service Providers. Choose from an extensive pool of 1050+ developers and give yourself the sigh of success you deserve with Bacancy. Get In Touch Today!

Bacancy - Staff Augmentation
DocuWriter.ai logo

DocuWriter.ai

Save hours of manually writing Code Documentation, Comments & DocBlocks, Test suites and Refactoring.

DocuWriter.ai
Rector logo

Rector

Your partner for seamless Laravel upgrades, cutting costs, and accelerating innovation for successful companies

Rector

The latest

View all →
Laracon EU Videos are now out image

Laracon EU Videos are now out

Read article
Use Google's Gemini AI in Laravel image

Use Google's Gemini AI in Laravel

Read article
Six Essential Plugins for Visual Studio Code image

Six Essential Plugins for Visual Studio Code

Read article
Modularize Your Laravel Application With the Modular Package image

Modularize Your Laravel Application With the Modular Package

Read article
Handle Money Transactions in Eloquent with Laravel Wallet image

Handle Money Transactions in Eloquent with Laravel Wallet

Read article
Tempo: The Easiest Way to Work With Dates in JavaScript image

Tempo: The Easiest Way to Work With Dates in JavaScript

Read article