詳細ガイド
テスト

コンポーネントハーネスの概要

コンポーネントハーネスは、テストがサポートされているAPIを介してエンドユーザーと同じ方法でコンポーネントと対話できるようにするクラスです。小さな再利用可能なウィジェットからフルページまで、あらゆるコンポーネントのテストハーネスを作成できます。

ハーネスにはいくつかの利点があります:

  • コンポーネントのDOM構造などの実装詳細から自身を隔離することで、テストの脆さを軽減します
  • テストの可読性を高め、保守を容易にします
  • 複数のテスト環境で使用できます
      
// Example of test with a harness for a component called MyButtonComponentit('should load button with exact text', async () => {  const button = await loader.getHarness(MyButtonComponentHarness);  expect(await button.getText()).toBe('Confirm');});

コンポーネントハーネスは、共有UIウィジェットに特に役立ちます。開発者は、DOM構造やCSSクラスなど、ウィジェットのプライベートな実装詳細に依存するテストを記述することがよくあります。これらの依存関係はテストを脆くし、保守を困難にします。ハーネスは代替手段を提供します。それは、エンドユーザーと同じ方法でウィジェットと対話するサポートされたAPIです。ウィジェットの実装変更がユーザーテストを壊す可能性は低くなります。例えば、Angular Materialは、ライブラリ内の各コンポーネントにテストハーネスを提供しています。

コンポーネントハーネスは複数のテスト環境をサポートしています。同じハーネス実装をユニットテストとエンドツーエンドテストの両方で使用できます。テスト作成者は1つのAPIを学ぶだけでよく、コンポーネント作成者は個別のユニットテストとエンドツーエンドテストの実装を保守する必要がありません。

多くの開発者は、以下の開発者タイプカテゴリーのいずれかに分類できます: テスト作成者、コンポーネントハーネス作成者、ハーネス環境作成者。以下の表を使用して、これらのカテゴリーに基づいてこのガイドの最も関連性の高いセクションを見つけてください:

開発者タイプ 説明 関連セクション
テスト作成者 他の誰かが作成したコンポーネントハーネスを使用してアプリケーションをテストする開発者。例えば、サードパーティのメニューコンポーネントを使用し、ユニットテストでそのメニューと対話する必要があるアプリケーション開発者などがこれに該当します。 テストでのコンポーネントハーネスの使用
コンポーネントハーネス作成者 再利用可能なAngularコンポーネントを保守し、ユーザーがテストで使用するためのテストハーネスを作成したい開発者。例えば、サードパーティのAngularコンポーネントライブラリの作成者や、大規模なAngularアプリケーション向けに共通コンポーネントのセットを保守する開発者などがこれに該当します。 コンポーネントハーネスの作成
ハーネス環境作成者 追加のテスト環境でコンポーネントハーネスを使用するためのサポートを追加したい開発者。すぐに利用できるサポートされているテスト環境については、テストハーネス環境とローダーを参照してください。 テスト環境にハーネスサポートを追加する

完全なAPIリファレンスについては、Angular CDKのコンポーネントハーネスAPIリファレンスページを参照してください。