测试工具

如何测试你的 Nuxt 应用程序。
如果你是模块作者,你可以在 模块作者指南 中找到更具体的信息。

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

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

安装

为了让你管理其他测试依赖项,@nuxt/test-utils 附带了各种可选的同行依赖项。例如:

  • 你可以选择 happy-domjsdom 作为运行时的 Nuxt 环境
  • 你可以选择 vitestcucumberjestplaywright 作为端到端测试运行器
  • 只有当你希望使用内置的浏览器测试工具(而不使用 @playwright/test 作为你的测试运行器)时,才需要 playwright-core
npm i --save-dev @nuxt/test-utils vitest @vue/test-utils happy-dom playwright-core

单元测试

我们目前提供一个用于单元测试需要 Nuxt 运行环境的代码的环境。它目前 仅支持 vitest (虽然欢迎为其他运行时提供贡献)。

设置

  1. @nuxt/test-utils/module 添加到你的 nuxt.config 文件中(可选)。它为你的 Nuxt DevTools 添加了 Vitest 集成,支持在开发中运行单元测试。
    export default defineNuxtConfig({
      modules: [
        '@nuxt/test-utils/module'
      ]
    })
    
  2. 创建一个 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.tsmy-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-domjsdom 环境中运行。在测试运行之前,将初始化一个全局 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('can mount some component', async () => {
    const component = await mountSuspended(SomeComponent)
    expect(component.text()).toMatchInlineSnapshot(
        '"This is an auto-imported component"'
    )
})
// 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 允许你在 Nuxt 环境中使用 @testing-library/vue 渲染任何 Vue 组件,使异步设置和访问来自 Nuxt 插件的注入成为可能。

这应该与 Testing Library 的工具一起使用,例如 screenfireEvent。在你的项目中安装 @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('can render some component', async () => {
  await renderSuspended(SomeComponent)
  expect(screen.getByText('This is an auto-imported component')).toBeDefined()
})
// 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' }
  }
})

// 你的测试在这里
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: 'mocked storage'}
    })
  }
})

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

// 然后,在测试中
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) {
    // ...
  }
})

// 相对路径或别名也有效
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: '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 composables、自动导入或上下文的组件,你可以按照以下步骤进行设置。

  1. 安装所需的依赖项
    npm i --save-dev vitest @vue/test-utils happy-dom @vitejs/plugin-vue
    
  2. 创建一个 vitest.config.ts,内容如下:
    import { defineConfig } from 'vitest/config'
    import vue from '@vitejs/plugin-vue'
    
    export default defineConfig({
      plugins: [vue()],
      test: {
        environment: 'happy-dom',
      },
    });
    
  3. 在你的 package.json 中添加一个新的测试命令
    "scripts": {
      "build": "nuxt build",
      "dev": "nuxt dev",
      ...
      "test": "vitest"
    },
    
  4. 创建一个简单的 <HelloWorld> 组件 components/HelloWorld.vue,内容如下:
    <template>
      <p>你好,世界</p>
    </template>
    
  5. 为这个新创建的组件创建一个简单的单元测试 ~/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('你好,世界')
      })
    })
    
  6. 运行 vitest 命令
    npm run test
    

恭喜你,你已准备好在 Nuxt 中使用 @vue/test-utils 开始单元测试!祝你测试愉快!

端到端测试

对于端到端测试,我们支持 VitestJestCucumberPlaywright 作为测试运行器。

设置

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

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

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

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

在幕后,setupbeforeAllbeforeEachafterEachafterAll 中执行多个任务,以正确设置 Nuxt 测试环境。

请在 setup 方法中使用以下选项。

Nuxt 配置

  • rootDir: 指向要进行测试的 Nuxt 应用的目录路径。
    • 类型: string
    • 默认值: '.'
  • configFile: 配置文件的名称。
    • 类型: string
    • 默认值: 'nuxt.config'

时机

  • setupTimeout: 允许 setupTest 完成其工作的时间(以毫秒为单位)(这可能包括根据传递的选项构建或生成 Nuxt 应用程序文件)。
    • 类型: number
    • 默认值: 60000

功能

  • build: 是否运行单独的构建步骤。
    • 类型: boolean
    • 默认值: true(如果禁用 browserserver 或提供了 host,则为 false
  • server: 是否启动服务器以响应测试套件中的请求。
    • 类型: boolean
    • 默认值: true(如果提供了 host,则为 false
  • port: 如果提供,则将启动的测试服务器端口设置为该值。
    • 类型: number | undefined
    • 默认值: undefined
  • host: 如果提供,使用一个 URL 作为测试目标,而不是构建和运行新的服务器。这对于针对已部署版本的应用程序或已运行的本地服务器进行“真实”的端到端测试非常有用(这可能显著减少测试执行时间)。请参阅 目标主机端到端示例
    • 类型: string
    • 默认值: undefined
  • browser: 在底层,Nuxt 测试工具使用 playwright 进行浏览器测试。如果设置了此选项,将启动一个浏览器,并可以在随后的测试套件中进行控制。
    • 类型: boolean
    • 默认值: false
  • browserOptions
    • 类型: object,具有以下属性
      • type: 要启动的浏览器类型 - chromiumfirefoxwebkit
      • launch: 向 playwight 启动浏览器时将传递的选项的 object。请参见 完整的 API 参考
  • runner: 指定测试套件的运行器。目前推荐使用 Vitest
    • 类型: 'vitest' | 'jest' | 'cucumber'
    • 默认值: 'vitest'
目标 host 端到端示例

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

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

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

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)
  })
})

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)

vitestjestcucumber 内,你可以使用 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))
    }
  },
  // ...
})
Read more in 查看完整的示例配置.

你的测试文件应直接使用来自 @nuxt/test-utils/playwrightexpecttest

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!')
})