Jest框架中的自定義測試匹配器

在 Jest 框架中，你可以創建自定義測試匹配器來滿足特定的測試需求

1. 首先，在項目根目錄下創建一個名為 customMatchers.ts（或 .js）的文件。這將包含我們的自定義測試匹配器實現。

2. 在 customMatchers.ts 文件中，編寫一個自定義測試匹配器函數。例如，我們可以創建一個名為 toBeWithinRange 的匹配器，用于檢查一個值是否在指定范圍內：

// customMatchers.ts
import { matcherHint, printExpected, printReceived } from 'jest-matcher-utils';

const toBeWithinRange = (received: number, floor: number, ceiling: number) => {
  const pass = received >= floor && received <= ceiling;

  const message = pass
    ? () =>
        `${matcherHint('.not.toBeWithinRange')}\n\n` +
        `Expected value not to be within range:\n` +
        `  floor: ${printExpected(floor)}\n` +
        `  ceiling: ${printExpected(ceiling)}\n` +
        `Received:\n` +
        `  ${printReceived(received)}`
    : () =>
        `${matcherHint('.toBeWithinRange')}\n\n` +
        `Expected value to be within range:\n` +
        `  floor: ${printExpected(floor)}\n` +
        `  ceiling: ${printExpected(ceiling)}\n` +
        `Received:\n` +
        `  ${printReceived(received)}`;

  return { message, pass };
};

3. 接下來，我們需要將自定義測試匹配器添加到 Jest 的全局 expect 對象中。在項目根目錄下創建一個名為 setupTests.ts（或 .js）的文件，并添加以下內容：

// setupTests.ts
import { toBeWithinRange } from './customMatchers';

expect.extend({
  toBeWithinRange,
});

4. 確保在 jest.config.js 文件中引用了 setupTests.ts 文件。如果你沒有這個文件，請創建一個并添加以下內容：

// jest.config.js
module.exports = {
  // ...其他配置
  setupFilesAfterEnv: ['./setupTests.ts'],
};

5. 現在，你可以在測試文件中使用自定義的 toBeWithinRange 匹配器：

// myComponent.test.ts
import React from 'react';
import { render, screen } from '@testing-library/react';
import MyComponent from './MyComponent';

test('renders the correct value', () => {
  render(<MyComponent />);
  const valueElement = screen.getByText(/Value: /i);
  const value = parseInt(valueElement.textContent.split(' ')[1], 10);

  expect(value).toBeWithinRange(1, 100);
});

在這個示例中，我們創建了一個名為 toBeWithinRange 的自定義測試匹配器，用于檢查一個值是否在指定范圍內。然后，我們在 setupTests.ts 文件中將其添加到 Jest 的全局 expect 對象中，并在測試文件中使用它。