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

feat(runner): test context can inject values from the config's provide #6813

Merged
merged 3 commits into from
Nov 13, 2024

Conversation

sheremet-va
Copy link
Member

@sheremet-va sheremet-va commented Oct 29, 2024

Description

Continuation of #6253
Related to #6226

This PR allows defining a context value that can be overridden by the project config:

// vitest.workspace.ts
export default defineWorkspace([
  {
    test: {
      environment: 'jsdom',
      provide: {
        myValue: 'injected',
      },
    },
  },
  {
    test: {
      environment: 'node',
    },
  },
])
const test = baseTest.extend({
  myValue: ['default', { injected: true }]
})

test('some test', ({ myValue }) => {
  // for the jsdom environment
  expect(myValue).toBe('injected')
  // for the node environment
  expect(myValue).toBe('default')
})

TODO

  • Docs (add for passing down values between the config and tests + context's injected)

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 Oct 29, 2024

Deploy Preview for vitest-dev ready!

Name Link
🔨 Latest commit ea26860
🔍 Latest deploy log https://app.netlify.com/sites/vitest-dev/deploys/6734ce8016ba27000845622c
😎 Deploy Preview https://deploy-preview-6813--vitest-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@sheremet-va sheremet-va added this to the 2.2.0 milestone Oct 29, 2024
@sheremet-va sheremet-va merged commit 85c64e3 into vitest-dev:main Nov 13, 2024
15 of 17 checks passed
@sheremet-va sheremet-va deleted the feat/allow-inject-context branch November 13, 2024 16:20
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.

1 participant