단위 테스트 대상 선정하기

저번시간에 보았던 단위테스트가 무엇인가 돌아보자면, 다른 컴포넌트와의 상호작용이 아닌 단일 컴포넌트를, 그 컴포넌트가 예상대로 동작하는지 확인하는 테스트이다.
그래서 Atomic 컴포넌트라고 불리는 것들이 단위테스트의 주 대상이라고 했다.

하지만 반면 또 너무 단순한 경우(단순한 ui 렌더링, 간단한 로직)에는 일일이 단위테스트를 거칠 필요 없이 다른 컴포넌트들과 함께 (상위 컴포넌트에서) 통합테스트에서 검증하는것으로도 충분하다.

리액트 훅, 유틸함수

컴포넌트 외에도 리액트 훅과 유틸 함수도 단위 테스트의 대상이 된다. (단위 테스트로 검증하기 매우 적합하다)

유틸 함수는 보통 여러 컴포넌트에서 공통적으로 사용되는 함수들이고 다음과 같은 특징들을 가지고있다 :

• 순수 함수 : 함수 외부의 상태를 변경하는 등, 외부와 상호삭용 하지 않는 함수. (불변 상수 단순 참조는 제외)
• UI 로직과 무관
• 비즈니스 로직 : 계산, 변환, 검증 등의 순수한 로직

모듈 모킹

shopping-mall-unit-test 브랜치에서 EmptyNotice와 NotFoundPage,ErrorPage 컴포넌트들을 단위 테스트 한다.

• EmptyNotice : 장바구니가 비어있는 상태에서 장바구니 페이지로 이동시에 장바구니가 비어있다고 보여주는 컴포넌트
  • 이 컴포넌트는 사실 여러 컴포넌트들이 조합되어 이루어진 컴포넌트임에도 불구하고 홈으로 이동한다는 하나의 기능만 가지고 있기 때문에 독립적인 컴포넌트라고 볼 수 있다.
• NotFoundPage : 사용자가 잘못된 경로로 이동했을 때 보여주는 페이지
• ErrorPage : 예상하지 못한 오류가 발생했을 때 보여주는 페이지
  • 두 에러 페이지 모두 페이지 단위의 큰 컴포넌트임에도 불구하고 굉장히 단순한 구성 요소를 가지고있고 마찬가지로 '뒤로 이동'과 같은 간단한 기능만 가지고 있기 때문에 단위 테스트로 검증할 수 있다.

그런데 위 세 컴포넌트 모두 react-router-dom의 useNavigate()훅을 가져와 사용하고있다. (즉 react-router-dom에 의존성을 가지고 있다.)
이 컴포넌트들을 단위 테스트 할때는 해당 기능을 제대로 호출하는지만 검증하면 된다. (외부 모듈의 검증은 해당 모듈 자체에서 테스트를 통해 검증할 일이지 참조하고 있는 여기서 할 일은 아님)
그리고 이 외부 모듈의 특정 기능을 제대로 호출하는지 알아보기 위해 모킹이라는 것을 한다.

모킹 : 실제 모듈,객체와 동일한 동작을 하도록 만든 모의 모듈,객체로 실제를 대체하는 것.

• 모킹을 통해 우리는 외부 모듈과 검증할 모듈을 분리해서 필요한 검증만 진행할 수 있다.
• 그러나 실제 모듈과 완전히 동일한 모의 객체를 구현하는 것은 큰 비용이 드는 작업이며, (정확히 무슨뜻일까?)
• 모의 객체를 남용하는 것은 테스트 신뢰성을 낮추는 결과를 낳는다.

const navigateFn = vi.fn();

vi.mock('react-router-dom', async () => {
  const original = await vi.importActual('react-router-dom');

  return { ...original, useNavigate: () => navigateFn };
});

it('Home으로 이동 버튼 클릭시 홈 경로로 이동하는 navigate가 실행된다', async () => {
  const { user } = await render(<NotFoundPage />);

  const button = await screen.getByRole('button', { name: 'Home으로 이동' });

  await user.click(button);

  expect(navigateFn).toHaveBeenNthCalledWith(1, '/', { replace: true });
});

vi.mock()함수를 통해 react-router-dom의 모킹을 만든다.
그러면 <NotFoundPage /> 컴포넌트가 불러오는 해당 모듈은 진짜 모듈이 아닌 여기서 만들어진 모킹이 된다.
그 컴포넌트에서 useNavigate()를 호출할 다음과 같이 호출할 때

  const handleClickNavigateHomeButton = () => {
    navigate(pageRoutes.main, { replace: true });
  };
  
  return(
  ...
  <button onClick={handleClickNavigateHomeButton}>Home으로 이동</button>
  )

실제로 호출되는 것은 모킹에 넣었던 navigateFn 스파이 함수다.
그래서 expect()매처로 useNavigate()함수를 호출하면서 어떤 인자를 넣었는지 ("/", {replace : true})확인할 수 있게 된다.

모킹 초기화

위에서 useNavigate()와 react-router-dom 모듈을 모킹했다.
그런데 이 모킹이 다른 테스트에 영향을 줄 수 있는 경우(다른 테스트에서는 다른 방식으로 모킹을 해야한다던가)를 위해 테스트 수행 후에는 모킹을 초기화하는것이 좋다.

//setupTests.js
...

beforeAll(() => {
  server.listen();
});

afterEach(() => {
  server.resetHandlers();
  vi.clearAllMocks();
});

afterAll(() => {
  vi.resetAllMocks();
  server.close();
});

...

clearAllMocks() :

• 모킹된 모의 객체 호출에 대한 히스토리를 초기화
  • 히스토리가 초기화되지 않고 계속 쌓이면 호출 횟수나 인자가 변경되어 다른 테스트에 영향을 줄 수 있다.
• 모킹된 모듈의 구현을 초기화 하지는 않는다 (모킹된 상태로 유지)

resetAllMocks() :

• 모킹된 모듈의 구현을 초기화