/
test.js
528 lines (463 loc) · 14.1 KB
/
test.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
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
/* eslint-env mocha */
'use strict';
const assert = require('assert');
const {exec, spawn} = require('child_process');
const path = require('path');
const {callbackify} = require('util');
const rimraf = require('rimraf');
const mkdirp = callbackify(require('mkdirp'));
const express = require('express');
const request = require('supertest');
const bodyParser = require('body-parser');
const data = {
foo: 'bar',
lorem: 'Ipsum',
a: {
b: 'c',
},
query: {},
};
const postData = {
success: true,
};
const putData = {
x: 'foo',
};
express()
.get('/html', (req, res) => {
res.send('<html><body><h1>Hello world</h1></body></html>');
})
.get('/data', (req, res) => {
res.json({
...data,
query: req.query,
});
})
.post('/data', (req, res) => {
res.json(postData);
})
.put('/data', (req, res) => {
res.json(putData);
})
.listen(9194);
describe('snapstub api', () => {
const snapstub = require('./');
// Mute stdout prints
const out = require('simple-output');
const _write = out.stdout.write;
out.stdout.write = a => a;
it('should correctly start a server', done => {
snapstub.start({
verbose: false,
mockFolderName: 'mocks',
});
request('http://localhost:8059')
.get('/data')
.expect(200)
.expect('Content-Type', /json/)
.expect(data)
.end(err => {
out.stdout.write = _write;
snapstub.stop();
done(err);
});
});
});
describe('snapstub cli', () => {
function runOnly({
cmd,
expected,
}) {
return function (done) {
exec(cmd, (err, stdout) => {
if (err) {
done(err);
}
assert.strictEqual(stdout.trim(), expected);
done();
}).stdin.end();
};
}
function runMockTest({
cmd,
port,
method,
middleware,
test,
}) {
return function (done) {
const emptyMiddleware = (a, b, n) => {
n();
};
express()
.use(middleware || emptyMiddleware)[method]('/data', (req, res) => {
test(req, res);
done();
})
.listen(port, e => {
if (e) {
done(e);
}
exec(cmd, err => {
if (err) {
done(err);
}
}).stdin.end();
});
};
}
function runAndLoadMockTest({
cmd,
debug,
supertests,
stdinWrite,
}) {
return function (done) {
this.timeout(6000);
const p = exec(`${cmd}${debug ? ' --debug' : ''}`, (err, stdout) => {
if (debug) {
console.log(stdout);
}
if (err) {
return done(err);
}
const child = spawn('./cli.js', ['start']);
if (debug) {
child.stdout.on('data', i => console.log(i.toString()));
}
child.stderr.on('data', err => {
throw new Error(err.toString());
});
child.stdin.end();
setTimeout(() => {
supertests()
.end(err => {
child.kill();
done(err);
});
}, 2000);
});
if (stdinWrite) {
p.stdin.write(stdinWrite);
}
p.stdin.end();
};
}
beforeEach(done => {
mkdirp(path.join(__dirname, '__mocks__'), done);
});
afterEach(done => {
rimraf(path.join(__dirname, '__mocks__'), done);
});
// RunOnly
it('should correctly save a snapshot', runOnly({
cmd: './cli.js add http://localhost:9194/data',
expected: `\x1B[32m✔\x1B[39m Successfully added: ${path.join(__dirname, '__mocks__', 'data', 'get.json')}`,
}));
it('should correctly save many snapshot methods', runOnly({
cmd: './cli.js add http://localhost:9194/data --method=post,head',
expected: `\x1B[32m✔\x1B[39m Successfully added: ${path.join(__dirname, '__mocks__', 'data', 'post.json')}
\x1B[32m✔\x1B[39m Successfully added: ${path.join(__dirname, '__mocks__', 'data', 'head.json')}`,
}));
it('should correctly save query param using hashed filename', runOnly({
cmd: './cli.js add http://localhost:9194/data?foo=bar',
expected: `\x1B[32m✔\x1B[39m Successfully added: ${path.join(__dirname, '__mocks__', 'data', 'get-e86365266e9e38d9a280c46142e665acbb2a262a9a00281be4a41309b678e952.json')}`,
}));
it('should correctly save using hashAlgorithm option', runOnly({
cmd: './cli.js add http://localhost:9194/data?foo=bar --hashAlgorithm=md5',
expected: `\x1B[32m✔\x1B[39m Successfully added: ${path.join(__dirname, '__mocks__', 'data', 'get-e198fcea7ddae86f20d9844a2243b714.json')}`,
}));
it('should correctly save using hashHeaders option', runOnly({
cmd: './cli.js add http://localhost:9194/data --hashHeaders=content-type --header="Content-Type: application/json"',
expected: `\x1B[32m✔\x1B[39m Successfully added: ${path.join(__dirname, '__mocks__', 'data', 'get-f83d19fbff806055593a9369c72c591d49b830bae4b2621709eb806f267ff63d.json')}`,
}));
it('should correctly save using multiple hashHeaders option', runOnly({
cmd: './cli.js add http://localhost:9194/data --hashHeaders=content-type,x-foo --header="Content-Type: application/json" --header="X-Foo: bar"',
expected: `\x1B[32m✔\x1B[39m Successfully added: ${path.join(__dirname, '__mocks__', 'data', 'get-b80e4b47fa8931fb55b7ad74a4c96b1db12454c89a51646710b06bc6c51f9d45.json')}`,
}));
it('should correctly filter cookies using hashCookies option', runOnly({
cmd: './cli.js add http://localhost:9194/data --hashCookies=foo,bar --header="Cookie: foo=foo; bar=bar; lorem=lorem" --header="X-Foo: bar"',
expected: `\x1B[32m✔\x1B[39m Successfully added: ${path.join(__dirname, '__mocks__', 'data', 'get-b6b48a0dfb604db54f3f559ff763e640a32e90f4ca12f33d68f3e80ab284f9b4.json')}`,
}));
it('should skip hash when using nohash option', runOnly({
cmd: './cli.js add http://localhost:9194/data --hashCookies=foo,bar --header="Cookie: foo=foo; bar=bar; lorem=lorem" --header="X-Foo: bar" --nohash',
expected: `\x1B[32m✔\x1B[39m Successfully added: ${path.join(__dirname, '__mocks__', 'data', 'get.json')}`,
}));
// ---
// RunMockTest
it('should be able to set a custom header when adding snapshots', runMockTest({
cmd: './cli.js add http://localhost:9195/data --header "X-Token: 0123F"',
method: 'get',
port: 9195,
test(req, res) {
assert.strictEqual(req.get('X-Token'), '0123F');
res.sendStatus(200);
},
}));
it('should be able to set multiple custom headers when adding snapshots', runMockTest({
cmd: './cli.js add http://localhost:9196/data --header "X-Token: 0123F" --header "X-Foo: bar"',
method: 'get',
port: 9196,
test(req, res) {
assert.strictEqual(req.get('X-Foo'), 'bar');
assert.strictEqual(req.get('X-Token'), '0123F');
res.sendStatus(200);
},
}));
it('should be able to POST simple json data', runMockTest({
cmd: './cli.js add http://localhost:9200/data --data \'{ "foo": "Bar" }\'',
method: 'post',
middleware: bodyParser.json(),
port: 9200,
test(req, res) {
assert.deepStrictEqual(req.body, {foo: 'Bar'});
res.sendStatus(200);
},
}));
it('should be able to POST json data', (bodyData => runMockTest({
cmd: `./cli.js add http://localhost:9197/data --data '${JSON.stringify(bodyData)}'`,
method: 'post',
middleware: bodyParser.json(),
port: 9197,
test(req, res) {
assert.deepStrictEqual(req.body, bodyData);
res.sendStatus(200);
},
}))({
foo: 'bar',
more: {
lorem: 'ipsum',
dolor: 'sit',
},
}));
it('should be able to POST form data', runMockTest({
cmd: './cli.js add http://localhost:9198/data --data "parameter=value&also=another" --verbose',
method: 'post',
middleware: bodyParser.urlencoded({extended: true}),
port: 9198,
test(req, res) {
assert.strictEqual(req.body.parameter, 'value');
assert.strictEqual(req.body.also, 'another');
res.sendStatus(200);
},
}));
it('should be able to PUT form data', runMockTest({
cmd: './cli.js add http://localhost:9199/data --data "parameter=something" --method=put',
method: 'put',
middleware: bodyParser.urlencoded({extended: true}),
port: 9199,
test(req, res) {
assert.strictEqual(req.body.parameter, 'something');
res.sendStatus(200);
},
}));
it('should be able to send from data file', runMockTest({
cmd: './cli.js add http://localhost:9201/data --data ./fixtures/data',
method: 'post',
middleware: bodyParser.urlencoded({extended: true}),
port: 9201,
test(req, res) {
assert.strictEqual(req.body.dolor.trim(), 'sit');
res.sendStatus(200);
},
}));
it('should be able to send from json data file', runMockTest({
cmd: './cli.js add http://localhost:9202/data --data ./fixtures/data.json',
method: 'post',
middleware: bodyParser.json(),
port: 9202,
test(req, res) {
assert.strictEqual(req.body.foo, 'Lorem');
res.sendStatus(200);
},
}));
// ---
// RunAndLoadMockTest
it('should correctly retrieve snapshot data', runAndLoadMockTest({
cmd: './cli.js add http://localhost:9194/data',
supertests: () => request('http://localhost:8059')
.get('/data')
.expect('Content-Type', /json/)
.expect(data),
}));
it('should correctly retrieve snapshot data from post method', runAndLoadMockTest({
cmd: './cli.js add http://localhost:9194/data --method=post',
supertests: () => request('http://localhost:8059')
.post('/data')
.expect('Content-Type', /json/)
.expect(postData),
}));
it('should correctly retrieve snapshot data from multiple http methods', runAndLoadMockTest({
cmd: './cli.js add http://localhost:9194/data --method=post,get,put',
supertests: () => request('http://localhost:8059')
.put('/data')
.expect('Content-Type', /json/)
.expect(putData),
}));
it('should be able to save arbitrary endpoint data', runAndLoadMockTest({
cmd: './cli.js save /foo',
supertests: () => request('http://localhost:8059')
.get('/foo')
.expect(200)
.expect('Content-Type', /json/)
.expect({pork: true}),
stdinWrite: '{"pork":true}',
}));
it('should be able to save to diff methods', runAndLoadMockTest({
cmd: './cli.js save /foo --method=post',
supertests: () => request('http://localhost:8059')
.post('/foo')
.expect(200)
.expect('Content-Type', /json/),
stdinWrite: '{"pork":true}',
}));
it('should be able to save and retrieve specific added endpoint using query string parameters', runAndLoadMockTest({
cmd: './cli.js add http://localhost:9194/data?msg=lorem%20ipsum',
supertests: () => request('http://localhost:8059')
.get('/data')
.query({
msg: 'lorem ipsum',
})
.expect('Content-Type', /json/)
.expect({...data, query: {
msg: 'lorem ipsum',
}}),
}));
it('should be able to save and retrieve specific added endpoint using multiple query string parameters', runAndLoadMockTest({
cmd: './cli.js add http://localhost:9194/data?foo=bar\\&lorem=ipsum',
supertests: () => request('http://localhost:8059')
.get('/data')
.query({
foo: 'bar',
lorem: 'ipsum',
})
.expect('Content-Type', /json/)
.expect({...data, query: {
foo: 'bar',
lorem: 'ipsum',
}}),
}));
it('should be able to save and retrieve specific text based responses using --nojson option', runAndLoadMockTest({
cmd: './cli.js add http://localhost:9194/html --nojson',
supertests: () => request('http://localhost:8059')
.get('/html')
.expect('Content-Type', /text/)
.expect('<html><body><h1>Hello world</h1></body></html>'),
}));
// ---
it('should print route messages to console by default', function (done) {
this.timeout(6000);
exec('./cli.js add http://localhost:9194/data', err => {
if (err) {
return done(err);
}
const child = spawn('./cli.js', ['start']);
child.stderr.on('data', err => {
throw new Error(err.toString());
});
child.stdin.end();
function validateRouteMsg() {
child.stdout.once('data', d => {
assert.equal(d.toString(), '\x1B[34mℹ\x1B[39m http://localhost:8059/data\n');
});
}
function validateSuccessMsg() {
child.stdout.once('data', data => {
assert.equal(data.toString(), '\x1B[32m✔\x1B[39m Successfully launched snapstub server on: http://localhost:8059\n');
validateRouteMsg();
});
}
validateSuccessMsg();
setTimeout(() => {
child.kill();
done(err);
}, 2000);
}).stdin.end();
});
it('should print messages to console when using --verbose option', function (done) {
this.timeout(6000);
exec('./cli.js add http://localhost:9194/data', err => {
if (err) {
return done(err);
}
const child = spawn('./cli.js', ['start', '--verbose']);
child.stderr.on('data', err => {
throw new Error(err.toString());
});
child.stdin.end();
child.stdout.on('data', data => {
assert.notEqual(data.toString().split('pathToMocks'), -1);
child.kill();
done(err);
});
}).stdin.end();
});
it('should not print messages to console when using --silent option', function (done) {
this.timeout(6000);
exec('./cli.js add http://localhost:9194/data', err => {
if (err) {
return done(err);
}
const child = spawn('./cli.js', ['start', '--silent']);
child.stderr.on('data', err => {
throw new Error(err.toString());
});
child.stdout.on('data', data => {
throw new Error(data);
});
child.stdin.end();
setTimeout(() => {
request('http://localhost:8059')
.post('/data')
.expect(200);
child.kill();
done();
}, 2000);
}).stdin.end();
});
it('should be able to save to multiple methods', function (done) {
this.timeout(6000);
const parent = exec('./cli.js save /foo --method=post,put', err => {
if (err) {
return done(err);
}
const child = spawn('./cli.js', ['start', '--silent']);
child.on('error', done);
child.stdin.end();
setTimeout(() => {
request('http://localhost:8059')
.put('/foo')
.expect(200)
.expect('Content-Type', /json/)
.end(err => {
if (err) {
child.kill();
done(err);
}
request('http://localhost:8059')
.post('/foo')
.expect(200)
.expect('Content-Type', /json/)
.end(err => { // eslint-disable-line
child.kill();
done(err);
});
});
}, 2000);
});
parent.stdin.write('{"pork":true}');
parent.stdin.end();
});
it('should get help message when using no valid command', done => {
exec('./cli.js', (err, stdout) => {
assert.strictEqual(stdout.indexOf('Usage:'), 1);
done(err);
}).stdin.end();
});
it('should get version number when using --version flag', done => {
exec('./cli.js --version', (err, stdout) => {
assert.strictEqual(stdout.trim(), require('./package.json').version);
done(err);
}).stdin.end();
});
});