@nuxt/test-utils 3.0.0-rc.9 → 3.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016-present - Nuxt Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,128 @@
-# Nuxt Test Utils
 
-Test utilities for Nuxt.
+[![Nuxt banner](./.github/assets/banner.png)](https://nuxt.com)
+
+# 👋 Welcome to Nuxt
+
+
+Nuxt's goal is to make web development intuitive and performant, with a great developer experience.<br>Learn more in the ['What is Nuxt?'](https://nuxt.com/docs/getting-started/introduction) section of our documentation.
+
+
+ <p>
+  <a href="https://www.npmjs.com/package/nuxt"><img src="https://img.shields.io/npm/v/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="Version"></a>
+  <a href="https://www.npmjs.com/package/nuxt"><img src="https://img.shields.io/npm/dm/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="Downloads"></a>
+  <a href="./LICENSE"><img src="https://img.shields.io/github/license/nuxt/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="License"></a>
+  <a href="https://volta.net/nuxt/nuxt?utm_source=nuxt_readme"><img src="https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg" alt="Volta board"></a>
+ </p>
+
+<table>
+<thead>
+<tr>
+<th width="2000" colspan="2">
+</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+  <td width="80" align="center" valign="top">
+    <br>
+    <a href="https://nuxt.com/docs"><img src="./.github/assets/documentation.png"></a>
+  </td>
+  <td valign="top">
+    <h3>Documentation</h3>
+    <p>
+      We highly recommend you take a look at <a href="https://nuxt.com">the Nuxt documentation</a> to level up.
+    </p>
+  </td>
+</tr>
+<tr>
+  <td width="80" align="center" valign="top">
+    <br>
+    <a href="https://nuxt.com/modules"><img src="./.github/assets/modules.png"></a>
+  </td>
+  <td valign="top">
+    <h3>Modules</h3>
+    <p>
+      Discover our <a href="https://nuxt.com/modules">list of modules</a> to supercharge your Nuxt project. Created by the Nuxt team and community.
+    </p>
+  </td>
+</tr>
+<tr>
+  <td width="80" align="center" valign="top">
+    <br>
+    <a href="https://nuxt.com/docs/examples/hello-world"><img src="./.github/assets/examples.png"></a>
+  </td>
+  <td>
+    <h3>Examples</h3>
+    <p>
+      Explore different ways of using Nuxt features and get inspired with <a href="https://nuxt.com/docs/examples/essentials/hello-world">our list of examples</a>.
+    </p>
+  </td>
+</tr>
+</tbody>
+</table>
+
+<table>
+<thead>
+<tr>
+<th width="2000" colspan="2">
+</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+  <td width="80" align="center" valign="top">
+    <br>
+    <a href="https://nuxt.com/docs/community/reporting-bugs"><img src="./.github/assets/reporting-bugs.png"></a>
+  </td>
+  <td valign="top">
+    <h3>Reporting bugs</h3>
+    <p>
+      Check out the <a href="https://nuxt.com/docs/community/reporting-bugs">Reporting Bugs</a> page.</p>
+    </p>
+  </td>
+</tr>
+<tr>
+  <td width="80" align="center" valign="top">
+    <br>
+    <a href="https://nuxt.com/docs/community/contribution"><img src="./.github/assets/suggestions.png"></a>
+  </td>
+  <td valign="top">
+    <h3>Suggestions</h3>
+    <p>
+      Check out the <a href="https://nuxt.com/docs/community/contribution">Contribution</a> page.
+    </p>
+  </td>
+</tr>
+<tr>
+  <td width="80" align="center" valign="top">
+    <br>
+    <a href="https://nuxt.com/docs/community/getting-help"><img src="./.github/assets/questions.png"></a>
+  </td>
+  <td valign="top">
+    <h3>Questions</h3>
+    <p>
+      Check out the <a href="https://nuxt.com/docs/community/getting-help">Getting Help</a> page.
+    </p>
+  </td>
+</tr>
+</tbody>
+</table>
+
+## Local Development
+
+Follow the docs to [Set Up Your Local Development Environment](https://nuxt.com/docs/community/framework-contribution#set-up-your-local-development-environment) to contribute to the framework and documentation.
+
+## Nuxt 2
+
+You can find the code for Nuxt 2 on the [`2.x-dev` branch](https://github.com/nuxt/nuxt/tree/2.x-dev) and the documentation at [nuxtjs.org](https://nuxtjs.org).
+
+## Follow us
+
+<p valign="center">
+  <a href="https://chat.nuxt.dev"><img width="20px" src="./.github/assets/discord.svg" alt="Discord"></a>&nbsp;&nbsp;<a href="https://twitter.nuxt.dev"><img width="20px" src="./.github/assets/twitter.svg" alt="Twitter"></a>&nbsp;&nbsp;<a href="https://github.nuxt.dev"><img width="20px" src="./.github/assets/github.svg" alt="GitHub"></a>
+</p>
+
+## License
+
+[MIT](./LICENSE)
+

package/dist/index.d.ts

@@ -1,14 +1,14 @@
-import * as playwright_core from 'playwright-core';
+import * as playwright from 'playwright';
 import { Browser, BrowserContextOptions, LaunchOptions } from 'playwright';
 import { NuxtConfig, Nuxt } from '@nuxt/schema';
 import { ExecaChildProcess } from 'execa';
-import { FetchOptions } from 'ohmyfetch';
+import { FetchOptions } from 'ofetch';
 
 declare function createBrowser(): Promise<void>;
 declare function getBrowser(): Promise<Browser>;
-declare function createPage(path?: string, options?: BrowserContextOptions): Promise<playwright_core.Page>;
+declare function createPage(path?: string, options?: BrowserContextOptions): Promise<playwright.Page>;
 
-declare type TestRunner = 'vitest' | 'jest';
+type TestRunner = 'vitest' | 'jest';
 interface TestOptions {
     testDir: string;
     fixture: string;
@@ -35,6 +35,7 @@ interface TestContext {
     browser?: Browser;
     url?: string;
     serverProcess?: ExecaChildProcess;
+    mockFn?: Function;
 }
 interface TestHooks {
     beforeEach: () => void;
@@ -49,6 +50,11 @@ declare function useTestContext(): TestContext;
 declare function setTestContext(context: TestContext): TestContext;
 declare function setTestContext(context?: TestContext): TestContext | undefined;
 declare function isDev(): boolean;
+declare function recoverContextFromEnv(): void;
+declare function exposeContextToEnv(): void;
+
+declare function mockFn(): Function | undefined;
+declare function mockLogger(): Record<string, Function>;
 
 declare function loadFixture(): Promise<void>;
 declare function buildFixture(): Promise<void>;
@@ -59,7 +65,7 @@ declare function fetch(path: string, options?: any): Promise<Response>;
 declare function $fetch(path: string, options?: FetchOptions): Promise<any>;
 declare function url(path: string): string;
 
-declare function setupJest(hooks: TestHooks): void;
+declare function setupJest(hooks: TestHooks): Promise<void>;
 
 declare function setupVitest(hooks: TestHooks): Promise<void>;
 
@@ -68,14 +74,15 @@ declare const setupMaps: {
     vitest: typeof setupVitest;
 };
 declare function createTest(options: Partial<TestOptions>): TestHooks;
-declare function setup(options: Partial<TestOptions>): Promise<void>;
+declare function setup(options?: Partial<TestOptions>): Promise<void>;
 
 interface RunTestOptions {
     rootDir: string;
     dev?: boolean;
     watch?: boolean;
     runner?: 'vitest';
+    globalSetup?: boolean;
 }
 declare function runTests(opts: RunTestOptions): Promise<void>;
 
-export { $fetch, RunTestOptions, buildFixture, createBrowser, createPage, createTest, createTestContext, fetch, getBrowser, isDev, loadFixture, runTests, setTestContext, setup, setupMaps, startServer, stopServer, url, useTestContext };
+export { $fetch, RunTestOptions, TestContext, TestHooks, TestOptions, TestRunner, buildFixture, createBrowser, createPage, createTest, createTestContext, exposeContextToEnv, fetch, getBrowser, isDev, loadFixture, mockFn, mockLogger, recoverContextFromEnv, runTests, setTestContext, setup, setupMaps, startServer, stopServer, url, useTestContext };

package/dist/index.mjs

@@ -2,9 +2,12 @@ import { resolve } from 'node:path';
 import defu from 'defu';
 import { execa } from 'execa';
 import { getRandomPort, waitForPort } from 'get-port-please';
-import { fetch as fetch$1, $fetch as $fetch$1 } from 'ohmyfetch';
+import { fetch as fetch$1, $fetch as $fetch$1 } from 'ofetch';
 import * as _kit from '@nuxt/kit';
+import consola from 'consola';
 import { promises, existsSync } from 'node:fs';
+import { dirname, resolve as resolve$1 } from 'pathe';
+import { fileURLToPath } from 'node:url';
 
 let currentContext;
 function createTestContext(options) {
@@ -12,20 +15,24 @@ function createTestContext(options) {
     testDir: resolve(process.cwd(), "test"),
     fixture: "fixture",
     configFile: "nuxt.config",
-    setupTimeout: 6e4,
+    setupTimeout: 120 * 1e3,
     dev: !!JSON.parse(process.env.NUXT_TEST_DEV || "false"),
     logLevel: 1,
     server: true,
     build: options.browser !== false || options.server !== false,
     nuxtConfig: {},
+    // TODO: auto detect based on process.env
     runner: "vitest",
     browserOptions: {
       type: "chromium"
     }
   });
-  return setTestContext({ options: _options });
+  return setTestContext({
+    options: _options
+  });
 }
 function useTestContext() {
+  recoverContextFromEnv();
   if (!currentContext) {
     throw new Error("No context is available. (Forgot calling setup or createContext?)");
   }
@@ -39,6 +46,15 @@ function isDev() {
   const ctx = useTestContext();
   return ctx.options.dev;
 }
+function recoverContextFromEnv() {
+  if (!currentContext && process.env.NUXT_TEST_CONTEXT) {
+    setTestContext(JSON.parse(process.env.NUXT_TEST_CONTEXT || "{}"));
+  }
+}
+function exposeContextToEnv() {
+  const { options, browser, url } = currentContext;
+  process.env.NUXT_TEST_CONTEXT = JSON.stringify({ options, browser, url });
+}
 
 const kit$1 = _kit.default || _kit;
 async function startServer() {
@@ -54,6 +70,7 @@ async function startServer() {
       env: {
         ...process.env,
         PORT: String(port),
+        NITRO_PORT: String(port),
         NODE_ENV: "development"
       }
     });
@@ -77,6 +94,7 @@ async function startServer() {
       env: {
         ...process.env,
         PORT: String(port),
+        NITRO_PORT: String(port),
         NODE_ENV: "test"
       }
     });
@@ -136,9 +154,22 @@ async function createPage(path, options) {
   return page;
 }
 
+function mockFn() {
+  const ctx = useTestContext();
+  return ctx.mockFn;
+}
+function mockLogger() {
+  const mocks = {};
+  consola.mockTypes((type) => {
+    mocks[type] = mockFn();
+    return mocks[type];
+  });
+  return mocks;
+}
+
 const kit = _kit.default || _kit;
 const isNuxtApp = (dir) => {
-  return existsSync(dir) && (existsSync(resolve(dir, "pages")) || existsSync(resolve(dir, "nuxt.config.js")) || existsSync(resolve(dir, "nuxt.config.ts")));
+  return existsSync(dir) && (existsSync(resolve(dir, "pages")) || existsSync(resolve(dir, "nuxt.config.js")) || existsSync(resolve(dir, "nuxt.config.mjs")) || existsSync(resolve(dir, "nuxt.config.cjs")) || existsSync(resolve(dir, "nuxt.config.ts")));
 };
 const resolveRootDir = () => {
   const { options } = useTestContext();
@@ -175,16 +206,20 @@ async function loadFixture() {
     overrides: ctx.options.nuxtConfig,
     configFile: ctx.options.configFile
   });
-  kit.logger.level = ctx.options.logLevel;
   await promises.mkdir(ctx.nuxt.options.buildDir, { recursive: true });
 }
 async function buildFixture() {
   const ctx = useTestContext();
+  const prevLevel = kit.logger.level;
+  kit.logger.level = ctx.options.logLevel;
   await kit.buildNuxt(ctx.nuxt);
+  kit.logger.level = prevLevel;
 }
 
-function setupJest(hooks) {
-  test("setup", hooks.setup, 120 * 1e3);
+async function setupJest(hooks) {
+  const jest = await import('jest');
+  hooks.ctx.mockFn = jest.fn;
+  test("setup", hooks.setup, hooks.ctx.options.setupTimeout);
   beforeEach(hooks.beforeEach);
   afterEach(hooks.afterEach);
   afterAll(hooks.afterAll);
@@ -192,7 +227,8 @@ function setupJest(hooks) {
 
 async function setupVitest(hooks) {
   const vitest = await import('vitest');
-  vitest.beforeAll(hooks.setup, 120 * 1e3);
+  hooks.ctx.mockFn = vitest.vi.fn;
+  vitest.beforeAll(hooks.setup, hooks.ctx.options.setupTimeout);
   vitest.beforeEach(hooks.beforeEach);
   vitest.afterEach(hooks.afterEach);
   vitest.afterAll(hooks.afterAll);
@@ -248,14 +284,18 @@ function createTest(options) {
     ctx
   };
 }
-async function setup(options) {
+async function setup(options = {}) {
   const hooks = createTest(options);
   const setupFn = setupMaps[hooks.ctx.options.runner];
   await setupFn(hooks);
 }
 
+const distDir = dirname(fileURLToPath(import.meta.url));
+resolve$1(distDir, "..");
+
 const RunTestDefaults = {
-  runner: "vitest"
+  runner: "vitest",
+  globalSetup: true
 };
 async function runTests(opts) {
   opts = { ...RunTestDefaults, ...opts };
@@ -265,16 +305,37 @@ async function runTests(opts) {
   if (opts.dev) {
     process.env.NUXT_TEST_DEV = "true";
   }
-  const { startVitest } = await import('vitest/dist/node.mjs');
+  process.env.NUXT_TEST_OPTIONS = JSON.stringify(opts);
+  const { startVitest } = await import('vitest/node');
   const succeeded = await startVitest(
+    "test",
     [],
+    // Vitest options
     {
       root: opts.rootDir,
-      run: !opts.watch
+      run: !opts.watch,
+      deps: {
+        inline: [/@nuxt\/test-utils/]
+      }
     },
+    // Vite options
     {
       esbuild: {
         tsconfigRaw: "{}"
+      },
+      test: {
+        dir: opts.rootDir,
+        deps: {
+          inline: [
+            distDir,
+            "@nuxt/test-utils",
+            "@nuxt/test-utils-edge"
+          ]
+        },
+        globals: true,
+        globalSetup: [
+          ...opts.globalSetup ? [resolve$1(distDir, "./runtime/global-setup")] : []
+        ]
       }
     }
   );
@@ -283,4 +344,4 @@ async function runTests(opts) {
   }
 }
 
-export { $fetch, buildFixture, createBrowser, createPage, createTest, createTestContext, fetch, getBrowser, isDev, loadFixture, runTests, setTestContext, setup, setupMaps, startServer, stopServer, url, useTestContext };
+export { $fetch, buildFixture, createBrowser, createPage, createTest, createTestContext, exposeContextToEnv, fetch, getBrowser, isDev, loadFixture, mockFn, mockLogger, recoverContextFromEnv, runTests, setTestContext, setup, setupMaps, startServer, stopServer, url, useTestContext };

package/dist/runtime/global-setup.d.ts

@@ -0,0 +1,2 @@
+export declare const setup: () => Promise<void>;
+export declare const teardown: () => Promise<void>;

package/dist/runtime/global-setup.mjs

@@ -0,0 +1,14 @@
+import * as _kit from "@nuxt/kit";
+import { createTest, exposeContextToEnv } from "@nuxt/test-utils";
+const kit = _kit.default || _kit;
+const options = JSON.parse(process.env.NUXT_TEST_OPTIONS || "{}");
+const hooks = createTest(options);
+export const setup = async () => {
+  kit.logger.info("Building Nuxt app...");
+  await hooks.setup();
+  exposeContextToEnv();
+  kit.logger.info("Running tests...");
+};
+export const teardown = async () => {
+  await hooks.afterAll();
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nuxt/test-utils",
-  "version": "3.0.0-rc.9",
-  "repository": "nuxt/framework",
+  "version": "3.1.0",
+  "repository": "nuxt/nuxt",
   "license": "MIT",
   "type": "module",
   "exports": "./dist/index.mjs",
@@ -9,27 +9,27 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "prepack": "unbuild"
-  },
   "dependencies": {
-    "@nuxt/kit": "3.0.0-rc.9",
-    "@nuxt/schema": "3.0.0-rc.9",
-    "defu": "^6.1.0",
+    "@nuxt/kit": "3.1.0",
+    "@nuxt/schema": "3.1.0",
+    "consola": "^2.15.3",
+    "defu": "^6.1.1",
     "execa": "^6.1.0",
-    "get-port-please": "^2.6.1",
-    "jiti": "^1.14.0",
-    "ohmyfetch": "^0.4.18"
+    "get-port-please": "^3.0.1",
+    "jiti": "^1.16.2",
+    "ofetch": "^1.0.0",
+    "pathe": "^1.0.0"
   },
   "devDependencies": {
-    "playwright": "^1.25.1",
+    "playwright": "^1.29.2",
     "unbuild": "latest",
-    "vitest": "~0.19.1"
+    "vitest": "^0.27.2"
   },
   "peerDependencies": {
-    "vue": "^3.2.38"
+    "vue": "^3.2.45"
   },
   "engines": {
-    "node": "^14.16.0 || ^16.11.0 || ^17.0.0 || ^18.0.0"
-  }
-}
+    "node": "^14.16.0 || ^16.10.0 || ^17.0.0 || ^18.0.0 || ^19.0.0"
+  },
+  "scripts": {}
+}