跳到主要内容

如何使用 Next.js 设置 Cypress

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

警告：

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

快速开始​

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

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

手动设置​

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

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

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

package.json
{
  "scripts": {
    "dev": "next dev",
    "build": "next build",
    "start": "next start",
    "lint": "next lint",
    "cypress:open": "cypress open"
  }
}

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

Terminal
npm run cypress:open

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

创建你的第一个 Cypress E2E 测试​

确保你的 cypress.config 文件具有以下配置：

cypress.config.ts
import { defineConfig } from 'cypress'

export default defineConfig({
  e2e: {
    setupNodeEvents(on, config) {},
  },
})

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

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

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

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

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

export default function About() {
  return (
    <div>
      <h1>About</h1>
      <Link href="/">Home</Link>
    </div>
  )
}

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

cypress/e2e/app.cy.js
describe('Navigation', () => {
  it('should navigate to the about page', () => {
    // 从索引页面开始
    cy.visit('http://localhost:3000/')

    // 找到一个 href 属性包含 "about" 的链接并点击它
    cy.get('a[href*="about"]').click()

    // 新 url 应该包含 "/about"
    cy.url().should('include', '/about')

    // 新页面应该包含一个带有 "About" 的 h1
    cy.get('h1').contains('About')
  })
})

运行 E2E 测试​

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

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

注意：

  • 你可以通过将 baseUrl: 'http://localhost:3000' 添加到 cypress.config.js 配置文件来使用 cy.visit("/") 而不是 cy.visit("http://localhost:3000/")。
  • 或者，你可以安装 start-server-and-test 包来与 Cypress 一起运行 Next.js 生产服务器。安装后，将 "test": "start-server-and-test start http://localhost:3000 cypress" 添加到你的 package.json 脚本字段。记住在更改后重新构建你的应用程序。

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

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

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

确保你的 cypress.config 文件具有以下配置：

cypress.config.ts
import { defineConfig } from 'cypress'

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

假设与前一节相同的组件，添加一个测试来验证组件是否渲染预期的输出：

cypress/component/about.cy.tsx
import Page from '../../app/page'

describe('<Page />', () => {
  it('should render and display expected content', () => {
    // 挂载 Home 页面的 React 组件
    cy.mount(<Page />)

    // 新页面应该包含一个带有 "Home" 的 h1
    cy.get('h1').contains('Home')

    // 验证一个带有预期 URL 的链接是否存在
    // 跟随链接更适合 E2E 测试
    cy.get('a[href="/about"]').should('be.visible')
  })
})
cypress/component/about.cy.js
import AboutPage from '../../pages/about'

describe('<AboutPage />', () => {
  it('should render and display expected content', () => {
    // 挂载 About 页面的 React 组件
    cy.mount(<AboutPage />)

    // 新页面应该包含一个带有 "About" 的 h1
    cy.get('h1').contains('About')

    // 验证一个带有预期 URL 的链接是否存在
    // 跟随链接更适合 E2E 测试
    cy.get('a[href="/"]').should('be.visible')
  })
})

注意：

  • Cypress 目前不支持 async 服务器组件的组件测试。我们建议使用 E2E 测试。
  • 由于组件测试不需要 Next.js 服务器，依赖服务器可用的功能（如 <Image />）可能无法开箱即用。

运行组件测试​

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

持续集成 (CI)​

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

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

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

最后于 更新