Skip to content

Add extra snapshot file format documentation #288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Naktibalda merged 1 commit into from
Aug 29, 2020
Merged

Add extra snapshot file format documentation #288

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion docs/09-Data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,9 +384,33 @@ public function testCategoriesAreTheSame(\AcceptanceTester $I, \Snapshot\Categor
}

{% endhighlight %}

If ever needed, the diff output can also be omitted by calling `shouldShowDiffOnFail(false)`.

### Working with different data formats

By default, all snapshot files are stored in json format, so if you have to work with different formats, neither the diff output or the snapshot file data will be helpful.
To fix this, you can call the snapshot method `shouldSaveAsJson(false)` and set the file extension by calling `setSnapshotFileExtension()`:

{% highlight php %}

<?php
public function testCategoriesAreTheSame(\AcceptanceTester $I, \Snapshot\Categories $snapshot)
{
// I fetch an HTML page
$I->amOnPage('/categories.html');
// I want to see the diff in case the snapshot data changes
$snapshot->shouldSaveAsJson(false);
$snapshot->setSnapshotFileExtension('html');
$snapshot->assert();
}

{% endhighlight %}

The snapshot file will be stored without encoding it to json format, and with the `.html` extension.

> Beware that this option will not perform any changes in the data returned by `fetchData`, and store it as it is.

## Conclusion

Codeception also assists the developer when dealing with data. Tools for database population
Expand Down