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.

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(coverage): prevent reportsDirectory from removing user's project #5376

Merged

Conversation

AriPerkkio
Copy link
Member

Description

Configuration below can remove user's whole project including local Git history from .git. One could accidentally use that when trying to generate coverage reports in the root of project instead of the default ./coverage, and find out that their whole project is now wiped (that's me 🙃).

// Don't run this
export default defineConfig({
  test: {
    coverage: {
      reportsDirectory: './',
    },
  },
})

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
  • Ideally, include a test that fails without this PR but passes with it.
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Tests

  • Run the tests with pnpm test:ci.

Documentation

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets

  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

Copy link

netlify bot commented Mar 12, 2024

Deploy Preview for fastidious-cascaron-4ded94 canceled.

Name Link
🔨 Latest commit 0012cec
🔍 Latest deploy log https://app.netlify.com/sites/fastidious-cascaron-4ded94/deploys/65f09c770d64030008198e79

Comment on lines +147 to +149
const reportsDirectory = resolve(resolved.root, resolved.coverage.reportsDirectory)

if (reportsDirectory === resolved.root || reportsDirectory === process.cwd())
Copy link
Contributor

@hi-ogawa hi-ogawa Mar 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe check also parent directory like ../?
Using root.startsWith(reportsDirectory) can cover root === reportsDirectory as a special case.

(Ah, I guess startsWith might not be it since "/some/directory".startsWith("/some/dir") is a false positive.)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can check startsWith(reportsDirectory + '/')

Copy link
Member Author

@AriPerkkio AriPerkkio Mar 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good. We can also add this improvement later on if you want to include this PR as is in the release @sheremet-va.

@sheremet-va sheremet-va merged commit 07ec377 into vitest-dev:main Mar 14, 2024
19 checks passed
@AriPerkkio AriPerkkio deleted the fix/prevent-removing-cwd-dir branch March 14, 2024 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants