[WIP] Snapshot functionality #1000
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
added
the
| @@ -188,6 +188,13 @@ function processArgs() { | |||
| ), | |||
| type: 'boolean', | |||
| }, | |||
| overwriteSnapshot: { | |||
There was a problem hiding this comment.
can we call this updateSnapshot and give it -u as a shortcut?
removing the default object serialize using JasminePretty printed, still using it for formatting the diff
since I'm going to rewrite the part that save the file only at the end of a file run, this will not work anyway
Moved almost all file/path access to it (todo moving the last in index), Create a snapshotState on jest-jasmine2 that gets passed to the `getMatchers` function, so that common can be deleted. `getMatchers` uses the snapshotState to gather the Spec fullname and to increment a counter (I may use an autoincrement getter here in the future, so that even this state is not handled here). `initialize` is now `getSnapshotState` which returns the state management relative to a single file, TestSnapshot is fully rewritten to load and save a file only once.
…` factory move all path management to TestSnapShot, also only export a `forFile` factory as per @cpojer comment, also rename file to `SnapshotFile` as per another comment.
fix creation of a snapshot file per test file if toMatchSnapshot hasn't been called.
adding basic unit tests
kentaromiura
force-pushed
the
snapshot_wip
branch
from
00f5b32 to
c19bf15
Compare
|
I rebased to 12.1.0 so it should be easier to rebase later. |
|
@facebook-github-bot import |
|
Thanks for importing. If you are an FB employee go to Phabricator to review. |
|
@facebook-github-bot shipit |
|
Thanks for importing. If you are an FB employee go to Phabricator to review. |
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
This pull request was closed.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit introduce a new matcher to
jest:toMatchSnapshot.this new matcher can be called as usual:
expect(something).toMatchSnapshot()the main idea is that the first time the test run it will store whatever is inside expect in a snapshot file,
the next time
jestruns it will check against it to see if something has changed.In order to store something on file we need to serialize it, so I currently implemented two different serialization strategies, if we are expecting a
Reactelement to match a snapshot representation then it will be currently be serialized using theReact.renderToStringmethod, otherwise it fallbacks tojest's pretty printer.I choose it because it provides out of the box support for
MapsandSetsother thanObjects andArrays.As the title mention this is a work in progress as I plan to iterate on it to improve the serialization strategies and possible the output when it fails the expectation.
The matcher uses jasmine
SpecgetFullNameas the key in the snapshot file, adding an index at the end, this enable us to use multipletoMatchSnapshot, not just in the sameSuite, but also in the sameSpec, when failing it will highlight which snapshot has failed prepending#in front of an index of it (it starts at 0, but we can change it to 1 if it creates confusion).When a test fails one can either fix the code breaking the expectation or, if the expectation is not up to date anymore, pass
--overwriteSnapshottojestto update it:This is an example of a failing test for a React component
