Move jest-each to core #6278

mattphillips · 2018-05-26T11:08:37Z

Summary

This PR moves jest-each into the core repo.

It will serve two purposes for Jest and the community:

It will contain the test.each logic that is required in both jest-jasmine2 and jest-circus
It will allow users of older versions of Jest to use the each().test syntax that currently exists with the package.

Why core?

It will allow us to keep the behaviour between test.each and each().test the same (as it is the same code just different invocation techniques) and stop them from diverging.

Currently the each logic is baked into jest-jasmine2 and will need to be ported over to jest-circus so to stop any duplication/divergence the code should live in a shared namespace of jest-each

Test plan

For this PR I've brought in the exact code from jest-each which has 100% test coverage

TODO

Copy jest-each into core
Remove all dot files, scripts and metadata
Add FB peeps as owners on npm

Separate PRs

Move bind logic explicitly into jest-each from jest-jasmine2
Add jest-each as a dependency to jest-jasmine2
Add jest-each as a dependency to jest-circus

EDIT: relates to #4362

aaronabramov

🎉 🎈

aaronabramov · 2018-05-26T11:56:15Z

packages/jest-each/src/__tests__/array.test.js

@@ -0,0 +1,200 @@
+import each from '../';


it would be awesome to have an integration test with snapshots of the output for it eventually!

aaronabramov · 2018-05-26T11:58:13Z

packages/jest-each/src/index.js

+  return arrayEach(global)(...args);
+};
+
+each.withGlobal = g => (...args) => {


you could probably just export

export default each.withGlobal(global);

I think it's more obvious to just export the each, as it is now

thymikee · 2018-05-26T12:07:30Z

packages/jest-each/.npmignore

@@ -0,0 +1,3 @@
+**/__tests__/**


We can add **/__mocks__/** just in case

yeah, this should copy all of the other npmignores, but add asset in addition to them

thymikee · 2018-05-26T12:07:49Z

packages/jest-each/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "jest-each",
+  "version": "0.5.0",


version 23.0.0

thymikee · 2018-05-26T12:09:00Z

packages/jest-each/src/array.js

@@ -0,0 +1,40 @@
+import util from 'util';


Please add // @flow to every source file (not needed for tests) :D

This can be added as a followup, as it will probably blow away

thymikee · 2018-05-26T12:11:52Z

CHANGELOG.md

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

+### Features
+
+* `[jest-each]` Move jest-each into core Jest


Move `jest-each` into Jest core

?

Also I think this is more of a chore action, but I'm probably wrong. cc @SimenB

I agree - the feature has already landed in Jest, moving this package in is just a step on the way for circus to get the feature as well

thymikee

Fix some inline comments and I'm good 👍

SimenB

Missing flow types as pointed out, but that's fine as a follow-up

codecov-io · 2018-05-27T08:52:19Z

Codecov Report

❗ No coverage uploaded for pull request base (master@f527647). Click here to learn what that means.
The diff coverage is 100%.

@@            Coverage Diff            @@
##             master    #6278   +/-   ##
=========================================
  Coverage          ?   63.65%           
=========================================
  Files             ?      225           
  Lines             ?     8626           
  Branches          ?        4           
=========================================
  Hits              ?     5491           
  Misses            ?     3134           
  Partials          ?        1

Impacted Files	Coverage Δ
packages/jest-each/src/template.js	`100% <100%> (ø)`
packages/jest-each/src/array.js	`100% <100%> (ø)`
packages/jest-each/src/index.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 f527647...9d40446. Read the comment docs.

mattphillips · 2018-05-27T09:25:44Z

@SimenB @thymikee @aaronabramov I think this is good to go.

I'll fix the flow changes in the next PR when I update jest-jasmine2 to use this - I've found a nice abstraction to remove most of this code anyway 😄

thymikee · 2018-05-27T09:26:23Z

Awesome! Let's do it

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

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.

mattphillips added 13 commits May 26, 2018 11:37

Copy jest-each into jest core

d607493

Add npm ignore to jest-each

dae5dbd

Update package to follow jest standards

4a0d2fe

Remove examples from jest-each

2b02670

Remove nested gitignore

47d5150

Remove licenses and broken links

1c4e907

Replace vsprint for node util

061cdcb

Move jest-each tests to __tests__ folder

5ecdcaa

Remove ci build

c231b93

Remove lockfile

bf85fe7

Fix lint errors

4e8864b

Fix object spread/rest with Object.assign

d5fae40

Add changelog entry

3e30540

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

aaronabramov approved these changes May 26, 2018

View reviewed changes

thymikee reviewed May 26, 2018

View reviewed changes

thymikee approved these changes May 26, 2018

View reviewed changes

SimenB approved these changes May 26, 2018

View reviewed changes

mattphillips added 4 commits May 27, 2018 09:19

Add mocks to be ignored

3d3da16

Update version to 23

b5989ac

Update change to be a chore

5b0379e

Fix mardown linting

9d40446

thymikee merged commit 8816df7 into jestjs:master May 27, 2018

mattphillips deleted the jest-each branch May 27, 2018 09:39

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

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

Move jest-each to core #6278

Move jest-each to core #6278

mattphillips commented May 26, 2018 •

edited

Loading

aaronabramov left a comment

aaronabramov May 26, 2018

aaronabramov May 26, 2018

thymikee May 26, 2018

thymikee May 26, 2018

SimenB May 26, 2018

thymikee May 26, 2018

thymikee May 26, 2018

thymikee May 26, 2018

thymikee May 26, 2018

thymikee May 26, 2018 •

edited

Loading

SimenB May 26, 2018

thymikee left a comment

SimenB left a comment

codecov-io commented May 27, 2018

mattphillips commented May 27, 2018

thymikee commented May 27, 2018

github-actions bot commented May 12, 2021

Move jest-each to core #6278

Move jest-each to core #6278

Conversation

mattphillips commented May 26, 2018 • edited Loading

Summary

Why core?

Test plan

TODO

Separate PRs

aaronabramov left a 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

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

thymikee May 26, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thymikee left a comment

Choose a reason for hiding this comment

SimenB left a comment

Choose a reason for hiding this comment

codecov-io commented May 27, 2018

Codecov Report

mattphillips commented May 27, 2018

thymikee commented May 27, 2018

github-actions bot commented May 12, 2021

mattphillips commented May 26, 2018 •

edited

Loading

thymikee May 26, 2018 •

edited

Loading