feat(nuxi)!: setup nuxt globally with nuxt test

examples/advanced/testing/package.json

@@ -4,9 +4,11 @@
   "scripts": {
     "build": "nuxi build",
     "dev": "nuxi dev",
-    "start": "nuxi preview"
+    "start": "nuxi preview",
+    "test": "nuxi test"
   },
   "devDependencies": {
+    "@nuxt/test-utils": "npm:@nuxt/test-utils-edge@latest",
     "nuxt": "npm:nuxt3@latest"
   }
 }

examples/advanced/testing/tests/basic.test.ts

@@ -1,13 +1,7 @@
-import { fileURLToPath } from 'node:url'
 import { describe, expect, it } from 'vitest'
-import { setup, $fetch, isDev } from '@nuxt/test-utils'
-
-describe('example', async () => {
-  await setup({
-    rootDir: fileURLToPath(new URL('..', import.meta.url)),
-    server: true
-  })
+import { $fetch, isDev } from '@nuxt/test-utils'
 
+describe('example', () => {
   it('Renders Hello Nuxt', async () => {
     expect(await $fetch('/')).toMatch('Hello Nuxt!')
   })

packages/nuxi/src/commands/test.ts

@@ -33,7 +33,9 @@ async function importTestUtils (): Promise<typeof import('@nuxt/test-utils')> {
         throw new Error('Invalid version of `@nuxt/test-utils` is installed!')
       }
       return exports
-    } catch (_err) { err = _err }
+    } catch (_err) {
+      err = _err
+    }
   }
   console.error(err)
   throw new Error('`@nuxt/test-utils-edge` seems missing. Run `npm i -D @nuxt/test-utils-edge` or `yarn add -D @nuxt/test-utils-edge` to install.')

packages/test-utils/build.config.ts

@@ -3,7 +3,8 @@ import { defineBuildConfig } from 'unbuild'
 export default defineBuildConfig({
   declaration: true,
   entries: [
-    'src/index'
+    'src/index',
+    { input: 'src/runtime/', outDir: 'dist/runtime', format: 'esm' }
   ],
   dependencies: [
   ],

packages/test-utils/package.json

@@ -19,7 +19,8 @@
     "execa": "^6.1.0",
     "get-port-please": "^2.5.0",
     "jiti": "^1.13.0",
-    "ohmyfetch": "^0.4.18"
+    "ohmyfetch": "^0.4.18",
+    "pathe": "^0.3.0"
   },
   "devDependencies": {
     "playwright": "^1.22.2",

packages/test-utils/src/context.ts

@@ -26,6 +26,7 @@ export function createTestContext (options: Partial<TestOptions>): TestContext {
 }
 
 export function useTestContext (): TestContext {
+  recoverContextFromEnv()
   if (!currentContext) {
     throw new Error('No context is available. (Forgot calling setup or createContext?)')
   }
@@ -41,3 +42,22 @@ export function isDev () {
   const ctx = useTestContext()
   return ctx.options.dev
 }
+
+export function recoverContextFromEnv () {
+  if (process.env.NUXT_TEST_CONTEXT && !currentContext) {
+    setTestContext(JSON.parse(process.env.NUXT_TEST_CONTEXT))
+  }
+}
+
+export function exposeContextToEnv () {
+  const {
+    options,
+    browser,
+    url
+  } = currentContext
+  process.env.NUXT_TEST_CONTEXT = JSON.stringify({
+    options,
+    browser,
+    url
+  })
+}

packages/test-utils/src/dirs.ts

@@ -0,0 +1,5 @@
+import { fileURLToPath } from 'node:url'
+import { dirname, resolve } from 'pathe'
+
+export const distDir = dirname(fileURLToPath(import.meta.url))
+export const pkgDir = resolve(distDir, '..')

packages/test-utils/src/index.ts

@@ -4,3 +4,4 @@ export * from './nuxt'
 export * from './server'
 export * from './setup'
 export * from './run'
+export * from './types'

packages/test-utils/src/run.ts

@@ -1,12 +1,17 @@
+import { resolve } from 'pathe'
+import { distDir } from './dirs'
+
 export interface RunTestOptions {
   rootDir: string,
   dev?: boolean,
   watch?: boolean
   runner?: 'vitest'
+  globalSetup?: boolean
 }
 
 const RunTestDefaults: Partial<RunTestOptions> = {
-  runner: 'vitest'
+  runner: 'vitest',
+  globalSetup: true
 }
 
 export async function runTests (opts: RunTestOptions) {
@@ -21,18 +26,35 @@ export async function runTests (opts: RunTestOptions) {
     process.env.NUXT_TEST_DEV = 'true'
   }
 
+  process.env.NUXT_TEST_OPTIONS = JSON.stringify(opts)
+
   const { startVitest } = await import('vitest/dist/node.js')
   const succeeded = await startVitest(
     [] /* argv */,
     // Vitest options
     {
-      root: opts.rootDir,
       run: !opts.watch
     },
     // Vite options
     {
       esbuild: {
         tsconfigRaw: '{}'
+      },
+      test: {
+        dir: opts.rootDir,
+        deps: {
+          inline: [
+            distDir,
+            '@nuxt/test-utils',
+            '@nuxt/test-utils-edge'
+          ]
+        },
+        globals: true,
+        globalSetup: [
+          opts.globalSetup
+            ? resolve(distDir, './runtime/global-setup.mjs')
+            : undefined
+        ]
       }
     }
   )

packages/test-utils/src/runtime/global-setup.ts

@@ -0,0 +1,12 @@
+import { createTest, exposeContextToEnv } from '@nuxt/test-utils'
+
+const hooks = createTest(JSON.parse(process.env.NUXT_TEST_OPTIONS))
+
+export const setup = async () => {
+  await hooks.setup()
+  exposeContextToEnv()
+}
+
+export const teardown = async () => {
+  await hooks.afterAll()
+}

packages/test-utils/src/setup/index.ts

@@ -67,7 +67,7 @@ export function createTest (options: Partial<TestOptions>): TestHooks {
   }
 }
 
-export async function setup (options: Partial<TestOptions>) {
+export async function setup (options: Partial<TestOptions> = {}) {
   const hooks = createTest(options)
 
   const setupFn = setupMaps[hooks.ctx.options.runner]

yarn.lock

@@ -1697,6 +1697,12 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@nuxt/test-utils@link:./packages/test-utils::locator=nuxt-framework%40workspace%3A.":
+  version: 0.0.0-use.local
+  resolution: "@nuxt/test-utils@link:./packages/test-utils::locator=nuxt-framework%40workspace%3A."
+  languageName: node
+  linkType: soft
+
 "@nuxt/test-utils@workspace:packages/test-utils":
   version: 0.0.0-use.local
   resolution: "@nuxt/test-utils@workspace:packages/test-utils"
@@ -1708,6 +1714,7 @@ __metadata:
     get-port-please: ^2.5.0
     jiti: ^1.13.0
     ohmyfetch: ^0.4.18
+    pathe: ^0.3.0
     playwright: ^1.22.2
     unbuild: latest
     vitest: ^0.14.2
@@ -6421,6 +6428,7 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "example-testing@workspace:examples/advanced/testing"
   dependencies:
+    "@nuxt/test-utils": "npm:@nuxt/test-utils-edge@latest"
     nuxt: "npm:nuxt3@latest"
   languageName: unknown
   linkType: soft