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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
|
const t = require('tap')
const requireInject = require('require-inject')
const { EventEmitter } = require('events')
const redactCwd = (path) => {
const normalizePath = p => p
.replace(/\\+/g, '/')
.replace(/\r\n/g, '\n')
const replaceCwd = p => p
.replace(new RegExp(normalizePath(process.cwd()), 'g'), '{CWD}')
const cleanupWinPaths = p => p
.replace(normalizePath(process.execPath), '/path/to/node')
.replace(normalizePath(process.env.HOME), '~/')
return cleanupWinPaths(
replaceCwd(
normalizePath(path)
)
)
}
t.cleanSnapshot = (str) => redactCwd(str)
let result = ''
const types = {
'init-author-name': String,
'init-version': String,
'init.author.name': String,
'init.version': String,
}
const defaults = {
'init-author-name': '',
'init-version': '1.0.0',
'init.author.name': '',
'init.version': '1.0.0',
}
const flatOptions = {
editor: 'vi',
json: false,
long: false,
global: false,
}
const npm = {
flatOptions,
log: {
info: () => null,
enableProgress: () => null,
disableProgress: () => null,
},
config: {
data: new Map(Object.entries({
default: { data: defaults, source: 'default values' },
global: { data: {}, source: '/etc/npmrc' },
cli: { data: flatOptions, source: 'command line options' },
})),
get (key) {
return flatOptions[key]
},
validate () {
return true
},
},
output: msg => {
result = msg
},
}
const usageUtil = () => 'usage instructions'
const mocks = {
'../../lib/utils/config.js': { defaults, types },
'../../lib/utils/usage.js': usageUtil,
}
const Config = requireInject('../../lib/config.js', mocks)
const config = new Config(npm)
t.test('config no args', t => {
config.exec([], (err) => {
t.match(err, /usage instructions/, 'should not error out on empty locations')
t.end()
})
})
t.test('config list', t => {
t.plan(2)
npm.config.find = () => 'cli'
result = ''
t.teardown(() => {
result = ''
delete npm.config.find
})
config.exec(['list'], (err) => {
t.ifError(err, 'npm config list')
t.matchSnapshot(result, 'should list configs')
})
})
t.test('config list overrides', t => {
t.plan(2)
npm.config.data.set('user', {
data: {
'init.author.name': 'Foo',
'//private-reg.npmjs.org/:_authThoken': 'f00ba1',
},
source: '~/.npmrc',
})
flatOptions['init.author.name'] = 'Bar'
npm.config.find = () => 'cli'
result = ''
t.teardown(() => {
result = ''
npm.config.data.delete('user')
delete flatOptions['init.author.name']
delete npm.config.find
})
config.exec(['list'], (err) => {
t.ifError(err, 'npm config list')
t.matchSnapshot(result, 'should list overridden configs')
})
})
t.test('config list --long', t => {
t.plan(2)
npm.config.find = key => key in flatOptions ? 'cli' : 'default'
flatOptions.long = true
result = ''
t.teardown(() => {
delete npm.config.find
flatOptions.long = false
result = ''
})
config.exec(['list'], (err) => {
t.ifError(err, 'npm config list --long')
t.matchSnapshot(result, 'should list all configs')
})
})
t.test('config list --json', t => {
t.plan(2)
flatOptions.json = true
result = ''
npm.config.list = [{
'//private-reg.npmjs.org/:_authThoken': 'f00ba1',
...npm.config.data.get('cli').data,
}]
const npmConfigGet = npm.config.get
npm.config.get = key => npm.config.list[0][key]
t.teardown(() => {
delete npm.config.list
flatOptions.json = false
npm.config.get = npmConfigGet
result = ''
})
config.exec(['list'], (err) => {
t.ifError(err, 'npm config list --json')
t.deepEqual(
JSON.parse(result),
{
editor: 'vi',
json: true,
long: false,
global: false,
},
'should list configs usin json'
)
})
})
t.test('config delete no args', t => {
config.exec(['delete'], (err) => {
t.match(err, { message: '\nUsage: usage instructions' })
t.end()
})
})
t.test('config delete key', t => {
t.plan(4)
npm.config.delete = (key, where) => {
t.equal(key, 'foo', 'should delete expected keyword')
t.equal(where, 'user', 'should delete key from user config by default')
}
npm.config.save = where => {
t.equal(where, 'user', 'should save user config post-delete')
}
config.exec(['delete', 'foo'], (err) => {
t.ifError(err, 'npm config delete key')
})
t.teardown(() => {
delete npm.config.delete
delete npm.config.save
})
})
t.test('config delete multiple key', t => {
t.plan(6)
const expect = [
'foo',
'bar',
]
npm.config.delete = (key, where) => {
t.equal(key, expect.shift(), 'should delete expected keyword')
t.equal(where, 'user', 'should delete key from user config by default')
}
npm.config.save = where => {
t.equal(where, 'user', 'should save user config post-delete')
}
config.exec(['delete', 'foo', 'bar'], (err) => {
t.ifError(err, 'npm config delete keys')
})
t.teardown(() => {
delete npm.config.delete
delete npm.config.save
})
})
t.test('config delete key --global', t => {
t.plan(4)
npm.config.delete = (key, where) => {
t.equal(key, 'foo', 'should delete expected keyword from global configs')
t.equal(where, 'global', 'should delete key from global config by default')
}
npm.config.save = where => {
t.equal(where, 'global', 'should save global config post-delete')
}
flatOptions.global = true
config.exec(['delete', 'foo'], (err) => {
t.ifError(err, 'npm config delete key --global')
})
t.teardown(() => {
flatOptions.global = false
delete npm.config.delete
delete npm.config.save
})
})
t.test('config set no args', t => {
config.exec(['set'], (err) => {
t.match(err, { message: '\nUsage: usage instructions' })
t.end()
})
})
t.test('config set key', t => {
t.plan(5)
npm.config.set = (key, val, where) => {
t.equal(key, 'foo', 'should set expected key to user config')
t.equal(val, 'bar', 'should set expected value to user config')
t.equal(where, 'user', 'should set key/val in user config by default')
}
npm.config.save = where => {
t.equal(where, 'user', 'should save user config')
}
config.exec(['set', 'foo', 'bar'], (err) => {
t.ifError(err, 'npm config set key')
})
t.teardown(() => {
delete npm.config.set
delete npm.config.save
})
})
t.test('config set key=val', t => {
t.plan(5)
npm.config.set = (key, val, where) => {
t.equal(key, 'foo', 'should set expected key to user config')
t.equal(val, 'bar', 'should set expected value to user config')
t.equal(where, 'user', 'should set key/val in user config by default')
}
npm.config.save = where => {
t.equal(where, 'user', 'should save user config')
}
config.exec(['set', 'foo=bar'], (err) => {
t.ifError(err, 'npm config set key')
})
t.teardown(() => {
delete npm.config.set
delete npm.config.save
})
})
t.test('config set multiple keys', t => {
t.plan(11)
const expect = [
['foo', 'bar'],
['bar', 'baz'],
['asdf', ''],
]
const args = ['foo', 'bar', 'bar=baz', 'asdf']
npm.config.set = (key, val, where) => {
const [expectKey, expectVal] = expect.shift()
t.equal(key, expectKey, 'should set expected key to user config')
t.equal(val, expectVal, 'should set expected value to user config')
t.equal(where, 'user', 'should set key/val in user config by default')
}
npm.config.save = where => {
t.equal(where, 'user', 'should save user config')
}
config.exec(['set', ...args], (err) => {
t.ifError(err, 'npm config set key')
})
t.teardown(() => {
delete npm.config.set
delete npm.config.save
})
})
t.test('config set key to empty value', t => {
t.plan(5)
npm.config.set = (key, val, where) => {
t.equal(key, 'foo', 'should set expected key to user config')
t.equal(val, '', 'should set "" to user config')
t.equal(where, 'user', 'should set key/val in user config by default')
}
npm.config.save = where => {
t.equal(where, 'user', 'should save user config')
}
config.exec(['set', 'foo'], (err) => {
t.ifError(err, 'npm config set key to empty value')
})
t.teardown(() => {
delete npm.config.set
delete npm.config.save
})
})
t.test('config set invalid key', t => {
t.plan(3)
const npmConfigValidate = npm.config.validate
npm.config.save = () => null
npm.config.set = () => null
npm.config.validate = () => false
npm.log.warn = (title, msg) => {
t.equal(title, 'config', 'should warn with expected title')
t.equal(msg, 'omitting invalid config values', 'should use expected msg')
}
t.teardown(() => {
npm.config.validate = npmConfigValidate
delete npm.config.save
delete npm.config.set
delete npm.log.warn
})
config.exec(['set', 'foo', 'bar'], (err) => {
t.ifError(err, 'npm config set invalid key')
})
})
t.test('config set key --global', t => {
t.plan(5)
npm.config.set = (key, val, where) => {
t.equal(key, 'foo', 'should set expected key to global config')
t.equal(val, 'bar', 'should set expected value to global config')
t.equal(where, 'global', 'should set key/val in global config')
}
npm.config.save = where => {
t.equal(where, 'global', 'should save global config')
}
flatOptions.global = true
config.exec(['set', 'foo', 'bar'], (err) => {
t.ifError(err, 'npm config set key --global')
})
t.teardown(() => {
flatOptions.global = false
delete npm.config.set
delete npm.config.save
})
})
t.test('config get no args', t => {
t.plan(2)
npm.config.find = () => 'cli'
result = ''
t.teardown(() => {
result = ''
delete npm.config.find
})
config.exec(['get'], (err) => {
t.ifError(err, 'npm config get no args')
t.matchSnapshot(result, 'should list configs on config get no args')
})
})
t.test('config get key', t => {
t.plan(2)
const npmConfigGet = npm.config.get
npm.config.get = (key) => {
t.equal(key, 'foo', 'should use expected key')
return 'bar'
}
npm.config.save = where => {
throw new Error('should not save')
}
config.exec(['get', 'foo'], (err) => {
t.ifError(err, 'npm config get key')
})
t.teardown(() => {
npm.config.get = npmConfigGet
delete npm.config.save
})
})
t.test('config get multiple keys', t => {
t.plan(4)
const expect = [
'foo',
'bar',
]
const npmConfigGet = npm.config.get
npm.config.get = (key) => {
t.equal(key, expect.shift(), 'should use expected key')
return 'asdf'
}
npm.config.save = where => {
throw new Error('should not save')
}
config.exec(['get', 'foo', 'bar'], (err) => {
t.ifError(err, 'npm config get multiple keys')
t.equal(result, 'foo=asdf\nbar=asdf')
})
t.teardown(() => {
result = ''
npm.config.get = npmConfigGet
delete npm.config.save
})
})
t.test('config get private key', t => {
config.exec(['get', '//private-reg.npmjs.org/:_authThoken'], (err) => {
t.match(
err,
/The \/\/private-reg.npmjs.org\/:_authThoken option is protected, and cannot be retrieved in this way/,
'should throw unable to retrieve error'
)
t.end()
})
})
t.test('config edit', t => {
t.plan(12)
const npmrc = `//registry.npmjs.org/:_authToken=0000000
init.author.name=Foo
sign-git-commit=true`
npm.config.data.set('user', {
source: '~/.npmrc',
})
npm.config.save = async where => {
t.equal(where, 'user', 'should save to user config by default')
}
const editMocks = {
...mocks,
'mkdirp-infer-owner': async () => null,
fs: {
readFile (path, encoding, cb) {
cb(null, npmrc)
},
writeFile (file, data, encoding, cb) {
t.equal(file, '~/.npmrc', 'should save to expected file location')
t.matchSnapshot(data, 'should write config file')
cb()
},
},
child_process: {
spawn: (bin, args) => {
t.equal(bin, 'vi', 'should use default editor')
t.strictSame(args, ['~/.npmrc'], 'should match user source data')
const ee = new EventEmitter()
process.nextTick(() => {
ee.emit('exit', 0)
})
return ee
},
},
}
const Config = requireInject('../../lib/config.js', editMocks)
const config = new Config(npm)
config.exec(['edit'], (err) => {
t.ifError(err, 'npm config edit')
// test no config file result
editMocks.fs.readFile = (p, e, cb) => {
cb(new Error('ERR'))
}
const Config = requireInject('../../lib/config.js', editMocks)
const config = new Config(npm)
config.exec(['edit'], (err) => {
t.ifError(err, 'npm config edit')
})
})
t.teardown(() => {
npm.config.data.delete('user')
delete npm.config.save
})
})
t.test('config edit --global', t => {
t.plan(6)
flatOptions.global = true
const npmrc = 'init.author.name=Foo'
npm.config.data.set('global', {
source: '/etc/npmrc',
})
npm.config.save = async where => {
t.equal(where, 'global', 'should save to global config')
}
const editMocks = {
...mocks,
'mkdirp-infer-owner': async () => null,
fs: {
readFile (path, encoding, cb) {
cb(null, npmrc)
},
writeFile (file, data, encoding, cb) {
t.equal(file, '/etc/npmrc', 'should save to global file location')
t.matchSnapshot(data, 'should write global config file')
cb()
},
},
child_process: {
spawn: (bin, args, cb) => {
t.equal(bin, 'vi', 'should use default editor')
t.strictSame(args, ['/etc/npmrc'], 'should match global source data')
const ee = new EventEmitter()
process.nextTick(() => {
ee.emit('exit', 137)
})
return ee
},
},
}
const Config = requireInject('../../lib/config.js', editMocks)
const config = new Config(npm)
config.exec(['edit'], (err) => {
t.match(err, /exited with code: 137/, 'propagated exit code from editor')
})
t.teardown(() => {
flatOptions.global = false
npm.config.data.delete('user')
delete npm.config.save
})
})
t.test('completion', t => {
const { completion } = config
const testComp = (argv, expect) => {
t.resolveMatch(completion({ conf: { argv: { remain: argv } } }), expect, argv.join(' '))
}
testComp(['npm', 'foo'], [])
testComp(['npm', 'config'], ['get', 'set', 'delete', 'ls', 'rm', 'edit', 'list'])
testComp(['npm', 'config', 'set', 'foo'], [])
const possibleConfigKeys = [...Object.keys(types)]
testComp(['npm', 'config', 'get'], possibleConfigKeys)
testComp(['npm', 'config', 'set'], possibleConfigKeys)
testComp(['npm', 'config', 'delete'], possibleConfigKeys)
testComp(['npm', 'config', 'rm'], possibleConfigKeys)
testComp(['npm', 'config', 'edit'], [])
testComp(['npm', 'config', 'list'], [])
testComp(['npm', 'config', 'ls'], [])
const partial = completion({conf: { argv: { remain: ['npm', 'config'] } }, partialWord: 'l'})
t.resolveMatch(partial, ['get', 'set', 'delete', 'ls', 'rm', 'edit'], 'npm config')
t.end()
})
|