Add mock return matchers #5879

rickhanlonii · 2018-03-27T01:57:34Z

Summary

[Edited] Adds spy matchers for the returnValues supported added in #5752 which pair with the call matchers

Closes #3821

Test plan

Added Unit Tests

Docs

Why Core

As is the case for most matchers, this could be a custom matcher. I think it belongs in core because:

It matches on a core internal, returnValue, so helps in discoverability for custom matchers
It adds parity with sinon spy.returned

mattphillips · 2018-03-27T09:42:48Z

Nice @rickhanlonii I really like the look of this matcher! Do you think we would want to handle the order the value was returned too? So a mock can return multiple values i.e.

test(`passes with mutliple calls`, () => {
  const fn = jest.fn(a => a * 2);
  fn(1);
  fn(2);
  fn(3);

  expect(fn).toReturn(2);
  expect(fn).toReturn(4);
  expect(fn).toReturn(6);
});

or with mockReturnValueOnce and mockReturnValue

myMock
  .mockReturnValueOnce(10)
  .mockReturnValueOnce('x')
  .mockReturnValue(true);

I think it might be good to assert that the mock returned the correct value at the correct position: first, second, N. This would be similar to nthCalledWith

What do you think?

SimenB · 2018-03-27T18:38:03Z

I'd like a "but it returned: " for failures pretty printing all values

rickhanlonii · 2018-03-27T19:51:04Z

@mattphillips good thinking - I see two options, curious what your thoughts are (ditto @SimenB)

Option 1: Mirror `.toBeCalledWith`

To mirror .toBeCalledWith, we would add (along with the aliases):

toReturn
toReturnLast
toReturnTimes
toNthReturn

Pros

Consistency
Flexibility
A matcher for every use case

Cons

A ton of new matchers

Option two: `toReturn`

Instead, we could have toReturn accept all of the values returned, in order:

test(`passes with multiple calls`, () => {
  const fn = jest.fn(a => a * 2);
  fn(1);
  fn(2);
  fn(3);

  expect(fn).toReturn(2, 4, 6);
});

Pros

Only one new matcher

Cons

Have to specify all of the returned values, in order

rickhanlonii · 2018-03-27T19:53:33Z

Keep in mind we also added thrownErrors to the spies so we're probably going to want core matchers to check that as well, meaning whatever we choose here will probably be doubled

SimenB · 2018-03-27T20:10:01Z

@cpojer thoughts?

cpojer · 2018-03-28T08:20:21Z

I like it, mirroring toBeCalledWith seems the most sensible approach.

SimenB · 2018-03-28T08:39:18Z

I can get down with matching toBeCalledWith, any extra matchers on top of that can go into jest-extended or some such.

Quickly to answer "Why core":

It matches on a core internal, returnValue, so helps in discoverability for custom matchers

This is meh, IMO. It was added to core to enable the use case, not to force matchers being added. We should be better at pointing to custom matchers listed in awesome-jest perhaps.

It adds parity with sinon spy.returned

That's a better point - being able to cover the use cases of tools people are using already out of the box is Jest's biggest strength (in addition to the crazy awesome watch mode).

mattphillips · 2018-03-28T09:02:05Z

I agree with @SimenB and @cpojer I think we should keep parity with toBeCalledWith

@SimenB how do you think we should point to awesome-jest matchers more? Perhaps we should update our issue template to point people over there to find community solutions?

SimenB · 2018-03-28T12:13:37Z

If the template gets to be too large, people ignore it (already an issue). But saying something like "if you want a new matcher, please see x" in the template might help?

SimenB · 2018-04-11T23:04:36Z

@rickhanlonii ping 🙂

A quick rebase shuold fix CI as well

rickhanlonii · 2018-04-12T16:23:55Z

Ah yes, sorry - I'm working on mirroring toBeCalledWith, will wrap up this week

rickhanlonii · 2018-04-18T02:26:56Z

Update: still needs docs, but the matchers are pushed and ready for review

Here's an overview of the returnValue matchers and aliases added paired with their calls matcher:

Matchers

called	returned
lastCalledWith	lastReturnedWith
nthCalledWith	nthReturnedWith
toBeCalled	toReturn
toBeCalledWith	toReturnWith
toBeCalledTimes	toReturnTimes

Aliases

called	returned
toHaveBeenLastCalledWith	toHaveLastReturnedWith
toHaveBeenNthCalledWith	toHaveNthReturnedWith
toHaveBeenCalled	toHaveReturned
toHaveBeenLastCalledWith	toHaveLastReturnedWith
toHaveBeenCalledTimes	toHaveReturnedTimes

rickhanlonii · 2018-04-18T02:32:29Z

packages/expect/src/spy_matchers.js

+  const receivedName = receivedIsSpy ? 'spy' : received.getMockName();
+  const count = receivedIsSpy
+    ? received.returnValues.count()
+    : received.mock.returnValues.length;


@cpojer I blamed the spy switching we're doing here to you - is this only to support jasmine spies or am I missing something? If it's just jasmine, I think we can remove this switch in the new returnValues matchers since jasmine does not store those values

Yes, this is just for Jasmine.

codecov-io · 2018-04-18T02:35:32Z

Codecov Report

Merging #5879 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master   #5879   +/-   ##
======================================
  Coverage    64.1%   64.1%           
======================================
  Files         217     217           
  Lines        8335    8335           
  Branches        4       4           
======================================
  Hits         5343    5343           
  Misses       2991    2991           
  Partials        1       1

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 9850275...e8a669a. Read the comment docs.

SimenB · 2018-04-18T16:19:24Z

packages/expect/src/spy_matchers.js

+
+  const message = pass
+    ? () =>
+        matcherHint('.not' + matcherName, receivedName) +


Should these use string templates?

SimenB · 2018-04-18T16:20:07Z

docs/ExpectAPI.md

+
+Also under the alias: `.toReturn(value)`
+
+If you have a mock function, you can use `.toHaveReturned` to test that the spy


Should we call it "spy"?

SimenB · 2018-04-18T16:20:44Z

docs/ExpectAPI.md

@@ -649,6 +649,22 @@ test('drinkEach drinks each drink', () => {
 });
 ```

+### `.toHaveReturned(value)`


Should doc every new matcher, right?

Update: still needs docs

Oh, ignore me then :D

rickhanlonii · 2018-04-22T21:00:35Z

Docs updated, this is ready for final review

rickhanlonii · 2018-04-26T13:25:01Z

Updated OP with a screenshot of the new docs 🤙

SimenB · 2018-04-27T11:44:34Z

packages/expect/src/__tests__/__snapshots__/spy_matchers.test.js.snap

+
+Expected mock function to have last returned:
+  <green>\\"foo\\"</>
+But it last returned:


is this correct?

ref the title being toHaveLastReturnedWith works when not called

Nice find - fixed

SimenB · 2018-04-27T11:45:14Z

packages/expect/src/__tests__/__snapshots__/spy_matchers.test.js.snap

+
+Expected mock function to not have last returned:
+  <green>Immutable.Map {\\"a\\": {\\"b\\": \\"c\\"}}</>"
+`;


should this say "but it did" or something?

Yeah, updated

SimenB

I added 2 inline comments, one being what I believe is a bug, the pother a question.

Other than that, I just think this is missing a changelog entry 🙂

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-12T15:07:28Z

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.

facebook-github-bot added the cla signed label Mar 27, 2018

Add toReturnValues and toHaveReturnedValues

7a3cf01

rickhanlonii force-pushed the rh-return-matchers branch from 8d80f5e to 7a3cf01 Compare March 27, 2018 01:58

Fix typos

e25cc3c

Add spy matchers to pair with called

9c7ec28

rickhanlonii commented Apr 18, 2018

View reviewed changes

SimenB reviewed Apr 18, 2018

View reviewed changes

rickhanlonii changed the title ~~Add toHaveReturned~~ Add mock return matchers Apr 22, 2018

rickhanlonii added 2 commits April 22, 2018 13:47

Clean up matchers

19aada6

Update docs

c8d094b

rm dupe note

64640a6

SimenB reviewed Apr 27, 2018

View reviewed changes

SimenB requested changes Apr 27, 2018

View reviewed changes

Updates based on feedback

22b6884

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

UselessPickles mentioned this pull request Jun 2, 2018

[jest] Add new structure and matchers related to mock results. DefinitelyTyped/DefinitelyTyped#26230

Closed

9 tasks

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 mock return matchers #5879

Add mock return matchers #5879

rickhanlonii commented Mar 27, 2018 •

edited

mattphillips commented Mar 27, 2018

SimenB commented Mar 27, 2018 •

edited

rickhanlonii commented Mar 27, 2018

rickhanlonii commented Mar 27, 2018

SimenB commented Mar 27, 2018

cpojer commented Mar 28, 2018

SimenB commented Mar 28, 2018

mattphillips commented Mar 28, 2018

SimenB commented Mar 28, 2018

SimenB commented Apr 11, 2018

rickhanlonii commented Apr 12, 2018

rickhanlonii commented Apr 18, 2018

rickhanlonii Apr 18, 2018

cpojer Apr 18, 2018

codecov-io commented Apr 18, 2018 •

edited

SimenB Apr 18, 2018

SimenB Apr 18, 2018

SimenB Apr 18, 2018

SimenB Apr 19, 2018

rickhanlonii commented Apr 22, 2018

rickhanlonii commented Apr 26, 2018

SimenB Apr 27, 2018

SimenB Apr 27, 2018

rickhanlonii Apr 29, 2018 •

edited

SimenB Apr 27, 2018

rickhanlonii Apr 29, 2018

SimenB left a comment

github-actions bot commented May 12, 2021


		Also under the alias: `.toReturn(value)`

		If you have a mock function, you can use `.toHaveReturned` to test that the spy

Add mock return matchers #5879

Add mock return matchers #5879

Conversation

rickhanlonii commented Mar 27, 2018 • edited

Summary

Test plan

Docs

Why Core

mattphillips commented Mar 27, 2018

SimenB commented Mar 27, 2018 • edited

rickhanlonii commented Mar 27, 2018

Option 1: Mirror .toBeCalledWith

Option two: toReturn

rickhanlonii commented Mar 27, 2018

SimenB commented Mar 27, 2018

cpojer commented Mar 28, 2018

SimenB commented Mar 28, 2018

mattphillips commented Mar 28, 2018

SimenB commented Mar 28, 2018

SimenB commented Apr 11, 2018

rickhanlonii commented Apr 12, 2018

rickhanlonii commented Apr 18, 2018

Matchers

Aliases

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-io commented Apr 18, 2018 • edited

Codecov Report

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 Apr 22, 2018

rickhanlonii commented Apr 26, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rickhanlonii Apr 29, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SimenB left a comment

Choose a reason for hiding this comment

github-actions bot commented May 12, 2021

rickhanlonii commented Mar 27, 2018 •

edited

SimenB commented Mar 27, 2018 •

edited

Option 1: Mirror `.toBeCalledWith`

Option two: `toReturn`

codecov-io commented Apr 18, 2018 •

edited

rickhanlonii Apr 29, 2018 •

edited