astrotomic / pest-plugin-laravel-snapshots

This package adds snapshot testing capabilities to Laravel HTTP tests with Pest.

Pest Laravel Snapshot Assertions

This package adds snapshot testing capabilities to Laravel HTTP tests with Pest. It uses the phpunit-snapshot-assertions package making snapshot assertions available in Pest HTTP tests.

Installation

You can install the package via composer:

composer require astrotomic/pest-plugin-laravel-snapshots --dev

Usage

At first you should use orchestra/testbench which adds the HTTP helper methods that return a \Illuminate\Testing\TestResponse instance.

use Orchestra\Testbench\TestCase;
uses(TestCase::class);

// long
test('html response body matches with snapshot')
    ->get('/html')
    ->assertMatchesHtmlSnapshot();

// short
// https://github.com/pestphp/pest-plugin-laravel
use function Pest\Laravel\get;
get('/html')->assertMatchesHtmlSnapshot();

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details. You could also be interested in CODE OF CONDUCT.

Security

If you discover any security related issues, please check SECURITY for steps to report it.

Credits

• Tom Witkowski
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

Treeware

You're free to use this package, but if it makes it to your production environment I would highly appreciate you buying the world a tree.

It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you contribute to my forest you’ll be creating employment for local families and restoring wildlife habitats.

You can buy trees at offset.earth/treeware

Read more about Treeware at treeware.earth