Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: separate cli-entry and cli tests #6489

Merged
merged 1 commit into from May 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
168 changes: 168 additions & 0 deletions test/lib/cli-entry.js
@@ -0,0 +1,168 @@
const t = require('tap')
const { load: loadMockNpm } = require('../fixtures/mock-npm.js')
const tmock = require('../fixtures/tmock.js')
const validateEngines = require('../../lib/es6/validate-engines.js')

const cliMock = async (t, opts) => {
let exitHandlerArgs = null
let npm = null
const exitHandlerMock = (...args) => {
exitHandlerArgs = args
npm.unload()
}
exitHandlerMock.setNpm = _npm => npm = _npm

const { Npm, outputs, logMocks, logs } = await loadMockNpm(t, { ...opts, init: false })
const cli = tmock(t, '{LIB}/cli-entry.js', {
'{LIB}/npm.js': Npm,
'{LIB}/utils/exit-handler.js': exitHandlerMock,
...logMocks,
})

return {
Npm,
cli: (p) => validateEngines(p, () => cli),
outputs,
exitHandlerCalled: () => exitHandlerArgs,
exitHandlerNpm: () => npm,
logs,
logsBy: (title) => logs.verbose.filter(([p]) => p === title).map(([p, ...rest]) => rest),
}
}

t.test('print the version, and treat npm_g as npm -g', async t => {
const { logsBy, logs, cli, Npm, outputs, exitHandlerCalled } = await cliMock(t, {
globals: { 'process.argv': ['node', 'npm_g', '-v'] },
})
await cli(process)

t.strictSame(process.argv, ['node', 'npm', '-g', '-v'], 'system process.argv was rewritten')
t.strictSame(logsBy('cli'), [['node npm']])
t.strictSame(logsBy('title'), [['npm']])
t.match(logsBy('argv'), [['"--global" "--version"']])
t.strictSame(logs.info, [
['using', 'npm@%s', Npm.version],
['using', 'node@%s', process.version],
])
t.equal(outputs.length, 1)
t.strictSame(outputs, [[Npm.version]])
t.strictSame(exitHandlerCalled(), [])
})

t.test('calling with --versions calls npm version with no args', async t => {
const { logsBy, cli, outputs, exitHandlerCalled } = await cliMock(t, {
globals: {
'process.argv': ['node', 'npm', 'install', 'or', 'whatever', '--versions'],
},
})
await cli(process)

t.equal(process.title, 'npm install or whatever')
t.strictSame(logsBy('cli'), [['node npm']])
t.strictSame(logsBy('title'), [['npm install or whatever']])
t.match(logsBy('argv'), [['"install" "or" "whatever" "--versions"']])
t.equal(outputs.length, 1)
t.match(outputs[0][0], { npm: String, node: String, v8: String })
t.strictSame(exitHandlerCalled(), [])
})

t.test('logged argv is sanitized', async t => {
const { logsBy, cli } = await cliMock(t, {
globals: {
'process.argv': [
'node',
'npm',
'version',
'--registry',
'https://u:password@npmjs.org/password',
],
},
})

await cli(process)
t.equal(process.title, 'npm version')
t.strictSame(logsBy('cli'), [['node npm']])
t.strictSame(logsBy('title'), [['npm version']])
t.match(logsBy('argv'), [['"version" "--registry" "https://u:***@npmjs.org/password"']])
})

t.test('logged argv is sanitized with equals', async t => {
const { logsBy, cli } = await cliMock(t, {
globals: {
'process.argv': [
'node',
'npm',
'version',
'--registry=https://u:password@npmjs.org',
],
},
})
await cli(process)

t.match(logsBy('argv'), [['"version" "--registry" "https://u:***@npmjs.org/"']])
})

t.test('print usage if no params provided', async t => {
const { cli, outputs, exitHandlerCalled, exitHandlerNpm } = await cliMock(t, {
globals: {
'process.argv': ['node', 'npm'],
},
})
await cli(process)

t.match(outputs[0][0], 'Usage:', 'outputs npm usage')
t.match(exitHandlerCalled(), [], 'should call exitHandler with no args')
t.ok(exitHandlerNpm(), 'exitHandler npm is set')
t.match(process.exitCode, 1)
})

t.test('print usage if non-command param provided', async t => {
const { cli, outputs, exitHandlerCalled, exitHandlerNpm } = await cliMock(t, {
globals: {
'process.argv': ['node', 'npm', 'tset'],
},
})
await cli(process)

t.match(outputs[0][0], 'Unknown command: "tset"')
t.match(outputs[0][0], 'Did you mean this?')
t.match(exitHandlerCalled(), [], 'should call exitHandler with no args')
t.ok(exitHandlerNpm(), 'exitHandler npm is set')
t.match(process.exitCode, 1)
})

t.test('load error calls error handler', async t => {
const err = new Error('test load error')
const { cli, exitHandlerCalled } = await cliMock(t, {
mocks: {
'{LIB}/utils/config/index.js': {
definitions: null,
flatten: null,
shorthands: null,
},
'@npmcli/config': class BadConfig {
async load () {
throw err
}
},
},
globals: {
'process.argv': ['node', 'npm', 'asdf'],
},
})
await cli(process)
t.strictSame(exitHandlerCalled(), [err])
})

t.test('unsupported node version', async t => {
const { cli, logs } = await cliMock(t, {
globals: {
'process.version': '12.6.0',
},
})
await cli(process)
t.match(
logs.warn[0][1],
/npm v.* does not support Node\.js 12\.6\.0\./
)
})
164 changes: 3 additions & 161 deletions test/lib/cli.js
@@ -1,168 +1,10 @@
const t = require('tap')
const { load: loadMockNpm } = require('../fixtures/mock-npm.js')
const tmock = require('../fixtures/tmock')
const validateEngines = require('../../lib/es6/validate-engines.js')

const cliMock = async (t, opts) => {
let exitHandlerArgs = null
let npm = null
const exitHandlerMock = (...args) => {
exitHandlerArgs = args
npm.unload()
}
exitHandlerMock.setNpm = _npm => npm = _npm

const { Npm, outputs, logMocks, logs } = await loadMockNpm(t, { ...opts, init: false })
t.test('returns cli-entry function', async t => {
const cli = tmock(t, '{LIB}/cli.js', {
'{LIB}/npm.js': Npm,
'{LIB}/utils/exit-handler.js': exitHandlerMock,
...logMocks,
})

return {
Npm,
cli: (p) => validateEngines(p, () => cli),
outputs,
exitHandlerCalled: () => exitHandlerArgs,
exitHandlerNpm: () => npm,
logs,
logsBy: (title) => logs.verbose.filter(([p]) => p === title).map(([p, ...rest]) => rest),
}
}

t.test('print the version, and treat npm_g as npm -g', async t => {
const { logsBy, logs, cli, Npm, outputs, exitHandlerCalled } = await cliMock(t, {
globals: { 'process.argv': ['node', 'npm_g', '-v'] },
})
await cli(process)

t.strictSame(process.argv, ['node', 'npm', '-g', '-v'], 'system process.argv was rewritten')
t.strictSame(logsBy('cli'), [['node npm']])
t.strictSame(logsBy('title'), [['npm']])
t.match(logsBy('argv'), [['"--global" "--version"']])
t.strictSame(logs.info, [
['using', 'npm@%s', Npm.version],
['using', 'node@%s', process.version],
])
t.equal(outputs.length, 1)
t.strictSame(outputs, [[Npm.version]])
t.strictSame(exitHandlerCalled(), [])
})

t.test('calling with --versions calls npm version with no args', async t => {
const { logsBy, cli, outputs, exitHandlerCalled } = await cliMock(t, {
globals: {
'process.argv': ['node', 'npm', 'install', 'or', 'whatever', '--versions'],
},
})
await cli(process)

t.equal(process.title, 'npm install or whatever')
t.strictSame(logsBy('cli'), [['node npm']])
t.strictSame(logsBy('title'), [['npm install or whatever']])
t.match(logsBy('argv'), [['"install" "or" "whatever" "--versions"']])
t.equal(outputs.length, 1)
t.match(outputs[0][0], { npm: String, node: String, v8: String })
t.strictSame(exitHandlerCalled(), [])
})

t.test('logged argv is sanitized', async t => {
const { logsBy, cli } = await cliMock(t, {
globals: {
'process.argv': [
'node',
'npm',
'version',
'--registry',
'https://u:password@npmjs.org/password',
],
},
})

await cli(process)
t.equal(process.title, 'npm version')
t.strictSame(logsBy('cli'), [['node npm']])
t.strictSame(logsBy('title'), [['npm version']])
t.match(logsBy('argv'), [['"version" "--registry" "https://u:***@npmjs.org/password"']])
})

t.test('logged argv is sanitized with equals', async t => {
const { logsBy, cli } = await cliMock(t, {
globals: {
'process.argv': [
'node',
'npm',
'version',
'--registry=https://u:password@npmjs.org',
],
},
})
await cli(process)

t.match(logsBy('argv'), [['"version" "--registry" "https://u:***@npmjs.org/"']])
})

t.test('print usage if no params provided', async t => {
const { cli, outputs, exitHandlerCalled, exitHandlerNpm } = await cliMock(t, {
globals: {
'process.argv': ['node', 'npm'],
},
'{LIB}/cli-entry.js': () => 'ENTRY',
})
await cli(process)

t.match(outputs[0][0], 'Usage:', 'outputs npm usage')
t.match(exitHandlerCalled(), [], 'should call exitHandler with no args')
t.ok(exitHandlerNpm(), 'exitHandler npm is set')
t.match(process.exitCode, 1)
})

t.test('print usage if non-command param provided', async t => {
const { cli, outputs, exitHandlerCalled, exitHandlerNpm } = await cliMock(t, {
globals: {
'process.argv': ['node', 'npm', 'tset'],
},
})
await cli(process)

t.match(outputs[0][0], 'Unknown command: "tset"')
t.match(outputs[0][0], 'Did you mean this?')
t.match(exitHandlerCalled(), [], 'should call exitHandler with no args')
t.ok(exitHandlerNpm(), 'exitHandler npm is set')
t.match(process.exitCode, 1)
})

t.test('load error calls error handler', async t => {
const err = new Error('test load error')
const { cli, exitHandlerCalled } = await cliMock(t, {
mocks: {
'{LIB}/utils/config/index.js': {
definitions: null,
flatten: null,
shorthands: null,
},
'@npmcli/config': class BadConfig {
async load () {
throw err
}
},
},
globals: {
'process.argv': ['node', 'npm', 'asdf'],
},
})
await cli(process)
t.strictSame(exitHandlerCalled(), [err])
})

t.test('unsupported node version', async t => {
const { cli, logs } = await cliMock(t, {
globals: {
'process.version': '12.6.0',
},
})
await cli(process)
t.match(
logs.warn[0][1],
/npm v.* does not support Node\.js 12\.6\.0\./
)
t.equal(cli(process), 'ENTRY')
})