Skip to content

Cloudflare 测试

你可以使用 @cloudflare/vitest-pool-workers 轻松实现 Cloudflare 测试,为此需要事先进行一些配置,更多相关信息可以在 Cloudflare 关于测试的文档 中找到。

使用 vitest pool workers 的 Cloudflare 测试在运行时提供一个 cloudflare:test 模块,该模块暴露了在测试期间作为第二个参数传入的 env,更多信息请查看 Cloudflare 测试 API 部分

以下是一个可以进行的配置示例:

ts
import { defineWorkersProject } from '@cloudflare/vitest-pool-workers/config'

export default defineWorkersProject(() => {
  return {
    test: {
      globals: true,
      poolOptions: {
        workers: { wrangler: { configPath: './wrangler.toml' } },
      },
    },
  }
})
toml
compatibility_date = "2024-09-09"
compatibility_flags = [ "nodejs_compat" ]

[vars]
MY_VAR = "my variable"

想象一下如下的应用:

ts
// src/index.ts
import { Hono } from 'hono'

type Bindings = {
  MY_VAR: string
}

const app = new Hono<{ Bindings: Bindings }>()

app.get('/hello', (c) => {
  return c.json({ hello: 'world', var: c.env.MY_VAR })
})

export default app

你可以通过传入从 cloudflare:test 模块暴露的 envapp.request() 来测试带有 Cloudflare Bindings 的应用:

ts
// src/index.test.ts
import { env } from 'cloudflare:test'
import app from './index'

describe('Example', () => {
  it('Should return 200 response', async () => {
    const res = await app.request('/hello', {}, env)

    expect(res.status).toBe(200)
    expect(await res.json()).toEqual({
      hello: 'world',
      var: 'my variable',
    })
  })
})

另请参阅

@cloudflare/vitest-pool-workers Github 仓库示例
从旧的测试系统迁移

在 MIT 许可证下发布。