New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix test retries that contain snapshots #8629
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
eeafd63
Fix bug with snapshots and retries
rogeliog df8a22e
Update CHANGELOG.md
rogeliog 2d997e6
Address e2e tests PR comments
rogeliog 8f103bd
Use correct type for snapshotState
rogeliog 313fb53
Simplify implementation and decouple it from expect
rogeliog File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,141 @@ | ||
/** | ||
* Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved. | ||
* | ||
* This source code is licensed under the MIT license found in the | ||
* LICENSE file in the root directory of this source tree. | ||
*/ | ||
|
||
import path from 'path'; | ||
import {cleanup, makeTemplate, writeFiles} from '../Utils'; | ||
import runJest from '../runJest'; | ||
|
||
const DIR = path.resolve(__dirname, '../to-match-inline-snapshot-with-retries'); | ||
const TESTS_DIR = path.resolve(DIR, '__tests__'); | ||
|
||
beforeEach(() => cleanup(TESTS_DIR)); | ||
afterAll(() => cleanup(TESTS_DIR)); | ||
|
||
test('works with a single snapshot', () => { | ||
const filename = 'basic-support.test.js'; | ||
const template = makeTemplate(` | ||
let index = 0; | ||
afterEach(() => { | ||
index += 1; | ||
}); | ||
jest.retryTimes($2); | ||
test('snapshots', () => expect($1).toMatchInlineSnapshot(\`3\`)); | ||
`); | ||
|
||
{ | ||
writeFiles(TESTS_DIR, { | ||
[filename]: template(['3', '1' /* retries */]), | ||
}); | ||
const {stderr, status} = runJest(DIR, ['-w=1', '--ci=false', filename]); | ||
expect(stderr).toMatch('Snapshots: 1 passed, 1 total'); | ||
expect(status).toBe(0); | ||
} | ||
|
||
{ | ||
writeFiles(TESTS_DIR, { | ||
[filename]: template(['index', '2' /* retries */]), | ||
}); | ||
const {stderr, status} = runJest(DIR, [ | ||
'-w=1', | ||
'--ci=false', | ||
'--testRunner=jest-circus/runner', | ||
filename, | ||
]); | ||
expect(stderr).toMatch('Received: 2'); | ||
expect(stderr).toMatch('1 snapshot failed from 1 test suite.'); | ||
expect(status).toBe(1); | ||
} | ||
|
||
{ | ||
writeFiles(TESTS_DIR, { | ||
[filename]: template(['index', '4' /* retries */]), | ||
}); | ||
const {stderr, status} = runJest(DIR, [ | ||
'-w=1', | ||
'--ci=false', | ||
'--testRunner=jest-circus/runner', | ||
filename, | ||
]); | ||
expect(stderr).toMatch('Snapshots: 1 passed, 1 total'); | ||
expect(status).toBe(0); | ||
} | ||
}); | ||
|
||
test('works when a different assertion is failing', () => { | ||
const filename = 'basic-support.test.js'; | ||
const template = makeTemplate(` | ||
jest.retryTimes($1); | ||
test('snapshots', () => { | ||
expect(3).toMatchInlineSnapshot(\`3\`); | ||
expect(false).toBe(true); | ||
}); | ||
`); | ||
|
||
{ | ||
writeFiles(TESTS_DIR, { | ||
[filename]: template(['4']), | ||
}); | ||
const {stderr, status} = runJest(DIR, ['-w=1', '--ci=false', filename]); | ||
expect(stderr).toMatch('Test Suites: 1 failed, 1 total'); | ||
expect(stderr).toMatch('Snapshots: 1 passed, 1 total'); | ||
expect(status).toBe(1); | ||
} | ||
}); | ||
|
||
test('works when multiple tests have snapshots but only one of them failed multiple times', () => { | ||
const filename = 'basic-support.test.js'; | ||
const template = makeTemplate(` | ||
test('passing snapshots', () => expect(1).toMatchInlineSnapshot(\`1\`)); | ||
describe('with retries', () => { | ||
let index = 0; | ||
afterEach(() => { | ||
index += 1; | ||
}); | ||
jest.retryTimes($2); | ||
test('snapshots', () => expect($1).toMatchInlineSnapshot(\`3\`)); | ||
}); | ||
`); | ||
|
||
{ | ||
writeFiles(TESTS_DIR, { | ||
[filename]: template(['3', '2' /* retries */]), | ||
}); | ||
const {stderr, status} = runJest(DIR, ['-w=1', '--ci=false', filename]); | ||
expect(stderr).toMatch('Snapshots: 2 passed, 2 total'); | ||
expect(status).toBe(0); | ||
} | ||
|
||
{ | ||
writeFiles(TESTS_DIR, { | ||
[filename]: template(['index', '2' /* retries */]), | ||
}); | ||
const {stderr, status} = runJest(DIR, [ | ||
'-w=1', | ||
'--ci=false', | ||
'--testRunner=jest-circus/runner', | ||
filename, | ||
]); | ||
expect(stderr).toMatch('Snapshot name: `with retries snapshots 1`'); | ||
expect(stderr).toMatch('Received: 2'); | ||
expect(stderr).toMatch('1 snapshot failed from 1 test suite.'); | ||
expect(status).toBe(1); | ||
} | ||
|
||
{ | ||
writeFiles(TESTS_DIR, { | ||
[filename]: template(['index', '4' /* retries */]), | ||
}); | ||
const {stderr, status} = runJest(DIR, [ | ||
'-w=1', | ||
'--ci=false', | ||
'--testRunner=jest-circus/runner', | ||
filename, | ||
]); | ||
expect(stderr).toMatch('Snapshots: 1 passed, 1 total'); | ||
expect(status).toBe(0); | ||
} | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,119 @@ | ||
/** | ||
* Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved. | ||
* | ||
* This source code is licensed under the MIT license found in the | ||
* LICENSE file in the root directory of this source tree. | ||
*/ | ||
|
||
import path from 'path'; | ||
import {cleanup, makeTemplate, writeFiles} from '../Utils'; | ||
import runJest from '../runJest'; | ||
|
||
const DIR = path.resolve(__dirname, '../to-match-snapshot-with-retries'); | ||
const TESTS_DIR = path.resolve(DIR, '__tests__'); | ||
|
||
beforeEach(() => cleanup(TESTS_DIR)); | ||
afterAll(() => cleanup(TESTS_DIR)); | ||
|
||
test('works with a single snapshot', () => { | ||
const filename = 'basic-support.test.js'; | ||
const template = makeTemplate(` | ||
let index = 0; | ||
afterEach(() => { | ||
index += 1; | ||
}); | ||
jest.retryTimes($2); | ||
test('snapshots', () => expect($1).toMatchSnapshot()); | ||
`); | ||
|
||
{ | ||
writeFiles(TESTS_DIR, { | ||
[filename]: template(['3', '1' /* retries */]), | ||
}); | ||
const {stderr, status} = runJest(DIR, ['-w=1', '--ci=false', filename]); | ||
expect(stderr).toMatch('1 snapshot written from 1 test suite.'); | ||
expect(status).toBe(0); | ||
} | ||
|
||
{ | ||
writeFiles(TESTS_DIR, { | ||
[filename]: template(['index', '2' /* retries */]), | ||
}); | ||
const {stderr, status} = runJest(DIR, [ | ||
'-w=1', | ||
'--ci=false', | ||
'--testRunner=jest-circus/runner', | ||
filename, | ||
]); | ||
expect(stderr).toMatch('Received: 2'); | ||
expect(stderr).toMatch('1 snapshot failed from 1 test suite.'); | ||
expect(status).toBe(1); | ||
} | ||
|
||
{ | ||
writeFiles(TESTS_DIR, { | ||
[filename]: template(['index', '4' /* retries */]), | ||
}); | ||
const {stderr, status} = runJest(DIR, [ | ||
'-w=1', | ||
'--ci=false', | ||
'--testRunner=jest-circus/runner', | ||
filename, | ||
]); | ||
expect(stderr).toMatch('Snapshots: 1 passed, 1 total'); | ||
expect(status).toBe(0); | ||
} | ||
}); | ||
|
||
test('works when multiple tests have snapshots but only one of them failed multiple times', () => { | ||
const filename = 'basic-support.test.js'; | ||
const template = makeTemplate(` | ||
test('passing snapshots', () => expect('foo').toMatchSnapshot()); | ||
describe('with retries', () => { | ||
let index = 0; | ||
afterEach(() => { | ||
index += 1; | ||
}); | ||
jest.retryTimes($2); | ||
test('snapshots', () => expect($1).toMatchSnapshot()); | ||
}); | ||
`); | ||
|
||
{ | ||
writeFiles(TESTS_DIR, { | ||
[filename]: template(['3', '2' /* retries */]), | ||
}); | ||
const {stderr, status} = runJest(DIR, ['-w=1', '--ci=false', filename]); | ||
expect(stderr).toMatch('2 snapshots written from 1 test suite.'); | ||
expect(status).toBe(0); | ||
} | ||
|
||
{ | ||
writeFiles(TESTS_DIR, { | ||
[filename]: template(['index', '2' /* retries */]), | ||
}); | ||
const {stderr, status} = runJest(DIR, [ | ||
'-w=1', | ||
'--ci=false', | ||
'--testRunner=jest-circus/runner', | ||
filename, | ||
]); | ||
expect(stderr).toMatch('Received: 2'); | ||
expect(stderr).toMatch('1 snapshot failed from 1 test suite.'); | ||
expect(status).toBe(1); | ||
} | ||
|
||
{ | ||
writeFiles(TESTS_DIR, { | ||
[filename]: template(['index', '4' /* retries */]), | ||
}); | ||
const {stderr, status} = runJest(DIR, [ | ||
'-w=1', | ||
'--ci=false', | ||
'--testRunner=jest-circus/runner', | ||
filename, | ||
]); | ||
expect(stderr).toMatch('Snapshots: 1 passed, 1 total'); | ||
expect(status).toBe(0); | ||
} | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"jest": { | ||
"testEnvironment": "node" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"jest": { | ||
"testEnvironment": "node" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oooh, I like this! good call