Add a way to conditionally skip a test

[gajus]

Use case

When writing integrations tests, it is common that a subset of tests require some configuration to be present, e.g. database connection URI. It is desirable not to run tests when that configuration is not present.

Proposed implementation

I would like to be able to skip a test from a within the test itself, e.g.

test('authenticates using captcha', async (t) => {
  if (!process.env.CAPTCHA_SOLVE_ID) {
    return t.skip('CAPTCHA_SOLVE_ID is not configured');
  }

  const captchaSolver = createCaptchaSolver(process.env.CAPTCHA_SOLVE_ID);

  const error = await t.throwsAsync(createAuthenticationCookieJar(captchaSolver, '[email protected]', 'bar'));

  t.true(error instanceof AuthenticationError);
  t.is(error.message, 'Invalid email or password.');
});

[gajus]

Another way this can be solved in user-land is:

const main = () => {
  if (!process.env.CAPTCHA_SOLVE_ID) {
    test.todo('integration tests cannot run because process.env.CAPTCHA_SOLVE_ID is not configured');

    return;
  }

  test('authenticates using captcha', async (t) => {
    const captchaSolver = createCaptchaSolver(process.env.CAPTCHA_SOLVE_ID);

    const error = await t.throwsAsync(createAuthenticationCookieJar(captchaSolver, '[email protected]', 'bar'));

    t.true(error instanceof AuthenticationError);
    t.is(error.message, 'Invalid email or password.');
  });
};

main();

[sindresorhus]

I think this is a duplicate of #2010. I agree, something like this would be very useful.

[gajus]

You are right. It is duplicate. Sorry, missed the other issue. t.cancel suggestion makes sense too.