Jestでテストをスキップする高度なテクニック：fdescribe、fit、環境変数、カスタムランナーを活用

2024-05-23

Jest でテストファイルを1つスキップする方法

describe.skip メソッドは、テストスイート全体をスキップするために使用されます。テストスイートには、1 つ以上の test 関数が含まれる describe ブロックが含まれます。

describe('Describe block to be skipped', () => {
  test('Test case 1', () => {
    // ...
  });

  test('Test case 2', () => {
    // ...
  });
});

上記の例では、Describe block to be skipped テストスイート全体がスキップされます。

test.skip メソッドは、個々のテストケースをスキップするために使用されます。

describe('Describe block', () => {
  test('Test case 1', () => {
    // ...
  });

  test.skip('Test case 2 to be skipped', () => {
    // ...
  });

  test('Test case 3', () => {
    // ...
  });
});

理由

テストをスキップする理由はいくつかあります。

テストがまだ未完了で、後で実装する予定がある場合
テストが現在失敗しており、修正する時間がない場合
特定の環境でのみ実行する必要があるテストをスキップする場合
処理速度が遅いテストをスキップして、テストスイートの実行時間を短縮する場合

fdescribe と fit メソッドを使用して、特定のテストスイートまたはテストケースに焦点を合わせることができます。
--only フラグを使用して、Jest コマンドラインから特定のテストスイートまたはテストケースのみを実行できます。

これらのオプションの詳細については、Jest ドキュメントを参照してください。

Jest でテストをスキップすることは、テストスイートを整理し、特定のテストに焦点を合わせ、実行時間を短縮するのに役立つ便利な機能です。describe.skip と test.skip メソッドを使用して、テストを簡単にスキップできます。

Jest でテストをスキップするサンプルコード

describe.skip を使用する

// describe.skip を使ってテストスイート全体をスキップ
describe.skip('Describe block to be skipped', () => {
  test('Test case 1', () => {
    // このテストは実行されない
    expect(1).toBe(2);
  });

  test('Test case 2', () => {
    // このテストも実行されない
    expect(true).toBe(false);
  });
});

// 実行されるテストスイート
describe('Describe block to be executed', () => {
  test('Test case 3', () => {
    // このテストは実行される
    expect(3).toBe(3);
  });

  test('Test case 4', () => {
    // このテストも実行される
    expect('hello').toBe('hello');
  });
});

describe('Describe block', () => {
  test('Test case 1', () => {
    // このテストは実行される
    expect(1 + 1).toBe(2);
  });

  test.skip('Test case 2 to be skipped', () => {
    // このテストはスキップされる
    expect(10 * 2).toBe(21); // これは失敗するはず
  });

  test('Test case 3', () => {
    // このテストは実行される
    expect('JavaScript').toBe('JavaScript');
  });
});

理由とオプション

上記の例では、describe.skip を使用してテストスイート全体をスキップし、test.skip を使用して個々のテストケースをスキップしています。テストをスキップする理由は、前述のとおりです。

Jest には、テストをスキップする他にも、テストをフォーカスしたり、特定の条件下でのみ実行したりするなど、さまざまなオプションが用意されています。これらのオプションの詳細については、Jest ドキュメントを参照してください。

Jest でテストをスキップするその他の方法

fdescribe と fit は、Jest 20.0.0 で導入された新しいフラグであり、describe と it ブロックをよりきめ細かく制御するのに役立ちます。

fdescribe: 特定の describe ブロックとその内部のすべてのテストに焦点を合わせます。他の describe ブロックはスキップされます。
fit: 特定の it テストケースに焦点を合わせます。他のテストケースはスキップされます。

例:

fdescribe('Focused describe block', () => {
  fit('Focused test case', () => {
    // このテストのみが実行される
    expect(true).toBe(true);
  });

  test('Other test case', () => {
    // このテストはスキップされる
    expect(false).toBe(true);
  });
});

describe('Another describe block', () => {
  test('Test case 1', () => {
    // このテストはスキップされる
    expect(1).toBe(2);
  });

  test('Test case 2', () => {
    // このテストはスキップされる
    expect('Hello').toBe('World');
  });
});

利点:

describe.skip と test.skip よりも記述的で明確なコードになります。
複数のテストに焦点を合わせたり、ネストされた describe ブロックを制御したりするのに役立ちます。

注意点:

Jest 20.0.0 以降が必要です。

環境変数を使用する

Jest は、テストの実行を制御するために使用できる環境変数をいくつか提供しています。

JEST_SKIP: この変数が true に設定されている場合、すべてのテストがスキップされます。
JEST_SKIP_DESCRIBE: この変数がカンマ区切りの名前のリストに設定されている場合、一致する名前を持つすべての describe ブロックがスキップされます。

# すべてのテストをスキップ
JEST_SKIP=true jest

# 特定の describe ブロックをスキップ
JEST_SKIP_DESCRIBE="MyDescribeBlock, AnotherDescribeBlock" jest

# 特定のテストケースをスキップ
JEST_SKIP_IT="myTestCase, anotherTestCase" jest

テストの実行をコマンドラインから簡単に制御できます。
CI/CD パイプラインなどで動的にテストをスキップするのに役立ちます。

テストコードを汚染する可能性があります。
環境変数の設定方法に注意する必要があります。

beforeEach フックを使用して、テストが実行される前に条件をチェックし、スキップするかどうかを決定できます。

describe('Describe block', () => {
  beforeEach(() => {
    if (someCondition) {
      // テストをスキップ
      jest.skip();
    }
  });

  test('Test case 1', () => {
    // ...
  });

  test('Test case 2', () => {
    // ...
  });
});