/
watch.spec.js
349 lines (302 loc) · 10.3 KB
/
watch.spec.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
'use strict';
const fs = require('fs-extra');
const os = require('os');
const path = require('path');
const helpers = require('../helpers');
describe('--watch', function() {
describe('when enabled', function() {
this.timeout(10 * 1000);
this.slow(3000);
beforeEach(function() {
this.tempDir = fs.mkdtempSync(path.join(os.tmpdir(), 'mocha-'));
});
afterEach(function() {
if (this.tempDir) {
return fs.remove(this.tempDir);
}
});
it('reruns test when watched test file is touched', function() {
const testFile = path.join(this.tempDir, 'test.js');
copyFixture('__default__', testFile);
return runMochaWatch([testFile], this.tempDir, () => {
touchFile(testFile);
}).then(results => {
expect(results, 'to have length', 2);
});
});
it('reruns test when file matching --watch-files changes', function() {
const testFile = path.join(this.tempDir, 'test.js');
copyFixture('__default__', testFile);
const watchedFile = path.join(this.tempDir, 'dir/file.xyz');
touchFile(watchedFile);
return runMochaWatch(
[testFile, '--watch-files', 'dir/*.xyz'],
this.tempDir,
() => {
touchFile(watchedFile);
}
).then(results => {
expect(results.length, 'to equal', 2);
});
});
it('reruns test when file matching --watch-files is added', function() {
const testFile = path.join(this.tempDir, 'test.js');
copyFixture('__default__', testFile);
const watchedFile = path.join(this.tempDir, 'lib/file.xyz');
return runMochaWatch(
[testFile, '--watch-files', '**/*.xyz'],
this.tempDir,
() => {
touchFile(watchedFile);
}
).then(results => {
expect(results, 'to have length', 2);
});
});
it('reruns test when file matching --watch-files is removed', function() {
const testFile = path.join(this.tempDir, 'test.js');
copyFixture('__default__', testFile);
const watchedFile = path.join(this.tempDir, 'lib/file.xyz');
touchFile(watchedFile);
return runMochaWatch(
[testFile, '--watch-files', 'lib/**/*.xyz'],
this.tempDir,
() => {
fs.removeSync(watchedFile);
}
).then(results => {
expect(results, 'to have length', 2);
});
});
it('does not rerun test when file not matching --watch-files is changed', function() {
const testFile = path.join(this.tempDir, 'test.js');
copyFixture('__default__', testFile);
const watchedFile = path.join(this.tempDir, 'dir/file.js');
touchFile(watchedFile);
return runMochaWatch(
[testFile, '--watch-files', 'dir/*.xyz'],
this.tempDir,
() => {
touchFile(watchedFile);
}
).then(results => {
expect(results.length, 'to equal', 1);
});
});
it('picks up new test files when they are added', function() {
const testFile = path.join(this.tempDir, 'test/a.js');
copyFixture('__default__', testFile);
return runMochaWatch(
['test/**/*.js', '--watch-files', 'test/**/*.js'],
this.tempDir,
() => {
const addedTestFile = path.join(this.tempDir, 'test/b.js');
copyFixture('passing', addedTestFile);
}
).then(results => {
expect(results, 'to have length', 2);
expect(results[0].passes, 'to have length', 1);
expect(results[1].passes, 'to have length', 3);
});
});
it('reruns test when file matching --extension is changed', function() {
const testFile = path.join(this.tempDir, 'test.js');
copyFixture('__default__', testFile);
const watchedFile = path.join(this.tempDir, 'file.xyz');
touchFile(watchedFile);
return runMochaWatch(
[testFile, '--extension', 'xyz,js'],
this.tempDir,
() => {
touchFile(watchedFile);
}
).then(results => {
expect(results, 'to have length', 2);
});
});
it('reruns when "rs\\n" typed', function() {
const testFile = path.join(this.tempDir, 'test.js');
copyFixture('__default__', testFile);
return runMochaWatch([testFile], this.tempDir, mochaProcess => {
mochaProcess.stdin.write('rs\n');
}).then(results => {
expect(results, 'to have length', 2);
});
});
it('reruns test when file starting with . and matching --extension is changed', function() {
const testFile = path.join(this.tempDir, 'test.js');
copyFixture('__default__', testFile);
const watchedFile = path.join(this.tempDir, '.file.xyz');
touchFile(watchedFile);
return runMochaWatch(
[testFile, '--extension', 'xyz,js'],
this.tempDir,
() => {
touchFile(watchedFile);
}
).then(results => {
expect(results, 'to have length', 2);
});
});
it('ignores files in "node_modules" and ".git" by default', function() {
const testFile = path.join(this.tempDir, 'test.js');
copyFixture('__default__', testFile);
const nodeModulesFile = path.join(
this.tempDir,
'node_modules',
'file.xyz'
);
const gitFile = path.join(this.tempDir, '.git', 'file.xyz');
touchFile(gitFile);
touchFile(nodeModulesFile);
return runMochaWatch(
[testFile, '--extension', 'xyz,js'],
this.tempDir,
() => {
touchFile(gitFile);
touchFile(nodeModulesFile);
}
).then(results => {
expect(results, 'to have length', 1);
});
});
it('ignores files matching --watch-ignore', function() {
const testFile = path.join(this.tempDir, 'test.js');
copyFixture('__default__', testFile);
const watchedFile = path.join(this.tempDir, 'dir/file-to-ignore.xyz');
touchFile(watchedFile);
return runMochaWatch(
[
testFile,
'--watch-files',
'dir/*.xyz',
'--watch-ignore',
'dir/*ignore*'
],
this.tempDir,
() => {
touchFile(watchedFile);
}
).then(results => {
expect(results.length, 'to equal', 1);
});
});
it('reloads test files when they change', function() {
const testFile = path.join(this.tempDir, 'test.js');
copyFixture('options/watch/test-file-change', testFile);
return runMochaWatch(
[testFile, '--watch-files', '**/*.js'],
this.tempDir,
() => {
replaceFileContents(
testFile,
'testShouldFail = true',
'testShouldFail = false'
);
}
).then(results => {
expect(results, 'to have length', 2);
expect(results[0].passes, 'to have length', 0);
expect(results[0].failures, 'to have length', 1);
expect(results[1].passes, 'to have length', 1);
expect(results[1].failures, 'to have length', 0);
});
});
it('reloads test dependencies when they change', function() {
const testFile = path.join(this.tempDir, 'test.js');
copyFixture('options/watch/test-with-dependency', testFile);
const dependency = path.join(this.tempDir, 'lib', 'dependency.js');
copyFixture('options/watch/dependency', dependency);
return runMochaWatch(
[testFile, '--watch-files', 'lib/**/*.js'],
this.tempDir,
() => {
replaceFileContents(
dependency,
'module.exports.testShouldFail = false',
'module.exports.testShouldFail = true'
);
}
).then(results => {
expect(results, 'to have length', 2);
expect(results[0].passes, 'to have length', 1);
expect(results[0].failures, 'to have length', 0);
expect(results[1].passes, 'to have length', 0);
expect(results[1].failures, 'to have length', 1);
});
});
// Regression test for https://github.com/mochajs/mocha/issues/2027
it('respects --fgrep on re-runs', function() {
const testFile = path.join(this.tempDir, 'test.js');
copyFixture('options/grep', testFile);
return runMochaWatch([testFile, '--fgrep', 'match'], this.tempDir, () => {
touchFile(testFile);
}).then(results => {
expect(results, 'to have length', 2);
expect(results[0].tests, 'to have length', 2);
expect(results[1].tests, 'to have length', 2);
});
});
});
});
/**
* Runs the mocha binary in watch mode calls `change` and returns the
* JSON reporter output.
*
* The function starts mocha with the given arguments and `--watch` and
* waits until the first test run has completed. Then it calls `change`
* and waits until the second test run has been completed. Mocha is
* killed and the list of JSON outputs is returned.
*/
function runMochaWatch(args, cwd, change) {
const [mochaProcess, resultPromise] = helpers.invokeMochaAsync(
[...args, '--watch', '--reporter', 'json'],
{cwd, stdio: 'pipe'}
);
return sleep(1000)
.then(() => change(mochaProcess))
.then(() => sleep(1000))
.then(() => {
mochaProcess.kill('SIGINT');
return resultPromise;
})
.then(data => {
const testResults = data.output
// eslint-disable-next-line no-control-regex
.replace(/\u001b\[\?25./g, '')
.split('\u001b[2K')
.map(x => JSON.parse(x));
return testResults;
});
}
/**
* Synchronously touch a file by appending a space to the end. Creates
* the file and all its parent directories if necessary.
*/
function touchFile(file) {
fs.ensureDirSync(path.dirname(file));
fs.appendFileSync(file, ' ');
}
/**
* Synchronously replace all substrings matched by `pattern` with
* `replacement` in the file’s content.
*/
function replaceFileContents(file, pattern, replacement) {
const contents = fs.readFileSync(file, 'utf-8');
const newContents = contents.replace(pattern, replacement);
fs.writeFileSync(file, newContents, 'utf-8');
}
/**
* Synchronously copy a fixture to the given destination file path.
* Creates parent directories of the destination path if necessary.
*/
function copyFixture(fixtureName, dest) {
const fixtureSource = helpers.resolveFixturePath(fixtureName);
fs.ensureDirSync(path.dirname(dest));
fs.copySync(fixtureSource, dest);
}
function sleep(time) {
return new Promise(resolve => {
setTimeout(resolve, time);
});
}