Feature request: test.skipIf(condition, name, test)

[relekang]

First of all thanks for making Jest 🙌

Do you want to request a feature or report a bug?
Request a feature. I will be happy to help out to make this happen if the feature is wanted.

What is the current behavior?
To skip test dynamically based on dynamic properties like the environment tests are running in it is necessary to wrap the body of the test or the whole test in an if statement. See example below from the jest codebase:

it('supports unix separators', () => {
  if (process.platform !== 'win32') {
    const path = '/path/to/__tests__/test.js';
    expect(searchSource.isTestFilePath(path)).toEqual(true);
  }
});

What is the expected behavior?
Would it be nice to be able to do it.skipIf(condition, name, test) and test.skipIf(condition, name, test)? That way the test report will show the tests as skipped instead of successful and it will be easier to detect if a skip condition is wrong.

it.skipIf(process.platform !== 'win32', 'supports unix separators', () => {
  const path = '/path/to/__tests__/test.js';
  expect(searchSource.isTestFilePath(path)).toEqual(true);
});

Please provide your exact Jest configuration and mention your Jest, node, yarn/npm version and operating system.
Node v7.7.2, Jest v20.0.4, Yarn v0.24.5, no extra jest configuration

[cpojer]

I don't think we'll support this for now as it doesn't seem like a necessary core feature. There is nothing that stops you from building your own wrapper for this feature, though :)

[relekang]

Will look into that, thanks for the quick response 🙂

[relekang]

If anyone stumbles over the issue looking for the same thing. I ended up with skip-if.

[kodikos]

Here is a simple pattern for the odd one-off occasion

const testIfCondition = mySkipCondition ? test.skip : test;
describe('Conditional Test', () => {
  testIfCondition('Only test on condition', () => {
    ...
  });
});

[roonyh]

Can't figure out how to do this for asynchronous tests :(

My skip condition is only available inside an asynchronous callback.

[kodikos]

Hi roonyh. Off the top of my head, the above would be something like:

whateverYourAsyncThingIs()
.then((values) => {
  return mySkipConditionBasedOnValues ? test.skip : test;
}).then((testIfCondition) => {
  describe('Conditional Test', () => {
    testIfCondition('Only test on condition', () => {
      ...
    });
  });
})

[roonyh]

Hi, Unfortunately that does not work. tests defined inside callbacks are not picked up by the runner.

[SimenB]

Tests have to be defined synchronously. https://jestjs.io/docs/en/troubleshooting.html#defining-tests

[roonyh]

@SimenB Ah. I figured this out, but could not find it documented. Thanks for pointing to it.

[SimenB]

You can do async work in globalSetup, but we currently do not have a good way of sharing stuff from globalSetup with tests. You can follow that in #7184

[dandv]

This is a dupe of #7245, (it's newer but has a lot more comments), which shows the demand for this feature.

@kodikos's workaround breaks IDEs, which won't recognize individual tests any more. Reposting a screenshot from the other issue, where the same workaround was suggeted:

[FabianoLothor]

I would have liked to saw this feature implemented.

[ronny1982]

Here is what i'm doing:

(process.platform === 'linux' ? it : it.skip)('should test linux code only', () => {
    // this test will run on linux and be skipped on all others ...
});

Can also be used for e.g. file scopes:

// assign the global `it` method based on platform
it = (process.platform === 'linux' ? it : it.skip);

// or even the global `describe` method based on platform
describe = (process.platform === 'linux' ? describe : describe.skip);

[pxmage]

this is my way of achieving this

export const itif = (name: string, condition: () => boolean, cb) => {
  it(name, (done) => {
    if(condition()) {
      cb(done)
    } else {
      console.warn(`[skipped]: ${name}`)
      done();
    }
  })
}

I created a helper function itif, then I can use it in this way:

      itif('should check this just registered user', () => user !== undefined, (done) => {
           // you test code
      })

in the above example, the user is a variable assigned by test cases before this one asynchronously.

PS: I ignored the timeout argument, you can add it if you need it.

[qmenoret]

If anyone is interested, we wrote a small extension to Jest to allow to select the OS to run the tests on nicely: https://www.npmjs.com/package/jest-os-detection 🙂

[github-actions]

This issue 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.