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
|
'use strict';
const EventEmitter = require('events');
const path = require('path');
const fs = require('fs');
const commonPathPrefix = require('common-path-prefix');
const uniqueTempDir = require('unique-temp-dir');
const findCacheDir = require('find-cache-dir');
const resolveCwd = require('resolve-cwd');
const debounce = require('lodash.debounce');
const autoBind = require('auto-bind');
const Promise = require('bluebird');
const getPort = require('get-port');
const arrify = require('arrify');
const ms = require('ms');
const babelConfigHelper = require('./lib/babel-config');
const CachingPrecompiler = require('./lib/caching-precompiler');
const RunStatus = require('./lib/run-status');
const AvaError = require('./lib/ava-error');
const AvaFiles = require('./lib/ava-files');
const fork = require('./lib/fork');
function resolveModules(modules) {
return arrify(modules).map(name => {
const modulePath = resolveCwd.silent(name);
if (modulePath === null) {
throw new Error(`Could not resolve required module '${name}'`);
}
return modulePath;
});
}
function getBlankResults() {
return {
stats: {
knownFailureCount: 0,
testCount: 0,
passCount: 0,
skipCount: 0,
todoCount: 0,
failCount: 0
},
tests: []
};
}
class Api extends EventEmitter {
constructor(options) {
super();
autoBind(this);
this.options = Object.assign({match: []}, options);
this.options.require = resolveModules(this.options.require);
}
_runFile(file, runStatus, execArgv) {
const hash = this.precompiler.precompileFile(file);
const precompiled = Object.assign({}, this._precompiledHelpers);
const resolvedfpath = fs.realpathSync(file);
precompiled[resolvedfpath] = hash;
const options = Object.assign({}, this.options, {precompiled});
if (runStatus.updateSnapshots) {
// Don't use in Object.assign() since it'll override options.updateSnapshots even when false.
options.updateSnapshots = true;
}
const emitter = fork(file, options, execArgv);
runStatus.observeFork(emitter);
return emitter;
}
run(files, options) {
return new AvaFiles({cwd: this.options.resolveTestsFrom, files})
.findTestFiles()
.then(files => this._run(files, options));
}
_onTimeout(runStatus) {
const timeout = ms(this.options.timeout);
const err = new AvaError(`Exited because no new tests completed within the last ${timeout}ms of inactivity`);
this._handleError(runStatus, err);
runStatus.emit('timeout');
}
_setupTimeout(runStatus) {
const timeout = ms(this.options.timeout);
runStatus._restartTimer = debounce(() => {
this._onTimeout(runStatus);
}, timeout);
runStatus._restartTimer();
runStatus.on('test', runStatus._restartTimer);
}
_cancelTimeout(runStatus) {
runStatus._restartTimer.cancel();
}
_setupPrecompiler(files) {
const isCacheEnabled = this.options.cacheEnabled !== false;
let cacheDir = uniqueTempDir();
if (isCacheEnabled) {
const foundDir = findCacheDir({
name: 'ava',
files
});
if (foundDir !== null) {
cacheDir = foundDir;
}
}
this.options.cacheDir = cacheDir;
const isPowerAssertEnabled = this.options.powerAssert !== false;
return babelConfigHelper.build(this.options.projectDir, cacheDir, this.options.babelConfig, isPowerAssertEnabled)
.then(result => {
this.precompiler = new CachingPrecompiler({
path: cacheDir,
getBabelOptions: result.getOptions,
babelCacheKeys: result.cacheKeys
});
});
}
_precompileHelpers() {
this._precompiledHelpers = {};
// Assumes the tests only load helpers from within the `resolveTestsFrom`
// directory. Without arguments this is the `projectDir`, else it's
// `process.cwd()` which may be nested too deeply. This will be solved
// as we implement RFC 001 and move helper compilation into the worker
// processes, avoiding the need for precompilation.
return new AvaFiles({cwd: this.options.resolveTestsFrom})
.findTestHelpers()
.map(file => { // eslint-disable-line array-callback-return
const hash = this.precompiler.precompileFile(file);
this._precompiledHelpers[file] = hash;
});
}
_run(files, options) {
options = options || {};
const runStatus = new RunStatus({
runOnlyExclusive: options.runOnlyExclusive,
prefixTitles: this.options.explicitTitles || files.length > 1,
base: path.relative(process.cwd(), commonPathPrefix(files)) + path.sep,
failFast: this.options.failFast,
updateSnapshots: options.updateSnapshots
});
this.emit('test-run', runStatus, files);
if (files.length === 0) {
const err = new AvaError('Couldn\'t find any files to test');
this._handleError(runStatus, err);
return Promise.resolve(runStatus);
}
return this._setupPrecompiler(files)
.then(() => this._precompileHelpers())
.then(() => {
if (this.options.timeout) {
this._setupTimeout(runStatus);
}
let overwatch;
if (this.options.concurrency > 0) {
const concurrency = this.options.serial ? 1 : this.options.concurrency;
overwatch = this._runWithPool(files, runStatus, concurrency);
} else {
// _runWithoutPool exists to preserve legacy behavior, specifically around `.only`
overwatch = this._runWithoutPool(files, runStatus);
}
return overwatch;
});
}
_computeForkExecArgs(files) {
const execArgv = this.options.testOnlyExecArgv || process.execArgv;
let debugArgIndex = -1;
// --inspect-brk is used in addition to --inspect to break on first line and wait
execArgv.some((arg, index) => {
const isDebugArg = /^--inspect(-brk)?($|=)/.test(arg);
if (isDebugArg) {
debugArgIndex = index;
}
return isDebugArg;
});
const isInspect = debugArgIndex >= 0;
if (!isInspect) {
execArgv.some((arg, index) => {
const isDebugArg = /^--debug(-brk)?($|=)/.test(arg);
if (isDebugArg) {
debugArgIndex = index;
}
return isDebugArg;
});
}
if (debugArgIndex === -1) {
return Promise.resolve([]);
}
return Promise
.map(files, () => getPort())
.map(port => {
const forkExecArgv = execArgv.slice();
let flagName = isInspect ? '--inspect' : '--debug';
const oldValue = forkExecArgv[debugArgIndex];
if (oldValue.indexOf('brk') > 0) {
flagName += '-brk';
}
forkExecArgv[debugArgIndex] = `${flagName}=${port}`;
return forkExecArgv;
});
}
_handleError(runStatus, err) {
runStatus.handleExceptions({
exception: err,
file: err.file ? path.relative(process.cwd(), err.file) : undefined
});
}
_runWithoutPool(files, runStatus) {
const tests = [];
let execArgvList;
// TODO: This should be cleared at the end of the run
runStatus.on('timeout', () => {
tests.forEach(fork => {
fork.exit();
});
});
return this._computeForkExecArgs(files)
.then(argvList => {
execArgvList = argvList;
})
.return(files)
.each((file, index) => {
return new Promise(resolve => {
const forkArgs = execArgvList[index];
const test = this._runFile(file, runStatus, forkArgs);
tests.push(test);
test.on('stats', resolve);
test.catch(resolve);
}).catch(err => {
err.results = [];
err.file = file;
return Promise.reject(err);
});
})
.then(() => {
if (this.options.match.length > 0 && !runStatus.hasExclusive) {
const err = new AvaError('Couldn\'t find any matching tests');
err.file = undefined;
err.results = [];
return Promise.reject(err);
}
const method = this.options.serial ? 'mapSeries' : 'map';
const options = {
runOnlyExclusive: runStatus.hasExclusive
};
return Promise[method](files, (file, index) => {
return tests[index].run(options).catch(err => {
err.file = file;
this._handleError(runStatus, err);
return getBlankResults();
});
});
})
.catch(err => {
this._handleError(runStatus, err);
return err.results;
})
.tap(results => {
// If no tests ran, make sure to tear down the child processes
if (results.length === 0) {
tests.forEach(test => {
test.send('teardown');
});
}
})
.then(results => {
// Cancel debounced _onTimeout() from firing
if (this.options.timeout) {
this._cancelTimeout(runStatus);
}
runStatus.processResults(results);
return runStatus;
});
}
_runWithPool(files, runStatus, concurrency) {
const tests = [];
let execArgvList;
runStatus.on('timeout', () => {
tests.forEach(fork => {
fork.exit();
});
});
return this._computeForkExecArgs(files)
.then(argvList => {
execArgvList = argvList;
})
.return(files)
.map((file, index) => {
return new Promise(resolve => {
const forkArgs = execArgvList[index];
const test = this._runFile(file, runStatus, forkArgs);
tests.push(test);
// If we're looking for matches, run every single test process in exclusive-only mode
const options = {
runOnlyExclusive: this.options.match.length > 0
};
resolve(test.run(options));
}).catch(err => {
err.file = file;
this._handleError(runStatus, err);
return getBlankResults();
});
}, {concurrency})
.then(results => {
// Filter out undefined results (usually result of caught exceptions)
results = results.filter(Boolean);
// Cancel debounced _onTimeout() from firing
if (this.options.timeout) {
this._cancelTimeout(runStatus);
}
if (this.options.match.length > 0 && !runStatus.hasExclusive) {
results = [];
const err = new AvaError('Couldn\'t find any matching tests');
this._handleError(runStatus, err);
}
runStatus.processResults(results);
return runStatus;
});
}
}
module.exports = Api;
|