[Jest] Jest mocking

자바스크립트 테스팅 프레임워크로 Jest를 사용할 때 장점 중에 하나는 다른 라이브러리 설치 없이 mock 기능을 지원한다는 점입니다.

mocking이란 ?

mocking은 단위 테스트를 작성할 때, 해당 코드가 의존하는 부분을 가짜(mock)로 대체하는 기법을 말합니다. 일반적으로 테스트하려는 코드가 의존하는 부분을 직접 생성하기가 부담스러운 경우 mocking이 많이 사용됩니다.

예를 들어, 데이터베이스에서 데이터를 삭제하는 코드에 대한 단위 테스트를 작성할 때, 실제 데이터베이스를 사용한다면 여러가지 문제점이 발생할 수 있습니다.

• 데이터베이스 접속과 같이 Network이나 I/O 작업이 포함된 테스트는 실행 속도가 현저히 떨어질 수 밖에 없습니다.
• 프로젝트의 규모가 커져서 한 번에 실행해야 할 테스트 케이스가 많아지면 이러한 작은 속도 저하들이 모여 큰 이슈가 될 수 있으며, CI/CD 파이프라인의 일부로 테스트가 자동화되어 자주 실행되어야 한다면 더 큰 문제가 될 수 있습니다.
• 테스트 자체를 위한 코드보다 데이터베이스와 연결을 맺고 트랜잭션을 생성하고 쿼리를 전송하는 코드가 더 길어질 수 있습니다. 즉, 배보다 배꼽이 더 커질 수 있습니다.
• 만약 테스트 실행 순간 일시적으로 데이터베이스가 오프라인 작업 중이었다면 해당 테스트는 실패하게 됩니다. 따라서 테스트가 인프라 환경에 영향을 받게 됩니다. (non-deterministic)
• 테스트가 종료 직후, 데이터베이스에서 변경 데이터를 직접 원복하거나 트랜잭션을 rollback 해줘야 하는데 상당히 번거로운 작업이 될 수 있습니다.

무엇보다 이런 방식으로 테스트를 작성하게 되면 특정 기능만 분리해서 테스트하겠다는 단위 테스트(Unit Test)의 근본적인 사상에 부합하지 않게 됩니다.

mocking은 이러한 상황에서 실제 객체인 척하는 가짜 객체를 생성하는 매커니즘을 제공합니다. 또한 테스트가 실행되는 동안 가짜 객체에 어떤 일들이 발생했는지를 기억하기 때문에 가짜 객체가 내부적으로 어떻게 사용되는지 검증할 수 있습니다. 결론적으로 mocking을 이용하면 실제 객체를 사용하는 것보다 훨씬 가볍고 빠르게 실행되면서도 항상 동일한 결과를 내는 테스트를 작성할 수 있습니다.

jset.fn() 사용법

Jest는 가짜 함수(mock function)을 생성할 수 있도록 jest.fn() 함수를 제공합니다.

const mockFn = jest.fn();

그리고 이 가짜함수는 일반 자바스크립트 함수와 동일한 방식으로 인자를 넘겨 호출할 수 있습니다.

mockFn();
mockFn(1);
mockFn("a");
mockFn([1, 2], { a: "b" });

위 가짜 함수의 호출 결과는 모두 undefined 입니다. 어떤 값을 리턴해야할 지 아직 알려주지 않았기 때문입니다.

mockFn.mockReturnValue("I am a mock!");
console.log(mockFn());

mockReturnValue(리턴값) 함수를 이용해서 가짜 함수가 어떤 값을 리턴해야할 지 설정해줄 수 있습니다. 비슷한 방식으로 mockResolvedValue(Promise가 resolve하는 값) 함수를 이용하면 가짜 비동기 함수를 만들 수 있습니다.

mockFn.mockResolvedValue("I will be a mock!");
mockFn().then((result) => {
  console.log(result);	// I will be a mock!		
});

뿐만 아니라 mockImplementation(구현 코드) 함수를 이용하면 아예 해당 함수를 통째로 즉석에서 재구현할 수도 있습니다.

mockFn.mockImplementation((name) => 'I am ${name}!`);
console.log(mockFn("Dale"));	// I am Dale!

테스트를 작성할 때 가짜 함수가 진짜로 유용한 이유는 가짜 함수는 자신이 어떻게 호출되었는지를 모두 기억한다는 점입니다.

mockFn("a");
mockFn(["b", "c"]);

expect(mockFn).toBeCalledTimes(2);	// 호출 횟수
expect(mockFn).toBeCalledWith("a");	// 인자
expect(mockFn).toBeCalledWith(["b", "c"]);

위와 같이 가짜 함수용으로 설계된 Jest Matcher인 toBeCalled*** 함수를 사용하면 가짜 함수가 몇번 호출되었고 인자로 무엇이 넘어왔었는지를 검증할 수 있습니다.

jest.spyOn() 사용법

mocking에는 스파이(spy)라는 개념이 있습니다. 현실이나 영화 속에서 스파이라는 직업은 "몰래" 정보를 캐내야 합니다. 테스트를 작성할 때도 이처럼, 어떤 객체에 속한 함수의 구현을 가짜로 대체하지 않고 해당 함수의 호출 여부와 어떻게 호출되었는지만을 알아내야 할 때가 있습니다. 이럴 때, Jest에서 제공하는 jest.spyOn(object, methodName)함수를 이용하면 됩니다.

const calculator = {
  add: (a, b) => a + b,
}

const spyFn = jest.spyOn(calculator, "add");

const result = calculator.add(2, 3);

expect(spyFn).toBeCalledTimes(1);
expect(spyFn).toBeCalledWith(2, 3);
expect(result).toBe(5);

위 예제를 보면, jest.spyOn() 함수를 이용해서 calculator 객체의 add라는 함수에 스파이를 붙였습니다. 따라서 add 함수를 호출한 후에 호출 횟수와 어떤 인자가 넘어갔는지 검증할 수 있습니다. 하지만 가짜 함수로 대체한 것은 아니기 때문에 결과 값은 원래 구현대로 2와 3의 합인 5가 되는 것을 알 수 있습니다.

테스트 작성

다음 예제 코드는 axios 라이브러리를 이용해서 REST API를 호출하여 사용자 데이터를 조회해주는 함수를 선언하고 있는 모듈입니다. 이번 포스팅에서는 이 findOne() 함수에 대한 테스트를 한 번 작성해보도록 하겠습니다.

const axios = require('axios');
const API_ENDPOINT = "https://jsonplaceholder.typicode.com";

module.exports = {
  findOne(id) {
    return axios.get(`${API_ENDPOINT}/users/${id}`).then((response) => response.data);    
  }  
};

먼저 mocking 없이 findOne()의 결과값에 대한 단순한 테스트를 작성합니다.

const userService = require('./userService");

test("findOne returns a user", async() => {
  const user = await userService.findOne(1);
  expect(user).toHaveProperty("id", 1);
  expect(user).toHaveProperty("name", "Leanne Graham");  
});

만약에 findOne() 함수가 외부 API 연동을 통해서 사용자 정보를 조회해야 하는지를 테스트하려면 어떻게 해야할까요? 이 함수는 내부적으로 axios 객체의 get 함수를 사용하고 있기 때문에 여기에 스파이를 붙이면 쉽게 알아낼 수 있습니다.

const axios = require("axios");
const userService = require("./userService");

test("findOne fetches data from the API endpoint", async () => {
  const spyGet = jest.spyOn(axios, "get");
  await userService.findOne(1);
  expect(spyGet).toBeCalledTimes(1);
  expect(spyGet).toBeCallWith(`https://jsonplaceholder.typicode.com/users/1`);
});

하지만 이 테스트는 API 서버가 다운된 상황이거나 Network이 단절된 환경에서 실행되면 오류가 발생하고 실패하게 됩니다. 따라서 위 두 개의 테스트 함수는 "테스트는 deterministic 해야한다. (언제 실행되든 항상 같은 결과를 내야한다.)"라는 원칙에 위배됩니다. 왜냐하면 단위 테스트가 단독으로 고립되어 있지 않고 외부 환경에 의존하기 때문입니다.

이 문제를 해결하려면, axios 객체의 get 함수가 항상 안정적으로 결과를 반환하도록 mocking 해야합니다. 즉, 다음과 같이 axios.get를 어떤 고정된 결과값을 리턴하는 가짜 함수로 대체해주면 됩니다.

const axios = require('axios');
const userService = require('./userService');

test('findOne returns what axios get returns', async () => {
  axios.get = jest.fn().mockResolvedValue({
    data: {
      id: 1, 
      name: "jinhyeok hong",      
    },
  });
  
  const user = await userService.findOne(1);
  expect(user).toHaveProperty("id", 1);
  expect(user).toHaveProperty("name", "jinhyeok hong");
});

이렇게 테스트 입장에서 통제할 수 없는 부분을 mocking 기법을 사용하면 외부 환경에 의존하지 않고도 얼마든지 독립적으로 실행 가능한 테스트를 작성할 수 있습니다.