JestMock全解析

JestMock是什麼？為什麼我們需要它？JestMock是Jest測試框架中的一個功能，它可以幫助我們方便地模擬一些外部依賴，例如調用介面、讀取配置文件等等。在進行單元測試的時候，使用JestMock可以讓我們更加方便地測試代碼，避免一些外部依賴未準備好而導致的測試失敗的問題。

一、基本使用

在使用JestMock時，首先需要了解的基本概念是”mock”和”spy”。Mock是指模擬一個函數或者一個模塊，讓它返回我們預定義的結果，這樣我們就可以在測試中使用這個模擬函數，而不用去依賴真實的介面或者模塊。Spy是指監控一個函數的調用情況，包括它被調用的次數、傳入的參數、返回的結果等等。

下面是一個簡單的例子，我們可以使用JestMock來模擬一個計算兩個數之和的函數：

const sum = (a, b) => a + b;

test('adds 1 + 2 to equal 3', () => {
  const mockedSum = jest.fn(sum);

  expect(mockedSum(1, 2)).toBe(3);
  expect(mockedSum).toHaveBeenCalledWith(1, 2);
});

在這個例子中，我們定義了一個函數sum來計算兩個數之和，然後我們使用jest.fn()來模擬這個函數。在測試代碼中，我們首先調用這個模擬函數並傳入1和2作為參數，然後檢查它的返回值是否為3，並且檢查它是否被調用了一次並且傳入了正確的參數。

二、模擬模塊

除了模擬函數以外，JestMock還支持模擬整個模塊。這可以在我們使用import命令引入一個模塊時非常有用。下面是一個例子：

// math.js
export const sum = (a, b) => a + b;
export const subtract = (a, b) => a - b;

// app.js
import { sum, subtract } from './math';

export const calculate = (a, b) => {
  const x = sum(a, b);
  const y = subtract(a, b);
  return x * y;
};

// app.test.js
jest.mock('./math', () => ({
  sum: jest.fn(() => 3),
  subtract: jest.fn(() => -1),
}));

test('calculate', () => {
  expect(calculate(1, 2)).toBe(-3);
  expect(sum).toHaveBeenCalledWith(1, 2);
  expect(subtract).toHaveBeenCalledWith(1, 2);
});

在這個例子中，我們定義了一個math模塊，它包含兩個函數：sum和subtract。我們通過import命令在app.js中引入這個模塊，並使用它們來計算a和b的值。在測試代碼app.test.js中，我們使用jest.mock()來模擬這個math模塊，並為sum函數和subtract函數分別指定了返回值。在測試calculate函數時，我們驗證了它的返回值以及模擬函數是否被正確調用。

三、Spy監控函數調用

除了模擬函數以外，JestMock還支持監控函數的調用情況。這在我們需要驗證一個函數是否被正確調用，以及調用次數、傳入參數等情況時非常有用。下面是一個例子：

const myFunc = jest.fn();

myFunc(1, 'a');
myFunc(2, 'b');
myFunc(3, 'c');

expect(myFunc).toHaveBeenCalledTimes(3);
expect(myFunc).toHaveBeenCalledWith(1, 'a');
expect(myFunc).toHaveBeenNthCalledWith(2, 2, 'b');
expect(myFunc).toHaveBeenLastCalledWith(3, 'c');

在這個例子中，我們定義了一個模擬函數myFunc，並且在不同的調用中傳入不同的參數。然後我們使用Jest的Spy機制來監控這個函數的調用情況，並斷言它的調用次數、傳入參數等情況是否符合預期。

四、Mock實現細節

在了解JestMock的使用過程中，也需要了解一些關於Mock實現細節方面的內容。

首先，JestMock的Mock實現不會被污染到其他測試用例中。這意味著在每個測試用例中，Mock實現會重新進行初始化，從而避免了Mock實現的污染問題。

其次，JestMock支持在Mock實現中可以設置返回值、throw錯誤等行為，還可以使用mockImplementation()方法來自定義Mock實現。例如：

const myFunc = jest.fn();

myFunc.mockImplementation(() => {
  console.log('mocked');
});

myFunc(); // logs 'mocked' to the console

在這個例子中，我們使用mockImplementation方法來自定義了Mock實現，讓它在被調用時輸出一段信息。這個功能通常用於測試一些非同步代碼，例如Promise。

五、Mock作用範圍

在JestMock中，Mock實現的作用範圍包括模塊級別和全局級別。模塊級別是指Mock實現只會對當前模塊下使用的函數或者模塊進行Mock，其他模塊不會受到影響。全局級別是指Mock實現會影響整個應用程序，在所有模塊中都會生效。

在實際應用中，我們需要注意Mock實現的作用範圍，避免它被誤用或者影響其他測試用例的運行。

六、總結

本文介紹了JestMock的基本使用方法，包括模擬函數、模塊、Spy監控函數調用等功能，同時也簡要介紹了Mock實現的細節和作用範圍。

使用JestMock可以讓我們更加方便地進行單元測試，避免一些外部依賴未準備好而導致的測試失敗的問題。在實際應用中，我們需要結合項目的具體情況，選擇合適的Mock實現方式，避免它被誤用或者影響其他測試用例的運行。