测试！

如何测试您的 Nuxt 应用程序。

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

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

安装

为了允许您管理其他测试依赖项，@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('my 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('my 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 Test Utils 文档以了解更多关于您可以传递的选项以及如何使用此工具。

例如：

// @noErrors
import { it, expect } from 'vitest'
import type { Component } from 'vue'
declare module '#components' {
  export const SomeComponent: Component
}
// ---cut---
// tests/components/SomeComponents.nuxt.spec.ts
import { mountSuspended } from '@nuxt/test-utils/runtime'
import { SomeComponent } from '#components'

it('can mount some component', async () => {
    const component = await mountSuspended(SomeComponent)
    expect(component.text()).toMatchInlineSnapshot(
        '"This is an auto-imported component"'
    )
})

// @noErrors
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('can also mount an app', async () => {
    const component = await mountSuspended(App, { route: '/test' })
    expect(component.html()).toMatchInlineSnapshot(`
      "<div>This is an auto-imported component</div>
      <div> I am a global component </div>
      <div>/</div>
      <a href="/test"> Test link </a>"
    `)
})

`renderSuspended`

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

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

此外，Testing Library 还依赖于测试全局变量进行清理。您应该在您的 Vitest 配置中打开这些选项。

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

示例：

// @noErrors
import { it, expect } from 'vitest'
import type { Component } from 'vue'
declare module '#components' {
  export const SomeComponent: Component
}
// ---cut---
// tests/components/SomeComponents.nuxt.spec.ts
import { renderSuspended } from '@nuxt/test-utils/runtime'
import { SomeComponent } from '#components'
import { screen } from '@testing-library/vue'

it('can render some component', async () => {
  await renderSuspended(SomeComponent)
  expect(screen.getByText('This is an auto-imported component')).toBeDefined()
})

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

it('can also render an app', async () => {
  const html = await renderSuspended(App, { route: '/test' })
  expect(html).toMatchInlineSnapshot(`
    "<div id="test-wrapper">
      <div>This is an auto-imported component</div>
      <div> I am a global component </div>
      <div>Index page</div><a href="/test"> Test link </a>
    </div>"
  `)
})

`mockNuxtImport`

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

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

mockNuxtImport('useStorage', () => {
  return () => {
    return { value: 'mocked storage' }
  }
})

// your tests here

mockNuxtImport 每个测试文件每个模拟导入只能使用一次。它实际上是一个宏，会被转换为 vi.mock，而 vi.mock 是提升的，如 Vitest 文档中所述。

如果您需要模拟 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: 'mocked storage'}
    })
  }
})

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

// Then, inside a test
useStorageMock.mockImplementation(() => {
  return { value: 'something else' }
})

`mockComponent`

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

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

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

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

// relative path or alias also works
mockComponent('~/components/my-component.vue', async () => {
  // or a factory function
  return defineComponent({
    setup(props) {
      // ...
    }
  })
})

// or you can use SFC for redirecting to a mock component
mockComponent('MyComponent', () => import('./MockComponent.vue'))

// your tests here

注意：您不能在工厂函数中引用局部变量，因为它们是提升的。如果您需要访问 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: 'test-field'
}))

默认情况下，您的请求将使用 GET 方法进行。您可以通过将对象设置为第二个参数而不是函数来使用其他方法。

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

registerEndpoint('/test/', {
  method: 'POST',
  handler: () => ({ test: 'test-field' })
})

注意：如果您的组件中的请求是去外部 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: 'mocked storage' }
  }
})

app.e2e.spec.ts

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

await setup({
  setupTimeout: 10000,
})

// ...

使用 `@vue/test-utils`

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

安装所需的依赖项

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>Hello world</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('component renders Hello world properly', () => {
    const wrapper = mount(HelloWorld)
    expect(wrapper.text()).toContain('Hello world')
  })
})

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

恭喜，您已经准备好在 Nuxt 中使用 @vue/test-utils 开始单元测试了！祝您测试愉快！

端到端测试

对于端到端测试，我们支持 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('My test', async () => {
  await setup({
    // 测试上下文选项
  })

  test('my 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 的选项 object。请参阅完整 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('login page', async () => {
  await setup({
    host: 'http://localhost:8787',
  })

  it('displays the email and password fields', async () => {
    const page = await createPage('/login')
    expect(await page.getByTestId('email').isVisible()).toBe(true)
    expect(await page.getByTestId('password').isVisible()).toBe(true)
  })
})

API

`$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 浏览器实例，并（可选地）将其指向运行服务器的路径。您可以在 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))
    }
  },
  // ...
})

另请参阅查看完整示例配置

您的测试文件应直接使用 @nuxt/test-utils/playwright 中的 expect 和 test：

tests/example.test.ts

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

test('test', async ({ page, goto }) => {
  await goto('/', { waitUntil: 'hydration' })
  await expect(page.getByRole('heading')).toHaveText('Welcome to 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('test', async ({ page, goto }) => {
  await goto('/', { waitUntil: 'hydration' })
  await expect(page.getByRole('heading')).toHaveText('Welcome to Playwright!')
})

※此页面是 Nuxt.js 官方文档的非官方翻译页面。

官方文档中的相应页面在此处：
https://nuxt.com/docs/3.x/getting-started/testing

安装

单元测试

设置

使用 Nuxt 运行时环境

🎭 内置模拟

intersectionObserver

indexedDB

🛠️ 辅助工具

mountSuspended

renderSuspended

mockNuxtImport

mockComponent

registerEndpoint