Skip to content

Commit

Permalink
chore: refactor audit tests
Browse files Browse the repository at this point in the history 
Use a real npm object, actually assert things

PR-URL: #4036
Credit: @wraithgar
Close: #4036
Reviewed-by: @lukekarrys
  • Loading branch information
@wraithgar
wraithgar committed Nov 10, 2021
1 parent ea352f5 commit 201df17
Showing 1 changed file with 89 additions and 118 deletions.
207 changes: 89 additions & 118 deletions test/lib/commands/audit.js
View file
Original file line number Diff line number Diff line change
@@ -1,24 +1,14 @@
const t = require('tap')
const { fake: mockNpm } = require('../../fixtures/mock-npm')
const { real: mockNpm } = require('../../fixtures/mock-npm')

t.test('should audit using Arborist', t => {
t.test('should audit using Arborist', async t => {
let ARB_ARGS = null
let AUDIT_CALLED = false
let REIFY_FINISH_CALLED = false
let AUDIT_REPORT_CALLED = false
let OUTPUT_CALLED = false
let ARB_OBJ = null

const npm = mockNpm({
prefix: 'foo',
config: {
json: false,
},
output: () => {
OUTPUT_CALLED = true
},
})
const Audit = t.mock('../../../lib/commands/audit.js', {
const { Npm, outputs } = mockNpm(t, {
'npm-audit-report': () => {
AUDIT_REPORT_CALLED = true
return {
Expand All @@ -34,7 +24,7 @@ t.test('should audit using Arborist', t => {
this.auditReport = {}
}
},
'../../../lib/utils/reify-finish.js': (npm, arb) => {
'../../lib/utils/reify-finish.js': (npm, arb) => {
if (arb !== ARB_OBJ) {
throw new Error('got wrong object passed to reify-output')
}
Expand All @@ -43,149 +33,130 @@ t.test('should audit using Arborist', t => {
},
})

const audit = new Audit(npm)
const npm = new Npm()
await npm.load()
npm.prefix = t.testdir()

t.test('audit', async t => {
await audit.exec([])
t.match(ARB_ARGS, { audit: true, path: 'foo' })
await npm.exec('audit', [])
t.match(ARB_ARGS, { audit: true, path: npm.prefix })
t.equal(AUDIT_CALLED, true, 'called audit')
t.equal(AUDIT_REPORT_CALLED, true, 'called audit report')
t.equal(OUTPUT_CALLED, true, 'called audit report')
t.match(outputs, [['there are vulnerabilities']])
})

t.test('audit fix', async t => {
await audit.exec(['fix'])
await npm.exec('audit', ['fix'])
t.equal(REIFY_FINISH_CALLED, true, 'called reify output')
})

t.end()
})

t.test('should audit - json', async t => {
const npm = mockNpm({
prefix: 'foo',
config: {
json: true,
t.plan(1)
const { Npm } = mockNpm(t, {
'npm-audit-report': (_, opts) => {
t.match(opts.reporter, 'json')
return {
report: 'there are vulnerabilities',
exitCode: 0,
}
},
output: () => {},
})

const Audit = t.mock('../../../lib/commands/audit.js', {
'npm-audit-report': () => ({
report: 'there are vulnerabilities',
exitCode: 0,
}),
'@npmcli/arborist': function () {
this.audit = () => {
this.auditReport = {}
}
},
'../../../lib/utils/reify-output.js': () => {},
'../../lib/utils/reify-output.js': () => {},
})
const audit = new Audit(npm)

await audit.exec([])
const npm = new Npm()
await npm.load()
npm.prefix = t.testdir()
npm.config.set('json', true)
await npm.exec('audit', [])
})

t.test('report endpoint error', t => {
for (const json of [true, false]) {
t.test(`json=${json}`, async t => {
const OUTPUT = []
const LOGS = []
const npm = mockNpm({
prefix: 'foo',
command: 'audit',
config: {
json,
},
flatOptions: {
json,
},
log: {
warn: (...warning) => LOGS.push(warning),
},
output: (...msg) => {
OUTPUT.push(msg)
},
})
const Audit = t.mock('../../../lib/commands/audit.js', {
'npm-audit-report': () => {
throw new Error('should not call audit report when there are errors')
},
'@npmcli/arborist': function () {
this.audit = () => {
this.auditReport = {
error: {
message: 'hello, this didnt work',
method: 'POST',
uri: 'https://example.com/',
headers: {
head: ['ers'],
},
statusCode: 420,
body: json ? { nope: 'lol' } : Buffer.from('i had a vuln but i eated it lol'),
},
}
}
},
'../../../lib/utils/reify-output.js': () => {},
})
const audit = new Audit(npm)
t.test('report endpoint error', async t => {
const { Npm, outputs, filteredLogs } = mockNpm(t, {
'npm-audit-report': () => {
throw new Error('should not call audit report when there are errors')
},
'@npmcli/arborist': function () {
this.audit = () => {
this.auditReport = {
error: {
message: 'hello, this didnt work',
method: 'POST',
uri: 'https://example.com/',
headers: {
head: ['ers'],
},
statusCode: 420,
body: 'this is a string',
// body: json ? { nope: 'lol' } : Buffer.from('i had a vuln but i eated it lol'),
},
}
}
},
'../../lib/utils/reify-output.js': () => {},
})
const npm = new Npm()
await npm.load()
npm.prefix = t.testdir()
// npm.config.set('json', )
t.test('json=false', async t => {
await t.rejects(npm.exec('audit', []), 'audit endpoint returned an error')
t.match(filteredLogs('warn'), ['hello, this didnt work'])
t.strictSame(outputs, [['this is a string']])
})

await t.rejects(audit.exec([]), 'audit endpoint returned an error')
t.strictSame(OUTPUT, [
[
json
? '{\n' +
' "message": "hello, this didnt work",\n' +
' "method": "POST",\n' +
' "uri": "https://example.com/",\n' +
' "headers": {\n' +
' "head": [\n' +
' "ers"\n' +
' ]\n' +
' },\n' +
' "statusCode": 420,\n' +
' "body": {\n' +
' "nope": "lol"\n' +
' }\n' +
'}'
: 'i had a vuln but i eated it lol',
],
])
t.strictSame(LOGS, [['audit', 'hello, this didnt work']])
t.test('json=true', async t => {
t.teardown(() => {
npm.config.set('json', false)
})
}
t.end()
npm.config.set('json', true)
await t.rejects(npm.exec('audit', []), 'audit endpoint returned an error')
t.match(filteredLogs('warn'), ['hello, this didnt work'])
t.strictSame(outputs, [[
'{\n' +
' "message": "hello, this didnt work",\n' +
' "method": "POST",\n' +
' "uri": "https://example.com/",\n' +
' "headers": {\n' +
' "head": [\n' +
' "ers"\n' +
' ]\n' +
' },\n' +
' "statusCode": 420,\n' +
' "body": "this is a string"\n' +
'}',
],
])
})
})

t.test('completion', t => {
const Audit = require('../../../lib/commands/audit.js')
const audit = new Audit({})
t.test('completion', async t => {
const { Npm } = mockNpm(t)
const npm = new Npm()
const audit = await npm.cmd('audit')
t.test('fix', async t => {
t.resolveMatch(
await t.resolveMatch(
audit.completion({ conf: { argv: { remain: ['npm', 'audit'] } } }),
['fix'],
'completes to fix'
)
t.end()
})

t.test('subcommand fix', t => {
t.resolveMatch(
t.test('subcommand fix', async t => {
await t.resolveMatch(
audit.completion({ conf: { argv: { remain: ['npm', 'audit', 'fix'] } } }),
[],
'resolves to ?'
)
t.end()
})

t.test('subcommand not recognized', t => {
t.rejects(audit.completion({ conf: { argv: { remain: ['npm', 'audit', 'repare'] } } }), {
t.test('subcommand not recognized', async t => {
await t.rejects(audit.completion({ conf: { argv: { remain: ['npm', 'audit', 'repare'] } } }), {
message: 'repare not recognized',
})
t.end()
})

t.end()
})

0 comments on commit 201df17

Please sign in to comment.