Add snapshot property matchers #6210

rickhanlonii · 2018-05-19T23:56:24Z

Summary

This PR introduces a new snapshot testing concept I'm calling "property matchers" (feedback on naming welcome)

Details

Implementation

You can now pass an object with asymmetric matchers into toMatchSnapshot which are then written to the snapshot instead of the original values:

Property checking

These matchers are checked before the snapshot is written or checked:

Note: it's weird that there is a note to re-run with -u to update, which will not update the snapshot since it's not the written value that fails. Recommend following up with a change to the reporter logic.

Also note: a diff would be a nice followup

Documentation

Expect

Snapshot Testing

Test plan

Added integration tests
No existing tests changed

rickhanlonii · 2018-05-20T00:00:10Z

packages/expect/src/index.js

        isNot,
+        iterableEquality,
+        subsetEquality,


Thoughts on exposing these to matchers and how?

maybe stick them in this.utils instead of directly on this?

I had the same thought, will move

also needs to be doced, fwiw

rickhanlonii · 2018-05-20T00:01:53Z

packages/jest-snapshot/src/plugins.js

@@ -18,6 +18,7 @@ const {
  Immutable,
  ReactElement,
  ReactTestComponent,
+  AsymmetricMatcher,


@thymikee already handled all the hard stuff for me, thanks!

rickhanlonii · 2018-05-20T00:02:11Z

website/i18n/en.json

@@ -80,7 +80,6 @@
    "Watch more videos|no description given": "Watch more videos",
    "Who's using Jest?|no description given": "Who's using Jest?",
    "Jest is used by teams of all sizes to test web applications, node.js services, mobile apps, and APIs.|no description given": "Jest is used by teams of all sizes to test web applications, node.js services, mobile apps, and APIs.",
-    "More Jest Users|no description given": "More Jest Users",


Unrelated but needed on master

codecov-io · 2018-05-20T00:10:14Z

Codecov Report

Merging #6210 into master will decrease coverage by 0.1%.
The diff coverage is 21.05%.

@@            Coverage Diff             @@
##           master    #6210      +/-   ##
==========================================
- Coverage   64.22%   64.12%   -0.11%     
==========================================
  Files         220      220              
  Lines        8483     8501      +18     
  Branches        3        4       +1     
==========================================
+ Hits         5448     5451       +3     
- Misses       3034     3049      +15     
  Partials        1        1

Impacted Files	Coverage Δ
packages/jest-snapshot/src/plugins.js	`80% <ø> (ø)`	⬆️
packages/jest-snapshot/src/State.js	`0% <0%> (ø)`	⬆️
packages/jest-snapshot/src/index.js	`56.14% <33.33%> (-6.91%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 73a656d...4dcd25b. Read the comment docs.

SimenB · 2018-05-20T09:43:33Z

This is so awesome, I'm excited!

Question - what about expect.objectContaining?

expect({ target: { value: "some value", key: 13 } }).toMatchSnapshot({
  target: expect.objectContaining({ value: "some value" })
});

To copy your original example:

it('will check the matchers and pass', () => {
  const user = {
    createdAt: new Date(),
    id: Math.floor(Math.random() * 20),
    name: 'LeBron James'
  };

  expect(user).toMatchSnapshot(
    expect.ObjectContaining({
      name: 'LeBron James'
    })
  );
});
 
// Snapshot
exports[`will check the matchers and pass 1`] = `
ObjectContaining {
  "name": "LeBron James",
}
`;

perhaps?

If that already works - mind adding a test?

SimenB · 2018-05-20T09:44:07Z

packages/jest-snapshot/src/index.js

+        report,
+      };
+    } else {
+      Object.assign(received, propertyMatchers);


This won't handle deep objects - should it be a deep merge instead?

Great catch, i'll add an integration test for this as well

Any follow up for this?

SimenB · 2018-05-20T09:49:11Z

integration-tests/__tests__/to_match_snapshot.test.js

+    });
+    `);
+
+  {


weird to use scopes here, although I get why you do it. why not just a descirbe around it and multiple tests instead?

My thoughts as well - I was copying the style from the rest of the suite. I'll update the suite 👌

rickhanlonii · 2018-05-20T15:59:12Z

@SimenB thanks!

expect.objectContaining works for properties of the object as in:

But not as the passed argument. That use case is interesting - what's the benefit of:

expect(user).toMatchSnapshot(expect.objectContaining({ name: 'LeBron' }));

Over

expect(user).toEqual(expect.objectContaining({ name: 'LeBron' });

SimenB · 2018-05-20T20:16:19Z

what's the benefit of:

At the top level, not much, only at a deeper level. Seeing as that works, I think my concern has been addressed! I'd love to see an extra test for it, though.

EDIT: ~~I suppose, expect({ name: 'LeBron', signDate: new Date(2018, 0, 0) }).toMatchSnapshot(expect.objectContaining({ name: 'LeBron' }); Not sure how useful that is?~~

meh, ignore me

orta · 2018-05-20T21:35:52Z

👍 nice idea

cpojer · 2018-05-22T05:13:00Z

Wow, I love this. Let's get it in for Jest 23.

thymikee · 2018-05-24T16:13:53Z

docs/ExpectAPI.md

@@ -1192,13 +1192,16 @@ test('this house has my desired features', () => {
 });
 ```

-### `.toMatchSnapshot(optionalString)`
+### `.toMatchSnapshot(propertyMatchers, snapshotName)`


I think it will be better to go with something like this:

### `.toMatchSnapshot(?propertyMatchers|snapshotName, ?snapshotName)`

Even though we explain this later

This Pull Request updates dependency [jest](https://github.com/facebook/jest) from `~22.4.0` to `~23.0.0` <details> <summary>Release Notes</summary> ### [`v23.0.0`](https://github.com/facebook/jest/blob/master/CHANGELOG.md#2300) [Compare Source](jestjs/jest@2745e3e...614f739) ##### Features * `[expect]` Expose `getObjectSubset`, `iterableEquality`, and `subsetEquality` ([#6210](`jestjs/jest#6210)) * `[jest-snapshot]` Add snapshot property matchers ([#6210](`jestjs/jest#6210)) * `[jest-config]` Support jest-preset.js files within Node modules ([#6185](`jestjs/jest#6185)) * `[jest-cli]` Add `--detectOpenHandles` flag which enables Jest to potentially track down handles keeping it open after tests are complete. ([#6130](`jestjs/jest#6130)) * `[jest-jasmine2]` Add data driven testing based on `jest-each` ([#6102](`jestjs/jest#6102)) * `[jest-matcher-utils]` Change "suggest to equal" message to be more advisory ([#6103](`jestjs/jest#6103)) * `[jest-message-util]` Don't ignore messages with `vendor` anymore ([#6117](`jestjs/jest#6117)) * `[jest-validate]` Get rid of `jest-config` dependency ([#6067](`jestjs/jest#6067)) * `[jest-validate]` Adds option to inject `deprecationEntries` ([#6067](`jestjs/jest#6067)) * `[jest-snapshot]` [**BREAKING**] Concatenate name of test, optional snapshot name and count ([#6015](`jestjs/jest#6015)) * `[jest-runtime]` Allow for transform plugins to skip the definition process method if createTransformer method was defined. ([#5999](`jestjs/jest#5999)) * `[expect]` Add stack trace for async errors ([#6008](`jestjs/jest#6008)) * `[jest-jasmine2]` Add stack trace for timeouts ([#6008](`jestjs/jest#6008)) * `[jest-jasmine2]` Add stack trace for thrown non-`Error`s ([#6008](`jestjs/jest#6008)) * `[jest-runtime]` Prevent modules from marking themselves as their own parent ([#5235](`jestjs/jest#5235)) * `[jest-mock]` Add support for auto-mocking generator functions ([#5983](`jestjs/jest#5983)) * `[expect]` Add support for async matchers ([#5919](`jestjs/jest#5919)) * `[expect]` Suggest toContainEqual ([#5948](`jestjs/jest#5953)) * `[jest-config]` Export Jest's default options ([#5948](`jestjs/jest#5948)) * `[jest-editor-support]` Move `coverage` to `ProjectWorkspace.collectCoverage` ([#5929](`jestjs/jest#5929)) * `[jest-editor-support]` Add `coverage` option to runner ([#5836](`jestjs/jest#5836)) * `[jest-haste-map]` Support extracting dynamic `import`s ([#5883](`jestjs/jest#5883)) * `[expect]` Improve output format for mismatchedArgs in mock/spy calls. ([#5846](`jestjs/jest#5846)) * `[jest-cli]` Add support for using `--coverage` in combination with watch mode, `--onlyChanged`, `--findRelatedTests` and more ([#5601](`jestjs/jest#5601)) * `[jest-jasmine2]` [**BREAKING**] Adds error throwing and descriptive errors to `it`/ `test` for invalid arguments. `[jest-circus]` Adds error throwing and descriptive errors to `it`/ `test` for invalid arguments ([#5558](`jestjs/jest#5558)) * `[jest-matcher-utils]` Add `isNot` option to `matcherHint` function ([#5512](`jestjs/jest#5512)) * `[jest-config]` Add `<rootDir>` to runtime files not found error report ([#5693](`jestjs/jest#5693)) * `[expect]` Make toThrow matcher pass only if Error object is returned from promises ([#5670](`jestjs/jest#5670)) * `[expect]` Add isError to utils ([#5670](`jestjs/jest#5670)) * `[expect]` Add inverse matchers (`expect.not.arrayContaining`, etc., [#5517](`jestjs/jest#5517)) * `[expect]` `expect.extend` now also extends asymmetric matchers ([#5503](`jestjs/jest#5503)) * `[jest-mock]` Update `spyOnProperty` to support spying on the prototype chain ([#5753](`jestjs/jest#5753)) * `[jest-mock]` Add tracking of return values in the `mock` property ([#5752](`jestjs/jest#5752)) * `[jest-mock]` Add tracking of thrown errors in the `mock` property ([#5764](`jestjs/jest#5764)) * `[expect]`Add nthCalledWith spy matcher ([#5605](`jestjs/jest#5605)) * `[jest-cli]` Add `isSerial` property that runners can expose to specify that they can not run in parallel ([#5706](`jestjs/jest#5706)) * `[expect]` Add `.toBeCalledTimes` and `toHaveBeenNthCalledWith` aliases ([#5826](`jestjs/jest#5826)) * `[jest-cli]` Interactive Snapshot Mode improvements ([#5864](`jestjs/jest#5864)) * `[jest-editor-support]` Add `no-color` option to runner ([#5909](`jestjs/jest#5909)) * `[jest-jasmine2]` Pretty-print non-Error object errors ([#5980](`jestjs/jest#5980)) * `[jest-message-util]` Include column in stack frames ([#5889](`jestjs/jest#5889)) * `[expect]` Introduce toStrictEqual ([#6032](`jestjs/jest#6032)) * `[expect]` Add return matchers ([#5879](`jestjs/jest#5879)) * `[jest-cli]` Improve snapshot summaries ([#6181](`jestjs/jest#6181)) * `[expect]` Include custom mock names in error messages ([#6199](`jestjs/jest#6199)) * `[jest-diff]` Support returning diff from oneline strings ([#6221](`jestjs/jest#6221)) * `[expect]` Improve return matchers ([#6172](`jestjs/jest#6172)) * `[jest-cli]` Overhaul watch plugin hooks names ([#6249](`jestjs/jest#6249)) * `[jest-mock]` Include tracked call results in serialized mock ([#6244](`jestjs/jest#6244)) ##### Fixes * `[jest-cli]` Fix stdin encoding to utf8 for watch plugins. ([#6253](`jestjs/jest#6253)) * `[expect]` Better detection of DOM Nodes for equality ([#6246](`jestjs/jest#6246)) * `[jest-cli]` Fix misleading action description for F key when in "only failed tests" mode. ([#6167](`jestjs/jest#6167)) * `[jest-worker]` Stick calls to workers before processing them ([#6073](`jestjs/jest#6073)) * `[babel-plugin-jest-hoist]` Allow using `console` global variable ([#6075](`jestjs/jest#6075)) * `[jest-jasmine2]` Always remove node core message from assert stack traces ([#6055](`jestjs/jest#6055)) * `[expect]` Add stack trace when `expect.assertions` and `expect.hasAssertions` causes test failures. ([#5997](`jestjs/jest#5997)) * `[jest-runtime]` Throw a more useful error when trying to require modules after the test environment is torn down ([#5888](`jestjs/jest#5888)) * `[jest-mock]` [**BREAKING**] Replace timestamps with `invocationCallOrder` ([#5867](`jestjs/jest#5867)) * `[jest-jasmine2]` Install `sourcemap-support` into normal runtime to catch runtime errors ([#5945](`jestjs/jest#5945)) * `[jest-jasmine2]` Added assertion error handling inside `afterAll hook` ([#5884](`jestjs/jest#5884)) * `[jest-cli]` Remove the notifier actions in case of failure when not in watch mode. ([#5861](`jestjs/jest#5861)) * `[jest-mock]` Extend .toHaveBeenCalled return message with outcome ([#5951](`jestjs/jest#5951)) * `[jest-runner]` Assign `process.env.JEST_WORKER_ID="1"` when in runInBand mode ([#5860](`jestjs/jest#5860)) * `[jest-cli]` Add descriptive error message when trying to use `globalSetup`/`globalTeardown` file that doesn't export a function. ([#5835](`jestjs/jest#5835)) * `[expect]` Do not rely on `instanceof RegExp`, since it will not work for RegExps created inside of a different VM ([#5729](`jestjs/jest#5729)) * `[jest-resolve]` Update node module resolution algorithm to correctly handle symlinked paths ([#5085](`jestjs/jest#5085)) * `[jest-editor-support]` Update `Settings` to use spawn in shell option ([#5658](`jestjs/jest#5658)) * `[jest-cli]` Improve the error message when 2 projects resolve to the same config ([#5674](`jestjs/jest#5674)) * `[jest-runtime]` remove retainLines from coverage instrumentation ([#5692](`jestjs/jest#5692)) * `[jest-cli]` Fix update snapshot issue when using watchAll ([#5696](`jestjs/jest#5696)) * `[expect]` Fix rejects.not matcher ([#5670](`jestjs/jest#5670)) * `[jest-runtime]` Prevent Babel warnings on large files ([#5702](`jestjs/jest#5702)) * `[jest-mock]` Prevent `mockRejectedValue` from causing unhandled rejection ([#5720](`jestjs/jest#5720)) * `[pretty-format]` Handle React fragments better ([#5816](`jestjs/jest#5816)) * `[pretty-format]` Handle formatting of `React.forwardRef` and `Context` components ([#6093](`jestjs/jest#6093)) * `[jest-cli]` Switch collectCoverageFrom back to a string ([#5914](`jestjs/jest#5914)) * `[jest-regex-util]` Fix handling regex symbols in tests path on Windows ([#5941](`jestjs/jest#5941)) * `[jest-util]` Fix handling of NaN/Infinity in mock timer delay ([#5966](`jestjs/jest#5966)) * `[jest-resolve]` Generalise test for package main entries equivalent to ".". ([#5968](`jestjs/jest#5968)) * `[jest-config]` Ensure that custom resolvers are used when resolving the configuration ([#5976](`jestjs/jest#5976)) * `[website]` Fix website docs ([#5853](`jestjs/jest#5853)) * `[expect]` Fix isEqual Set and Map to compare object values and keys regardless of order ([#6150](`jestjs/jest#6150)) * `[pretty-format]` [**BREAKING**] Remove undefined props from React elements ([#6162](`jestjs/jest#6162)) * `[jest-haste-map]` Properly resolve mocked node modules without package.json defined ([#6232](`jestjs/jest#6232)) ##### Chore & Maintenance * `[jest-runner]` Move sourcemap installation from `jest-jasmine2` to `jest-runner` ([#6176](`jestjs/jest#6176)) * `[jest-cli]` Use yargs's built-in `version` instead of rolling our own ([#6215](`jestjs/jest#6215)) * `[docs]` Add explanation on how to mock methods not implemented in JSDOM * `[jest-jasmine2]` Simplify `Env.execute` and TreeProcessor to setup and clean resources for the top suite the same way as for all of the children suites ([#5885](`jestjs/jest#5885)) * `[babel-jest]` [**BREAKING**] Always return object from transformer ([#5991](`jestjs/jest#5991)) * `[*]` Run Prettier on compiled output ([#5858](`jestjs/jest#3497)) * `[jest-cli]` Add fileChange hook for plugins ([#5708](`jestjs/jest#5708)) * `[docs]` Add docs on using `jest.mock(...)` ([#5648](`jestjs/jest#5648)) * `[docs]` Mention Jest Puppeteer Preset ([#5722](`jestjs/jest#5722)) * `[docs]` Add jest-community section to website ([#5675](`jestjs/jest#5675)) * `[docs]` Add versioned docs for v22.4 ([##5733](https://github.com/facebook/jest/pull/#5733)) * `[docs]` Improve Snapshot Testing Guide ([#5812](`jestjs/jest#5812)) * `[jest-runtime]` [**BREAKING**] Remove `jest.genMockFn` and `jest.genMockFunction` ([#6173](`jestjs/jest#6173)) * `[jest-message-util]` Avoid adding unnecessary indent to blank lines in stack traces ([#6211](`jestjs/jest#6211)) --- </details> --- This PR has been generated by [Renovate Bot](https://renovatebot.com).

This Pull Request updates dependency [jest](https://github.com/facebook/jest) from `~22.4.0` to `~23.0.0` <details> <summary>Release Notes</summary> ### [`v23.0.0`](https://github.com/facebook/jest/blob/master/CHANGELOG.md#2300) [Compare Source](jestjs/jest@2745e3e...v23.0.0) ##### Features * `[expect]` Expose `getObjectSubset`, `iterableEquality`, and `subsetEquality` ([#6210](`jestjs/jest#6210)) * `[jest-snapshot]` Add snapshot property matchers ([#6210](`jestjs/jest#6210)) * `[jest-config]` Support jest-preset.js files within Node modules ([#6185](`jestjs/jest#6185)) * `[jest-cli]` Add `--detectOpenHandles` flag which enables Jest to potentially track down handles keeping it open after tests are complete. ([#6130](`jestjs/jest#6130)) * `[jest-jasmine2]` Add data driven testing based on `jest-each` ([#6102](`jestjs/jest#6102)) * `[jest-matcher-utils]` Change "suggest to equal" message to be more advisory ([#6103](`jestjs/jest#6103)) * `[jest-message-util]` Don't ignore messages with `vendor` anymore ([#6117](`jestjs/jest#6117)) * `[jest-validate]` Get rid of `jest-config` dependency ([#6067](`jestjs/jest#6067)) * `[jest-validate]` Adds option to inject `deprecationEntries` ([#6067](`jestjs/jest#6067)) * `[jest-snapshot]` [**BREAKING**] Concatenate name of test, optional snapshot name and count ([#6015](`jestjs/jest#6015)) * `[jest-runtime]` Allow for transform plugins to skip the definition process method if createTransformer method was defined. ([#5999](`jestjs/jest#5999)) * `[expect]` Add stack trace for async errors ([#6008](`jestjs/jest#6008)) * `[jest-jasmine2]` Add stack trace for timeouts ([#6008](`jestjs/jest#6008)) * `[jest-jasmine2]` Add stack trace for thrown non-`Error`s ([#6008](`jestjs/jest#6008)) * `[jest-runtime]` Prevent modules from marking themselves as their own parent ([#5235](`jestjs/jest#5235)) * `[jest-mock]` Add support for auto-mocking generator functions ([#5983](`jestjs/jest#5983)) * `[expect]` Add support for async matchers ([#5919](`jestjs/jest#5919)) * `[expect]` Suggest toContainEqual ([#5948](`jestjs/jest#5953)) * `[jest-config]` Export Jest's default options ([#5948](`jestjs/jest#5948)) * `[jest-editor-support]` Move `coverage` to `ProjectWorkspace.collectCoverage` ([#5929](`jestjs/jest#5929)) * `[jest-editor-support]` Add `coverage` option to runner ([#5836](`jestjs/jest#5836)) * `[jest-haste-map]` Support extracting dynamic `import`s ([#5883](`jestjs/jest#5883)) * `[expect]` Improve output format for mismatchedArgs in mock/spy calls. ([#5846](`jestjs/jest#5846)) * `[jest-cli]` Add support for using `--coverage` in combination with watch mode, `--onlyChanged`, `--findRelatedTests` and more ([#5601](`jestjs/jest#5601)) * `[jest-jasmine2]` [**BREAKING**] Adds error throwing and descriptive errors to `it`/ `test` for invalid arguments. `[jest-circus]` Adds error throwing and descriptive errors to `it`/ `test` for invalid arguments ([#5558](`jestjs/jest#5558)) * `[jest-matcher-utils]` Add `isNot` option to `matcherHint` function ([#5512](`jestjs/jest#5512)) * `[jest-config]` Add `<rootDir>` to runtime files not found error report ([#5693](`jestjs/jest#5693)) * `[expect]` Make toThrow matcher pass only if Error object is returned from promises ([#5670](`jestjs/jest#5670)) * `[expect]` Add isError to utils ([#5670](`jestjs/jest#5670)) * `[expect]` Add inverse matchers (`expect.not.arrayContaining`, etc., [#5517](`jestjs/jest#5517)) * `[expect]` `expect.extend` now also extends asymmetric matchers ([#5503](`jestjs/jest#5503)) * `[jest-mock]` Update `spyOnProperty` to support spying on the prototype chain ([#5753](`jestjs/jest#5753)) * `[jest-mock]` Add tracking of return values in the `mock` property ([#5752](`jestjs/jest#5752)) * `[jest-mock]` Add tracking of thrown errors in the `mock` property ([#5764](`jestjs/jest#5764)) * `[expect]`Add nthCalledWith spy matcher ([#5605](`jestjs/jest#5605)) * `[jest-cli]` Add `isSerial` property that runners can expose to specify that they can not run in parallel ([#5706](`jestjs/jest#5706)) * `[expect]` Add `.toBeCalledTimes` and `toHaveBeenNthCalledWith` aliases ([#5826](`jestjs/jest#5826)) * `[jest-cli]` Interactive Snapshot Mode improvements ([#5864](`jestjs/jest#5864)) * `[jest-editor-support]` Add `no-color` option to runner ([#5909](`jestjs/jest#5909)) * `[jest-jasmine2]` Pretty-print non-Error object errors ([#5980](`jestjs/jest#5980)) * `[jest-message-util]` Include column in stack frames ([#5889](`jestjs/jest#5889)) * `[expect]` Introduce toStrictEqual ([#6032](`jestjs/jest#6032)) * `[expect]` Add return matchers ([#5879](`jestjs/jest#5879)) * `[jest-cli]` Improve snapshot summaries ([#6181](`jestjs/jest#6181)) * `[expect]` Include custom mock names in error messages ([#6199](`jestjs/jest#6199)) * `[jest-diff]` Support returning diff from oneline strings ([#6221](`jestjs/jest#6221)) * `[expect]` Improve return matchers ([#6172](`jestjs/jest#6172)) * `[jest-cli]` Overhaul watch plugin hooks names ([#6249](`jestjs/jest#6249)) * `[jest-mock]` Include tracked call results in serialized mock ([#6244](`jestjs/jest#6244)) ##### Fixes * `[jest-cli]` Fix stdin encoding to utf8 for watch plugins. ([#6253](`jestjs/jest#6253)) * `[expect]` Better detection of DOM Nodes for equality ([#6246](`jestjs/jest#6246)) * `[jest-cli]` Fix misleading action description for F key when in "only failed tests" mode. ([#6167](`jestjs/jest#6167)) * `[jest-worker]` Stick calls to workers before processing them ([#6073](`jestjs/jest#6073)) * `[babel-plugin-jest-hoist]` Allow using `console` global variable ([#6075](`jestjs/jest#6075)) * `[jest-jasmine2]` Always remove node core message from assert stack traces ([#6055](`jestjs/jest#6055)) * `[expect]` Add stack trace when `expect.assertions` and `expect.hasAssertions` causes test failures. ([#5997](`jestjs/jest#5997)) * `[jest-runtime]` Throw a more useful error when trying to require modules after the test environment is torn down ([#5888](`jestjs/jest#5888)) * `[jest-mock]` [**BREAKING**] Replace timestamps with `invocationCallOrder` ([#5867](`jestjs/jest#5867)) * `[jest-jasmine2]` Install `sourcemap-support` into normal runtime to catch runtime errors ([#5945](`jestjs/jest#5945)) * `[jest-jasmine2]` Added assertion error handling inside `afterAll hook` ([#5884](`jestjs/jest#5884)) * `[jest-cli]` Remove the notifier actions in case of failure when not in watch mode. ([#5861](`jestjs/jest#5861)) * `[jest-mock]` Extend .toHaveBeenCalled return message with outcome ([#5951](`jestjs/jest#5951)) * `[jest-runner]` Assign `process.env.JEST_WORKER_ID="1"` when in runInBand mode ([#5860](`jestjs/jest#5860)) * `[jest-cli]` Add descriptive error message when trying to use `globalSetup`/`globalTeardown` file that doesn't export a function. ([#5835](`jestjs/jest#5835)) * `[expect]` Do not rely on `instanceof RegExp`, since it will not work for RegExps created inside of a different VM ([#5729](`jestjs/jest#5729)) * `[jest-resolve]` Update node module resolution algorithm to correctly handle symlinked paths ([#5085](`jestjs/jest#5085)) * `[jest-editor-support]` Update `Settings` to use spawn in shell option ([#5658](`jestjs/jest#5658)) * `[jest-cli]` Improve the error message when 2 projects resolve to the same config ([#5674](`jestjs/jest#5674)) * `[jest-runtime]` remove retainLines from coverage instrumentation ([#5692](`jestjs/jest#5692)) * `[jest-cli]` Fix update snapshot issue when using watchAll ([#5696](`jestjs/jest#5696)) * `[expect]` Fix rejects.not matcher ([#5670](`jestjs/jest#5670)) * `[jest-runtime]` Prevent Babel warnings on large files ([#5702](`jestjs/jest#5702)) * `[jest-mock]` Prevent `mockRejectedValue` from causing unhandled rejection ([#5720](`jestjs/jest#5720)) * `[pretty-format]` Handle React fragments better ([#5816](`jestjs/jest#5816)) * `[pretty-format]` Handle formatting of `React.forwardRef` and `Context` components ([#6093](`jestjs/jest#6093)) * `[jest-cli]` Switch collectCoverageFrom back to a string ([#5914](`jestjs/jest#5914)) * `[jest-regex-util]` Fix handling regex symbols in tests path on Windows ([#5941](`jestjs/jest#5941)) * `[jest-util]` Fix handling of NaN/Infinity in mock timer delay ([#5966](`jestjs/jest#5966)) * `[jest-resolve]` Generalise test for package main entries equivalent to ".". ([#5968](`jestjs/jest#5968)) * `[jest-config]` Ensure that custom resolvers are used when resolving the configuration ([#5976](`jestjs/jest#5976)) * `[website]` Fix website docs ([#5853](`jestjs/jest#5853)) * `[expect]` Fix isEqual Set and Map to compare object values and keys regardless of order ([#6150](`jestjs/jest#6150)) * `[pretty-format]` [**BREAKING**] Remove undefined props from React elements ([#6162](`jestjs/jest#6162)) * `[jest-haste-map]` Properly resolve mocked node modules without package.json defined ([#6232](`jestjs/jest#6232)) ##### Chore & Maintenance * `[jest-runner]` Move sourcemap installation from `jest-jasmine2` to `jest-runner` ([#6176](`jestjs/jest#6176)) * `[jest-cli]` Use yargs's built-in `version` instead of rolling our own ([#6215](`jestjs/jest#6215)) * `[docs]` Add explanation on how to mock methods not implemented in JSDOM * `[jest-jasmine2]` Simplify `Env.execute` and TreeProcessor to setup and clean resources for the top suite the same way as for all of the children suites ([#5885](`jestjs/jest#5885)) * `[babel-jest]` [**BREAKING**] Always return object from transformer ([#5991](`jestjs/jest#5991)) * `[*]` Run Prettier on compiled output ([#5858](`jestjs/jest#3497)) * `[jest-cli]` Add fileChange hook for plugins ([#5708](`jestjs/jest#5708)) * `[docs]` Add docs on using `jest.mock(...)` ([#5648](`jestjs/jest#5648)) * `[docs]` Mention Jest Puppeteer Preset ([#5722](`jestjs/jest#5722)) * `[docs]` Add jest-community section to website ([#5675](`jestjs/jest#5675)) * `[docs]` Add versioned docs for v22.4 ([##5733](https://github.com/facebook/jest/pull/#5733)) * `[docs]` Improve Snapshot Testing Guide ([#5812](`jestjs/jest#5812)) * `[jest-runtime]` [**BREAKING**] Remove `jest.genMockFn` and `jest.genMockFunction` ([#6173](`jestjs/jest#6173)) * `[jest-message-util]` Avoid adding unnecessary indent to blank lines in stack traces ([#6211](`jestjs/jest#6211)) --- </details> --- This PR has been generated by [Renovate Bot](https://renovatebot.com).

This Pull Request updates dependency [jest](https://github.com/facebook/jest) from `v22.4.3` to `v23.0.1` <details> <summary>Release Notes</summary> ### [`v23.0.1`](https://github.com/facebook/jest/blob/master/CHANGELOG.md#2301) [Compare Source](jestjs/jest@v23.0.0...3a3b4e3) ##### Chore & Maintenance * `[jest-jasemine2]` Add dependency on jest-each ([#6308](`jestjs/jest#6308)) * `[jest-each]` Move jest-each into core Jest ([#6278](`jestjs/jest#6278)) * `[examples]` Update typescript example to using ts-jest ([#6260](`jestjs/jest#6260)) ##### Fixes * `[pretty-format]` Serialize inverse asymmetric matchers correctly ([#6272](`jestjs/jest#6272)) --- ### [`v23.0.0`](https://github.com/facebook/jest/blob/master/CHANGELOG.md#2300) [Compare Source](jestjs/jest@2745e3e...v23.0.0) ##### Features * `[expect]` Expose `getObjectSubset`, `iterableEquality`, and `subsetEquality` ([#6210](`jestjs/jest#6210)) * `[jest-snapshot]` Add snapshot property matchers ([#6210](`jestjs/jest#6210)) * `[jest-config]` Support jest-preset.js files within Node modules ([#6185](`jestjs/jest#6185)) * `[jest-cli]` Add `--detectOpenHandles` flag which enables Jest to potentially track down handles keeping it open after tests are complete. ([#6130](`jestjs/jest#6130)) * `[jest-jasmine2]` Add data driven testing based on `jest-each` ([#6102](`jestjs/jest#6102)) * `[jest-matcher-utils]` Change "suggest to equal" message to be more advisory ([#6103](`jestjs/jest#6103)) * `[jest-message-util]` Don't ignore messages with `vendor` anymore ([#6117](`jestjs/jest#6117)) * `[jest-validate]` Get rid of `jest-config` dependency ([#6067](`jestjs/jest#6067)) * `[jest-validate]` Adds option to inject `deprecationEntries` ([#6067](`jestjs/jest#6067)) * `[jest-snapshot]` [**BREAKING**] Concatenate name of test, optional snapshot name and count ([#6015](`jestjs/jest#6015)) * `[jest-runtime]` Allow for transform plugins to skip the definition process method if createTransformer method was defined. ([#5999](`jestjs/jest#5999)) * `[expect]` Add stack trace for async errors ([#6008](`jestjs/jest#6008)) * `[jest-jasmine2]` Add stack trace for timeouts ([#6008](`jestjs/jest#6008)) * `[jest-jasmine2]` Add stack trace for thrown non-`Error`s ([#6008](`jestjs/jest#6008)) * `[jest-runtime]` Prevent modules from marking themselves as their own parent ([#5235](`jestjs/jest#5235)) * `[jest-mock]` Add support for auto-mocking generator functions ([#5983](`jestjs/jest#5983)) * `[expect]` Add support for async matchers ([#5919](`jestjs/jest#5919)) * `[expect]` Suggest toContainEqual ([#5948](`jestjs/jest#5953)) * `[jest-config]` Export Jest's default options ([#5948](`jestjs/jest#5948)) * `[jest-editor-support]` Move `coverage` to `ProjectWorkspace.collectCoverage` ([#5929](`jestjs/jest#5929)) * `[jest-editor-support]` Add `coverage` option to runner ([#5836](`jestjs/jest#5836)) * `[jest-haste-map]` Support extracting dynamic `import`s ([#5883](`jestjs/jest#5883)) * `[expect]` Improve output format for mismatchedArgs in mock/spy calls. ([#5846](`jestjs/jest#5846)) * `[jest-cli]` Add support for using `--coverage` in combination with watch mode, `--onlyChanged`, `--findRelatedTests` and more ([#5601](`jestjs/jest#5601)) * `[jest-jasmine2]` [**BREAKING**] Adds error throwing and descriptive errors to `it`/ `test` for invalid arguments. `[jest-circus]` Adds error throwing and descriptive errors to `it`/ `test` for invalid arguments ([#5558](`jestjs/jest#5558)) * `[jest-matcher-utils]` Add `isNot` option to `matcherHint` function ([#5512](`jestjs/jest#5512)) * `[jest-config]` Add `<rootDir>` to runtime files not found error report ([#5693](`jestjs/jest#5693)) * `[expect]` Make toThrow matcher pass only if Error object is returned from promises ([#5670](`jestjs/jest#5670)) * `[expect]` Add isError to utils ([#5670](`jestjs/jest#5670)) * `[expect]` Add inverse matchers (`expect.not.arrayContaining`, etc., [#5517](`jestjs/jest#5517)) * `[expect]` `expect.extend` now also extends asymmetric matchers ([#5503](`jestjs/jest#5503)) * `[jest-mock]` Update `spyOnProperty` to support spying on the prototype chain ([#5753](`jestjs/jest#5753)) * `[jest-mock]` Add tracking of return values in the `mock` property ([#5752](`jestjs/jest#5752)) * `[jest-mock]` Add tracking of thrown errors in the `mock` property ([#5764](`jestjs/jest#5764)) * `[expect]`Add nthCalledWith spy matcher ([#5605](`jestjs/jest#5605)) * `[jest-cli]` Add `isSerial` property that runners can expose to specify that they can not run in parallel ([#5706](`jestjs/jest#5706)) * `[expect]` Add `.toBeCalledTimes` and `toHaveBeenNthCalledWith` aliases ([#5826](`jestjs/jest#5826)) * `[jest-cli]` Interactive Snapshot Mode improvements ([#5864](`jestjs/jest#5864)) * `[jest-editor-support]` Add `no-color` option to runner ([#5909](`jestjs/jest#5909)) * `[jest-jasmine2]` Pretty-print non-Error object errors ([#5980](`jestjs/jest#5980)) * `[jest-message-util]` Include column in stack frames ([#5889](`jestjs/jest#5889)) * `[expect]` Introduce toStrictEqual ([#6032](`jestjs/jest#6032)) * `[expect]` Add return matchers ([#5879](`jestjs/jest#5879)) * `[jest-cli]` Improve snapshot summaries ([#6181](`jestjs/jest#6181)) * `[expect]` Include custom mock names in error messages ([#6199](`jestjs/jest#6199)) * `[jest-diff]` Support returning diff from oneline strings ([#6221](`jestjs/jest#6221)) * `[expect]` Improve return matchers ([#6172](`jestjs/jest#6172)) * `[jest-cli]` Overhaul watch plugin hooks names ([#6249](`jestjs/jest#6249)) * `[jest-mock]` Include tracked call results in serialized mock ([#6244](`jestjs/jest#6244)) ##### Fixes * `[jest-cli]` Fix stdin encoding to utf8 for watch plugins. ([#6253](`jestjs/jest#6253)) * `[expect]` Better detection of DOM Nodes for equality ([#6246](`jestjs/jest#6246)) * `[jest-cli]` Fix misleading action description for F key when in "only failed tests" mode. ([#6167](`jestjs/jest#6167)) * `[jest-worker]` Stick calls to workers before processing them ([#6073](`jestjs/jest#6073)) * `[babel-plugin-jest-hoist]` Allow using `console` global variable ([#6075](`jestjs/jest#6075)) * `[jest-jasmine2]` Always remove node core message from assert stack traces ([#6055](`jestjs/jest#6055)) * `[expect]` Add stack trace when `expect.assertions` and `expect.hasAssertions` causes test failures. ([#5997](`jestjs/jest#5997)) * `[jest-runtime]` Throw a more useful error when trying to require modules after the test environment is torn down ([#5888](`jestjs/jest#5888)) * `[jest-mock]` [**BREAKING**] Replace timestamps with `invocationCallOrder` ([#5867](`jestjs/jest#5867)) * `[jest-jasmine2]` Install `sourcemap-support` into normal runtime to catch runtime errors ([#5945](`jestjs/jest#5945)) * `[jest-jasmine2]` Added assertion error handling inside `afterAll hook` ([#5884](`jestjs/jest#5884)) * `[jest-cli]` Remove the notifier actions in case of failure when not in watch mode. ([#5861](`jestjs/jest#5861)) * `[jest-mock]` Extend .toHaveBeenCalled return message with outcome ([#5951](`jestjs/jest#5951)) * `[jest-runner]` Assign `process.env.JEST_WORKER_ID="1"` when in runInBand mode ([#5860](`jestjs/jest#5860)) * `[jest-cli]` Add descriptive error message when trying to use `globalSetup`/`globalTeardown` file that doesn't export a function. ([#5835](`jestjs/jest#5835)) * `[expect]` Do not rely on `instanceof RegExp`, since it will not work for RegExps created inside of a different VM ([#5729](`jestjs/jest#5729)) * `[jest-resolve]` Update node module resolution algorithm to correctly handle symlinked paths ([#5085](`jestjs/jest#5085)) * `[jest-editor-support]` Update `Settings` to use spawn in shell option ([#5658](`jestjs/jest#5658)) * `[jest-cli]` Improve the error message when 2 projects resolve to the same config ([#5674](`jestjs/jest#5674)) * `[jest-runtime]` remove retainLines from coverage instrumentation ([#5692](`jestjs/jest#5692)) * `[jest-cli]` Fix update snapshot issue when using watchAll ([#5696](`jestjs/jest#5696)) * `[expect]` Fix rejects.not matcher ([#5670](`jestjs/jest#5670)) * `[jest-runtime]` Prevent Babel warnings on large files ([#5702](`jestjs/jest#5702)) * `[jest-mock]` Prevent `mockRejectedValue` from causing unhandled rejection ([#5720](`jestjs/jest#5720)) * `[pretty-format]` Handle React fragments better ([#5816](`jestjs/jest#5816)) * `[pretty-format]` Handle formatting of `React.forwardRef` and `Context` components ([#6093](`jestjs/jest#6093)) * `[jest-cli]` Switch collectCoverageFrom back to a string ([#5914](`jestjs/jest#5914)) * `[jest-regex-util]` Fix handling regex symbols in tests path on Windows ([#5941](`jestjs/jest#5941)) * `[jest-util]` Fix handling of NaN/Infinity in mock timer delay ([#5966](`jestjs/jest#5966)) * `[jest-resolve]` Generalise test for package main entries equivalent to ".". ([#5968](`jestjs/jest#5968)) * `[jest-config]` Ensure that custom resolvers are used when resolving the configuration ([#5976](`jestjs/jest#5976)) * `[website]` Fix website docs ([#5853](`jestjs/jest#5853)) * `[expect]` Fix isEqual Set and Map to compare object values and keys regardless of order ([#6150](`jestjs/jest#6150)) * `[pretty-format]` [**BREAKING**] Remove undefined props from React elements ([#6162](`jestjs/jest#6162)) * `[jest-haste-map]` Properly resolve mocked node modules without package.json defined ([#6232](`jestjs/jest#6232)) ##### Chore & Maintenance * `[jest-runner]` Move sourcemap installation from `jest-jasmine2` to `jest-runner` ([#6176](`jestjs/jest#6176)) * `[jest-cli]` Use yargs's built-in `version` instead of rolling our own ([#6215](`jestjs/jest#6215)) * `[docs]` Add explanation on how to mock methods not implemented in JSDOM * `[jest-jasmine2]` Simplify `Env.execute` and TreeProcessor to setup and clean resources for the top suite the same way as for all of the children suites ([#5885](`jestjs/jest#5885)) * `[babel-jest]` [**BREAKING**] Always return object from transformer ([#5991](`jestjs/jest#5991)) * `[*]` Run Prettier on compiled output ([#5858](`jestjs/jest#3497)) * `[jest-cli]` Add fileChange hook for plugins ([#5708](`jestjs/jest#5708)) * `[docs]` Add docs on using `jest.mock(...)` ([#5648](`jestjs/jest#5648)) * `[docs]` Mention Jest Puppeteer Preset ([#5722](`jestjs/jest#5722)) * `[docs]` Add jest-community section to website ([#5675](`jestjs/jest#5675)) * `[docs]` Add versioned docs for v22.4 ([#5733](`jestjs/jest#5733)) * `[docs]` Improve Snapshot Testing Guide ([#5812](`jestjs/jest#5812)) * `[jest-runtime]` [**BREAKING**] Remove `jest.genMockFn` and `jest.genMockFunction` ([#6173](`jestjs/jest#6173)) * `[jest-message-util]` Avoid adding unnecessary indent to blank lines in stack traces ([#6211](`jestjs/jest#6211)) --- ### [`v22.4.4`](jestjs/jest@6851d8b...v22.4.4) [Compare Source](jestjs/jest@6851d8b...v22.4.4) --- </details> --- This PR has been generated by [Renovate Bot](https://renovatebot.com).

github-actions · 2021-05-12T11:07:16Z

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.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

Add snapshot property matchers

6366b3e

facebook-github-bot added the cla signed label May 19, 2018

Update changelog

46e7bbd

rickhanlonii commented May 20, 2018

View reviewed changes

SimenB reviewed May 20, 2018

View reviewed changes

rickhanlonii added 2 commits May 24, 2018 14:01

Update based on feedback

5fe1459

Fix tests

29f5c5d

thymikee reviewed May 24, 2018

View reviewed changes

Merge branch 'master' into rh/property-matchers

4dcd25b

cpojer merged commit aac32f9 into jestjs:master May 24, 2018

ncovercash mentioned this pull request May 24, 2018

Update babel-jest to the latest version 🚀 Shopify/draggable#223

Closed

dependencies bot mentioned this pull request Jun 1, 2018

Update babel-jest in / from 22.1.0 to 23.0.1 leonardofaria/leozera-ui#192

Closed

rickhanlonii deleted the rh/property-matchers branch July 16, 2018 14:28

dependencies bot mentioned this pull request Nov 1, 2018

Update jest in / from 22.1.4 to 23.6.0 leonardofaria/leozera-ui#250

Closed

snyk-bot mentioned this pull request Mar 17, 2020

[Snyk] Upgrade expect from 23.0.0 to 23.6.0 yowainwright/react-workshop#8

Merged

github-actions bot locked as resolved and limited conversation to collaborators May 12, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add snapshot property matchers #6210

Add snapshot property matchers #6210

rickhanlonii commented May 19, 2018

rickhanlonii May 20, 2018

SimenB May 20, 2018

rickhanlonii May 20, 2018

SimenB May 20, 2018

rickhanlonii May 20, 2018

rickhanlonii May 20, 2018

codecov-io commented May 20, 2018 •

edited

Loading

SimenB commented May 20, 2018 •

edited

Loading

SimenB May 20, 2018

rickhanlonii May 20, 2018

ftes Jul 13, 2018

SimenB Jul 13, 2018

SimenB May 20, 2018

rickhanlonii May 20, 2018

rickhanlonii commented May 20, 2018

SimenB commented May 20, 2018 •

edited

Loading

orta commented May 20, 2018

cpojer commented May 22, 2018

thymikee May 24, 2018

github-actions bot commented May 12, 2021

+                  });
+                  `);
+                {

Add snapshot property matchers #6210

Add snapshot property matchers #6210

Conversation

rickhanlonii commented May 19, 2018

Summary

Details

Implementation

Property checking

Documentation

Expect

Snapshot Testing

Test plan

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-io commented May 20, 2018 • edited Loading

Codecov Report

SimenB commented May 20, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rickhanlonii commented May 20, 2018

SimenB commented May 20, 2018 • edited Loading

orta commented May 20, 2018

cpojer commented May 22, 2018

Choose a reason for hiding this comment

github-actions bot commented May 12, 2021

codecov-io commented May 20, 2018 •

edited

Loading

SimenB commented May 20, 2018 •

edited

Loading

SimenB commented May 20, 2018 •

edited

Loading