Skip to content

speicherhafen/snapshot-testing

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 
 
 
 
 
 
 

Snapshot Testing

Build Status

Provides PHPUnit assertions for snapshot testing

Installation

composer require --dev kigaroo/snapshot-testing

Basic Usage

use KigaRoo\SnapshotTesting\MatchesSnapshots;

final class MyUnitTest extends TestCase
{
    use MatchesSnapshots;
    
    public function testJson()
    {
        $myJsonData = json_encode([
            'foo' => 'bar',
        ]);
        
        $this->assertMatchesJsonSnapshot($myJsonData);
    }    
    
    public function testXml()
    {
        $myXmlData = "<?xml version="1.0" encoding="UTF-8"?><root><id>7d644cc6-70fa-11e9-89e1-220d3e3a2561</id></root>";
        
        $this->assertMatchesXmlSnapshot($myJsonData);
    }    
    
    public function testCsv()
    {
        $myCsvData = <<<CSV
"foo bar";123
"foo bar";456
"foo bar";789
CSV;
        $this->assertMatchesCsvSnapshot($myCsvData);
    }    
    
    public function testCsvVariant()
    {
        $myCsvData = <<<CSV
'foo bar',123
'foo bar',456
'foo bar',789
CSV;
        $this->assertMatchesCsvSnapshot($myCsvData, [], ',', "'");
    }
}

Using Wildcards

If you have content in your data which changes intentionally you can use wildcards:

use KigaRoo\SnapshotTesting\MatchesSnapshots;
use KigaRoo\SnapshotTesting\Wildcard\UuidWildcard;

final class MyUnitTest extends TestCase
{
    use MatchesSnapshots;
    
    public function testJson()
    {
        $myJsonData = json_encode([
            'id' => '7d644cc6-70fa-11e9-89e1-220d3e3a2561',
            'foo' => 'bar',
        ]);
        
        $this->assertMatchesJsonSnapshot($myJsonData, [
            new UuidWildcard('id'),
        ]);
    }    
    
    public function testXml()
    {
        $myXmlData = '<?xml version="1.0" encoding="UTF-8"?><root><id>7d644cc6-70fa-11e9-89e1-220d3e3a2561</id></root>';

        $this->assertMatchesXmlSnapshot($myXmlData, [
            new UuidWildcard('id'),
        ]);
    }
    
    public function testCsv()
    {
        $myCsvData = <<<CSV
"7d644cc6-70fa-11e9-89e1-220d3e3a2561";123
"7d644cc6-70fa-11e9-89e1-220d3e3a2561";456
"7d644cc6-70fa-11e9-89e1-220d3e3a2561";789
CSV;
        $this->assertMatchesCsvSnapshot($myCsvData, [
            new UuidWildcard('[*][0]'),
        ]);
    }    
}

This ignores the concrete uuid given for the field "id" and only checks that a valid uuid is provided.

The library currently supports the following wildcards:

  • BooleanWildcard
  • IntegerWildcard
  • UuidWildcard
  • UuidOrNullWildcard
  • DateTimeWildcard
  • DateTimeOrNullWildcard
  • StringWildcard
  • ObjectOrNullWildcard

Usage in CI

When running your tests in Continuous Integration you would possibly want to disable the creation of snapshots.

By using the --without-creating-snapshots parameter, PHPUnit will fail if the snapshots don't exist.

> ./vendor/bin/phpunit -d --without-creating-snapshots

1) ExampleTest::test_it_matches_a_string
Snapshot "ExampleTest__test_it_matches_a_string__1.txt" does not exist. 
You can automatically create it by removing `-d --without-creating-snapshots` of PHPUnit's CLI arguments.

About

Provides PHPUnit assertions for snapshot testing

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages