feat(coverage): add `allowExternal` option by vojvodics · Pull Request #3894 · vitest-dev/vitest

vojvodics · 2023-08-05T13:41:41Z

Description

Implements allowExternal option removed in v0.34.0

Resolves #3867

bolt-new-by-stackblitz · 2023-08-05T13:41:44Z

Run & review this pull request in StackBlitz Codeflow.

netlify · 2023-08-05T13:41:47Z

✅ Deploy Preview for fastidious-cascaron-4ded94 canceled.

Name	Link
🔨 Latest commit	`25cf08b`
🔍 Latest deploy log	https://app.netlify.com/sites/fastidious-cascaron-4ded94/deploys/64dcf42242289e0008fdcd21

test/coverage-test/vitest.config.ts

packages/vitest/src/node/config.ts

AriPerkkio

I'm not sure if setting allowExternal: true for all coverage tests is good approach. But let's do that for now and I'll see if better way to test this is possible.

docs/config/index.md

packages/vitest/src/types/coverage.ts

test/coverage-test/vitest.config.ts

packages/vitest/src/node/config.ts

test/coverage-test/vitest.config.ts

test/coverage-test/coverage-report-tests/generic.report.test.ts

vojvodics · 2023-08-15T16:21:16Z

@AriPerkkio I had the idea to run the tests via cli argument (e.g. "test:v8": "node ./testing.mjs --provider v8 && node ./testing.mjs --provider v8 --allowExternal") But.. I didn't manage to make it work - not sure if it's possible to have conditional snapshots (that could automatically be updated, not by matching inline snapshot)?
What I basically want is if allowExternal is passed to check if it matches one snapshot, and if not if it matches the original snapshot (everything currently points me to having 2 separate folders is the solution to having separate tests for both options).

AriPerkkio · 2023-08-15T16:38:14Z

Maybe we should have a separate testing.mjs script for testing different coverage options like allowExternal. It could be a single script in package.json.

Something like:

// vitest/test/coverage-test/testing-options.mjs

import { startVitest } from 'vitest/node'

const testCases = [
  {
    testConfig: {
      include: ['test/allow-external.test.ts'],
      coverage: { allowExternal: true, include: ['**/src/**', '**/test-utils/fixtures/**'] },
    },
    assertionConfig: {
      include: ['coverage-report-tests/allow-external.test.ts'],
    },
  },
]

for (const provider of ['v8', 'istanbul']) {
  for (const { testConfig, assertionConfig } of testCases) {
    // Run test case
    await startVitest('test', ['tests/'], {
      name: `With settings: ${JSON.stringify(testConfig)}`,
      ...testConfig,
      coverage: {
        enabled: true,
        provider,
        ...testConfig.coverage,
      },
    })

    // Check generated coverage report
    await startVitest('test', ['coverage-report-tests'], {
      ...assertionConfig,
    })
  }
}

And then we could leave the regular testing.mjs without allowExternal.

AriPerkkio

I've refactored the testing setup of test/coverage-test. Now both true|false values of allowExternal are tested.

Thanks @vojvodics!

vojvodics added 3 commits August 5, 2023 13:27

feat: add allowExternal option for coverage providers

550df64

Add tests

fe305e0

add docs

2e0fcc2

vojvodics commented Aug 5, 2023

View reviewed changes

test/coverage-test/vitest.config.ts Outdated Show resolved Hide resolved

packages/vitest/src/node/config.ts Show resolved Hide resolved

vojvodics mentioned this pull request Aug 5, 2023

allowExternal option for v8 coverage provider #3867

Closed

4 tasks

AriPerkkio changed the title ~~feat: add allowExternal option for coverage providers~~ feat(coverage): add allowExternal option Aug 6, 2023

AriPerkkio requested changes Aug 6, 2023

View reviewed changes

vojvodics added 2 commits August 12, 2023 12:28

Update docs

43438c6

Update tests to include external files

ee2ad69

AriPerkkio reviewed Aug 15, 2023

View reviewed changes

test/coverage-test/coverage-report-tests/generic.report.test.ts Show resolved Hide resolved

test/coverage-test/coverage-report-tests/generic.report.test.ts Outdated Show resolved Hide resolved

test/coverage-test/coverage-report-tests/generic.report.test.ts Show resolved Hide resolved

AriPerkkio added 3 commits August 15, 2023 19:13

test: update paths

4b4e4e8

test: update paths

43d6567

test: update paths

0ff798a

AriPerkkio force-pushed the feat/allow-external branch 2 times, most recently from 639830a to 5df6aa4 Compare August 16, 2023 16:01

test(coverage): option specific test setup

25cf08b

AriPerkkio force-pushed the feat/allow-external branch from 5df6aa4 to 25cf08b Compare August 16, 2023 16:06

AriPerkkio approved these changes Aug 16, 2023

View reviewed changes

AriPerkkio marked this pull request as ready for review August 16, 2023 16:40

sheremet-va merged commit c03faa2 into vitest-dev:main Aug 21, 2023

vojvodics deleted the feat/allow-external branch August 21, 2023 17:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Comments

feat(coverage): add `allowExternal` option#3894

feat(coverage): add `allowExternal` option#3894
sheremet-va merged 9 commits intovitest-dev:mainfrom
vojvodics:feat/allow-external

vojvodics commented Aug 5, 2023

Uh oh!

bolt-new-by-stackblitz bot commented Aug 5, 2023

Uh oh!

netlify bot commented Aug 5, 2023 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

AriPerkkio left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vojvodics commented Aug 15, 2023

Uh oh!

AriPerkkio commented Aug 15, 2023

Uh oh!

AriPerkkio left a comment

Uh oh!

Uh oh!

Comments

Conversation

vojvodics commented Aug 5, 2023

Description

Uh oh!

bolt-new-by-stackblitz bot commented Aug 5, 2023

Uh oh!

netlify bot commented Aug 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for fastidious-cascaron-4ded94 canceled.

Uh oh!

Uh oh!

Uh oh!

AriPerkkio left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vojvodics commented Aug 15, 2023

Uh oh!

AriPerkkio commented Aug 15, 2023

Uh oh!

AriPerkkio left a comment

Choose a reason for hiding this comment

Uh oh!

netlify bot commented Aug 5, 2023 •

edited

Loading