AAAパターンで実現するクリーンなテストコード

公開日2024.12.03

#エンジニア概念マップ
#テスト

エンジニア

Tsukamura

あなたは次のようなテストコードを見たことはありませんか？

test('商品追加のテスト', () => {
  const cart = new ShoppingCart();
  expect(cart.getTotal()).toBe(0);
  cart.addItem('apple', 100);
  expect(cart.getTotal()).toBe(100);
  cart.addItem('banana', 150);
  expect(cart.getTotal()).toBe(250);
});

一見問題なさそうに見えるこのテストコード。しかし、このような書き方には実は大きな問題が潜んでいます。今回は、テストコードを整理するための重要な考え方「AAAパターン」について解説します。

AAAパターンとは？
悪い例と良い例で学ぶAAAパターン
悪い例：フェーズが混在したテストコード
良い例：AAAパターンを適用したテストコード
AAAパターンを実践するためのTips
1. コメントでフェーズを区切る
2. 空行でフェーズを視覚的に分ける
3. 各フェーズの役割を意識する
AAAパターン採用のメリット
まとめ

AAAパターンとは？

AAAパターンは、テストコードを以下の3つのフェーズに分けて構造化する手法です。

Arrange（準備）：テストに必要な前提条件を整える
Act（実行）：テスト対象の機能を実行する
Assert（確認）：期待する結果が得られたかを検証する

この3つのフェーズを明確に分けることで、テストの意図がクリアになり、保守性が大幅に向上します。

悪い例と良い例で学ぶAAAパターン

悪い例：フェーズが混在したテストコード

test('商品追加時の合計金額テスト', () => {
  const cart = new ShoppingCart();
  expect(cart.getTotal()).toBe(0);     // 準備と確認が混在
  cart.addItem('apple', 100);          // 実行
  expect(cart.getTotal()).toBe(100);   // 確認
  cart.addItem('banana', 150);         // また実行
  expect(cart.getTotal()).toBe(250);   // さらに確認
});

このコードの問題点

各フェーズの境界が不明確
複数の動作を一度にテストしている
テストが失敗した際の原因特定が困難

良い例：AAAパターンを適用したテストコード

test('商品追加時の合計金額が正しく計算されること', () => {
  // Arrange（準備）
  const cart = new ShoppingCart();
  const testItems = [
    { item: 'apple', price: 100 },
    { item: 'banana', price: 150 }
  ];
  const expectedTotal = 250;

  // Act（実行）
  testItems.forEach(({ item, price }) => {
    cart.addItem(item, price);
  });
  const actualTotal = cart.getTotal();

  // Assert（確認）
  expect(actualTotal).toBe(expectedTotal);
});

改善された点

テストの各フェーズが明確に分離されている
テストの意図が理解しやすい
期待値と実際の値の比較が1か所にまとまっている
デバッグが容易

AAAパターンを実践するためのTips

1. コメントでフェーズを区切る

// Arrange
// Act
// Assert

2. 空行でフェーズを視覚的に分ける

// Arrange
const service = new Service();
const input = 'test';

// Act
const result = service.process(input);

// Assert
expect(result).toBe('TEST');