Welcome to mirror list, hosted at ThFree Co, Russian Federation.

utils.reify-output.js « tap « test - github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: e08e3ecc161346f5154a2fb6da5510176ebcfb5b (plain)
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
'use strict'

const t = require('tap')
const requireInject = require('require-inject')

const log = require('npmlog')
log.level = 'warn'

t.cleanSnapshot = str => str.replace(/in [0-9]+ms/g, 'in {TIME}ms')

const settings = {
  fund: true
}
const npmock = {
  started: Date.now(),
  flatOptions: settings
}
const getReifyOutput = tester =>
  requireInject(
    '../../lib/utils/reify-output.js',
    {
      '../../lib/npm.js': npmock,
      '../../lib/utils/output.js': tester
    }
  )

t.test('missing info', (t) => {
  t.plan(1)
  const reifyOutput = getReifyOutput(
    out => t.doesNotHave(
      out,
      'looking for funding',
      'should not print fund message if missing info'
    )
  )

  reifyOutput({
    actualTree: {
      children: []
    },
    diff: {
      children: []
    }
  })
})

t.test('single package', (t) => {
  t.plan(1)
  const reifyOutput = getReifyOutput(
    out => {
      if (out.endsWith('looking for funding')) {
        t.match(
          out,
          '1 package is looking for funding',
          'should print single package message'
        )
      }
    }
  )

  reifyOutput({
    actualTree: {
      name: 'foo',
      package: {
        name: 'foo',
        version: '1.0.0'
      },
      edgesOut: new Map([
        ['bar', {
          to: {
            name: 'bar',
            package: {
              name: 'bar',
              version: '1.0.0',
              funding: { type: 'foo', url: 'http://example.com' }
            }
          }
        }]
      ])
    },
    diff: {
      children: []
    }
  })
})

t.test('no message when funding config is false', (t) => {
  t.teardown(() => { settings.fund = true })
  settings.fund = false
  const reifyOutput = getReifyOutput(
    out => {
      if (out.endsWith('looking for funding')) {
        t.fail('should not print funding info', { actual: out })
      }
    }
  )

  reifyOutput({
    actualTree: {
      name: 'foo',
      package: {
        name: 'foo',
        version: '1.0.0'
      },
      edgesOut: new Map([
        ['bar', {
          to: {
            name: 'bar',
            package: {
              name: 'bar',
              version: '1.0.0',
              funding: { type: 'foo', url: 'http://example.com' }
            }
          }
        }]
      ])
    },
    diff: {
      children: []
    }
  })

  t.end()
})

t.test('print appropriate message for many packages', (t) => {
  t.plan(1)
  const reifyOutput = getReifyOutput(
    out => {
      if (out.endsWith('looking for funding')) {
        t.match(
          out,
          '3 packages are looking for funding',
          'should print single package message'
        )
      }
    }
  )

  reifyOutput({
    actualTree: {
      name: 'foo',
      package: {
        name: 'foo',
        version: '1.0.0'
      },
      edgesOut: new Map([
        ['bar', {
          to: {
            name: 'bar',
            package: {
              name: 'bar',
              version: '1.0.0',
              funding: { type: 'foo', url: 'http://example.com' }
            }
          }
        }],
        ['lorem', {
          to: {
            name: 'lorem',
            package: {
              name: 'lorem',
              version: '1.0.0',
              funding: { type: 'foo', url: 'http://example.com' }
            }
          }
        }],
        ['ipsum', {
          to: {
            name: 'ipsum',
            package: {
              name: 'ipsum',
              version: '1.0.0',
              funding: { type: 'foo', url: 'http://example.com' }
            }
          }
        }]
      ])
    },
    diff: {
      children: []
    }
  })
})

t.test('no output when silent', t => {
  const reifyOutput = getReifyOutput(out => {
    t.fail('should not get output when silent', { actual: out })
  })
  t.teardown(() => log.level = 'warn')
  log.level = 'silent'
  reifyOutput({
    actualTree: { inventory: { size: 999 }, children: [] },
    auditReport: {
      toJSON: () => mock.auditReport,
      vulnerabilities: {},
      metadata: {
        vulnerabilities: {
          total: 99
        }
      }
    },
    diff: {
      children: [
        { action: 'ADD', ideal: { location: 'loc' } }
      ]
    }
  })
  t.end()
})

t.test('packages changed message', t => {
  const output = []
  const reifyOutput = getReifyOutput(out => {
    output.push(out)
  })

  // return a test function that builds up the mock and snapshots output
  const testCase = (t, added, removed, changed, audited, json, command) => {
    settings.json = json
    npmock.command = command
    const mock = {
      actualTree: { inventory: { size: audited }, children: [] },
      auditReport: audited ? {
        toJSON: () => mock.auditReport,
        vulnerabilities: {},
        metadata: {
          vulnerabilities: {
            total: 0
          }
        }
      } : null,
      diff: {
        children: [
          { action: 'some random unexpected junk' }
        ]
      }
    }
    for (let i = 0; i < added; i++) {
      mock.diff.children.push({ action: 'ADD', ideal: { location: 'loc' } })
    }
    for (let i = 0; i < removed; i++) {
      mock.diff.children.push({ action: 'REMOVE', actual: { location: 'loc' } })
    }
    for (let i = 0; i < changed; i++) {
      const actual = { location: 'loc' }
      const ideal = { location: 'loc' }
      mock.diff.children.push({ action: 'CHANGE', actual, ideal })
    }
    output.length = 0
    reifyOutput(mock)
    t.matchSnapshot(output.join('\n'), JSON.stringify({
      added,
      removed,
      changed,
      audited,
      json
    }))
  }

  const cases = []
  for (const added of [0, 1, 2]) {
    for (const removed of [0, 1, 2]) {
      for (const changed of [0, 1, 2]) {
        for (const audited of [0, 1, 2]) {
          for (const json of [true, false]) {
            cases.push([added, removed, changed, audited, json, 'install'])
          }
        }
      }
    }
  }

  // add case for when audit is the command
  cases.push([0, 0, 0, 2, true, 'audit'])
  cases.push([0, 0, 0, 2, false, 'audit'])

  t.plan(cases.length)
  for (const [added, removed, changed, audited, json, command] of cases) {
    testCase(t, added, removed, changed, audited, json, command)
  }

  t.end()
})