Dart テスト基礎

このスキルを使用する場面

以下の場合にこのスキルを使用します:

• 新しいテストファイルを作成する
• groupでテストスイートを構造化する
• dart_test.yamlを通じてテスト実行を設定する
• テストのライフサイクルメソッドを理解する

発見

テスト構造の改善候補を見つけるには:

try-finallyクリーンアップ

addTearDownの代わりにtry-finallyを使用してクリーンアップしているテストを検索:

• Regex: \bfinally\s*\{ (テスト内のリソースクリーンアップに使用されているかを確認)

コア概念

1. テスト構造 (testとgroup)

• test: テストの基本単位です。

  test('description', () {
    // assertions
  });
  

• group: テストを論理的なブロックに整理するために使用します。

  • グループはネストできます。
  • 説明は連結されます (例: "Group Description Test Description")。
  • setUpとtearDown呼び出しのスコープを設定するのに役立ちます。
  • 命名: クラス名に対応するグループにはPascalCaseを使用します (例: group('MyClient', ...))。
  • 単一グループを避ける: ファイル内のすべてのテストを単一のgroup呼び出しでラップしないでください (唯一のグループの場合)。
    • 注意: 明示的に要求されない限り、あなたが作成していない既存コードのクリーンアップ時にグループを削除しないでください。これはDIFFに大きな変動をもたらし、ほとんどのエンジニアが望まないものです。

• テストの命名 test('test name here',:

  • 冗長な「test」プレフィックスを避けます。代わりにgroupを使用します。
  • 説明に期待される動作または結果を含めます (例: 'throws StateError'または'adds API key to URL')。
  • 説明は、グループ名と連結したときに読みやすいようにしてください。

• 名前付きパラメータの配置:

  • testとgroup呼び出しの場合、名前付きパラメータ (例: testOn, timeout, skip) を説明文の直後、コールバッククロージャの前に配置します。これにより、テストロジックを最後に保つことで読みやすさが向上します。

    test('description', testOn: 'vm', () {
      // assertions
    });
    

2. ライフサイクルメソッド (setUp, tearDown)

• setUp: 現在のgroup内のすべてのtestの前に実行されます (ネストされたグループを含む)。
• tearDown: 現在のgroup内のすべてのtestの後に実行されます。
• setUpAll: グループ内の最初のテストの前に一度だけ実行されます。
• tearDownAll: グループ内のすべてのテストの後に一度だけ実行されます。

ベストプラクティス:

• テスト分離を保証するため、状態のリセットにsetUpを使用します。
• リセットなしでテスト間でミュータブルな状態を共有しないようにします。

3. リソースのクリーンアップ

• test本体内で作成されたリソースをクリーンアップするには、try-finallyブロックの代わりにaddTearDownの使用を検討してください。

避ける:

test('can create and delete a file', () {
  final file = File('temp.txt');
  try {
    file.writeAsStringSync('hello');
    expect(file.readAsStringSync(), 'hello');
  } finally {
    if (file.existsSync()) file.deleteSync();
  }
});

推奨:

test('can create and delete a file', () {
  final file = File('temp.txt');
  // リソース作成の直後にティアダウンを登録
  addTearDown(() {
    if (file.existsSync()) file.deleteSync();
  });

  file.writeAsStringSync('hello');
  expect(file.readAsStringSync(), 'hello');
});

4. 設定 (dart_test.yaml)

dart_test.yamlファイルはテストランナーを設定します。一般的な設定は以下の通りです:

プラットフォーム

テストが実行される場所を定義します (vm, chrome, node)。

platforms:
  - vm
  - chrome

タグ

テストを分類して、特定のサブセットを実行します。

tags:
  integration:
    timeout: 2x

コード内での使用:

@Tags(['integration'])
import 'package:test/test.dart';

タグの実行: dart test --tags integration

タイムアウト

テストのデフォルトタイムアウトを設定します。

timeouts:
  2x # デフォルトタイムアウトの2倍

5. ファイル命名

• テストファイルは_test.dartで終わる必要があり、テストランナーに認識されます。
• test/ディレクトリにテストを配置します。

一般的なコマンド

• dart test: すべてのテストを実行します。
• dart test test/path/to/file_test.dart: 特定のファイルを実行します。
• dart test --name "substring": 説明に一致するテストを実行します。

関連スキル

dart-test-fundamentalsはテストの構造化と設定のためのコアスキルです。これらのテスト内でアサーションを書くには、以下を参照してください:

• dart-matcher-best-practices: プロジェクトが従来のpackage:matcher(expect呼び出し)を使用している場合に使用します。
• dart-checks-migration: プロジェクトが最新のpackage:checks(check呼び出し)に移行している場合に使用します。