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

Allow to pass findRelatedTests and nonFlagArgs to updateConfigAndRun #10659

Merged
merged 4 commits into from
Oct 23, 2020

Conversation

wclr
Copy link
Contributor

@wclr wclr commented Oct 20, 2020

Summary

Allow to pass findRelatedTests and nonFlagArgs to updateConfigAndRun
This is a need to make possible runtime changes of config to filter running tests based on for example FS watching events (in watch plugin).

Example of the plugin that makes jest run only tests related to a changed file.

const chokidar = require('chokidar')

let updateConfigAndRun
let lastFileChanged

chokidar
  .watch('.', {
    ignored: /node_modules|\.tmp/,
  })
  .on('change', (f) => {
    lastFileChanged = f
  })

class RelatedWatchPlugin {
  apply(jestHooks) {
    jestHooks.onFileChange((x, f) => {
      if (updateConfigAndRun && lastFileChanged) {
        updateConfigAndRun({
          findRelatedTests: true,
          testPathPattern: lastFileChanged,
          nonFlagArgs: [lastFileChanged], // without setting nonFlagArgs it doesn't work
        })
        lastFileChanged = undefined
      }
    })

    jestHooks.shouldRunTestSuite((testSuiteInfo) => {
      if (!updateConfigAndRun) {
        // skip running test until enabled
        return false
      }
      return true
    })
  }
  getUsageInfo(gConfig) {
    return {
      key: 'n',
      prompt:
        (updateConfigAndRun ? 'disable' : 'enabled') +
        ' running related to fs changed files',
    }
  }
  run(_, updateAndRun) {
    updateConfigAndRun = updateConfigAndRun ? undefined : updateAndRun
    return Promise.resolve(false)
  }
}

Test plan

jest-core/__tests__/watch.test.js updated to check if options pass.

@facebook-github-bot
Copy link
Contributor

Hi @whitecolor!

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file.

In order for us to review and merge your code, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

Copy link
Member

@SimenB SimenB left a comment

Choose a reason for hiding this comment

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

Can you add a changelog entry?

Also, and example watch plugin? Just so I understand the use case 🙂

@wclr
Copy link
Contributor Author

wclr commented Oct 20, 2020

@SimenB Added changelog entry and plugin example in PR desc.

Copy link
Member

@SimenB SimenB left a comment

Choose a reason for hiding this comment

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

thanks!

@SimenB SimenB changed the title Allow to pass findRelatedTests and nonFlagArgs to updateConfigAndRun Allow to pass findRelatedTests and nonFlagArgs to updateConfigAndRun Oct 23, 2020
@SimenB SimenB merged commit 1535af7 into jestjs:master Oct 23, 2020
This was referenced Mar 15, 2021
@github-actions
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 11, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants