Add option `testSequencer` allow user use custom sequencer. #8223

WeiAnAn · 2019-03-26T18:14:21Z

Summary

This PR implement feature mention in #6194.
After some discussion, change to move testSequencer into individual package.
Give an option like runner, let user can user custom sequencer to handle tests order.

Test plan

update unit tests
add new e2e test

SimenB

Thanks, this looks great! Left some inline comments, but overall this looks awesome.

Mind updating the changelog in addition to addressing inline comments?

packages/jest-core/src/runJest.ts

e2e/custom-test-sequencer/testSequencer.js

packages/jest-cli/src/cli/args.ts

packages/jest-test-sequencer/src/index.ts

codecov-io · 2019-03-27T03:06:38Z

Codecov Report

Merging #8223 into master will increase coverage by 0.08%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #8223      +/-   ##
==========================================
+ Coverage   62.27%   62.35%   +0.08%     
==========================================
  Files         265      265              
  Lines       10573    10560      -13     
  Branches     2572     2566       -6     
==========================================
+ Hits         6584     6585       +1     
+ Misses       3399     3387      -12     
+ Partials      590      588       -2

Impacted Files	Coverage Δ
packages/jest-config/src/Defaults.ts	`100% <ø> (ø)`	⬆️
packages/jest-test-sequencer/src/index.ts	`89.36% <ø> (ø)`
packages/jest-config/src/index.ts	`12.5% <ø> (ø)`	⬆️
packages/jest-config/src/ValidConfig.ts	`100% <ø> (ø)`	⬆️
packages/jest-core/src/runJest.ts	`34.66% <100%> (+0.88%)`	⬆️
packages/jest-config/src/utils.ts	`75.86% <100%> (+0.86%)`	⬆️
packages/jest-config/src/normalize.ts	`77.99% <100%> (+0.28%)`	⬆️
packages/jest-core/src/ReporterDispatcher.ts	`81.25% <0%> (-2.97%)`	⬇️
packages/jest-runtime/src/index.ts	`69.16% <0%> (-0.23%)`	⬇️
packages/babel-plugin-jest-hoist/src/index.ts	`0% <0%> (ø)`	⬆️
... and 10 more

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 f246058...745cad3. Read the comment docs.

WeiAnAn · 2019-03-27T03:44:45Z

Should we provide a package/api like create-jest-ruuner.
It will make writing custom sequencer easier.

e2e/__tests__/customTestSequencers.test.ts

e2e/custom-test-sequencer/testSequencer.js

packages/jest-cli/src/cli/args.ts

packages/jest-config/src/normalize.ts

…n yarn PnP

e2e/custom-test-sequencer/testSequencer.js

packages/jest-core/package.json

thymikee

What @SimenB said, plus a bunch of nits :)

docs/Configuration.md

jeysal

Thanks a lot @WeiAnAn! I left a few nits.

CHANGELOG.md

docs/CLI.md

docs/Configuration.md

packages/jest-config/src/normalize.ts

Co-Authored-By: WeiAnAn <[email protected]>

SimenB

Thank you for the great work here!

We've released 24.6, so could you merge in master, and ensure version numbers are correct and that the changelog entries are in the correct place? Happy to merge after that!

packages/jest-core/package.json

WeiAnAn · 2019-04-02T08:14:19Z

Merge 24.6 and update version number to 24.6.0.
Thank you everyone to help me complete this PR.
I learned a lot from this experience.

jeysal

Thanks a lot @WeiAnAn, I think this will make a lot of people in #6194 happy 😅

SimenB · 2019-04-02T15:13:51Z

docs/Configuration.md

+Sort test path alphabetically
+
+```js
+const Sequencer = require('@jest/test-sequencer').default;


This could do import Sequencer from '@jest/test-sequencer'; instead to avoid the .default part. Fine as-is though

SimenB · 2019-04-02T15:16:24Z

Thanks @WeiAnAn!

arcanis · 2019-04-03T16:36:29Z

packages/jest-config/src/Defaults.ts

@@ -71,6 +71,7 @@ const defaultOptions: Config.DefaultOptions = {
  testRegex: [],
  testResultsProcessor: null,
  testRunner: 'jasmine2',
+  testSequencer: '@jest/test-sequencer',


This value doesn't get fully resolved unless explicitly set, so it cannot work with PnP. It should be done like here: https://github.com/WeiAnAn/jest/blob/301a5cda50bf82617fe776938ee3fbd1c24b4a7c/packages/jest-config/src/normalize.ts#L477-L479

We resolve it in normalize already don't we?

I'm checking, but I think it only get resolved when the testSequence option is explicitly set - otherwise it uses the default value as-is.

github-actions · 2021-05-11T20:06:50Z

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.

WeiAnAn added 3 commits March 27, 2019 01:26

move testSequencer to individual package

cac8a66

add testSequencer option to let user use custom sequencer

27b7eba

giving testSequencer own normalize function

4b12436

facebook-github-bot added the cla signed label Mar 26, 2019

WeiAnAn mentioned this pull request Mar 26, 2019

Add prioritySequence option #8209

Closed

lint

aeea6ad

SimenB requested changes Mar 26, 2019

View reviewed changes

SimenB requested review from jeysal, scotthovestadt and thymikee March 26, 2019 19:39

WeiAnAn added 6 commits March 27, 2019 10:39

remove test comment

5093f46

keep export default

b94e545

use interopRequireDefault to import package

ca3305e

correct testSequencer default package name

b5c593a

add runInBand arg to assure running test in sequence

9223489

update changelog

ec029bb

SimenB reviewed Mar 27, 2019

View reviewed changes

e2e/__tests__/customTestSequencers.test.ts Outdated Show resolved Hide resolved

SimenB reviewed Mar 27, 2019

View reviewed changes

e2e/custom-test-sequencer/testSequencer.js Outdated Show resolved Hide resolved

SimenB requested changes Mar 27, 2019

View reviewed changes

e2e/custom-test-sequencer/testSequencer.js Outdated Show resolved Hide resolved

e2e/custom-test-sequencer/testSequencer.js Show resolved Hide resolved

packages/jest-cli/src/cli/args.ts Show resolved Hide resolved

packages/jest-config/src/normalize.ts Show resolved Hide resolved

WeiAnAn added 2 commits March 27, 2019 18:17

just only implement sort function in test

02f14fa

add a dependency on @jest/test-scheduler to jest-config so it works i…

46ef8f0

…n yarn PnP

SimenB reviewed Mar 27, 2019

View reviewed changes

e2e/custom-test-sequencer/testSequencer.js Outdated Show resolved Hide resolved

SimenB reviewed Mar 27, 2019

View reviewed changes

e2e/custom-test-sequencer/testSequencer.js Show resolved Hide resolved

SimenB reviewed Mar 27, 2019

View reviewed changes

packages/jest-core/package.json Outdated Show resolved Hide resolved

WeiAnAn added 4 commits March 27, 2019 23:48

remove wrong dependency

30ac7e5

let tests easier

4bc5a01

update docs

409a9ba

fix wrong option name

abc58e2

thymikee reviewed Mar 27, 2019

View reviewed changes

docs/Configuration.md Outdated Show resolved Hide resolved

docs/Configuration.md Outdated Show resolved Hide resolved

docs/Configuration.md Outdated Show resolved Hide resolved

docs/Configuration.md Show resolved Hide resolved

WeiAnAn and others added 2 commits March 28, 2019 22:49

add Test type in configuration

1b3f0ef

Merge branch 'master' into custom-sequencer

35b2177

jeysal suggested changes Mar 30, 2019

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

docs/CLI.md Outdated Show resolved Hide resolved

docs/Configuration.md Outdated Show resolved Hide resolved

packages/jest-config/src/normalize.ts Show resolved Hide resolved

jeysal and others added 7 commits March 30, 2019 22:24

Update docs/CLI.md

f8b9b17

Co-Authored-By: WeiAnAn <[email protected]>

keep example as js instead of ts

4efe85c

update changelog which affect multiple packages to one line.

20910a9

add @jest/test-sequencer to dependency

2e8fe7b

merge master

7d58433

update changelog

9662a12

move @jest/test-sequencer to dev dependency

7e8d15a

SimenB approved these changes Apr 2, 2019

View reviewed changes

packages/jest-core/package.json Outdated Show resolved Hide resolved

WeiAnAn and others added 3 commits April 2, 2019 15:58

Update @jest/core package.json

0866aba

merge version 24.6

5ffb812

update version to 24.6.0

745cad3

jeysal reviewed Apr 2, 2019

View reviewed changes

jeysal approved these changes Apr 2, 2019

View reviewed changes

SimenB reviewed Apr 2, 2019

View reviewed changes

sort

301a5cd

SimenB merged commit 2bc6280 into jestjs:master Apr 2, 2019

SimenB mentioned this pull request Apr 2, 2019

Running tests in a specific order #6194

Closed

arcanis reviewed Apr 3, 2019

View reviewed changes

jeysal mentioned this pull request May 23, 2019

The minimal custom scheduler #8478

Closed

snyk-bot mentioned this pull request Dec 15, 2019

[Snyk] Upgrade babel-jest from 24.0.0 to 24.9.0 jakeherp/burger-builder#14

Open

This was referenced Mar 21, 2020

[Snyk] Upgrade: jest, jest-cli lwojcik/sc2pte-panel-frontend#88

Closed

[Snyk] Upgrade jest from 24.0.0 to 24.9.0 DavidKindler/burger-builder#47

Merged

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add option `testSequencer` allow user use custom sequencer. #8223

Add option `testSequencer` allow user use custom sequencer. #8223

WeiAnAn commented Mar 26, 2019

SimenB left a comment

codecov-io commented Mar 27, 2019 •

edited

Loading

WeiAnAn commented Mar 27, 2019

thymikee left a comment

jeysal left a comment

SimenB left a comment

WeiAnAn commented Apr 2, 2019

jeysal left a comment

SimenB Apr 2, 2019

SimenB commented Apr 2, 2019

arcanis Apr 3, 2019

SimenB Apr 3, 2019

arcanis Apr 3, 2019

github-actions bot commented May 11, 2021

Add option testSequencer allow user use custom sequencer. #8223

Add option testSequencer allow user use custom sequencer. #8223

Conversation

WeiAnAn commented Mar 26, 2019

Summary

Test plan

SimenB left a comment

Choose a reason for hiding this comment

codecov-io commented Mar 27, 2019 • edited Loading

Codecov Report

WeiAnAn commented Mar 27, 2019

thymikee left a comment

Choose a reason for hiding this comment

jeysal left a comment

Choose a reason for hiding this comment

SimenB left a comment

Choose a reason for hiding this comment

WeiAnAn commented Apr 2, 2019

jeysal left a comment

Choose a reason for hiding this comment

SimenB Apr 2, 2019

Choose a reason for hiding this comment

SimenB commented Apr 2, 2019

arcanis Apr 3, 2019

Choose a reason for hiding this comment

SimenB Apr 3, 2019

Choose a reason for hiding this comment

arcanis Apr 3, 2019

Choose a reason for hiding this comment

github-actions bot commented May 11, 2021

Add option `testSequencer` allow user use custom sequencer. #8223

Add option `testSequencer` allow user use custom sequencer. #8223

codecov-io commented Mar 27, 2019 •

edited

Loading