Pass options to specific tests/suites in order to overwrite configuration throughout test/suite

[jennifer-shehane]

Current behavior:

Currently you can change the configuration within tests mainly be setting Cypress.config(). This will change the configuration for the duration of the entirety of tests. Sometimes you just want configuration set for the current block of test/suite.

Furthermore, in order to filter certain tests/suites by the browser we're running in, we have to use Cypress.isBrowser() to do kinda of strange filters like below:

const runOn = (browser, fn) => {
  if (Cypress.isBrowser(browser)) {
    fn()
  }
}

const ignoreOn = (browser, fn) => {
  if (!Cypress.isBrowser(browser)) {
    fn()
  }
}

// Run happy path tests if Cypress is run via Firefox
runOn('firefox', () => {
  describe('happy path suite', () => {
    it('...')
    it('...')
    it('...')
  })
})

Desired behavior:

• users can add test configuration in object during test/suite declaration:

it('can test with config', {
    defaultCommandTimeout: 200
  }, () => {
    // test body
  })

• run test only in certain browsers:

it('only runs in ff', {
    browser: 'firefox'
  }, () => {
  })

• api for excluding browsers:

it('does not run in ff', {
    browser: '!firefox'
  }, () => {})

• can apply same options for the whole suite:

describe('suite with config', {
    defaultCommandTimeout: 40
  }, () => {
	// all tests declared here will inherit the config
  })

Versions

4.5.0

[cypress-bot]

The code for this is done in cypress-io/cypress#5346, but has yet to be released.
We'll update this issue and reference the changelog when it's released.

[cypress-bot]

Released in 4.8.0.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v4.8.0, please open a new issue.