【TypeScript】効率的なテスト戦略 - Jest & Testing Library活用

概要

TypeScriptプロジェクトでは、コードの品質と保守性を確保するためにテストが不可欠です。本記事では、TypeScriptで効率的なテスト戦略を構築するために、JestとTesting Libraryを活用した方法について解説します。Jestは、JavaScript/TypeScript向けのテストフレームワークであり、Testing LibraryはReactなどのUIコンポーネントのテストに特化したツールです。この記事では、ユニットテスト、コンポーネントテスト、エンドツーエンドテストの実践方法を紹介します。

Jestの基礎とセットアップ

Jestの基本

Jestは、Facebookによって開発されたJavaScript向けのテストフレームワークです。テスト実行のスピードが速く、シンプルな設定で始められることから、TypeScriptプロジェクトに最適です。特徴としては、次の3つが挙げられます。

• 設定が容易
  基本的にインストールするだけで簡単にテストが始められる。
• モック機能が充実
  モジュールや関数のモック（偽物）を簡単に作成し、依存性を切り離したテストが可能。
• 豊富なアサーション
  expect()を使用して直感的なアサーションが可能。

Jestのセットアップ

TypeScriptでJestをセットアップする手順は以下のとおりです。

1. Jestと関連パッケージをインストール

   npm install --save-dev jest ts-jest @types/jest

2. Jestの設定ファイルを作成 jest.config.jsを作成し、TypeScriptのサポートを有効にします。

   module.exports = {
     preset: 'ts-jest',
     testEnvironment: 'node',
     moduleFileExtensions: ['ts', 'js'],
     testMatch: ['/__tests__//*.test.ts'],
   };

3. テストの実行
   コマンドラインから次のコマンドでテストを実行できます。

   npx jest

Testing Libraryの導入と役割

Testing Libraryは、ReactやVueなどのUIライブラリでコンポーネントのテストをサポートするツールです。DOMの状態やユーザー操作をエミュレートすることで、UIコンポーネントが期待通りに動作するかを確認するのに適しています。ユーザー視点での操作に重きを置いたテストが可能なため、ユーザーフレンドリーなテストを書くことができます。

Testing Libraryのセットアップ

Reactと組み合わせて使用する例を紹介します。以下のようにインストールすることで、Testing Libraryを簡単に導入できます。

npm install --save-dev @testing-library/react @testing-library/jest-dom

ユニットテストの実装例

ユニットテストは、関数やクラスなどの小さな単位をテストするもので、ビジネスロジックが正しく機能しているかを確認するために使用します。TypeScriptでのユニットテストは、型サポートにより型エラーも事前に検出可能です。

サンプルユニットテスト

次に、計算機の加算機能をユニットテストする例です。

// calculator.ts
export function add(a: number, b: number): number {
  return a + b;
}

// calculator.test.ts
import { add } from './calculator';
describe('Calculator', () => {
  test('2 + 3 equals 5', () => {
    expect(add(2, 3)).toBe(5);
  });
  test('0 + 0 equals 0', () => {
    expect(add(0, 0)).toBe(0);
  });
});

describeブロックでテストのグループを定義し、test関数で個別のテストケースを記述します。expect関数によりアサーションを行い、テストが期待通りに動作することを確認します。

コンポーネントテストの実装例

コンポーネントテストは、UIコンポーネントが正しくレンダリングされ、ユーザーインタラクションに対して期待通りに動作するかを確認するテストです。Testing Libraryの機能を使用することで、DOM操作やユーザーイベントを再現し、コンポーネントの状態をテストします。

Reactコンポーネントのテスト例

以下は、Testing Libraryを用いたReactコンポーネントのテスト例です。

// Button.tsx
import React from 'react';
type ButtonProps = {
  onClick: () => void;
  label: string;
};
export const Button: React.FC<ButtonProps> = ({ onClick, label }) => (
  <button onClick={onClick}>{label}</button>
);

// Button.test.tsx
import React from 'react';
import { render, screen, fireEvent } from '@testing-library/react';
import '@testing-library/jest-dom';
import { Button } from './Button';
describe('Button component', () => {
  test('renders button with label', () => {
    render(<Button onClick={() => {}} label="Click me" />);
    expect(screen.getByText('Click me')).toBeInTheDocument();
  });
  test('calls onClick handler when clicked', () => {
    const onClickMock = jest.fn();
    render(<Button onClick={onClickMock} label="Click me" />);
    fireEvent.click(screen.getByText('Click me'));
    expect(onClickMock).toHaveBeenCalledTimes(1);
  });
});

1つ目のテストケースでは、ボタンが正しくレンダリングされ、labelが表示されているかを確認しています。2つ目のテストケースでは、ユーザーがボタンをクリックした際にonClickハンドラーが呼び出されることを検証しています。fireEventを使うことで、ユーザーインタラクションをシミュレーションできます。

エンドツーエンドテストの導入

エンドツーエンド（E2E）テストは、アプリケーション全体の動作をユーザー視点で検証するためのテストです。TypeScriptとJest、Testing Libraryを組み合わせて、E2Eテストを導入することで、ユーザーシナリオに沿ったテストが可能です。例えば、ログインフローやデータ登録など、ユーザーの一連の操作が期待通りに動作するかを確認します。

エンドツーエンドテ

スト例 ここでは、ユーザーがページにアクセスして情報を入力するE2Eテストの例を示します。Testing LibraryのuserEventを使用して、フォーム入力のシナリオを検証します。

// LoginForm.test.tsx
import React from 'react';
import { render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import '@testing-library/jest-dom';
import { LoginForm } from './LoginForm';
describe('Login Form', () => {
  test('allows the user to submit the form after filling it out', async () => {
    render(<LoginForm />);
    const emailInput = screen.getByLabelText(/email/i);
    const passwordInput = screen.getByLabelText(/password/i);
    const submitButton = screen.getByRole('button', { name: /submit/i });
    await userEvent.type(emailInput, 'user@example.com');
    await userEvent.type(passwordInput, 'password123');
    userEvent.click(submitButton);
    expect(await screen.findByText(/welcome/i)).toBeInTheDocument();
  });
});

この例では、userEventを使用してフォームにデータを入力し、送信ボタンをクリックする操作をエミュレートしています。その後、画面に表示される期待値を確認して、シナリオ全体が正しく動作しているかを検証しています。

まとめ

TypeScriptプロジェクトにおける効率的なテスト戦略は、Jestを基盤としたユニットテスト、Testing Libraryを活用したコンポーネントテスト、エンドツーエンドテストの3段階で構築されます。これにより、各層でコードの品質を高め、ユーザー目線のテストが可能です。TypeScriptの型サポートと組み合わせることで、堅牢で信頼性の高いテストを構築でき、プロジェクトの成長に伴う保守コストも削減されるでしょう。