feat: allow storing received screenshot on failure

ablok commented 2 years ago

Description

Currently, when a screenshot test fails, the actual (received) image is not stored, other than in a diff image. This PR allows users to set 2 variables: storeReceivedOnFailure and customReceivedDir. When a test fails, and storeReceivedOnFailure is set to true, the received image will also be stored. You can optionally specify a custom location where to store these images by setting customReceivedDir. Not really sure about the naming. Could also use actual instead of received. The feature is currently an addition, but could also be a toggle between storing the composed diff image or storing seperate images. 🤷‍♂️

Motivation and Context

This fixes #260 . This is useful when running in CI. If a screenshot test fails. you can get a new baseline image directly from the build and commit it as the new baseline if the change is as expected.

How Has This Been Tested?

Added unit tests. Tested it locally.

Types of Changes

[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] Documentation (adding or updating documentation)
[ ] Dependency update

Checklist:

[x] My change requires a change to the documentation and I have updated the documentation accordingly.
[x] My changes are in sync with the code style of this project.
[x] There aren't any other open Pull Requests for the same issue/update.
[ ] These changes should be applied to a maintenance branch.
[ ] I have added the Apache 2.0 license header to any new files created.

What is the Impact to Developers Using Jest-Image-Snapshot?

Impact should be none. Use of this feature is optional.

CLAassistant commented 2 years ago

All committers have signed the CLA.

ablok commented 2 years ago

Feedback why this is a good/bad idea would be appreciated.

ablok commented 2 years ago

@Matthew-Mallimo could you check the changes I made?

oneamexbot commented 2 years ago

:tada: This PR is included in version 5.1.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

americanexpress / jest-image-snapshot