fix: filtering with --spec option for projects in Docker container root
#23535
Conversation
…tbiethman/23380-root-spec-pattern
|
Thanks for taking the time to open a PR!
|
| @@ -9,6 +9,10 @@ import { toPosix } from '../util/file' | |||
|
|
|||
| const debug = Debug('cypress:data-context:sources:FileDataSource') | |||
|
|
|||
| export const matchGlobs = async (globs: string | string[], globbyOptions?: GlobbyOptions) => { | |||
| return await globby(globs, globbyOptions) | |||
| } | |||
There was a problem hiding this comment.
Our pinned version of globby exports the function itself as the module export, making it difficult to stub calls to it for unit testing purposes.
So I added a little wrapper here so I could stub these calls appropriately, but I can remove this if I'm missing an obvious way to stub the module directly.
|
|
||
| expect(files).to.eq(mockMatches) | ||
| expect(matchGlobsStub).to.have.been.calledWith( | ||
| ['cypress/e2e/**.cy.js'], |
There was a problem hiding this comment.
In 10.6.0, this test case would produce .cypress/e2e/**.cy.js, which is not a valid pattern.
|
Test summary
Run details
View run in Cypress Dashboard ➡️ This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard |
| if (globPattern.startsWith(workingDirectoryPrefix)) { | ||
| return globPattern.replace(workingDirectoryPrefix, '') | ||
| } | ||
|
|
||
| return globPattern |
There was a problem hiding this comment.
Would return path.relative(workingDirectoryPrefix, globPattern) also work instead of these 5 lines? Might not even need line 39 at that point
There was a problem hiding this comment.
I think path.relative has the potential to mutate the glob patterns to be relative to the current execution directory, which may or may not equal the given cwd argument. In those cases, the pattern would no longer be representative of what the user expects.
| @@ -9,6 +9,10 @@ import { toPosix } from '../util/file' | |||
|
|
|||
| const debug = Debug('cypress:data-context:sources:FileDataSource') | |||
|
|
|||
| export const matchGlobs = async (globs: string | string[], globbyOptions?: GlobbyOptions) => { | |||
There was a problem hiding this comment.
An async function with return await is equivalent to a non-async function that just returns the promise.
--specoption results in "no specs found" when project is located at Docker root directory #23380User facing changelog
--specrun mode option would not find any specs if the project was located at the root directory of a file system.Additional details
This logic has been changed a few times lately to ensure that we are only globbing user-provided patterns. These changes introduced a regression where, with a working directory of root (
/), the glob pattern would be incorrectly manipulated:working dir of
/+ glob pattern of/foo/bar/*.cy.js=>.foo/bar/*.cy.js// this won't match anythingThis typically only occurred with our docker images, where users may mount project content directly to the container's root. We correct this issue by having better checks around our absolute glob pattern detection and deriving implicit relative patterns (
foo/bar/*.cy.jsrather than./foo/bar/*.cy.js) for the glob patterns that we must manipulate.Steps to test
The added unit tests now show the root working directory scenarios being properly handled.
I also created a validation repo here: https://github.com/tbiethman/verify-23535. Steps to validate are included on its README.
How has the user experience changed?
PR Tasks
cypress-documentation?type definitions?