1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
const NPMLOG = require('npmlog')
const { LEVELS } = require('proc-log')
const merge = (...objs) => objs.reduce((acc, obj) => ({ ...acc, ...obj }))
const mockLogs = (otherMocks = {}) => {
// Return mocks as an array with getters for each level
// that return an array of logged properties with the
// level removed. This is for convenience throughout tests
const logs = Object.defineProperties(
[],
['timing', ...LEVELS].reduce((acc, level) => {
acc[level] = {
get () {
return this
.filter(([l]) => level === l)
.map(([l, ...args]) => args)
},
}
return acc
}, {})
)
// This returns an object with mocked versions of all necessary
// logging modules. It mocks them with methods that add logs
// to an array which it also returns. The reason it also returns
// the mocks is that in tests the same instance of these mocks
// should be passed to multiple calls to t.mock.
// XXX: this is messy and fragile and should be removed in favor
// of some other way to collect and filter logs across all tests
const logMocks = {
'proc-log': merge(
{ LEVELS },
LEVELS.reduce((acc, l) => {
acc[l] = (...args) => {
// Re-emit log item for since the log file listens on these
process.emit('log', l, ...args)
// Dont add pause/resume events to the logs. Those aren't displayed
// and emitting them is tested in the display layer
if (l !== 'pause' && l !== 'resume') {
logs.push([l, ...args])
}
}
return acc
}, {}),
otherMocks['proc-log']
),
// Object.assign is important here because we need to assign
// mocked properties directly to npmlog and then mock with that
// object. This is necessary so tests can still directly set
// `log.level = 'silent'` anywhere in the test and have that
// that reflected in the npmlog singleton.
// XXX: remove with npmlog
npmlog: Object.assign(NPMLOG, merge(
// no-op all npmlog methods by default so tests
// dont output anything to the terminal
Object.keys(NPMLOG.levels).reduce((acc, k) => {
acc[k] = () => {}
return acc
}, {}),
// except collect timing logs
{ timing: (...args) => logs.push(['timing', ...args]) },
otherMocks.npmlog
)),
}
return { logs, logMocks }
}
module.exports = mockLogs
|
