-
Notifications
You must be signed in to change notification settings - Fork 5
/
test-machine.js
418 lines (359 loc) · 15.8 KB
/
test-machine.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
module.exports = require('machine').build({
identity: 'test-machine',
inputs: {
machineInstance: {
example: '===',
description: 'The already-instantiated machine instance.',
required: true
},
using: {
description: 'A dictionary of configured input values.',
example: '===',
protect: true,
required: true
},
expectedOutcome: {
description: 'The name of the exit callback that this machine should trigger.',
example: 'success'
},
expectedOutput: {
description: 'The return value this machine should provide.',
example: '==='
},
maxDuration: {
description: 'The max # of miliseconds to allow this machine to run before considering the test a failure.',
example: 2000
},
postConditions: {
description: 'A set of postcondition functions to run.',
example: [{
label: 'should result in a dictionary of some kind',
fn:'->'
}],
defaultsTo: []
}
},
exits: {
invalidExpectedOutput: {
description: 'Could not dehydrate and/or `JSON.parse` the specified expected output.'
},
cantStringifyOutput: {
description: 'The return value could not be stringified into JSON - perhaps it contains circular references?',
extendedDescription:
'Note that we use the `===` exemplar here. This is necessary because it is the simplest '+
'way to represent `output: undefined`. Even if we set the `output` facet to `===`, since '+
'the base value for the ref type is `null` as of rttc@9.3.0, that wouldn\'t work either.',
outputExample: '===',
// {
// message: 'Output returned by the `finglebär` machine\'s "foobar" exit could not be stringified...etc',
// outcome: 'success',
// output: '===?', (but could also be undefined)
// inspectedOutput: '{ stuff: "things" }',
// duration: 2948
// }
},
failed: {
description: 'The test failed because the result was not the expected output and/or the expected outcome.',
outputFriendlyName: 'Failure report',
extendedDescription:
'Note that we use the `===` exemplar for `actual` here. This is necessary because it is '+
'the simplest way to represent `actual.output === undefined`. Even if we set the `output` '+
'facet to `===`, since the base value for the ref type is `null` as of rttc@9.3.0, that '+
'wouldn\'t work either.',
outputExample: {
message: 'Expected outcome was "success" but actually the machine triggered its "error" exit.',
wrongOutcome: false,
wrongOutput: false,
tookTooLong: false,
failedPostConditions: [{
index: 0,
label: 'should result in a dictionary of some kind',
error: '==='
}],
actual: '===',
// {
// outcome: 'success',
// output: '===?' (but also could be `undefined`),
// inspectedOutput: '{ stuff: "things" }',
// duration: 2948
// }
}
},
success: {
description: 'The test was successful.',
outputFriendlyName: 'What actually happened',
outputDescription: 'A dictionary reporting the actual outcome, output, duration, etc.',
extendedDescription:
'Note that we use the `===` exemplar here. This is necessary because it is the simplest '+
'way to represent `output: undefined`. Even if we set the `output` facet to `===`, since '+
'the base value for the ref type is `null` as of rttc@9.3.0, that wouldn\'t work either.',
outputExample: '===',
// {
// outcome: 'success',
// output: '===?' (but also could be `undefined`),
// inspectedOutput: '{ stuff: "things" }',
// duration: 2948
// }
}
},
fn: function (inputs, exits) {
/**
* Module depenencies
*/
var util = require('util');
var _ = require('@sailshq/lodash');
var async = require('async');
var rttc = require('rttc');
var JsonDiffer = require('json-diff');
var chalk = require('chalk');
var runInstantiatedMachine = require('./run-instantiated-machine');
if (_.isArray(inputs.using) || !_.isObject(inputs.using)) {
return exits.error('Invalid input value for `using`. Should be a dictionary of input values.');
}
var machineInstance = inputs.machineInstance;
// Deserialize `inputs.using` (the input values to feed in to the machine)
var inputValues;
try {
inputValues = _.reduce(inputs.using, function (memo, inputVal, inputName){
// Handle case where a value was provided for an unknown input
var inputDef = machineInstance.inputs[inputName];
if (!inputDef) {
throw new Error('Test specifies a value for an input which does not actually exist in the machine definition (`'+inputName+'`).');
}
// Hydrate input value (i.e. make the functions juicy)
var valToUse;
try {
valToUse = rttc.hydrate(inputVal, rttc.infer(inputDef.example));
}
catch (e) {
// TODO: backwards compatibility..?
throw e;
}
// If configured input value is a string, but the machine is expecting
// a JSON value, then attempt to parse.
var typeSchema = rttc.infer(inputDef.example);
var isExpectingJson = (typeSchema !== 'string' && typeSchema !== 'number' && typeSchema !== 'boolean' && typeSchema !== 'lamda');
if (_.isString(valToUse) && isExpectingJson) {
try {
valToUse = JSON.parse(valToUse);
}
catch (e) {
// If parsing fails, then just pass the string straight through.
}
}
// Skip undefined input values.
if (_.isUndefined(valToUse)) {
return memo;
}
memo.push({
name: inputName,
value: valToUse
});
return memo;
}, []);
}
catch (e) {
return exits.error(e);
}
// console.log('USING:',inputs.using);
// console.log('INPUT VALUES:',inputValues);
// console.log('\n\n');
// Use `runInstantiatedMachine` from machinepack-machines in here
// to avoid unnecessary duplication of code.
runInstantiatedMachine({
machineInstance: machineInstance,
argins: inputValues
}).switch({
error: function (err){
return exits.error(err);
},
cantStringifyOutput: function (whatActuallyHappened) {
return exits.cantStringifyOutput(_.extend({
message: util.format('Output returned by `%s` machine\'s "%s" exit could not be stringified as JSON:\n',machineInstance.identity, whatActuallyHappened.outcome,whatActuallyHappened.inspectedOutput),
}, whatActuallyHappened));
},
success: function (whatActuallyHappened){
// If expected output is specified, but expected *outcome* isn't, assume
// the test is referring to the success exit.
var outputAssertion = inputs.expectedOutput;
if (!_.isUndefined(outputAssertion) && !_.isString(inputs.expectedOutcome)) {
inputs.expectedOutcome = 'success';
}
// Validate against the provided assertions and build a failure report object.
var failureReport = {
// This message is extended below.
message: util.format('Expectations failed for `%s` machine. ', machineInstance.identity),
// Metadata indicating status of the run.
wrongOutcome: false,
wrongOutput: false,
tookTooLong: false,
failedPostConditions: [],
// Also include actual result stats from the run.
actual: {
output: whatActuallyHappened.output,
inspectedOutput: whatActuallyHappened.inspectedOutput,
outcome: whatActuallyHappened.outcome,
duration: whatActuallyHappened.duration
}
};
// If specified, test `outcome` assertion (which exit was traversed)
if (_.isString(inputs.expectedOutcome)) {
failureReport.wrongOutcome = (inputs.expectedOutcome !== whatActuallyHappened.outcome);
}
// If specified, test JSON-encoded `output` assertion (output value returned from exit)
if (!_.isUndefined(outputAssertion)) {
// Now compare actual vs. expected output
try {
// Look up the exit definition for the expected outcome
var exitDef = machineInstance.exits[whatActuallyHappened.outcome];
// and use it to infer the expected `typeSchema` in order to do a
// better comparison with isEqual().
if (_.isUndefined(exitDef.example)) {
failureReport.wrongOutput = !rttc.isEqual(outputAssertion, whatActuallyHappened.output);
}
else {
var typeSchema = rttc.infer(exitDef.example);
failureReport.wrongOutput = !rttc.isEqual(outputAssertion, whatActuallyHappened.output, typeSchema);
}
}
catch (e){
var _testFailedErr = new Error(util.format('Could not compare result with expected value using rttc.isEqual(), because an Error was encountered:'+e.stack));
_.extend(_testFailedErr, {
actual: whatActuallyHappened
});
return exits.error(_testFailedErr);
}
}
// Check `maxDuration`
if (!_.isUndefined(inputs.maxDuration)) {
if (whatActuallyHappened.duration > inputs.maxDuration) {
failureReport.tookTooLong = true;
}
}
// Validate postconditions
async.eachSeries(_.range(inputs.postConditions.length), function (i, next){
// Run post-condition function
// console.log('about to test post condition #'+i+' :: ', util.inspect(inputs.postConditions[i], false, null));
try {
// TODO: provide some kind of configurable timeout for post-condition functions
inputs.postConditions[i].fn(whatActuallyHappened.output, function (err) {
// If it provided a truthy `err`, then this is a failure-
// so track the array index.
if (err) {
var actualOutputMsg = '\n\n';
if (_.isError(whatActuallyHappened.output)) {
actualOutputMsg +='Actual output was an error:\n'+whatActuallyHappened.output.stack;
}
else {
actualOutputMsg = 'Actual output:\n'+util.inspect(whatActuallyHappened.output, false, null);
}
if (_.isError(err)) {
err.message += actualOutputMsg;
err.stack += actualOutputMsg;
}
else if (_.isString(err)) {
err += actualOutputMsg;
err = new Error(err);
}
else {
err = new Error('Post-condition test failed- returned error data:\n'+util.inspect(err, false, null)+actualOutputMsg);
}
failureReport.failedPostConditions.push({
index: i,
label: inputs.postConditions[i].label,
error: err
});
}
return next();
});
}
catch (e) {
var err = e;
var actualOutputMsg = '\n\n';
if (_.isError(whatActuallyHappened.output)) {
actualOutputMsg +='Actual output was an error:\n'+whatActuallyHappened.output.stack;
}
else {
actualOutputMsg = 'Actual output:\n'+util.inspect(whatActuallyHappened.output, false, null);
}
if (_.isError(err)) {
err.message += actualOutputMsg;
err.stack += actualOutputMsg;
}
else if (_.isString(err)) {
err += actualOutputMsg;
err = new Error(err);
}
else {
err = new Error('Post-condition test failed- returned error data:\n'+util.inspect(err, false, null)+actualOutputMsg);
}
failureReport.failedPostConditions.push({
index: i,
label: inputs.postConditions[i].label,
error: err
});
return next();
}
}, function (err) {
if (err) {
return exits.error(err);
}
// Determine whether the test passed overall or not.
var didTestPass =
!failureReport.wrongOutcome &&
!failureReport.wrongOutput &&
!failureReport.tookTooLong &&
(failureReport.failedPostConditions.length === 0);
// If the test passed, report back to test engine and bail out.
if (didTestPass) {
return exits.success(whatActuallyHappened);
}
// Otherwise, if we're here, that means the test failed.
// Report back to test engine w/ a detailed failure report..
// Enhance result msg using outcome and inspectedOutput.
if (failureReport.wrongOutcome) {
failureReport.message += util.format(' Expected outcome "%s" but actually the machine triggered its "%s" exit', inputs.expectedOutcome, whatActuallyHappened.outcome);
if (!_.isUndefined(whatActuallyHappened.output)) {
failureReport.message += util.format(' and returned a %s:\n %s', rttc.getDisplayType(whatActuallyHappened.output), whatActuallyHappened.inspectedOutput);
}
else {
failureReport.message += '.';
}
}
// Enhance result msg using expected `output` and actual output.
if (failureReport.wrongOutput) {
// Showing full expected output AND actual output can get really overwhelming sometimes.
// So we check how big this stuff is before showing that.
//
// If the expected output AND actual output are both objects of some kind (could be arrays
// too) then try to compute the JSON diff and use that.
var diffStr;
if (_.isObject(failureReport.actual.output) && _.isObject(outputAssertion)){
try {
diffStr = JsonDiffer.diffString(failureReport.actual.output, outputAssertion);
} catch (e) { /*ignore errors here-- we just use the more basic output if that happens */ }
}
if (diffStr) {
failureReport.message += util.format(
' Expected output was a %s -- but actually the machine returned a %s. (diff below...)\n'+
chalk.reset(' Diff:'), rttc.getDisplayType(outputAssertion), rttc.getDisplayType(failureReport.actual.output), diffStr);
}
// If that doesn't work, or if either the expected or actual output is a non-object,
// then just show the normal expected vs. actual message:
else {
failureReport.message += util.format(' Expected output was: `%s` (a %s) -- but actually the machine returned: `%s` (a %s)', util.inspect(outputAssertion, false, null), rttc.getDisplayType(outputAssertion), util.inspect(whatActuallyHappened.output, false, null), rttc.getDisplayType(failureReport.actual.output));
}
}
if (failureReport.tookTooLong) {
failureReport.message += util.format(' Machine execution took longer than expected- should have finished in %d miliseconds, but actually took %d.', inputs.maxDuration, whatActuallyHappened.duration);
}
if (failureReport.failedPostConditions.length > 0) {
failureReport.message += util.format(' The provided post-condition function failed.');
}
// console.log('FAILURE REPORT:',failureReport);
return exits.failed(failureReport);
}); //</async.eachSeries>
} // </runMachine.success>
}); // </runMachine()>
}
});