fix(test): resolve test utils from project

Author: danielroe

packages/nuxt-cli/src/commands/test.ts

@@ -1,11 +1,11 @@
 importprocessfrom'node:process'
+import{pathToFileURL}from'node:url'
 
 import{defineCommand}from'citty'
-
-import{logger}from'../utils/logger'
+import{resolveModulePath}from'exsolve'
 
 import{resolveRootDir}from'../utils/paths'
-import{logLevelArgs,rootDirArgs}from'./_shared'
+import{rootDirArgs}from'./_shared'
 
 exportdefaultdefineCommand({
 meta: {
@@ -14,7 +14,6 @@ export default defineCommand({
 },
 args: {
  ...rootDirArgs,
- ...logLevelArgs,
 dev: {
 type: 'boolean',
 description: 'Run in dev mode',
@@ -29,35 +28,28 @@ export default defineCommand({
 
 constcwd=resolveRootDir(ctx.args)
 
-const{ runTests }=awaitimportTestUtils()
+const{ runTests }=awaitimportTestUtils(cwd)
 awaitrunTests({
 rootDir: cwd,
 dev: ctx.args.dev,
 watch: ctx.args.watch,
- ...{},
 })
 },
 })
 
-asyncfunctionimportTestUtils(): Promise<typeofimport('@nuxt/test-utils')>{
-leterr
-for(constpkgof[
-'@nuxt/test-utils-nightly',
-'@nuxt/test-utils-edge',
-'@nuxt/test-utils',
-]){
-try{
-constexports=awaitimport(pkg)
-// Detect old @nuxt/test-utils
-if(!exports.runTests){
-thrownewError('Invalid version of `@nuxt/test-utils` is installed!')
-}
-returnexports
+exportasyncfunctionimportTestUtils(rootDir: string): Promise<typeofimport('@nuxt/test-utils')>{
+for(constpkgof['@nuxt/test-utils-nightly','@nuxt/test-utils-edge','@nuxt/test-utils']){
+constentry=resolveModulePath(pkg,{from: rootDir,try: true})
+if(!entry){
+continue
 }
-catch(_err){
-err=_err
+
+constexports=awaitimport(pathToFileURL(entry).href)
+if(typeofexports.runTests!=='function'){
+thrownewTypeError(`The installed version of \`${pkg}\` does not support \`nuxt test\`.`)
 }
+returnexports
 }
-logger.error(String(err))
-thrownewError('`@nuxt/test-utils` seems missing. Run `npm i -D @nuxt/test-utils` or `yarn add -D @nuxt/test-utils` to install.')
+
+thrownewError('`@nuxt/test-utils` is not installed in this project. Install it as a development dependency to use `nuxt test`.')
 }

packages/nuxt-cli/test/unit/commands/test.spec.ts

@@ -0,0 +1,64 @@
+import{mkdir,rm,writeFile}from'node:fs/promises'
+import{tmpdir}from'node:os'
+import{join}from'node:path'
+
+import{afterEach,describe,expect,it}from'vitest'
+
+import{importTestUtils}from'../../../src/commands/test'
+
+consttempDirs: string[]=[]
+
+asyncfunctioncreateProject(packageName?: string,source='export function runTests() {}'){
+constrootDir=join(tmpdir(),`nuxt-test-command-${crypto.randomUUID()}`)
+tempDirs.push(rootDir)
+awaitmkdir(rootDir,{recursive: true})
+
+if(packageName){
+constpackageDir=join(rootDir,'node_modules', ...packageName.split('/'))
+awaitmkdir(packageDir,{recursive: true})
+awaitwriteFile(join(packageDir,'package.json'),JSON.stringify({name: packageName,type: 'module',exports: './index.js'}))
+awaitwriteFile(join(packageDir,'index.js'),source)
+}
+
+returnrootDir
+}
+
+afterEach(async()=>{
+awaitPromise.all(tempDirs.splice(0).map(dir=>rm(dir,{recursive: true,force: true})))
+})
+
+describe('importTestUtils',()=>{
+it('loads test utils from the project',async()=>{
+constrootDir=awaitcreateProject('@nuxt/test-utils')
+
+expect((awaitimportTestUtils(rootDir)).runTests).toBeTypeOf('function')
+})
+
+it('prefers nightly when multiple variants are installed',async()=>{
+constrootDir=awaitcreateProject('@nuxt/test-utils-nightly','export function runTests() {}; export const channel = "nightly"')
+constpackageDir=join(rootDir,'node_modules','@nuxt','test-utils')
+awaitmkdir(packageDir,{recursive: true})
+awaitwriteFile(join(packageDir,'package.json'),JSON.stringify({name: '@nuxt/test-utils',type: 'module',exports: './index.js'}))
+awaitwriteFile(join(packageDir,'index.js'),'export function runTests() {}; export const channel = "stable"')
+
+expect((awaitimportTestUtils(rootDir)asany).channel).toBe('nightly')
+})
+
+it('does not fall back when an installed variant fails to load',async()=>{
+constrootDir=awaitcreateProject('@nuxt/test-utils-nightly','import "missing-dependency"; export function runTests() {}')
+
+awaitexpect(importTestUtils(rootDir)).rejects.toThrow(/missing-dependency/)
+})
+
+it('reports an incompatible installed version',async()=>{
+constrootDir=awaitcreateProject('@nuxt/test-utils','export const setup = true')
+
+awaitexpect(importTestUtils(rootDir)).rejects.toThrow('The installed version of `@nuxt/test-utils` does not support `nuxt test`.')
+})
+
+it('reports a missing project dependency',async()=>{
+constrootDir=awaitcreateProject()
+
+awaitexpect(importTestUtils(rootDir)).rejects.toThrow('`@nuxt/test-utils` is not installed in this project.')
+})
+})

packages/nuxt-cli/test/unit/help.spec.ts

@@ -369,7 +369,7 @@ describe('help', () => {
 })
 
 it('nuxt test',async()=>{
-expect(awaitusage(commands.test,main)).toMatchInlineSnapshot(`
+expect((awaitusage(commands.test,main)).replaceAll(/+$/gm,'')).toMatchInlineSnapshot(`
  "Run tests (nuxt test v0.0.0)
 
  USAGE nuxt test [OPTIONS] [ROOTDIR]
@@ -380,9 +380,8 @@ describe('help', () => {
 
  OPTIONS
 
- --logLevel=<silent|info|verbose> Specify build-time log level
- --dev Run in dev mode 
- --watch Watch mode 
+ --dev Run in dev mode
+ --watch Watch mode
  "
  `)
 })