🧱 Jest 개념 정리 - 파라미터화 테스트(test.each() & describe.each())

원문 참고: DaleSeo 블로그 - Jest로 파라미터화 테스트하기

---

🎯 개요

테스트 코드를 작성하다 보면 입력값만 다른 동일한 테스트 코드가 반복되는 경우가 많습니다.
이때 Jest의 test.each()와 describe.each()를 이용하면 반복되는 코드를 제거하고,
데이터 기반(데이터 드리븐) 테스트를 간결하게 작성할 수 있습니다.

---

1️⃣ test.each — 하나의 테스트를 여러 데이터로 반복

📘 예시: 덧셈 함수

// add.js
export const add = (a, b) => a + b;

// add.test.js
import { add } from './add';

test.each([
  [1, 2, 3],
  [2, 2, 4],
  [10, -5, 5],
])('add(%i, %i) = %i', (a, b, expected) => {
  expect(add(a, b)).toBe(expected);
});

✅ 특징

• 2차원 배열로 입력값을 나열해 한 번에 여러 테스트 수행
• %i, %s, %p 등의 포맷 문자열을 통해 테스트 이름에 데이터 삽입 가능
• it.each() 도 동일하게 동작 (test의 alias)

📈 출력 예시

✓ add(1, 2) = 3
✓ add(2, 2) = 4
✓ add(10, -5) = 5

---

2️⃣ describe.each — 여러 테스트(it)를 데이터 세트별로 반복

📘 예시: 인사말 생성 함수

// greet.js
export function greet(name, { upper = false, prefix = '' } = {}) {
  let msg = `${prefix}${name}`;
  return upper ? msg.toUpperCase() : msg;
}

// greet.test.js
import { greet } from './greet';

describe.each([
  ['기본',           { upper: false, prefix: '' }],
  ['대문자 옵션',     { upper: true,  prefix: '' }],
  ['접두사 옵션',     { upper: false, prefix: 'Mr. ' }],
])('greet 옵션: %s', (_label, options) => {
  it('이름을 포함해야 한다', () => {
    const out = greet('kim', options);
    expect(out).toEqual(expect.stringContaining('kim'));
  });

  it('대문자 옵션을 반영한다', () => {
    const out = greet('kim', options);
    const isUpper = out === out.toUpperCase();
    expect(isUpper).toBe(Boolean(options.upper));
  });

  it('접두사 옵션을 반영한다', () => {
    const out = greet('kim', options);
    expect(out).toEqual(expect.stringContaining(options.prefix));
  });
});

✅ 특징

• 테스트 그룹 전체(describe 블록) 를 데이터별로 반복 실행
• 동일한 로직을 환경/옵션/설정 세트마다 반복 검증할 때 유용

📈 출력 예시

 PASS  ./greet.test.js
  greet 옵션: 기본
    ✓ 이름을 포함해야 한다
    ✓ 대문자 옵션을 반영한다
    ✓ 접두사 옵션을 반영한다
  greet 옵션: 대문자 옵션
    ✓ 이름을 포함해야 한다
    ✓ 대문자 옵션을 반영한다
    ✓ 접두사 옵션을 반영한다
  greet 옵션: 접두사 옵션
    ✓ 이름을 포함해야 한다
    ✓ 대문자 옵션을 반영한다
    ✓ 접두사 옵션을 반영한다

---

3️⃣ 템플릿 리터럴 표기법

Jest는 배열 외에도 표 형태의 데이터 입력을 지원합니다.

test.each`
  a    | b    | expected
  ${1} | ${2} | ${3}
  ${2} | ${2} | ${4}
  ${5} | ${-2}| ${3}
`('add($a, $b) = $expected', ({ a, b, expected }) => {
  expect(add(a, b)).toBe(expected);
});

가독성이 높고, 테이블 형태의 데이터가 한눈에 들어옵니다.

---

4️⃣ test.each vs describe.each 비교

구분	반복 단위	용도	장점	예시
test.each	개별 테스트	한 함수의 입력값 반복	단순하고 빠름	add(a,b)
describe.each	테스트 그룹	여러 테스트를 환경별로 반복	before/after 훅 사용 가능	옵션, DB 환경별 테스트

선택 가이드

• “같은 동작을 여러 데이터로 검증” → test.each
• “환경/옵션에 따라 동작이 달라지는 그룹 테스트” → describe.each

---

5️⃣ describe.each의 before/after 훅 사용

describe.each는 데이터 세트마다 독립된 describe 블록을 생성하기 때문에,
각 블록 내에서 beforeAll, afterAll, beforeEach, afterEach 훅을 사용할 수 있습니다.

📘 예시: DB 환경별 테스트

describe.each([
  ['MySQL', { host: 'localhost', port: 3306 }],
  ['PostgreSQL', { host: 'localhost', port: 5432 }],
])('DB 연결 테스트: %s', (dbName, config) => {
  beforeAll(() => {
    console.log(`${dbName} 연결 시작`);
    // connectToDB(config)
  });

  afterAll(() => {
    console.log(`${dbName} 연결 해제`);
    // disconnectFromDB()
  });

  test('연결 성공 여부 확인', () => {
    expect(true).toBe(true); // 실제론 DB 연결 테스트
  });

  test('쿼리 실행 테스트', () => {
    expect(true).toBe(true);
  });
});

💡 실행 흐름

1. 첫 번째 describe(MySQL)
   → beforeAll → 2개의 테스트 → afterAll
2. 두 번째 describe(PostgreSQL)
   → beforeAll → 2개의 테스트 → afterAll

즉, 각 데이터 세트마다 setup(준비)과 cleanup(정리)가 독립적으로 이루어집니다.

---

6️⃣ 핵심 요약

• test.each: 동일 테스트를 여러 입력값으로 반복
• describe.each: 여러 테스트 그룹을 환경별로 반복
• describe.each는 각 그룹마다 before/after 훅 사용 가능
• 유지보수성과 가독성을 높이는 데이터 중심 테스트 패턴
• 현실적인 사용 예시:
  • 수학 함수 입력값 검증 (test.each)
  • 옵션/환경별 기능 테스트 (describe.each)
  • 다국어·다테마 UI 테스트 (describe.each)

---