-
Notifications
You must be signed in to change notification settings - Fork 105
/
runner.js
434 lines (376 loc) · 11.5 KB
/
runner.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
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
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
'use strict';
const EventEmitter = require('events').EventEmitter;
const path = require('path');
const _ = require('lodash');
const debug = require('debug')('runner');
const debugPerf = require('debug')('perf');
const uuid = require('uuid');
const A = require('async');
const Stats = require('./stats2');
const JSCK = require('jsck');
const tryResolve = require('try-require').resolve;
const createPhaser = require('./phases');
const createReader = require('./readers');
const engineUtil = require('./engine_util');
const wl = require('./weighted-pick');
const Engines = {
http: {},
ws: {},
socketio: {}
};
JSCK.Draft4 = JSCK.draft4;
const schema = new JSCK.Draft4(require('./schemas/artillery_test_script.json'));
module.exports = {
runner: runner,
validate: validate,
stats: Stats
};
function validate(script) {
let validation = schema.validate(script);
return validation;
}
function runner(script, payload, options, callback) {
let opts = _.assign({
periodicStats: script.config.statsInterval || 10,
mode: script.config.mode || 'uniform'
},
options);
let warnings = {
plugins: {
// someplugin: {
// message: 'Plugin not found',
// error: new Error()
// }
},
engines: {
// see plugins
}
};
_.each(script.config.phases, function(phaseSpec) {
phaseSpec.mode = phaseSpec.mode || script.config.mode;
});
if (payload) {
if (_.isArray(payload[0])) {
script.config.payload = [
{
fields: script.config.payload.fields,
reader: createReader(script.config.payload.order),
data: payload
}
];
} else {
script.config.payload = payload;
_.each(script.config.payload, function(el) {
el.reader = createReader(el.order);
});
}
} else {
script.config.payload = null;
}
let runnableScript = _.cloneDeep(script);
// Flatten flows (can have nested arrays of request specs with YAML references):
_.each(runnableScript.scenarios, function(scenarioSpec) {
scenarioSpec.flow = _.flatten(scenarioSpec.flow);
});
let ee = new EventEmitter();
//
// load engines:
//
let runnerEngines = _.map(
Object.assign({}, Engines, runnableScript.config.engines),
function loadEngine(engineConfig, engineName) {
let moduleName = 'artillery-engine-' + engineName;
try {
if (Engines[engineName]) {
moduleName = './engine_' + engineName;
}
let Engine = require(moduleName);
let engine = new Engine(runnableScript, ee, engineUtil);
engine.__name = engineName;
return engine;
} catch (err) {
console.log(
'WARNING: engine %s specified but module %s could not be loaded',
engineName,
moduleName);
console.log(err.stack);
warnings.engines[engineName] = {
message: 'Could not load',
error: err
};
}
}
);
//
// load plugins:
//
let runnerPlugins = [];
let requirePaths = [];
let pro = null;
if (tryResolve('artillery-pro')) {
pro = require('artillery-pro');
requirePaths = requirePaths.concat(pro.getPluginPath());
} else {
debug('Artillery Pro is not installed.');
}
requirePaths.push('');
if (process.env.ARTILLERY_PLUGIN_PATH) {
requirePaths = requirePaths.concat(process.env.ARTILLERY_PLUGIN_PATH.split(':'));
}
debug('require paths: ', requirePaths);
runnableScript.config.plugins = runnableScript.config.plugins || {};
if (process.env.ARTILLERY_PLUGINS) {
let additionalPlugins = {};
try {
additionalPlugins = JSON.parse(process.env.ARTILLERY_PLUGINS);
} catch (ignoreErr) {
debug(ignoreErr);
}
runnableScript.config.plugins = Object.assign(
runnableScript.config.plugins,
additionalPlugins);
}
_.each(runnableScript.config.plugins, function tryToLoadPlugin(pluginConfig, pluginName) {
let pluginConfigScope = pluginConfig.scope || runnableScript.config.pluginsScope;
let pluginPrefix = pluginConfigScope ? pluginConfigScope : 'artillery-plugin-';
let requireString = pluginPrefix + pluginName;
let Plugin, plugin;
requirePaths.forEach(function(rp) {
try {
Plugin = require(path.join(rp, requireString));
if (typeof Plugin === 'function') {
// Plugin interface v1
plugin = new Plugin(runnableScript.config, ee);
plugin.__name = pluginName;
} else if (typeof Plugin === 'object' && typeof Plugin.Plugin === 'function') {
// Plugin interface 2+
plugin = new Plugin.Plugin(runnableScript, ee, options);
plugin.__name = pluginName;
}
} catch (err) {
debug(err);
}
});
if (!Plugin || !plugin) {
console.log(
'WARNING: plugin %s specified but module %s could not be loaded',
pluginName,
requireString);
warnings.plugins[pluginName] = {
message: 'Could not load'
};
} else {
debug('Plugin %s loaded from %s', pluginName, requireString);
runnerPlugins.push(plugin);
}
});
const promise = new Promise(function(resolve, reject) {
ee.run = function() {
let runState = {
pendingScenarios: 0,
pendingRequests: 0,
compiledScenarios: null,
scenarioEvents: null,
picker: undefined,
plugins: runnerPlugins,
engines: runnerEngines
};
debug('run() with: %j', runnableScript);
run(runnableScript, ee, opts, runState);
};
ee.stop = function (done) {
// allow plugins to cleanup
A.eachSeries(
runnerPlugins,
function(plugin, next) {
if (plugin.cleanup) {
plugin.cleanup(function(err) {
if (err) {
debug(err);
}
return next();
});
} else {
return next();
}
},
function(err) {
return done(err);
});
};
// FIXME: Warnings should be returned from this function instead along with
// the event emitter. That will be a breaking change.
ee.warnings = warnings;
resolve(ee);
});
if (callback && typeof callback === 'function') {
promise.then(callback.bind(null, null), callback);
}
return promise;
}
function run(script, ee, options, runState) {
let intermediate = Stats.create();
let aggregate = [];
let phaser = createPhaser(script.config.phases);
phaser.on('arrival', function() {
runScenario(script, intermediate, runState);
});
phaser.on('phaseStarted', function(spec) {
ee.emit('phaseStarted', spec);
});
phaser.on('phaseCompleted', function(spec) {
ee.emit('phaseCompleted', spec);
});
phaser.on('done', function() {
debug('All phases launched');
const doneYet = setInterval(function checkIfDone() {
if (runState.pendingScenarios === 0) {
if (runState.pendingRequests !== 0) {
debug('DONE. Pending requests: %s', runState.pendingRequests);
}
clearInterval(doneYet);
clearInterval(periodicStatsTimer);
sendStats();
intermediate.free();
let aggregateReport = Stats.combine(aggregate).report();
return ee.emit('done', aggregateReport);
} else {
debug('Pending requests: %s', runState.pendingRequests);
debug('Pending scenarios: %s', runState.pendingScenarios);
}
}, 500);
});
const periodicStatsTimer = setInterval(sendStats, options.periodicStats * 1000);
function sendStats() {
aggregate.push(intermediate.clone());
intermediate._concurrency = runState.pendingScenarios;
intermediate._pendingRequests = runState.pendingRequests;
ee.emit('stats', intermediate.clone());
intermediate.reset();
}
phaser.run();
}
function runScenario(script, intermediate, runState) {
const start = process.hrtime();
//
// Compile scenarios if needed
//
if (!runState.compiledScenarios) {
_.each(script.scenarios, function(scenario) {
if (!scenario.weight) {
scenario.weight = 1;
}
});
runState.picker = wl(script.scenarios);
runState.scenarioEvents = new EventEmitter();
runState.scenarioEvents.on('customStat', function(stat) {
intermediate.addCustomStat(stat.stat, stat.value);
});
runState.scenarioEvents.on('started', function() {
runState.pendingScenarios++;
});
runState.scenarioEvents.on('error', function(errCode) {
intermediate.addError(errCode);
});
runState.scenarioEvents.on('request', function() {
intermediate.newRequest();
runState.pendingRequests++;
});
runState.scenarioEvents.on('match', function() {
intermediate.addMatch();
});
runState.scenarioEvents.on('response', function(delta, code, uid) {
intermediate.completedRequest();
intermediate.addLatency(delta);
intermediate.addCode(code);
let entry = [Date.now(), uid, delta, code];
intermediate.addEntry(entry);
runState.pendingRequests--;
});
runState.compiledScenarios = _.map(
script.scenarios,
function(scenarioSpec) {
const name = scenarioSpec.engine || 'http';
const engine = runState.engines.find((e) => e.__name === name);
return engine.createScenario(scenarioSpec, runState.scenarioEvents);
}
);
}
let i = runState.picker()[0];
debug('picking scenario %s (%s) weight = %s',
i,
script.scenarios[i].name,
script.scenarios[i].weight);
intermediate.newScenario(script.scenarios[i].name || i);
const scenarioStartedAt = process.hrtime();
const scenarioContext = createContext(script);
const finish = process.hrtime(start);
const runScenarioDelta = (finish[0] * 1e9) + finish[1];
debugPerf('runScenarioDelta: %s', Math.round(runScenarioDelta / 1e6 * 100) / 100);
runState.compiledScenarios[i](scenarioContext, function(err, context) {
runState.pendingScenarios--;
if (err) {
debug(err);
} else {
const scenarioFinishedAt = process.hrtime(scenarioStartedAt);
const delta = (scenarioFinishedAt[0] * 1e9) + scenarioFinishedAt[1];
intermediate.addScenarioLatency(delta);
intermediate.completedScenario();
}
});
}
/**
* Create initial context for a scenario.
*/
function createContext(script) {
const INITIAL_CONTEXT = {
vars: {
target: script.config.target,
$environment: script._environment
},
funcs: {
$randomNumber: $randomNumber,
$randomString: $randomString
}
};
let result = _.cloneDeep(INITIAL_CONTEXT);
//
// variables from payloads
//
if (script.config.payload) {
_.each(script.config.payload, function(el) {
let row = el.reader(el.data);
_.each(el.fields, function(fieldName, j) {
result.vars[fieldName] = row[j];
});
});
}
//
// inline variables
//
if (script.config.variables) {
_.each(script.config.variables, function(v, k) {
let val;
if (_.isArray(v)) {
val = _.sample(v);
} else {
val = v;
}
result.vars[k] = val;
});
}
result._uid = uuid.v4();
return result;
}
//
// Generator functions for template strings:
//
function $randomNumber(min, max) {
return _.random(min, max);
}
function $randomString(length) {
return Math.random().toString(36).substr(2, length);
}