测试工具

如果你是模块的作者，可以在模块作者指南中找到更具体的信息。

Nuxt 通过 @nuxt/test-utils 提供一流的端到端和单元测试支持，这是一套测试工具和配置的库，目前用于我们在 Nuxt 本身中使用的测试以及模块生态系统中的测试。

观看 Alexander Lichter 关于如何入门使用 @nuxt/test-utils 的视频。

安装

为了让你能够管理其他测试依赖项，@nuxt/test-utils 带有各种可选的对等依赖项。例如：

你可以选择 happy-dom 和 jsdom 作为运行时 Nuxt 环境
你可以选择 vitest、cucumber、jest 和 playwright 作为端到端测试运行器
如果你希望使用内置的浏览器测试工具（并且不使用 @playwright/test 作为测试运行器），则仅需要 playwright-core

npm i --save-dev @nuxt/test-utils vitest @vue/test-utils happy-dom playwright-core

单元测试

我们当前提供一个用于单元测试需要 Nuxt 运行时环境的环境。它目前 仅支持 vitest（虽然欢迎对添加其他运行时的贡献）。

设置

将 @nuxt/test-utils/module 添加到你的 nuxt.config 文件中（可选）。它为你的 Nuxt DevTools 添加了 Vitest 集成，支持在开发中运行单元测试。
```
export default defineNuxtConfig
({
  modules
: [
    '@nuxt/test-utils/module'
  ]
})
```

创建一个 vitest.config.ts 文件，内容如下：

import { defineVitestConfig
 } from '@nuxt/test-utils/config'

export default defineVitestConfig
({
  // 你需要的任何自定义 Vitest 配置
})

在你的 vitest 配置中导入 @nuxt/test-utils 时，必须在 package.json 中指定 "type": "module"，或者相应地重命名你的 vitest 配置文件。

例如：vitest.config.m{ts,js}。

可以通过使用 .env.test 文件设置测试的环境变量。

使用 Nuxt 运行时环境

默认情况下，@nuxt/test-utils 不会更改你的默认 Vitest 环境，因此你可以进行细粒度的选择，进行 Nuxt 测试和其他单元测试一起运行。

你可以通过在测试文件名中添加 .nuxt.（例如，my-file.nuxt.test.ts 或 my-file.nuxt.spec.ts）或直接在测试文件中添加 @vitest-environment nuxt 作为注释，来选择使用 Nuxt 环境。

// @vitest-environment nuxt
import { test
 } from 'vitest'

test
('我的测试', () => {
  // ... 在 Nuxt 环境中测试！
})

你也可以在你的 Vitest 配置中设置 environment: 'nuxt'，以启用 所有测试 的 Nuxt 环境。

// vitest.config.ts
import { fileURLToPath
 } from 'node:url'
import { defineVitestConfig
 } from '@nuxt/test-utils/config'

export default defineVitestConfig
({
  test
: {
    environment
: 'nuxt',
    // 你可以选择性地设置 Nuxt 特定的环境选项
    // environmentOptions: {
    //   nuxt: {
    //     rootDir: fileURLToPath(new URL('./playground', import.meta.url)),
    //     domEnvironment: 'happy-dom', // 'happy-dom'（默认）或 'jsdom'
    //     overrides: {
    //       // 其他你想传递的 Nuxt 配置
    //     }
    //   }
    // }
  }
})

如果你默认设置了 environment: 'nuxt'，你可以根据需要选择每个测试文件退出默认环境。

// @vitest-environment node
import { test
 } from 'vitest'

test
('我的测试', () => {
  // ... 在没有 Nuxt 环境中测试！
})

当你在 Nuxt 环境中运行测试时，它们将在 happy-dom 或 jsdom 环境中运行。在测试运行之前，将初始化一个全局 Nuxt 应用（包括，例如，运行你在 app.vue 中定义的任何插件或代码）。这意味着你应该特别小心不要在测试中改变全局状态（或者，如果需要，在之后重置它）。

🎭 内置模拟

@nuxt/test-utils 提供了一些用于 DOM 环境的内置模拟。

`intersectionObserver`

默认 true，创建一个没有任何功能的 IntersectionObserver API 的虚拟类。

`indexedDB`

默认 false，使用 fake-indexeddb 创建 IndexedDB API 的功能模拟。

这些可以在 vitest.config.ts 文件的 environmentOptions 部分中配置：

import { defineVitestConfig
 } from '@nuxt/test-utils/config'

export default defineVitestConfig
({
  test
: {
    environmentOptions
: {
      nuxt
: {
        mock
: {
          intersectionObserver
: true,
          indexedDb
: true,
        }
      }
    }
  }
})

🛠️ 辅助工具

@nuxt/test-utils 提供了多个辅助工具，使测试 Nuxt 应用更容易。

`mountSuspended`

mountSuspended 允许你在 Nuxt 环境中挂载任何 Vue 组件，支持异步设置和访问来自 Nuxt 插件的注入。

在底层，mountSuspended 包装了 @vue/test-utils 的 mount，因此你可以查看 Vue 测试工具文档了解你可以传递的选项以及如何使用此工具。

例如：

// tests/components/SomeComponents.nuxt.spec.ts
import { mountSuspended
 } from '@nuxt/test-utils/runtime'
import { SomeComponent
 } from '#components'

it
('可以挂载某个组件', async () => {
    const component
 = await mountSuspended
(SomeComponent
)
    expect
(component
.text
()).toMatchInlineSnapshot
(
        '"这是一个自动导入的组件"'
    )
})

import { it, expect } from 'vitest'
// ---cut---
// tests/components/SomeComponents.nuxt.spec.ts
import { mountSuspended } from '@nuxt/test-utils/runtime'
import App from '~/app.vue'

// tests/App.nuxt.spec.ts
it('也可以挂载一个应用', async () => {
    const component = await mountSuspended(App, { route: '/test' })
    expect(component.html()).toMatchInlineSnapshot(`
      "<div>这是一个自动导入的组件</div>
      <div> 我是一个全局组件 </div>
      <div>/</div>
      <a href="/test"> 测试链接 </a>"
    `)
})

`renderSuspended`

renderSuspended 允许你在 Nuxt 环境中使用 @testing-library/vue 渲染任何 Vue 组件，支持异步设置和访问来自 Nuxt 插件的注入。

这应该与 Testing Library 的工具一起使用，例如 screen 和 fireEvent。在你的项目中安装 @testing-library/vue 以使用这些功能。

此外，Testing Library 还依赖于用于清理的测试全局变量。你应该在你的 Vitest 配置中打开它们。

传入的组件将在一个 <div id="test-wrapper"></div> 中渲染。

示例：

// tests/components/SomeComponents.nuxt.spec.ts
import { renderSuspended
 } from '@nuxt/test-utils/runtime'
import { SomeComponent
 } from '#components'
import { screen
 } from '@testing-library/vue'

it
('可以渲染某个组件', async () => {
  await renderSuspended
(SomeComponent
)
  expect
(screen
.getByText
('这是一个自动导入的组件')).toBeDefined
()
})

import { it, expect } from 'vitest'
// ---cut---
// tests/App.nuxt.spec.ts
import { renderSuspended } from '@nuxt/test-utils/runtime'
import App from '~/app.vue'

it('也可以渲染一个应用', async () => {
  const html = await renderSuspended(App, { route: '/test' })
  expect(html).toMatchInlineSnapshot(`
    "<div id="test-wrapper">
      <div>这是一个自动导入的组件</div>
      <div> 我是一个全局组件 </div>
      <div>首页</div><a href="/test"> 测试链接 </a>
    </div>"
  `)
})

`mockNuxtImport`

mockNuxtImport 允许你模拟 Nuxt 的自动导入功能。例如，要模拟 useStorage，你可以这样做：

import { mockNuxtImport
 } from '@nuxt/test-utils/runtime'

mockNuxtImport
('useStorage', () => {
  return () => {
    return { value
: '模拟存储' }
  }
})

// 在这里编写测试

mockNuxtImport 每个测试文件中每个被模拟的导入只能使用一次。它实际上是一个宏，转换为 vi.mock，并且 vi.mock 是提升的，详细说明见这里。

如果你需要模拟一个 Nuxt 导入并在测试之间提供不同的实现，可以通过创建和暴露你的模拟，使用 vi.hoisted，然后在 mockNuxtImport 中使用这些模拟。这样，你就可以访问模拟的导入，并在测试之间更改实现。注意在每个测试之前或之后还原模拟以撤销运行之间的模拟状态更改。

import { vi
 } from 'vitest'
import { mockNuxtImport
 } from '@nuxt/test-utils/runtime'

const { useStorageMock
 } = vi
.hoisted
(() => {
  return {
    useStorageMock
: vi
.fn
(() => {
      return { value
: '模拟存储'}
    })
  }
})

mockNuxtImport
('useStorage', () => {
  return useStorageMock
})

// 然后，在一个测试中
useStorageMock
.mockImplementation
(() => {
  return { value
: '其他东西' }
})

`mockComponent`

mockComponent 允许你模拟 Nuxt 的组件。第一个参数可以是 PascalCase 中的组件名称，或组件的相对路径。第二个参数是一个工厂函数，返回模拟的组件。

例如，要模拟 MyComponent，你可以：

import { mockComponent } from '@nuxt/test-utils/runtime'

mockComponent('MyComponent', {
  props: {
    value: String
  },
  setup(props) {
    // ...
  }
})

// 相对路径或别名也可行
mockComponent('~/components/my-component.vue', async () => {
  // 或者一个工厂函数
  return defineComponent({
    setup(props) {
      // ...
    }
  })
})

// 或者你可以用 SFC 重定向到一个模拟组件
mockComponent('MyComponent', () => import('./MockComponent.vue'))

// 在这里编写测试

注意：无法在工厂函数中引用局部变量，因为它们被提升。如果需要访问 Vue API 或其他变量，必须在工厂函数中导入它们。

import { mockComponent
 } from '@nuxt/test-utils/runtime'

mockComponent
('MyComponent', async () => {
  const { ref
, h
 } = await import('vue')

  return defineComponent
({
    setup
(props
) {
      const counter
 = ref
(0)
      return () => h
('div', null, counter
.value
)
    }
  })
})

`registerEndpoint`

registerEndpoint 允许你创建返回模拟数据的 Nitro 端点。如果你想测试一个向 API 请求以显示某些数据的组件，这可能会很有用。

第一个参数是端点名称（例如 /test/）。第二个参数是返回模拟数据的工厂函数。

例如，要模拟 /test/ 端点，你可以这样做：

import { registerEndpoint
 } from '@nuxt/test-utils/runtime'

registerEndpoint
('/test/', () => ({
  test
: '测试字段'
}))

默认情况下，你的请求将使用 GET 方法。如果通过将对象作为第二个参数而不是函数，可以使用其他方法。

import { registerEndpoint
 } from '@nuxt/test-utils/runtime'

registerEndpoint
('/test/', {
  method
: 'POST',
  handler
: () => ({ test
: '测试字段' })
})

注意：如果你组件中的请求指向一个外部 API，你可以使用 baseURL 并使用 Nuxt 环境覆盖配置（$test），这样所有请求都将指向 Nitro 服务器。

与端到端测试的冲突

@nuxt/test-utils/runtime 和 @nuxt/test-utils/e2e 需要在不同的测试环境中运行，因此不能在同一个文件中使用。

如果你想使用 @nuxt/test-utils 的端到端和单元测试功能，可以将测试分散到不同的文件中。你可以通过特殊的 // @vitest-environment nuxt 注释为每个文件指定测试环境，或者将你的运行时单元测试文件命名为 .nuxt.spec.ts 扩展名。

app.nuxt.spec.ts

import { mockNuxtImport
 } from '@nuxt/test-utils/runtime'

mockNuxtImport
('useStorage', () => {
  return () => {
    return { value
: '模拟存储' }
  }
})

app.e2e.spec.ts

import { setup
, $fetch
 } from '@nuxt/test-utils/e2e'

await setup
({
  setupTimeout
: 10000,
})

// ...

使用 `@vue/test-utils`

如果你更喜欢单独使用 @vue/test-utils 进行 Nuxt 的单元测试，并且你只测试不依赖于 Nuxt 组合式 API、自动导入或上下文的组件，你可以按照以下步骤进行设置。

安装所需的依赖

npm i --save-dev vitest @vue/test-utils happy-dom @vitejs/plugin-vue

创建一个 vitest.config.ts，内容如下：

import { defineConfig } from 'vitest/config'
import vue from '@vitejs/plugin-vue'

export default defineConfig({
  plugins: [vue()],
  test: {
    environment: 'happy-dom',
  },
});

在你的 package.json 中添加一个测试的新命令

"scripts": {
  "build": "nuxt build",
  "dev": "nuxt dev",
  ...
  "test": "vitest"
},

创建一个简单的 <HelloWorld> 组件 components/HelloWorld.vue，内容如下：
```
<template>
  <p>你好，世界</p>
</template>
```

为这个新创建的组件创建一个简单的单元测试 ~/components/HelloWorld.spec.ts

import { describe, it, expect } from 'vitest'
import { mount } from '@vue/test-utils'

import HelloWorld from './HelloWorld.vue'

describe('HelloWorld', () => {
  it('组件正确渲染 Hello world', () => {
    const wrapper = mount(HelloWorld)
    expect(wrapper.text()).toContain('你好，世界')
  })
})

运行 vitest 命令
```
npm run test
```

恭喜你，你已准备好开始使用 @vue/test-utils 进行 Nuxt 的单元测试！祝你测试愉快！

端到端测试

对于端到端测试，我们支持 Vitest、Jest、Cucumber 和 Playwright 作为测试运行器。

设置

在每个 describe 块中使用 @nuxt/test-utils/e2e 帮助方法时，你需要在开始之前设置测试上下文。

test/my-test.spec.ts

import { describe
, test
 } from 'vitest'
import { setup
, $fetch
 } from '@nuxt/test-utils/e2e'

describe
('我的测试', async () => {
  await setup
({
    // 测试上下文选项
  })

  test
('我的测试', () => {
    // ...
  })
})

在幕后，setup 在 beforeAll、beforeEach、afterEach 和 afterAll 中执行许多任务，以正确设置 Nuxt 测试环境。

请使用以下选项来配置 setup 方法。

Nuxt 配置

rootDir：要测试的 Nuxt 应用的目录路径。
- 类型：string
- 默认：'.'
configFile：配置文件的名称。
- 类型：string
- 默认：'nuxt.config'

时限

setupTimeout：允许 setupTest 完成其工作的时间（以毫秒为单位）（这可能包括构建或生成 Nuxt 应用的文件，具体取决于传递的选项）。
- 类型：number
- 默认：60000

功能

build：是否运行一个单独的构建步骤。
- 类型：boolean
- 默认：true（如果禁用 browser 或 server，或者提供了 host，则为 false）
server：是否启动一个服务器来响应测试套件中的请求。
- 类型：boolean
- 默认：true（如果提供了 host，则为 false）
port：如果提供，则将启动的测试服务器端口设置为该值。
- 类型：number | undefined
- 默认：undefined
host：如果提供，则使用 URL 作为测试目标，而不是重新构建并运行一个新服务器。对于在生产环境中通常使用的部署版本的应用进行 "真实" 端到端测试或指向已运行的本地服务器，会有显著减少测试执行时间的好处。请参见下面的目标主机端到端示例。
- 类型：string
- 默认：undefined
browser：在底层，Nuxt 测试工具使用 playwright 进行浏览器测试。如果设置了此选项，将启动浏览器，并可以在后续的测试套件中控制。
- 类型：boolean
- 默认：false
browserOptions
- 类型：object，具有以下属性
  - type：要启动的浏览器类型 - 可以是 chromium、firefox 或 webkit
  - launch：一个对象，包含将传递给 playwright 的启动浏览器的选项。请参见完整 API 参考。
runner：指定测试套件的运行器。目前推荐使用 Vitest。
- 类型：'vitest' | 'jest' | 'cucumber'
- 默认：'vitest'

目标 `host` 端到端示例

端到端测试的常见用例是针对在通常用作生产的同一环境中运行的部署应用程序运行测试。

对于本地开发或自动部署管道，针对单独的本地服务器进行测试可能更有效，并且通常比让测试框架在测试之间重建更快。

要利用单独的目标主机进行端到端测试，只需为 setup 函数提供 host 属性和所需的 URL。

import { setup, createPage } from '@nuxt/test-utils/e2e'
import { describe, it, expect } from 'vitest'

describe('登录页面', async () => {
  await setup({
    host: 'http://localhost:8787',
  })

  it('显示电子邮件和密码字段', async () => {
    const page = await createPage('/login')
    expect(await page.getByTestId('email').isVisible()).toBe(true)
    expect(await page.getByTestId('password').isVisible()).toBe(true)
  })
})

APIs

`$fetch(url)`

获取服务器渲染页面的 HTML。

import { $fetch
 } from '@nuxt/test-utils/e2e'

const html
 = await $fetch
('/')

`fetch(url)`

获取服务器渲染页面的响应。

import { fetch
 } from '@nuxt/test-utils/e2e'

const res
 = await fetch
('/')
const { body
, headers
 } = res

`url(path)`

获取给定页面的完整 URL（包括测试服务器运行的端口）。

import { url
 } from '@nuxt/test-utils/e2e'

const pageUrl
 = url
('/page')
// 'http://localhost:6840/page'

在浏览器中测试

我们在 @nuxt/test-utils 中提供内置支持，使用 Playwright，无论是通过编程方式还是通过 Playwright 测试运行器。

`createPage(url)`

在 vitest、jest 或 cucumber 中，你可以使用 createPage 创建一个配置的 Playwright 浏览器实例，并（可选地）指向 running 服务器的一个路径。你可以在 Playwright 文档中找到可用的 API 方法的更多信息。

import { createPage
 } from '@nuxt/test-utils/e2e'

const page
 = await createPage
('/page')
// 你可以从 `page` 变量访问所有 Playwright API

使用 Playwright 测试运行器进行测试

我们还提供了使用 Playwright 测试运行器测试 Nuxt 的一流支持。

npm i --save-dev @playwright/test @nuxt/test-utils

你可以提供全局 Nuxt 配置，使用与之前提到的 setup() 函数相同的配置详细信息。

playwright.config.ts

import { fileURLToPath } from 'node:url'
import { defineConfig, devices } from '@playwright/test'
import type { ConfigOptions } from '@nuxt/test-utils/playwright'

export default defineConfig<ConfigOptions>({
  use: {
    nuxt: {
      rootDir: fileURLToPath(new URL('.', import.meta.url))
    }
  },
  // ...
})

Read more in 查看完整的示例配置.

然后你的测试文件应该直接使用 expect 和 test 从 @nuxt/test-utils/playwright：

tests/example.test.ts

import { expect, test } from '@nuxt/test-utils/playwright'

test('测试', async ({ page, goto }) => {
  await goto('/', { waitUntil: 'hydration' })
  await expect(page.getByRole('heading')).toHaveText('欢迎使用 Playwright！')
})

你也可以直接在测试文件中配置你的 Nuxt 服务器：

tests/example.test.ts

import { expect, test } from '@nuxt/test-utils/playwright'

test.use({
  nuxt: {
    rootDir: fileURLToPath(new URL('..', import.meta.url))
  }
})

test('测试', async ({ page, goto }) => {
  await goto('/', { waitUntil: 'hydration' })
  await expect(page.getByRole('heading')).toHaveText('欢迎使用 Playwright！')
})

部署

学习如何将你的 Nuxt 应用部署到任何托管提供商。

升级指南

了解如何升级到最新的 Nuxt 版本。

目标 host 端到端示例

目标 `host` 端到端示例