forked from istanbuljs/nyc
-
Notifications
You must be signed in to change notification settings - Fork 0
/
instrument.js
356 lines (284 loc) · 9.79 KB
/
instrument.js
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
'use strict'
const fs = require('../lib/fs-promises')
const path = require('path')
const { promisify } = require('util')
const t = require('tap')
const makeDir = require('make-dir')
const cpFile = require('cp-file')
const isWindows = require('is-windows')()
const rimraf = promisify(require('rimraf'))
const { runNYC, testSuccess, fixturesCLI } = require('./helpers')
const subdir = path.resolve(fixturesCLI, 'subdir')
const outputDir = path.resolve(subdir, './output-dir')
const removedByClean = path.resolve(outputDir, 'removed-by-clean')
function cleanup () {
return Promise.all([
rimraf(path.resolve(subdir, 'output-dir')),
rimraf(path.resolve(fixturesCLI, 'output-dir'))
])
}
t.test('clean before', cleanup)
t.afterEach(cleanup)
t.test('works in directories without a package.json', async t => {
const { status } = await runNYC({
args: ['instrument', './input-dir', './output-dir'],
cwd: subdir
})
t.strictEqual(status, 0)
const target = path.resolve(subdir, 'output-dir', 'index.js')
t.match(await fs.readFile(target, 'utf8'), /console.log\('Hello, World!'\)/)
})
t.test('can be configured to exit on error', async t => {
const { status } = await runNYC({
args: ['instrument', '--exit-on-error', './input-dir', './output-dir'],
cwd: subdir
})
t.strictEqual(status, 1)
})
t.test('allows a single file to be instrumented', async t => {
const inputPath = path.resolve(fixturesCLI, './half-covered.js')
const inputMode = (await fs.stat(inputPath)).mode & 0o7777
const newMode = 0o775
if (!isWindows) {
await fs.chmod(inputPath, newMode)
}
const { status } = await runNYC({
args: ['instrument', './half-covered.js', outputDir]
})
t.strictEqual(status, 0)
const files = await fs.readdir(outputDir)
t.strictSame(files, ['half-covered.js'])
if (!isWindows) {
const outputPath = path.resolve(outputDir, 'half-covered.js')
const outputMode = (await fs.stat(outputPath)).mode & 0o7777
t.strictEqual(outputMode, newMode)
await fs.chmod(inputPath, inputMode)
}
})
t.test('allows a directory of files to be instrumented', async t => {
const { status } = await runNYC({
args: ['instrument', './nyc-config-js', outputDir]
})
t.strictEqual(status, 0)
const files = fs.readdirSync(outputDir)
t.strictEqual(files.includes('index.js'), true)
t.strictEqual(files.includes('ignore.js'), true)
t.strictEqual(files.includes('package.json'), false)
t.strictEqual(files.includes('node_modules'), false)
const includeTarget = path.resolve(outputDir, 'ignore.js')
t.match(await fs.readFile(includeTarget, 'utf8'), /function cov_/)
})
t.test('copies all files from <input> to <output> as well as those that have been instrumented', async t => {
// force node_modules to exist so we can verify that it is copied.
const nmDir = path.resolve(fixturesCLI, 'nyc-config-js', 'node_modules')
await makeDir(nmDir)
await fs.writeFile(path.join(nmDir, 'test-file'), '')
const { status } = await runNYC({
args: ['instrument', '--complete-copy', './nyc-config-js', outputDir]
})
t.strictEqual(status, 0)
const files = await fs.readdir(outputDir)
t.strictEqual(files.includes('index.js'), true)
t.strictEqual(files.includes('ignore.js'), true)
t.strictEqual(files.includes('package.json'), true)
t.strictEqual(files.includes('node_modules'), true)
const includeTarget = path.resolve(outputDir, 'ignore.js')
t.match(await fs.readFile(includeTarget, 'utf8'), /function cov_/)
})
t.test('can instrument the project directory', async t => {
const { status } = await runNYC({
args: ['instrument', '.', outputDir]
})
t.strictEqual(status, 0)
const files = await fs.readdir(outputDir)
t.strictEqual(files.includes('args.js'), true)
t.strictEqual(files.includes('subdir'), true)
})
t.test('allows a sub-directory of files to be instrumented', async t => {
const { status } = await runNYC({
args: ['instrument', './subdir/input-dir', outputDir]
})
t.strictEqual(status, 0)
const files = await fs.readdir(outputDir)
t.strictEqual(files.includes('index.js'), true)
})
t.test('allows a subdirectory to be excluded via .nycrc file', async t => {
const { status } = await runNYC({
args: [
'instrument',
'--nycrc-path',
'./.instrument-nycrc',
'./subdir/input-dir',
outputDir
]
})
t.strictEqual(status, 0)
const files = fs.readdirSync(outputDir)
t.strictEqual(files.includes('exclude-me'), true)
t.strictEqual(files.includes('node_modules'), true)
t.strictEqual(files.includes('index.js'), true)
t.strictEqual(files.includes('bad.js'), true)
const includeTarget = path.resolve(outputDir, 'index.js')
t.match(await fs.readFile(includeTarget, 'utf8'), /function cov_/)
const excludeTarget = path.resolve(outputDir, 'exclude-me', 'index.js')
t.notMatch(await fs.readFile(excludeTarget, 'utf8'), /function cov_/)
})
t.test('allows a file to be excluded', async t => {
const { status } = await runNYC({
args: [
'instrument',
'--complete-copy',
'--exclude',
'exclude-me/index.js',
'./subdir/input-dir',
outputDir
]
})
t.strictEqual(status, 0)
const files = await fs.readdir(outputDir)
t.strictEqual(files.includes('exclude-me'), true)
const excludeTarget = path.resolve(outputDir, 'exclude-me', 'index.js')
t.notMatch(await fs.readFile(excludeTarget, 'utf8'), /function cov_/)
})
t.test('allows specifying a single sub-directory to be included', async t => {
const { status } = await runNYC({
args: [
'instrument',
'--include',
'**/include-me/**',
'./subdir/input-dir',
outputDir
]
})
t.strictEqual(status, 0)
const files = await fs.readdir(outputDir)
t.strictEqual(files.includes('include-me'), true)
const instrumented = path.resolve(outputDir, 'include-me', 'include-me.js')
t.match(await fs.readFile(instrumented, 'utf8'), /function cov_/)
})
t.test('allows a file to be excluded from an included directory', async t => {
const { status } = await runNYC({
args: [
'instrument',
'--complete-copy',
'--exclude',
'**/exclude-me.js',
'--include',
'**/include-me/**',
'./subdir/input-dir',
outputDir
]
})
t.strictEqual(status, 0)
const files = await fs.readdir(outputDir)
t.strictEqual(files.includes('include-me'), true)
const includeMeFiles = await fs.readdir(path.resolve(outputDir, 'include-me'))
t.strictEqual(includeMeFiles.includes('include-me.js'), true)
t.strictEqual(includeMeFiles.includes('exclude-me.js'), true)
const includeTarget = path.resolve(outputDir, 'include-me', 'include-me.js')
t.match(await fs.readFile(includeTarget, 'utf8'), /function cov_/)
const excludeTarget = path.resolve(outputDir, 'exclude-me', 'index.js')
t.notMatch(await fs.readFile(excludeTarget, 'utf8'), /function cov_/)
})
t.test('aborts if trying to write files in place', async t => {
const { status, stderr } = await runNYC({
args: ['instrument', './', './']
})
t.strictEqual(status, 1)
t.match(stderr, /cannot instrument files in place/)
})
t.test('can write files in place with --in-place switch', async t => {
const sourceDir = path.resolve(fixturesCLI, 'instrument-inplace')
await makeDir(outputDir)
await Promise.all(['package.json', 'file1.js', 'file2.js'].map(
file => cpFile(path.join(sourceDir, file), path.join(outputDir, file))
))
const { status } = await runNYC({
args: [
'instrument',
'--in-place',
'--include',
'file1.js',
'.'
],
cwd: outputDir
})
t.strictEqual(status, 0)
const file1 = path.resolve(outputDir, 'file1.js')
t.match(await fs.readFile(file1, 'utf8'), /function cov_/)
const file2 = path.resolve(outputDir, 'file2.js')
t.notMatch(await fs.readFile(file2, 'utf8'), /function cov_/)
await testSuccess(t, {
args: ['--all', process.execPath, '-e', ''],
cwd: outputDir
})
})
t.test('aborts if trying to delete while writing files in place', async t => {
const { status, stderr } = await runNYC({
args: [
'instrument',
'--in-place',
'--delete',
'--include',
'file1.js',
'./instrument-inplace'
]
})
t.strictEqual(status, 1)
t.match(stderr, /cannot use '--delete' when instrumenting files in place/)
})
t.test('aborts if trying to instrument files from outside the project root directory', async t => {
const { status, stderr } = await runNYC({
args: [
'instrument',
'--delete',
'../',
'./'
]
})
t.strictEqual(status, 1)
t.match(stderr, /cannot instrument files outside project root directory/)
})
t.test('cleans the output directory if `--delete` is specified', async t => {
await makeDir(removedByClean)
const { status } = await runNYC({
args: [
'instrument',
'--delete',
'true',
'./subdir/input-dir',
outputDir
]
})
t.strictEqual(status, 0)
const files = await fs.readdir(outputDir)
t.strictEqual(files.includes('removed-by-clean'), false)
t.strictEqual(files.includes('exclude-me'), true)
})
t.test('does not clean the output directory by default', async t => {
await makeDir(removedByClean)
const { status } = await runNYC({
args: [
'instrument',
'./subdir/input-dir',
outputDir
]
})
t.strictEqual(status, 0)
const files = await fs.readdir(outputDir)
t.strictEqual(files.includes('removed-by-clean'), true)
})
t.test('aborts if trying to clean process.cwd()', async t => {
const { status, stderr } = await runNYC({
args: ['instrument', '--delete', './src', './']
})
t.strictEqual(status, 1)
t.match(stderr, /attempt to delete/)
})
t.test('aborts if trying to clean outside working directory', async t => {
const { status, stderr } = await runNYC({
args: ['instrument', '--delete', './', '../']
})
t.strictEqual(status, 1)
t.match(stderr, /attempt to delete/)
})