如何使用 Next.js 设置 Cypress

Cypress是一个用于端到端 (E2E)和组件测试的测试运行器。本页将向你展示如何使用 Next.js 设置 Cypress 并编写你的第一个测试。

警告

低于 13.6.3 版本的 Cypress 不支持带 moduleResolution:"bundler" 的 TypeScript 5。但是，此问题已在 Cypress 13.6.3 及更高版本中解决。Cypress v13.6.3

快速入门

你可以使用 create-next-app 和 with-cypress 示例快速开始。

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

手动设置

要手动设置 Cypress，请将 cypress 安装为开发依赖项。

npm install -D cypress
# or
yarn add -D cypress
# or
pnpm install -D cypress

将 Cypress open 命令添加到 package.json 脚本字段。

{
  "scripts": {
    "dev": "next dev",
    "build": "next build",
    "start": "next start",
    "lint": "eslint",
    "cypress:open": "cypress open"
  }
}

首次运行 Cypress 以打开 Cypress 测试套件。

npm run cypress:open

你可以选择配置 E2E 测试和/或组件测试。选择任何这些选项都将自动在你的项目中创建一个 cypress.config.js 文件和一个 cypress 文件夹。

创建你的第一个 Cypress E2E 测试

确保你的 cypress.config 文件包含以下配置：

import { defineConfig } from 'cypress'
 
export default defineConfig({
  e2e: {
    setupNodeEvents(on, config) {},
  },
})

然后，创建两个新的 Next.js 文件：

import Link from 'next/link'
 
export default function Page() {
  return (
    <div>
      <h1>Home</h1>
      <Link href="/about">About</Link>
    </div>
  )
}

import Link from 'next/link'
 
export default function Page() {
  return (
    <div>
      <h1>About</h1>
      <Link href="/">Home</Link>
    </div>
  )
}

添加一个测试以检查你的导航是否正常工作：

describe('Navigation', () => {
  it('should navigate to the about page', () => {
    // Start from the index page
    cy.visit('https://:3000/')
 
    // Find a link with an href attribute containing "about" and click it
    cy.get('a[href*="about"]').click()
 
    // The new url should include "/about"
    cy.url().should('include', '/about')
 
    // The new page should contain an h1 with "About"
    cy.get('h1').contains('About')
  })
})

运行 E2E 测试

Cypress 将模拟用户导航你的应用程序，这需要你的 Next.js 服务器正在运行。我们建议针对你的生产代码运行测试，以更接近地模拟你的应用程序的行为。

运行 npm run build && npm run start 来构建你的 Next.js 应用程序，然后在另一个终端窗口中运行 npm run cypress:open 来启动 Cypress 并运行你的 E2E 测试套件。

须知

通过在 cypress.config.js 配置文件中添加 baseUrl: 'https://:3000'，你可以使用 cy.visit("/") 而不是 cy.visit("https://:3000/")。

另外，你可以安装 start-server-and-test 包，将 Next.js 生产服务器与 Cypress 一起运行。安装后，将 "test": "start-server-and-test start https://:3000 cypress" 添加到你的 package.json 脚本字段。请记住在进行新更改后重新构建你的应用程序。

创建你的第一个 Cypress 组件测试

组件测试构建并挂载特定组件，而无需捆绑整个应用程序或启动服务器。

在 Cypress 应用程序中选择组件测试，然后选择 Next.js 作为你的前端框架。你的项目中将创建一个 cypress/component 文件夹，并且 cypress.config.js 文件将更新以启用组件测试。

确保你的 cypress.config 文件包含以下配置：

import { defineConfig } from 'cypress'
 
export default defineConfig({
  component: {
    devServer: {
      framework: 'next',
      bundler: 'webpack',
    },
  },
})

假设与上一节中的组件相同，添加一个测试以验证组件是否正在渲染预期输出：

import Page from '../../app/page'
 
describe('<Page />', () => {
  it('should render and display expected content', () => {
    // Mount the React component for the Home page
    cy.mount(<Page />)
 
    // The new page should contain an h1 with "Home"
    cy.get('h1').contains('Home')
 
    // Validate that a link with the expected URL is present
    // Following the link is better suited to an E2E test
    cy.get('a[href="/about"]').should('be.visible')
  })
})

须知:

Cypress 目前不支持 async 服务器组件的组件测试。我们建议使用 E2E 测试。

由于组件测试不需要 Next.js 服务器，因此依赖于服务器的 <Image /> 等功能可能无法开箱即用。

运行组件测试

在你的终端中运行 npm run cypress:open 来启动 Cypress 并运行你的组件测试套件。

持续集成 (CI)

除了交互式测试，你还可以使用 cypress run 命令以无头模式运行 Cypress，这更适合 CI 环境。

{
  "scripts": {
    //...
    "e2e": "start-server-and-test dev https://:3000 \"cypress open --e2e\"",
    "e2e:headless": "start-server-and-test dev https://:3000 \"cypress run --e2e\"",
    "component": "cypress open --component",
    "component:headless": "cypress run --component"
  }
}

你可以从这些资源中了解更多关于 Cypress 和持续集成的信息：