跳到主要内容
目录

使用 Jest 配置 Next.js

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

备注

由于异步 Server 组件是 React 生态系统的新功能，Jest 目前不支持它们。 虽然您仍然可以运行同步 Server 和 Client 组件的单元测试，但我们建议对于异步组件使用端到端测试。

快速入门​

您可以使用 create-next-app 以 Next.js with-jest 示例快速入门：

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

手动设置​

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

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

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

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

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)

在幕后，next/jest 自动为您配置 Jest，包括：

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

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

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

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

tsconfig.json 或 jsconfig.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.setup.ts 中添加以下导入：

jest.setup.ts
import '@testing-library/jest-dom'
备注

在 v6.0 中，extend-expect 被删除， 因此如果您在 v6 之前使用 @testing-library/jest-dom， 您需要导入 @testing-library/jest-dom/extend-expect。

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

在 package.json 中添加测试脚本​

最后，在您的 package.json 文件中添加 jest 测试脚本：

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

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

创建您的第一个测试​

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

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

app/page.tsx
import Link from 'next/link'

export default async function Home() {
  return (
    <div>
      <h1>Home</h1>
      <Link href="/about">About</Link>
    </div>
  )
}
__tests__/page.test.jsx
import '@testing-library/jest-dom'
import { render, screen } from '@testing-library/react'
import Page from '../app/page'

describe('Page', () => {
  it('renders a heading', () => {
    render(<

Page />)
    const heading = screen.getByRole('heading', { level: 1 })
    expect(heading).toBeInTheDocument()
  })
})

可选：添加快照测试

为了跟踪组件中的任何意外更改，可以选择添加一个快照测试：

__tests__/snapshot.js
import { render } from '@testing-library/react'
import Page from '../app/page'

it('renders homepage unchanged', () => {
  const { container } = render(<Page />)
  expect(container).toMatchSnapshot()
})

运行您的测试​

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

npm run test
# 或
yarn test
# 或
pnpm test

附加资源​

有关更多阅读，您可能会发现以下资源有用：