fix: support snapshot with expect.soft
#9231
There are no files selected for viewing
This file contains hidden or 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
|
Collaborator
There was a problem hiding this comment. Added a quick guide for snapshot test suites. We can likely simplify |
This file contains hidden or 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 @@ | ||
| TODO: explain which test script does what. |
This file contains hidden or 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 @@ | ||
| __snapshots__ |
This file contains hidden or 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,16 @@ | ||
| import { expect, test } from 'vitest' | ||
|
|
||
| test('toMatchSnapshot', () => { | ||
| expect.soft('--snap-1--').toMatchSnapshot() | ||
| expect.soft('--snap-2--').toMatchSnapshot() | ||
| }) | ||
|
|
||
| test('toMatchFileSnapshot', async () => { | ||
| await expect.soft('--file-1--').toMatchFileSnapshot('./__snapshots__/custom1.txt') | ||
| await expect.soft('--file-2--').toMatchFileSnapshot('./__snapshots__/custom2.txt') | ||
| }) | ||
|
|
||
| test('toThrowErrorMatchingSnapshot', () => { | ||
| expect.soft(() => { throw new Error('--error-1--') }).toThrowErrorMatchingSnapshot() | ||
| expect.soft(() => { throw new Error('--error-2--') }).toThrowErrorMatchingSnapshot() | ||
| }) |
This file contains hidden or 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,11 @@ | ||
| import { expect, test } from 'vitest' | ||
|
|
||
| test('not supported yet', () => { | ||
| expect(() => expect.soft('test').toMatchInlineSnapshot()).toThrowErrorMatchingInlineSnapshot( | ||
| `[Error: toMatchInlineSnapshot cannot be used with "soft"]`, | ||
| ) | ||
|
|
||
| expect(() => expect.soft(() => {}).toThrowErrorMatchingInlineSnapshot()).toThrowErrorMatchingInlineSnapshot( | ||
| `[Error: toThrowErrorMatchingInlineSnapshot cannot be used with "soft"]`, | ||
| ) | ||
| }) |
This file contains hidden or 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,197 @@ | ||
| import fs, { readFileSync } from 'node:fs' | ||
| import { join } from 'node:path' | ||
| import { expect, test } from 'vitest' | ||
| import { editFile, runVitest } from '../../test-utils' | ||
|
|
||
| test('soft', async () => { | ||
| const root = join(import.meta.dirname, 'fixtures/soft') | ||
| const testFile = join(root, 'basic.test.ts') | ||
| const snapshotFile = join(root, '__snapshots__/basic.test.ts.snap') | ||
| const customFile1 = join(root, '__snapshots__/custom1.txt') | ||
| const customFile2 = join(root, '__snapshots__/custom2.txt') | ||
|
|
||
| // reset and create snapshots from scratch | ||
| fs.rmSync(join(root, '__snapshots__'), { recursive: true, force: true }) | ||
| let result = await runVitest({ root, update: 'new' }) | ||
| expect(result.stderr).toMatchInlineSnapshot(`""`) | ||
| expect(readFileSync(snapshotFile, 'utf-8')).toMatchInlineSnapshot(` | ||
| "// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html | ||
|
|
||
| exports[\`toMatchSnapshot 1\`] = \`"--snap-1--"\`; | ||
|
|
||
| exports[\`toMatchSnapshot 2\`] = \`"--snap-2--"\`; | ||
|
|
||
| exports[\`toThrowErrorMatchingSnapshot 1\`] = \`[Error: --error-1--]\`; | ||
|
|
||
| exports[\`toThrowErrorMatchingSnapshot 2\`] = \`[Error: --error-2--]\`; | ||
| " | ||
| `) | ||
| expect(readFileSync(customFile1, 'utf-8')).toMatchInlineSnapshot(`"--file-1--"`) | ||
| expect(readFileSync(customFile2, 'utf-8')).toMatchInlineSnapshot(`"--file-2--"`) | ||
| expect(result.errorTree()).toMatchInlineSnapshot(` | ||
| Object { | ||
| "basic.test.ts": Object { | ||
| "toMatchFileSnapshot": "passed", | ||
| "toMatchSnapshot": "passed", | ||
| "toThrowErrorMatchingSnapshot": "passed", | ||
| }, | ||
| } | ||
| `) | ||
|
|
||
| // edit tests to introduce snapshot errors | ||
| editFile(testFile, s => s | ||
| .replace(`--snap-1--`, `--snap-1-edit--`) | ||
| .replace(`--snap-2--`, `--snap-2-edit--`) | ||
| .replace(`--file-1--`, `--file-1-edit--`) | ||
| .replace(`--file-2--`, `--file-2-edit--`) | ||
| .replace(`--error-1--`, `--error-1-edit--`) | ||
| .replace(`--error-2--`, `--error-2-edit--`)) | ||
| result = await runVitest({ root, update: false }) | ||
| expect(result.stderr).toMatchInlineSnapshot(` | ||
| " | ||
| ⎯⎯⎯⎯⎯⎯⎯ Failed Tests 3 ⎯⎯⎯⎯⎯⎯⎯ | ||
|
|
||
| FAIL basic.test.ts > toMatchSnapshot | ||
| Error: Snapshot \`toMatchSnapshot 1\` mismatched | ||
|
|
||
| Expected: ""--snap-1--"" | ||
| Received: ""--snap-1-edit--"" | ||
|
|
||
| ❯ basic.test.ts:4:34 | ||
| 2| | ||
| 3| test('toMatchSnapshot', () => { | ||
| 4| expect.soft('--snap-1-edit--').toMatchSnapshot() | ||
| | ^ | ||
| 5| expect.soft('--snap-2-edit--').toMatchSnapshot() | ||
| 6| }) | ||
|
|
||
| ⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯[1/6]⎯ | ||
|
|
||
| FAIL basic.test.ts > toMatchSnapshot | ||
| Error: Snapshot \`toMatchSnapshot 2\` mismatched | ||
|
|
||
| Expected: ""--snap-2--"" | ||
| Received: ""--snap-2-edit--"" | ||
|
|
||
| ❯ basic.test.ts:5:34 | ||
| 3| test('toMatchSnapshot', () => { | ||
| 4| expect.soft('--snap-1-edit--').toMatchSnapshot() | ||
| 5| expect.soft('--snap-2-edit--').toMatchSnapshot() | ||
| | ^ | ||
| 6| }) | ||
| 7| | ||
|
|
||
| ⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯[2/6]⎯ | ||
|
|
||
| FAIL basic.test.ts > toMatchFileSnapshot | ||
| Error: Snapshot \`toMatchFileSnapshot 1\` mismatched | ||
|
|
||
| Expected: "--file-1--" | ||
| Received: "--file-1-edit--" | ||
|
|
||
| ❯ basic.test.ts:9:3 | ||
| 7| | ||
| 8| test('toMatchFileSnapshot', async () => { | ||
| 9| await expect.soft('--file-1-edit--').toMatchFileSnapshot('./__snapsh… | ||
| | ^ | ||
| 10| await expect.soft('--file-2-edit--').toMatchFileSnapshot('./__snapsh… | ||
| 11| }) | ||
|
|
||
| ⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯[3/6]⎯ | ||
|
|
||
| FAIL basic.test.ts > toMatchFileSnapshot | ||
| Error: Snapshot \`toMatchFileSnapshot 2\` mismatched | ||
|
|
||
| Expected: "--file-2--" | ||
| Received: "--file-2-edit--" | ||
|
|
||
| ❯ basic.test.ts:10:3 | ||
| 8| test('toMatchFileSnapshot', async () => { | ||
| 9| await expect.soft('--file-1-edit--').toMatchFileSnapshot('./__snapsh… | ||
| 10| await expect.soft('--file-2-edit--').toMatchFileSnapshot('./__snapsh… | ||
| | ^ | ||
| 11| }) | ||
| 12| | ||
|
|
||
| ⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯[4/6]⎯ | ||
|
|
||
| FAIL basic.test.ts > toThrowErrorMatchingSnapshot | ||
| Error: Snapshot \`toThrowErrorMatchingSnapshot 1\` mismatched | ||
|
|
||
| Expected: "[Error: --error-1--]" | ||
| Received: "[Error: --error-1-edit--]" | ||
|
|
||
| ❯ basic.test.ts:14:62 | ||
| 12| | ||
| 13| test('toThrowErrorMatchingSnapshot', () => { | ||
| 14| expect.soft(() => { throw new Error('--error-1-edit--') }).toThrowEr… | ||
| | ^ | ||
| 15| expect.soft(() => { throw new Error('--error-2-edit--') }).toThrowEr… | ||
| 16| }) | ||
|
|
||
| ⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯[5/6]⎯ | ||
|
|
||
| FAIL basic.test.ts > toThrowErrorMatchingSnapshot | ||
| Error: Snapshot \`toThrowErrorMatchingSnapshot 2\` mismatched | ||
|
|
||
| Expected: "[Error: --error-2--]" | ||
| Received: "[Error: --error-2-edit--]" | ||
|
|
||
| ❯ basic.test.ts:15:62 | ||
| 13| test('toThrowErrorMatchingSnapshot', () => { | ||
| 14| expect.soft(() => { throw new Error('--error-1-edit--') }).toThrowEr… | ||
| 15| expect.soft(() => { throw new Error('--error-2-edit--') }).toThrowEr… | ||
| | ^ | ||
| 16| }) | ||
| 17| | ||
|
|
||
| ⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯[6/6]⎯ | ||
|
|
||
| " | ||
| `) | ||
| expect(result.errorTree()).toMatchInlineSnapshot(` | ||
| Object { | ||
| "basic.test.ts": Object { | ||
| "toMatchFileSnapshot": Array [ | ||
| "Snapshot \`toMatchFileSnapshot 1\` mismatched", | ||
| "Snapshot \`toMatchFileSnapshot 2\` mismatched", | ||
| ], | ||
| "toMatchSnapshot": Array [ | ||
| "Snapshot \`toMatchSnapshot 1\` mismatched", | ||
| "Snapshot \`toMatchSnapshot 2\` mismatched", | ||
| ], | ||
| "toThrowErrorMatchingSnapshot": Array [ | ||
| "Snapshot \`toThrowErrorMatchingSnapshot 1\` mismatched", | ||
| "Snapshot \`toThrowErrorMatchingSnapshot 2\` mismatched", | ||
| ], | ||
| }, | ||
| } | ||
| `) | ||
|
|
||
| // run with update | ||
| result = await runVitest({ root, update: 'all' }) | ||
| expect(result.stderr).toMatchInlineSnapshot(`""`) | ||
| expect(readFileSync(snapshotFile, 'utf-8')).toMatchInlineSnapshot(` | ||
| "// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html | ||
|
|
||
| exports[\`toMatchSnapshot 1\`] = \`"--snap-1-edit--"\`; | ||
|
|
||
| exports[\`toMatchSnapshot 2\`] = \`"--snap-2-edit--"\`; | ||
|
|
||
| exports[\`toThrowErrorMatchingSnapshot 1\`] = \`[Error: --error-1-edit--]\`; | ||
|
|
||
| exports[\`toThrowErrorMatchingSnapshot 2\`] = \`[Error: --error-2-edit--]\`; | ||
| " | ||
| `) | ||
| expect(readFileSync(customFile1, 'utf-8')).toMatchInlineSnapshot(`"--file-1-edit--"`) | ||
| expect(readFileSync(customFile2, 'utf-8')).toMatchInlineSnapshot(`"--file-2-edit--"`) | ||
| expect(result.errorTree()).toMatchInlineSnapshot(` | ||
| Object { | ||
| "basic.test.ts": Object { | ||
| "toMatchFileSnapshot": "passed", | ||
| "toMatchSnapshot": "passed", | ||
| "toThrowErrorMatchingSnapshot": "passed", | ||
| }, | ||
| } | ||
| `) | ||
| }) |
Oops, something went wrong.
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.
I wasn't sure why this check is needed specifically. Let me test run by commenting out. Please let me know if there's a reason for this.
Uh oh!
There was an error while loading. Please reload this page.
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.
Oh wait, I realized that this should be actually good to keep since we should still make
recordAsyncExpectit functional for non soft case. We just didn't have a test to catch this.EIDIT: Ah no.
wrapAssertionalways exists regardless of soft or not, sorecordAsyncExpect's hanging promise detection won't work (but still auto await should be working).