Skip to content
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.

Sign up for GitHub

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

feat(cli): Support location filters for suites #7048

Merged
merged 5 commits into from
Dec 9, 2024
Merged

feat(cli): Support location filters for suites #7048

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bca7f06
First attempt at supporting matching by suite
mzhubail Dec 8, 2024
a6db81e
Add more test cases related to suites
mzhubail Dec 8, 2024
a1b7384
idk what this is
mzhubail Dec 8, 2024
8becf2c
Change if statement code style
mzhubail Dec 8, 2024
e8a2379
Empty commit to re-trigger workflow
mzhubail Dec 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 22 additions & 16 deletions packages/runner/src/utils/collect.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export function interpretTaskModes(
): void {
const matchedLocations: number[] = []

const traverseSuite = (suite: Suite, parentIsOnly?: boolean) => {
const traverseSuite = (suite: Suite, parentIsOnly?: boolean, parentMatchedWithLocation?: boolean) => {
const suiteIsOnly = parentIsOnly || suite.mode === 'only'

suite.tasks.forEach((t) => {
Expand All @@ -37,30 +37,36 @@ export function interpretTaskModes(
t.mode = 'run'
}
}
if (t.type === 'test') {
if (namePattern && !getTaskFullName(t).match(namePattern)) {

let hasLocationMatch = parentMatchedWithLocation
// Match test location against provided locations, only run if present
// in `testLocations`. Note: if `includeTaskLocations` is not enabled,
// all test will be skipped.
if (testLocations !== undefined && testLocations.length !== 0) {
if (t.location && testLocations?.includes(t.location.line)) {
t.mode = 'run'
matchedLocations.push(t.location.line)
hasLocationMatch = true
}
else if (parentMatchedWithLocation) {
t.mode = 'run'
}
else if (t.type === 'test') {
t.mode = 'skip'
}
}

// Match test location against provided locations, only run if present
// in `testLocations`. Note: if `includeTaskLocations` is not enabled,
// all test will be skipped.
if (testLocations !== undefined && testLocations.length !== 0) {
if (t.location && testLocations?.includes(t.location.line)) {
t.mode = 'run'
matchedLocations.push(t.location.line)
}
else {
t.mode = 'skip'
}
if (t.type === 'test') {
if (namePattern && !getTaskFullName(t).match(namePattern)) {
t.mode = 'skip'
}
}
else if (t.type === 'suite') {
if (t.mode === 'skip') {
skipAllTasks(t)
}
else {
traverseSuite(t, includeTask)
traverseSuite(t, includeTask, hasLocationMatch)
}
}
})
Expand All @@ -73,7 +79,7 @@ export function interpretTaskModes(
}
}

traverseSuite(file, parentIsOnly)
traverseSuite(file, parentIsOnly, false)

const nonMatching = testLocations?.filter(loc => !matchedLocations.includes(loc))
if (nonMatching && nonMatching.length !== 0) {
Expand Down
75 changes: 75 additions & 0 deletions packages/vitest/LICENSE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -931,6 +931,23 @@ Repository: micromatch/micromatch

---------------------------------------

## mimic-fn
License: MIT
By: Sindre Sorhus
Repository: sindresorhus/mimic-fn

> MIT License
>
> Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
>
> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
>
> The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
>
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---------------------------------------

## mlly
License: MIT
Repository: unjs/mlly
Expand Down Expand Up @@ -959,6 +976,23 @@ Repository: unjs/mlly

---------------------------------------

## onetime
License: MIT
By: Sindre Sorhus
Repository: sindresorhus/onetime

> MIT License
>
> Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
>
> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
>
> The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
>
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---------------------------------------

## p-limit
License: MIT
By: Sindre Sorhus
Expand Down Expand Up @@ -1137,6 +1171,23 @@ Repository: privatenumber/resolve-pkg-maps

---------------------------------------

## restore-cursor
License: MIT
By: Sindre Sorhus
Repository: sindresorhus/restore-cursor

> MIT License
>
> Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
>
> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
>
> The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
>
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---------------------------------------

## reusify
License: MIT
By: Matteo Collina
Expand Down Expand Up @@ -1194,6 +1245,30 @@ Repository: git://github.com/feross/run-parallel.git

---------------------------------------

## signal-exit
License: ISC
By: Ben Coe
Repository: https://github.com/tapjs/signal-exit.git

> The ISC License
>
> Copyright (c) 2015, Contributors
>
> Permission to use, copy, modify, and/or distribute this software
> for any purpose with or without fee is hereby granted, provided
> that the above copyright notice and this permission notice
> appear in all copies.
>
> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
> OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE
> LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES
> OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
> WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
> ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

---------------------------------------

## sisteransi
License: MIT
By: Terkel Gjervig
Expand Down
87 changes: 85 additions & 2 deletions test/cli/test/location-filters.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,54 @@ describe('location filter with list command', () => {
expect(stderr).toEqual('')
})

test('finds "basic suite" at correct line number', async () => {
const { stdout, stderr } = await runVitestCli(
'list',
`-r=${fixturePath}`,
`${fixturePath}/basic.test.ts:3`,
)

expect(stdout).toMatchInlineSnapshot(`
"basic.test.ts > basic suite > inner suite > some test
basic.test.ts > basic suite > inner suite > another test
basic.test.ts > basic suite > basic test
"
`)
expect(stderr).toEqual('')
})

test('finds "inner suite" at correct line number', async () => {
const { stdout, stderr } = await runVitestCli(
'list',
`-r=${fixturePath}`,
`${fixturePath}/basic.test.ts:4`,
)

expect(stdout).toMatchInlineSnapshot(`
"basic.test.ts > basic suite > inner suite > some test
basic.test.ts > basic suite > inner suite > another test
"
`)
expect(stderr).toEqual('')
})

test('handles matching test inside a suite', async () => {
const { stdout, stderr } = await runVitestCli(
'list',
`-r=${fixturePath}`,
`${fixturePath}/basic.test.ts:3`,
`${fixturePath}/basic.test.ts:9`,
)

expect(stdout).toMatchInlineSnapshot(`
"basic.test.ts > basic suite > inner suite > some test
basic.test.ts > basic suite > inner suite > another test
basic.test.ts > basic suite > basic test
"
`)
expect(stderr).toEqual('')
})

test('handles file with a dash in the name', async () => {
const { stdout, stderr } = await runVitestCli(
'list',
Expand Down Expand Up @@ -120,13 +168,48 @@ describe('location filter with run command', () => {
`${fixturePath}/math.test.ts:3`,
)

// expect(`${stdout}\n--------------------\n${stderr}`).toEqual('')

expect(stdout).contain('1 passed')
expect(stdout).contain('1 skipped')
expect(stderr).toEqual('')
})

test('finds "basic suite" at correct line number', async () => {
const { stdout, stderr } = await runVitestCli(
'run',
`-r=${fixturePath}`,
`${fixturePath}/basic.test.ts:3`,
)

expect(stdout).contain('3 passed')
expect(stdout).contain('1 skipped')
expect(stderr).toEqual('')
})

test('finds "inner suite" at correct line number', async () => {
const { stdout, stderr } = await runVitestCli(
'run',
`-r=${fixturePath}`,
`${fixturePath}/basic.test.ts:4`,
)

expect(stdout).contain('2 passed')
expect(stdout).contain('2 skipped')
expect(stderr).toEqual('')
})

test('handles matching test inside a suite', async () => {
const { stdout, stderr } = await runVitestCli(
'run',
`-r=${fixturePath}`,
`${fixturePath}/basic.test.ts:3`,
`${fixturePath}/basic.test.ts:9`,
)

expect(stdout).contain('3 passed')
expect(stdout).contain('1 skipped')
expect(stderr).toEqual('')
})

test('handles file with a dash in the name', async () => {
const { stdout, stderr } = await runVitestCli(
'run',
Expand Down
Loading