テストのフィルタリング

スイートとテストのフィルタリング、タイムアウト設定、スイートとテストの並列実行について説明します。

CLI

CLI を使用すると、ファイル名でテストをフィルタリングできます。

$ vitest basic

この例では、ファイル名にbasicを含むテストファイルのみが実行されます。以下に例を示します。

basic.test.ts
basic-foo.test.ts
basic/foo.test.ts

タイムアウトの設定

テストのタイムアウトは、テスト関数の第 3 引数にミリ秒単位で指定できます。デフォルト値は 5 秒です。

import { test } from 'vitest';

test('name', async () => {
  /* ... */
}, 1000);

beforeAllなどのフックでもタイムアウトを設定できます。デフォルト値はテストと同様に 5 秒です。

import { beforeAll } from 'vitest';

beforeAll(async () => {
  /* ... */
}, 1000);

スイートとテストのスキップ

特定のスイートまたはテストの実行をスキップするには、.skipを使用します。

import { assert, describe, it } from 'vitest';

describe.skip('skipped suite', () => {
  it('test', () => {
    // スイートがスキップされるため、エラーは発生しません
    assert.equal(Math.sqrt(4), 3);
  });
});

describe('suite', () => {
  it.skip('skipped test', () => {
    // テストがスキップされるため、エラーは発生しません
    assert.equal(Math.sqrt(4), 3);
  });
});

特定のスイートとテストの実行

特定のスイートやテストのみを実行するには、.onlyを使用します。

import { assert, describe, it } from 'vitest';

// このスイート（および`.only`が指定された他のスイート）のみが実行されます
describe.only('suite', () => {
  it('test', () => {
    assert.equal(Math.sqrt(4), 3);
  });
});

describe('another suite', () => {
  it('skipped test', () => {
    // 他のテストに`.only`が指定されているため、このテストはスキップされます
    assert.equal(Math.sqrt(4), 3);
  });

  it.only('test', () => {
    // このテスト（および`.only`が指定された他のテスト）のみが実行されます
    assert.equal(Math.sqrt(4), 2);
  });
});

未実装のスイートとテスト

将来実装する予定のスイートやテストのプレースホルダーとして、.todoを使用します。.todoでマークされたスイートとテストは、レポートに未実装項目として表示されます。

import { describe, it } from 'vitest';

// このスイートは未実装としてレポートに表示されます
describe.todo('unimplemented suite');

// このテストは未実装としてレポートに表示されます
describe('suite', () => {
  it.todo('unimplemented test');
});