jest.spyOn

🔵 개념 및 역할

• 스파이(Spy): 실제 함수의 동작은 그대로 유지하면서, 호출 여부, 호출 횟수, 전달된 인자 등을 기록합니다.
• 목적: 함수의 내부 로직은 건드리지 않고, 함수가 어떻게 사용되었는지를 감시하여 테스트의 신뢰성을 높이는 데 사용됩니다.

---

🔵 기본 사용법

1. 스파이 생성하기

   const calculator = {
     add: (a, b) => a + b,
   };
   
   // 'calculator' 객체의 'add' 메서드에 스파이 부착
   const spyFn = jest.spyOn(calculator, 'add');
   

2. 함수 호출 및 결과 검증

   const result = calculator.add(2, 3);
   
   // 호출 횟수 확인
   expect(spyFn).toHaveBeenCalledTimes(1);
   // 전달된 인자 확인
   expect(spyFn).toHaveBeenCalledWith(2, 3);
   // 함수의 실제 결과값 확인
   expect(result).toBe(5);
   

   • 설명: 위 예제는 jest.spyOn()을 사용하여 add 함수가 호출된 횟수와 인자를 검증하면서도, 함수의 원래 동작(두 수의 합)을 그대로 수행함을 보여줍니다.

---

🔵 확장 기능 및 활용법

1. 함수 동작 대체 (mockImplementation)
   • 목적: 테스트 상황에 따라 함수의 동작을 변경할 수 있습니다.
   • 예제:

     jest.spyOn(myObject, 'myMethod').mockImplementation(arg => `Mocked, ${arg}!`);
     console.log(myObject.myMethod('World')); // 출력: "Mocked, World!"
     

   • 설명: 위 예제는 myMethod의 원래 로직 대신 지정한 로직으로 동작하도록 설정하여, 특정 테스트 시나리오에 맞는 결과를 얻을 수 있게 합니다.
2. 원본 함수 복구 (mockRestore)
   • 목적: 테스트 후 원래 함수의 상태로 복구하여 다른 테스트에 영향을 주지 않도록 합니다.
   • 예제:

     const spy = jest.spyOn(myObject, 'myMethod');
     // ... 테스트 코드 실행 ...
     spy.mockRestore();  // 원본 함수로 복구
     

   • 설명: 복구하지 않으면 스파이가 남아 다른 테스트에 영향을 줄 수 있으므로, 테스트 후 반드시 원래 상태로 돌려놓아야 합니다.

---

🔵 실제 테스트 환경에서의 사용 예시

1. 외부 API 테스트
   • 예를 들어, axios 라이브러리를 사용하는 경우, 내부 axios.get 함수에 스파이를 부착하여 API 호출을 감시할 수 있습니다.

   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).toHaveBeenCalledTimes(1);
     expect(spyGet).toHaveBeenCalledWith(`https://jsonplaceholder.typicode.com/users/1`);
   });
   

   • 주의사항: 외부 API에 의존하지 않도록, 필요한 경우 jest.fn()을 활용해 가짜 함수로 대체하여 테스트 환경을 독립적으로 구성할 수 있습니다.
2. 테스트의 결정성(Deterministic) 확보
   • 목적: 네트워크 상태나 API 서버의 응답에 영향을 받지 않고 항상 동일한 결과를 내도록 테스트를 작성합니다.
   • 방법: axios.get를 jest.fn().mockResolvedValue()로 대체하여 고정된 결과를 리턴하게 합니다.

   axios.get = jest.fn().mockResolvedValue({
     data: {
       id: 1,
       name: "Dale Seo",
     },
   });
   

---

🔵 요약

• jest.spyOn()은 함수의 호출 정보를 감시하면서도 원본 로직을 그대로 유지하는 강력한 도구입니다.
• 필요에 따라 함수의 동작을 변경하거나, 테스트 후 원래 상태로 복구하는 등의 다양한 활용법이 있습니다.
• 이를 통해 테스트의 신뢰성을 높이고, 외부 환경에 의존하지 않는 안정적인 테스트 환경을 구성할 수 있습니다.

---

 

출처

https://inpa.tistory.com/entry/JEST-%F0%9F%93%9A-%EB%AA%A8%ED%82%B9-mocking-jestfn-jestspyOn#mocking_%EB%A9%94%EC%86%8C%EB%93%9C_-_jest.spyon

 

https://www.daleseo.com/jest-fn-spy-on/