[jest-each]: Add support for keyPaths in test titles #6457

mattphillips · 2018-06-13T12:34:26Z

Summary

Opening this up for review early as I want @SimenB @thymikee @rickhanlonii opinion on how to share the getPath logic that is defined in expect.

Add support for $key.path syntax in tagged template test titles.

Example:

// Actions
const increment = () => ({type: 'increment'});
const decrement = () => ({type: 'decrement'});

// Reducer
const reducer = (state = 0, {type}) => {
  switch (type) {
    case 'increment':
      return state + 1;
    case 'decrement':
      return state - 1;
    default:
      return state;
  }
};

test.each`
  state | action         | nextState
  ${0}  | ${increment()} | ${1}
  ${0}  | ${decrement()} | ${-1}
`(
  'returns $nextState when the state is $state and $action.type is dispatched $nextState',
  ({state, action, nextState}) => {
    expect(reducer(state, action)).toEqual(nextState);
  },
);

Test plan

See unit tests

TODO:

Changelog
Update docs
Some how share the getPath logic with expect

mattphillips · 2018-06-13T12:35:06Z

packages/jest-each/src/bind.js

+  Object.prototype.hasOwnProperty.call(object, value) ||
+  Object.prototype.hasOwnProperty.call(object.constructor.prototype, value);
+
+const getPath = (object: Object, propertyPath: string | Array<string>) => {


I've inlined this for now to get it working, it shouldn't stay here :)

can we just use lodash.get or something?

I didn't think we were using lodash anywhere? This getPath algorithm is used in the toHaveProperty matcher and offers a nicer returned value than lodash as it tracks the last visited object.

EDIT: see expect utils

sticking it in jest-utils should be fine for sharing (although @cpojer hates the util package :D)

Should I move it as part of this PR or would it be better in a separate PR?

SimenB · 2018-06-13T12:55:09Z

As part of this is fine

mattphillips · 2018-06-13T13:40:11Z

@SimenB have you seen an eslint error like this before?

https://circleci.com/gh/facebook/jest/25790?utm_campaign=vcs-integration-link&utm_medium=referral&utm_source=github-build-link

Not sure what is going wrong 😕

SimenB · 2018-06-13T16:12:24Z

Syntax error in the browserbuild, which must be es5

mattphillips · 2018-06-13T16:20:10Z

Hmm @SimenB so it looks like expect cannot depend on jest-util then? How else can we share the getPath code?

This reverts commit 6b98ef1.

codecov-io · 2018-06-14T08:48:42Z

Codecov Report

Merging #6457 into master will increase coverage by 0.05%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #6457      +/-   ##
==========================================
+ Coverage   63.48%   63.53%   +0.05%     
==========================================
  Files         227      227              
  Lines        8697     8709      +12     
  Branches        4        3       -1     
==========================================
+ Hits         5521     5533      +12     
  Misses       3175     3175              
  Partials        1        1

Impacted Files	Coverage Δ
packages/jest-each/src/bind.js	`100% <100%> (ø)`	⬆️

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 9c1c3b1...341997a. Read the comment docs.

mattphillips · 2018-06-14T08:58:51Z

@SimenB I've updated this to inline a much simpler getPath function so no need to add anything to jest-util

SimenB · 2018-06-14T09:23:50Z

CHANGELOG.md

@@ -1,5 +1,9 @@
 ## master

+### Features
+
+- `[jest-each]` Add support for keyPaths in test titles ([#6457](https://github.com/facebook/jest/pull/6457/files))


remove /files

This Pull Request updates dependency [jest](https://github.com/facebook/jest) from `v23.1.0` to `v23.2.0` <details> <summary>Release Notes</summary> ### [`v23.2.0`](https://github.com/facebook/jest/blob/master/CHANGELOG.md#2320) [Compare Source](jestjs/jest@v23.1.0...v23.2.0) ##### Features - `[jest-each]` Add support for keyPaths in test titles ([#6457](`https://github.com/facebook/jest/pull/6457`)) - `[jest-cli]` Add `jest --init` option that generates a basic configuration file with a short description for each option ([#6442](`https://github.com/facebook/jest/pull/6442`)) - `[jest.retryTimes]` Add `jest.retryTimes()` option that allows failed tests to be retried n-times when using jest-circus. ([#6498](`https://github.com/facebook/jest/pull/6498`)) ##### Fixes - `[jest-cli]` Add check to make sure one or more tests have run before notifying when using `--notify` ([#6495](`https://github.com/facebook/jest/pull/6495`)) - `[jest-cli]` Pass `globalConfig` as a parameter to `globalSetup` and `globalTeardown` functions ([#6486](`https://github.com/facebook/jest/pull/6486`)) - `[jest-config]` Add missing options to the `defaults` object ([#6428](`https://github.com/facebook/jest/pull/6428`)) - `[expect]` Using symbolic property names in arrays no longer causes the `toEqual` matcher to fail ([#6391](`https://github.com/facebook/jest/pull/6391`)) - `[expect]` `toEqual` no longer tries to compare non-enumerable symbolic properties, to be consistent with non-symbolic properties. ([#6398](`https://github.com/facebook/jest/pull/6398`)) - `[jest-util]` `console.timeEnd` now properly log elapsed time in milliseconds. ([#6456](`https://github.com/facebook/jest/pull/6456`)) - `[jest-mock]` Fix `MockNativeMethods` access in react-native `jest.mock()` ([#6505](`https://github.com/facebook/jest/pull/6505`)) ##### Chore & Maintenance - `[docs]` Add jest-each docs for 1 dimensional arrays ([#6444](`https://github.com/facebook/jest/pull/6444`/files)) --- </details> --- This PR has been generated by [Renovate Bot](https://renovatebot.com).

github-actions · 2021-05-12T12:07:37Z

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 support for keyPaths in test titles

611dbf8

facebook-github-bot added the cla signed label Jun 13, 2018

mattphillips commented Jun 13, 2018

View reviewed changes

mattphillips mentioned this pull request Jun 13, 2018

jest-each: Support accessing attributes in name interpolation #6452

Closed

mattphillips added 4 commits June 13, 2018 14:16

Move getPath from expect/utils to jest-util

6b98ef1

Add changelog entry

0f0066a

Add keypath interpolation docs

776da62

Add missing license and flow comments

c7184d5

mattphillips added 3 commits June 14, 2018 09:20

Revert "Move getPath from expect/utils to jest-util"

8853f40

This reverts commit 6b98ef1.

Refactor getPath to be simplier

6d17440

Remove unused code

fbdbcb6

SimenB reviewed Jun 14, 2018

View reviewed changes

SimenB approved these changes Jun 14, 2018

View reviewed changes

mattphillips and others added 2 commits June 14, 2018 10:31

Fix changelog link

341997a

Merge branch 'master' into jest-each-template-keypath

ff60085

cpojer merged commit fcadc46 into jestjs:master Jun 20, 2018

dependencies bot mentioned this pull request Jun 25, 2018

Update babel-jest in / from 21.2.0 to 23.2.0 pcardune/redux-firebase-mirror#133

Open

This was referenced Jul 9, 2018

Update babel-jest in / from 23.0.1 to 23.2.0 severest/retrobot#154

Closed

Update jest in / from 23.1.0 to 23.3.0 severest/retrobot#161

Closed

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

[jest-each]: Add support for keyPaths in test titles #6457

[jest-each]: Add support for keyPaths in test titles #6457

mattphillips commented Jun 13, 2018 •

edited

Loading

mattphillips Jun 13, 2018

SimenB Jun 13, 2018

mattphillips Jun 13, 2018 •

edited

Loading

SimenB Jun 13, 2018

mattphillips Jun 13, 2018

SimenB commented Jun 13, 2018

mattphillips commented Jun 13, 2018 •

edited

Loading

SimenB commented Jun 13, 2018

mattphillips commented Jun 13, 2018

codecov-io commented Jun 14, 2018 •

edited

Loading

mattphillips commented Jun 14, 2018

SimenB Jun 14, 2018

github-actions bot commented May 12, 2021

[jest-each]: Add support for keyPaths in test titles #6457

[jest-each]: Add support for keyPaths in test titles #6457

Conversation

mattphillips commented Jun 13, 2018 • edited Loading

Summary

Test plan

TODO:

mattphillips Jun 13, 2018

Choose a reason for hiding this comment

SimenB Jun 13, 2018

Choose a reason for hiding this comment

mattphillips Jun 13, 2018 • edited Loading

Choose a reason for hiding this comment

SimenB Jun 13, 2018

Choose a reason for hiding this comment

mattphillips Jun 13, 2018

Choose a reason for hiding this comment

SimenB commented Jun 13, 2018

mattphillips commented Jun 13, 2018 • edited Loading

SimenB commented Jun 13, 2018

mattphillips commented Jun 13, 2018

codecov-io commented Jun 14, 2018 • edited Loading

Codecov Report

mattphillips commented Jun 14, 2018

SimenB Jun 14, 2018

Choose a reason for hiding this comment

github-actions bot commented May 12, 2021

mattphillips commented Jun 13, 2018 •

edited

Loading

mattphillips Jun 13, 2018 •

edited

Loading

mattphillips commented Jun 13, 2018 •

edited

Loading

codecov-io commented Jun 14, 2018 •

edited

Loading