Tests auf Cloudflare

Mit @cloudflare/vitest-pool-workers kannst du Tests auf Cloudflare einfach umsetzen. Dafür ist zunächst eine gewisse Konfiguration erforderlich. Weitere Informationen findest du in der Cloudflare-Dokumentation zu Tests.

Beim Testen auf Cloudflare mit dem Vitest-Workers-Pool steht zur Laufzeit das Modul cloudflare:test bereit. Es stellt das Umgebungsobjekt bereit, das beim Testen als zweites Argument übergeben wird. Weitere Informationen findest du im Abschnitt zu den Cloudflare-Test-APIs.

Hier ist eine mögliche Beispielkonfiguration:

vitest.config.ts

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

export default defineWorkersProject(() => {
  return {
    test: {
      globals: true,
      poolOptions: {
        workers: { wrangler: { configPath: './wrangler.toml' } },
      },
    },
  }
})

wrangler.toml

compatibility_date = "2024-09-09"
compatibility_flags = [ "nodejs_compat" ]

[vars]
MY_VAR = "my variable"

Gehen wir von folgender Anwendung aus:

// 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

Du kannst die Anwendung mit Cloudflare-Bindings testen, indem du das vom Modul cloudflare:test bereitgestellte env an app.request() übergibst:

// 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',
    })
  })
})

Siehe auch

@cloudflare/vitest-pool-workers: Beispiele im GitHub-Repository
Vom alten Testsystem migrieren