madewithlove/phpunit-snapshots

Snaphot testing for PHPUnit

PHPUnit Snapshots

, _(*1)

This trait allows you to use Jest-like snapshot testing in your PHPUnit tests., _(*2)

It is a very basic trait and is only meant to snapshot JSON-encodable structures, not complex objects and such., _(*3)

Installation

composer require madewithlove/phpunit-snapshots

Usage

Using snapshots in tests

Simply call the assertion on any encodable result (the result of a function, a variable, etc.). You can pass an identifier as second argument which will be used as title of the snapshot in the snapshot file., _(*4)

<?php
class MyTestCase extends \PHPUnit_Framework_TestCase
{
    use \Madewithlove\PhpunitSnapshots\SnapshotAssertions;

    public function testSomething()
    {
        $this->assertEqualsSnapshot($this->someComplexOperation());
        $this->assertEqualsSnapshot($this->someComplexOperation(), 'Compute something');
    }
}

This will generate a snapshot if we didn't have one for this test, else it will assert that the current results match the ones in the snapshot., _(*5)

Updating all snapshots

You can update all snapshots in your tests by running the following:, _(*6)

$ phpunit -d --update

Testing

bash $ composer test, _(*7)

License

The MIT License (MIT). Please see License File for more information., _(*8)