-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
fix: resolve fixture overrides from test's suite in beforeEach hooks
#9826
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
Merged
sheremet-va
merged 12 commits into
vitest-dev:main
from
hi-ogawa:fix/9810-override-auto-fixtures
Mar 10, 2026
Merged
Changes from 8 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
ea6a18f
fix: resolve fixture overrides from test's suite in beforeEach hooks …
hi-ogawa 41744db
fix: use context.task?.suite instead of hookContext?.task?.suite
hi-ogawa f582e13
test: add variant tests for override + beforeEach fixture resolution
hi-ogawa 0cd9394
test: split override+beforeEach tests into separate top-level describes
hi-ogawa e9c20f5
test: rename fixtures to base/derived in override tests
hi-ogawa 0e2175d
test: add aroundEach override test case
hi-ogawa 10079df
chore: adjust comment to clarify xxxEach scope
hi-ogawa b1c6ce1
test: adjust comment
hi-ogawa 00a4144
refactor: caller passes suite to withFixtures
hi-ogawa ecc0428
chore: fix types
hi-ogawa 6d7ba29
refactor: move code
hi-ogawa b0d52c9
Merge branch 'main' into fix/9810-override-auto-fixtures
hi-ogawa File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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 |
|---|---|---|
|
|
@@ -640,3 +640,136 @@ describe('builder pattern with non-function values', () => { | |
| expect(chainedSync).toBe('HELLO WORLD') | ||
| }) | ||
| }) | ||
|
|
||
| // https://github.com/vitest-dev/vitest/issues/9810 | ||
| describe('override auto fixture with outer beforeEach', () => { | ||
| const myTest = test | ||
| .extend('base', { auto: true }, () => 'base:default') | ||
| .extend('derived', { auto: true }, ({ base }) => { | ||
| return `derived:${base}` | ||
| }) | ||
|
|
||
| beforeEach(({ task }) => { | ||
| expect(task).toBeTruthy() | ||
| }) | ||
|
|
||
| describe('with override', () => { | ||
| myTest.override('base', 'base:override') | ||
|
|
||
| myTest('auto fixture sees overridden dependency', ({ base, derived }) => { | ||
| expect(base).toBe('base:override') | ||
| expect(derived).toBe('derived:base:override') | ||
| }) | ||
| }) | ||
| }) | ||
|
|
||
| describe('override auto fixture with co-located beforeEach', () => { | ||
| const myTest = test | ||
| .extend('base', { auto: true }, () => 'base:default') | ||
| .extend('derived', { auto: true }, ({ base }) => { | ||
| return `derived:${base}` | ||
| }) | ||
|
|
||
| myTest.override('base', 'base:override') | ||
|
|
||
| beforeEach(({ task }) => { | ||
| expect(task).toBeTruthy() | ||
| }) | ||
|
|
||
| myTest('override applies when beforeEach is co-located', ({ base, derived }) => { | ||
| expect(base).toBe('base:override') | ||
| expect(derived).toBe('derived:base:override') | ||
| }) | ||
| }) | ||
|
|
||
| describe('override non-auto fixture with outer beforeEach', () => { | ||
| const myTest = test | ||
| .extend('base', () => 'base:default') | ||
| .extend('derived', ({ base }) => `derived:${base}`) | ||
|
|
||
| beforeEach(({ task }) => { | ||
| expect(task).toBeTruthy() | ||
| }) | ||
|
|
||
| describe('with override', () => { | ||
| myTest.override('base', 'base:override') | ||
|
|
||
| myTest('override applies to non-auto dependency', ({ base, derived }) => { | ||
| expect(base).toBe('base:override') | ||
| expect(derived).toBe('derived:base:override') | ||
| }) | ||
| }) | ||
| }) | ||
|
|
||
| describe('override fixture accessed in outer beforeEach', () => { | ||
| const myTest = test | ||
| .extend('base', () => 'base:default') | ||
| .extend('derived', ({ base }) => `derived:${base}`) | ||
|
|
||
| const hookValues: string[] = [] | ||
|
|
||
| myTest.beforeEach(({ base }) => { | ||
| hookValues.push(base) | ||
| }) | ||
|
|
||
| describe('with override', () => { | ||
| myTest.override('base', 'base:override') | ||
|
|
||
| myTest('beforeEach sees overridden fixture', ({ derived }) => { | ||
| expect(hookValues).toEqual(['base:override']) | ||
| expect(derived).toBe('derived:base:override') | ||
| }) | ||
| }) | ||
| }) | ||
|
Comment on lines
+704
to
+723
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The issue wasn't only |
||
|
|
||
| describe('nested overrides with outer beforeEach', () => { | ||
| const myTest = test | ||
| .extend('base', { auto: true }, () => 'base:default') | ||
| .extend('derived', { auto: true }, ({ base }) => { | ||
| return `derived:${base}` | ||
| }) | ||
|
|
||
| beforeEach(({ task }) => { | ||
| expect(task).toBeTruthy() | ||
| }) | ||
|
|
||
| describe('outer', () => { | ||
| myTest.override('base', 'base:outer') | ||
|
|
||
| myTest('outer override', ({ base, derived }) => { | ||
| expect(base).toBe('base:outer') | ||
| expect(derived).toBe('derived:base:outer') | ||
| }) | ||
|
|
||
| describe('inner', () => { | ||
| myTest.override('base', 'base:inner') | ||
|
|
||
| myTest('inner override wins', ({ base, derived }) => { | ||
| expect(base).toBe('base:inner') | ||
| expect(derived).toBe('derived:base:inner') | ||
| }) | ||
| }) | ||
| }) | ||
| }) | ||
|
|
||
| describe('override fixture accessed in aroundEach', () => { | ||
| const myTest = test | ||
| .extend('base', () => 'base:default') | ||
| .extend('derived', ({ base }) => `derived:${base}`) | ||
|
|
||
| const hookValues: string[] = [] | ||
|
|
||
| myTest.aroundEach(async (runTest, { base }) => { | ||
| hookValues.push(base) | ||
| await runTest() | ||
| }) | ||
|
|
||
| describe('with override', () => { | ||
| myTest.override('base', 'base:override') | ||
|
|
||
| myTest('aroundEach sees overridden fixture', ({ derived }) => { | ||
| expect(hookValues).toEqual(['base:override']) | ||
| expect(derived).toBe('derived:base:override') | ||
| }) | ||
| }) | ||
| }) | ||
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 want to avoid using
context.taskanywhere in fixtures resolution, it's an implied value that makes this harder to track, in my opinion. Could we pass suite down as an option instead?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 didn't see it, but that indeed shows the flow better. I think this is what you mean. Updated.