fix(tests): move more tests to use real npm

This moves a handful of the smaller tests to using the new npm mock that
uses the real actual npm object.  It also extends the testing surface
area of a few tests back down into the actual `process.spawn` that
results, instead of anything internal to the code.

Some dead code in `lib/test.js` was found during this, as well as an
instance of a module throwing a string instead of an error object.

Author: wraithgar

lib/set.js

@@ -22,7 +22,7 @@ class Set extends BaseCommand {
 
   exec (args, cb) {
     if (!args.length)
-      return cb(this.usage)
+      return cb(this.usageError())
     this.npm.commands.config(['set'].concat(args), cb)
   }
 }

lib/test.js

@@ -19,15 +19,5 @@ class Test extends LifecycleCmd {
       'script-shell',
     ]
   }
-
-  exec (args, cb) {
-    super.exec(args, er => {
-      if (er && er.code === 'ELIFECYCLE') {
-        /* eslint-disable standard/no-callback-literal */
-        cb('Test failed.  See above for more details.')
-      } else
-        cb(er)
-    })
-  }
 }
 module.exports = Test

node_modules/.gitignore

@@ -126,6 +126,7 @@
     "@npmcli/arborist",
     "@npmcli/ci-detect",
     "@npmcli/config",
+    "@npmcli/package-json",
     "@npmcli/run-script",
     "abbrev",
     "ansicolors",
@@ -198,6 +199,7 @@
     "eslint-plugin-promise": "^5.1.0",
     "eslint-plugin-standard": "^5.0.0",
     "licensee": "^8.2.0",
+    "spawk": "^1.7.1",
     "tap": "^15.0.9"
   },
   "scripts": {

package-lock.json

@@ -11,6 +11,10 @@ for (const level of ['silly', 'verbose', 'timing', 'notice', 'warn', 'error'])
 const { title, execPath } = process
 
 const RealMockNpm = (t, otherMocks = {}) => {
+  t.afterEach(() => {
+    outputs.length = 0
+    logs.length = 0
+  })
   t.teardown(() => {
     for (const level of ['silly', 'verbose', 'timing', 'notice', 'warn', 'error'])
       npmlog[level] = realLog[level]
@@ -23,6 +27,9 @@ const RealMockNpm = (t, otherMocks = {}) => {
   })
   const logs = []
   const outputs = []
+  const joinedOutput = () => {
+    return outputs.map(o => o.join(' ')).join('\n')
+  }
   const npm = t.mock('../../lib/npm.js', otherMocks)
   const command = async (command, args = []) => {
     return new Promise((resolve, reject) => {
@@ -39,7 +46,7 @@ const RealMockNpm = (t, otherMocks = {}) => {
     }
   }
   npm.output = (...msg) => outputs.push(msg)
-  return { npm, logs, outputs, command }
+  return { npm, logs, outputs, command, joinedOutput }
 }
 
 const realConfig = require('../../lib/utils/config')

package.json

@@ -1,24 +1,26 @@
 const t = require('tap')
 
-const FindDupes = require('../../lib/find-dupes.js')
+const { real: mockNpm } = require('../fixtures/mock-npm')
 
-t.test('should run dedupe in dryRun mode', (t) => {
-  t.plan(3)
-  const findDupesTest = new FindDupes({
-    config: {
-      set: (k, v) => {
-        t.match(k, 'dry-run')
-        t.match(v, true)
-      },
+t.test('should run dedupe in dryRun mode', async (t) => {
+  t.plan(5)
+  const { npm, command } = mockNpm(t, {
+    '@npmcli/arborist': function (args) {
+      t.ok(args, 'gets options object')
+      t.ok(args.path, 'gets path option')
+      t.ok(args.dryRun, 'is called in dryRun mode')
+      this.dedupe = () => {
+        t.ok(true, 'dedupe is called')
+      }
     },
-    commands: {
-      dedupe: (args, cb) => {
-        t.match(args, [])
-        cb()
-      },
+    '../../lib/utils/reify-finish.js': (npm, arb) => {
+      t.ok(arb, 'gets arborist tree')
     },
   })
-  findDupesTest.exec({}, () => {
-    t.end()
-  })
+  await npm.load()
+  // explicitly set to false so we can be 100% sure it's always true when it
+  // hits arborist
+  npm.config.set('dry-run', false)
+  npm.config.set('prefix', 'foo')
+  await command('find-dupes')
 })

test/fixtures/mock-npm.js

@@ -1,16 +1,16 @@
 const t = require('tap')
+const { real: mockNpm } = require('../fixtures/mock-npm')
 
-t.test('should retrieve values from npm.commands.config', (t) => {
-  const Get = t.mock('../../lib/get.js')
-  const get = new Get({
-    commands: {
-      config: ([action, arg]) => {
-        t.equal(action, 'get', 'should use config get action')
-        t.equal(arg, 'foo', 'should use expected key')
-        t.end()
-      },
-    },
-  })
-
-  get.exec(['foo'])
+t.test('should retrieve values from config', async t => {
+  const { joinedOutput, command, npm } = mockNpm(t)
+  const name = 'editor'
+  const value = 'vigor'
+  await npm.load()
+  npm.config.set(name, value)
+  await command('get', [name])
+  t.equal(
+    joinedOutput(),
+    value,
+    'outputs config item'
+  )
 })

test/lib/find-dupes.js

@@ -1,15 +1,23 @@
 const t = require('tap')
 const glob = require('glob')
 const { resolve } = require('path')
+const { real: mockNpm } = require('../fixtures/mock-npm')
 
 const full = process.env.npm_lifecycle_event === 'check-coverage'
 
 if (!full)
   t.pass('nothing to do here, not checking for full coverage')
 else {
-  // some files do config.get() on load, so have to load npm first
-  const npm = require('../../lib/npm.js')
-  t.test('load npm first', t => npm.load(t.end))
+  const { npm } = mockNpm(t)
+
+  t.teardown(() => {
+    const exitHandler = require('../../lib/utils/exit-handler.js')
+    exitHandler()
+  })
+
+  t.test('load npm first', async t => {
+    await npm.load()
+  })
 
   t.test('load all the files', t => {
     // just load all the files so we measure coverage for the missing tests
@@ -21,11 +29,4 @@ else {
     t.pass('loaded all files')
     t.end()
   })
-
-  t.test('call the exit handler so we dont freak out', t => {
-    const exitHandler = require('../../lib/utils/exit-handler.js')
-    exitHandler.setNpm(npm)
-    exitHandler()
-    t.end()
-  })
 }

test/lib/get.js

@@ -1,19 +1,13 @@
 const t = require('tap')
+const { real: mockNpm } = require('../fixtures/mock-npm')
 
-t.test('prefix', (t) => {
-  t.plan(3)
-  const dir = '/prefix/dir'
-
-  const Prefix = require('../../lib/prefix.js')
-  const prefix = new Prefix({
-    prefix: dir,
-    output: (output) => {
-      t.equal(output, dir, 'prints the correct directory')
-    },
-  })
-
-  prefix.exec([], (err) => {
-    t.error(err, 'npm prefix')
-    t.ok('should have printed directory')
-  })
+t.test('prefix', async (t) => {
+  const { joinedOutput, command, npm } = mockNpm(t)
+  await npm.load()
+  await command('prefix')
+  t.equal(
+    joinedOutput(),
+    npm.prefix,
+    'outputs npm.prefix'
+  )
 })