Setting up Jest with Next.js

Jest 和 React Testing Library 经常一起用于单元测试和快照测试。本指南将向你展示如何在 Next.js 中设置 Jest 并编写你的第一个测试。

值得注意的是：由于异步 Server Components 是 React 生态系统中的新特性，Jest 目前不支持它们。虽然你仍然可以对同步的 Server 和 Client Components 进行单元测试，但我们建议对异步组件使用端到端测试。

快速开始

你可以使用 create-next-app 和 Next.js 的 with-jest 示例快速开始：

Terminal

npx create-next-app@latest --example with-jest with-jest-app

手动设置

自 Next.js 12 发布以来，Next.js 现在内置了 Jest 的配置。

要设置 Jest，请将 jest 和以下包作为开发依赖项安装：

Terminal

npm install -D jest jest-environment-jsdom @testing-library/react @testing-library/dom @testing-library/jest-dom ts-node
# 或
yarn add -D jest jest-environment-jsdom @testing-library/react @testing-library/dom @testing-library/jest-dom ts-node
# 或
pnpm install -D jest jest-environment-jsdom @testing-library/react @testing-library/dom @testing-library/jest-dom ts-node

通过运行以下命令生成一个基本的 Jest 配置文件：

Terminal

npm init jest@latest
# 或
yarn create jest@latest
# 或
pnpm create jest@latest

这将引导你完成一系列提示，为你的项目设置 Jest，包括自动创建一个 jest.config.ts|js 文件。

更新你的配置文件以使用 next/jest。这个转换器包含了 Jest 与 Next.js 配合使用所需的所有必要配置选项：

jest.config.ts

import type { Config } from "jest";
import nextJest from "next/jest.js";
 
const createJestConfig = nextJest ({
  // 提供你的 Next.js 应用的路径，以加载 next.config.js 和 .env 文件到你的测试环境
  dir: "./",
});
 
// 添加任何自定义配置以传递给 Jest
const config: Config = {
  coverageProvider: "v8",
  testEnvironment: "jsdom",
  // 在每个测试运行之前添加更多设置选项
  // setupFilesAfterEnv: ['<rootDir>/jest.setup.ts'],
};
 
// 以这种方式导出 createJestConfig 是为了确保 next/jest 可以加载 Next.js 的异步配置
export default createJestConfig (config);

jest.config.js

const nextJest = require ("next/jest");
 
/** @type {import('jest').Config} */
const createJestConfig = nextJest ({
  // 提供你的 Next.js 应用的路径，以加载 next.config.js 和 .env 文件到你的测试环境
  dir: "./",
});
 
// 添加任何自定义配置以传递给 Jest
const config = {
  coverageProvider: "v8",
  testEnvironment: "jsdom",
  // 在每个测试运行之前添加更多设置选项
  // setupFilesAfterEnv: ['<rootDir>/jest.setup.ts'],
};
 
// 以这种方式导出 createJestConfig 是为了确保 next/jest 可以加载 Next.js 的异步配置
module.exports = createJestConfig (config);

在底层，next/jest 自动为你配置 Jest，包括：

使用 Next.js 编译器设置 transform
自动模拟样式表 (.css、.module.css 及其 scss 变体)、图像导入和 next/font
将 .env (及所有变体) 加载到 process.env
从测试解析和转换中忽略 node_modules
从测试解析中忽略 .next
加载 next.config.js 以启用 SWC 转换的标志

值得注意的是：要直接测试环境变量，请在单独的设置脚本或 jest.config.ts 文件中手动加载它们。有关更多信息，请参阅测试环境变量。

设置 Jest (使用 Babel)

如果你选择不使用 Next.js 编译器而使用 Babel，你将需要手动配置 Jest，并额外安装 babel-jest 和 identity-obj-proxy。

以下是为 Next.js 配置 Jest 的推荐选项：

jest.config.js

module.exports = {
  collectCoverage: true,
  // 在 node 14.x 上，覆盖提供程序 v8 提供了良好的速度和较好的报告
  coverageProvider: "v8",
  collectCoverageFrom: [
    "**/*.{js,jsx,ts,tsx}",
    "!**/*.d.ts",
    "!**/node_modules/**",
    "!<rootDir>/out/**",
    "!<rootDir>/.next/**",
    "!<rootDir>/*.config.js",
    "!<rootDir>/coverage/**",
  ],
  moduleNameMapper: {
    // 处理 CSS 导入 (使用 CSS 模块)
    // https://jestjs.io/docs/webpack#mocking-css-modules
    "^.+\\.module\\.(css|sass|scss)$": "identity-obj-proxy",
 
    // 处理 CSS 导入 (不使用 CSS 模块)
    "^.+\\.(css|sass|scss)$": "<rootDir>/__mocks__/styleMock.js",
 
    // 处理图像导入
    // https://jestjs.io/docs/webpack#handling-static-assets
    '^.+\\.(png|jpg|jpeg|gif|webp|avif|ico|bmp|svg)$': `<rootDir>/__mocks__/fileMock.js`,
 
    // 处理模块别名
    "^@/components/(.*)$": "<rootDir>/components/$1",
 
    // 处理 @next/font
    "@next/font/(.*)": `<rootDir>/__mocks__/nextFontMock.js`,
    // 处理 next/font
    "next/font/(.*)": `<rootDir>/__mocks__/nextFontMock.js`,
    // 禁用 server-only
    "server-only": `<rootDir>/__mocks__/empty.js`,
  },
  // 在每个测试运行之前添加更多设置选项
  // setupFilesAfterEnv: ['<rootDir>/jest.setup.js'],
  testPathIgnorePatterns: ["<rootDir>/node_modules/", "<rootDir>/.next/"],
  testEnvironment: "jsdom",
  transform: {
    // 使用 babel-jest 来转译测试，使用 next/babel 预设
    // https://jestjs.io/docs/configuration#transform-objectstring-pathtotransformer--pathtotransformer-object
    "^.+\\.(js|jsx|ts|tsx)$": ["babel-jest", { presets: ["next/babel"] }],
  },
  transformIgnorePatterns: [
    "/node_modules/",
    "^.+\\.module\\.(css|sass|scss)$",
  ],
};

你可以在 Jest 文档中了解更多关于每个配置选项的信息。我们还建议你查看 next/jest 配置，了解 Next.js 如何配置 Jest。

处理样式表和图像导入

样式表和图像在测试中不会被使用，但导入它们可能会导致错误，因此需要对它们进行模拟。

在 __mocks__ 目录中创建上述配置中引用的模拟文件 - fileMock.js 和 styleMock.js：

__mocks__/fileMock.js

module.exports = "test-file-stub";

__mocks__/styleMock.js

module.exports = {};

有关处理静态资源的更多信息，请参阅 Jest 文档。

处理字体

要处理字体，在 __mocks__ 目录中创建 nextFontMock.js 文件，并添加以下配置：

__mocks__/nextFontMock.js

module.exports = new Proxy (
  {},
  {
    get: function getter () {
      return () => ({
        className: "className",
        variable: "variable",
        style: { fontFamily: "fontFamily" },
      });
    },
  }
);

可选：处理绝对导入和模块路径别名

如果你的项目使用了模块路径别名，你需要配置 Jest 来解析导入，方法是将 jsconfig.json 文件中的 paths 选项与 jest.config.js 文件中的 moduleNameMapper 选项匹配。例如：

tsconfig.json

{
  "compilerOptions": {
    "module": "esnext",
    "moduleResolution": "bundler",
    "baseUrl": "./",
    "paths": {
      "@/components/*": ["components/*"]
    }
  }
}

jest.config.js

moduleNameMapper: {
  // ...
  '^@/components/(.*)$': '<rootDir>/components/$1',
}

可选：使用自定义匹配器扩展 Jest

@testing-library/jest-dom 包含一组方便的自定义匹配器，如 .toBeInTheDocument()，使编写测试变得更容易。你可以通过在 Jest 配置文件中添加以下选项，为每个测试导入自定义匹配器：

jest.config.ts

setupFilesAfterEnv: ["<rootDir>/jest.setup.ts"];

jest.config.js

setupFilesAfterEnv: ["<rootDir>/jest.setup.js"];

然后，在 jest.setup.ts 中添加以下导入：

jest.setup.ts

import "@testing-library/jest-dom";

jest.setup.js

import "@testing-library/jest-dom";

值得注意的是： extend-expect 在 v6.0 中被移除，所以如果你使用的是 6.0 之前版本的 @testing-library/jest-dom，你需要导入 @testing-library/jest-dom/extend-expect。

如果你需要在每个测试之前添加更多的设置选项，可以将它们添加到上面的 jest.setup.js 文件中。

在 `package.json` 中添加测试脚本：

最后，在你的 package.json 文件中添加一个 Jest test 脚本：

package.json

{
  "scripts": {
    "dev": "next dev",
    "build": "next build",
    "start": "next start",
    "test": "jest",
    "test:watch": "jest --watch"
  }
}

jest --watch 将在文件发生变化时重新运行测试。有关更多 Jest CLI 选项，请参阅 Jest 文档。

创建你的第一个测试：

你的项目现在已准备好运行测试。在项目的根目录下创建一个名为 __tests__ 的文件夹。

例如，我们可以添加一个测试来检查 <Home /> 组件是否成功渲染了一个标题：

pages/index.js

export default function Home () {
  return <h1>Home</h1>;
}

__tests__/index.test.js

import "@testing-library/jest-dom";
import { render, screen } from "@testing-library/react";
import Home from "../pages/index";
 
describe ("Home", () => {
  it ("renders a heading", () => {
    render (<Home />);
 
    const heading = screen.getByRole ("heading", { level: 1 });
 
    expect (heading).toBeInTheDocument ();
  });
});

你也可以选择添加一个快照测试，以跟踪组件中的任何意外变化：

__tests__/snapshot.js

import { render } from "@testing-library/react";
import Home from "../pages/index";
 
it ("renders homepage unchanged", () => {
  const { container } = render (<Home />);
  expect (container).toMatchSnapshot ();
});

值得注意的是：测试文件不应该包含在 Pages Router 中，因为 Pages Router 中的任何文件都被视为路由。

运行你的测试

然后，运行以下命令来执行你的测试：

Terminal

npm run test
# 或
yarn test
# 或
pnpm test

其他资源

如需进一步阅读，你可能会发现以下资源有用：

Next.js 与 Jest 示例
Jest 文档
React Testing Library 文档
Testing Playground - 使用良好的测试实践来匹配元素。