untestutils

untestutils

Docs: https://s00d.github.io/untestutils/

Test the product the way it actually runs — not a mock of a mock of a framework.

Most “test utils” help you write more tests. untestutils changes what you test: the same prepare → start → URL/dir path your users hit, with real cookies, SEO headers, redirects, locale payloads, and browser behavior — shared once across Vitest and Playwright.

The idea

Shipping software is not “a component mounted in happy-dom”. It is:

• a built (or generated) app
• a running process on a real URL
• data and side effects that only appear after prepare/start (i18n merges, cookies, sitemap, Nitro routes, …)

If your suite never walks that path, you are testing a parallel universe. Failures show up in staging instead.

untestutils is a harness around one contract:

Recipe  →  prepare?  →  start  →  { url } and/or { dir }
Harness →  useHarness('id')  /  Playwright test.use({ harness })

You describe how the real target comes up. Specs assert against that live target. Prepare is cached and shared — so “test like production” stays fast enough for CI.

Why not “just helpers”?

Utils (untestutils/utils) exist, but they are tools for real-runtime checks — not a second testing philosophy.

What you get

• Recipes, not preset zoos — compose targets; Nuxt is a factory, not a special universe
• Shared prepare — warm once, reuse across workers / projects
• Vitest + Playwright — same ids; fixtures page / goto / $fetch
• Remote host() — post-deploy smoke against staging/prod
• Reality-oriented utils — cookies, SEO head, domain emulation, redirect tracking, poll
• CLI — init, doctor, optional AI fix / cover / generate
• Perf suite — build + load against the same recipe mindset (untestutils/perf)
• Support matrix — what is stable in CI vs optional / out of 1.0

Quick start

pnpm add -D untestutils vitest
# optional
pnpm add -D @playwright/test playwright-core

pnpm dlx untestutils init --preset vitest

// recipes.ts — how the real app comes up
import { defineRecipes } from 'untestutils'
import { nuxt } from 'untestutils/nuxt'
import { resolve } from 'node:path'

export const recipes = defineRecipes({
  basic: nuxt({
    id: 'basic',
    root: resolve('./fixtures/basic'),
    run: 'server',
  }),
}, import.meta.url)

// vitest.config.ts — plugin from untestutils/vitest/plugin
import { defineConfig } from 'vitest/config'
import { untestutils } from 'untestutils/vitest/plugin'
import { recipes } from './recipes'

export default defineConfig({
  plugins: [
    untestutils({
      recipes,
      prewarm: ['basic'],
    }),
  ],
  test: { include: ['tests/e2e/**/*.test.ts'] },
})

// tests/e2e/locale.test.ts — specs from untestutils/vitest
import { describe, test, expect, useHarness } from 'untestutils/vitest'
import { setLocaleCookie, getLocaleCookie } from 'untestutils/utils'

describe('locale', () => {
  test('cookie survives reload on the live app', async ({ page }) => {
    const app = await useHarness('basic')
    await page.goto(app.url)
    await setLocaleCookie(page, 'de')
    await page.reload()
    expect(await getLocaleCookie(page)).toBe('de')
  })
})

Same Recipe id works from Playwright via createPlaywrightConfig — one definition of “how the app runs”, two runners.

Links

• Docs
• Why · Getting started
• How it works
• Support matrix
• Vitest · Playwright
• Migration from @nuxt/test-utils
• CLI · API
• Roadmap · CONTRIBUTING

License

MIT