/
hock.js
422 lines (381 loc) · 10.3 KB
/
hock.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
'use strict';
var qs = require('querystring'),
url_ = require('url'),
http = require('http'),
util = require('util'),
events = require('events').EventEmitter,
Request = require('./request'),
deepEqual = require('deep-equal'),
urlEqual = require('url-equal');
/**
* Hock class
*
* @description This is the main class for Hock. It handles creation
* of the underlying webserver, and enqueing all of the requests.
*
* @param {object} [options] options for your Hock server
* @param {boolean} [options.throwOnUnmatched] Tell Hock to throw if
* receiving a request without a match (Default=true)
*
* @type {Function}
*/
var Hock = module.exports = function (options) {
options = options || {};
this._throwOnUnmatched = (typeof options.throwOnUnmatched === 'boolean' ? options.throwOnUnmatched : true);
this._assertions = [];
this.handler = Hock.prototype.handler.bind(this);
events.EventEmitter.call(this);
};
util.inherits(Hock, events.EventEmitter);
/**
* Hock.enqueue
*
* @description enqueue a request into the queue
*
* @param {object} request The request to enter in the hock queue
* @param request
*/
Hock.prototype.enqueue = function (request) {
if (this._requestFilter) {
request._requestFilter = this._requestFilter;
}
if (this._defaultReplyHeaders) {
request._defaultReplyHeaders = this._defaultReplyHeaders;
}
this._assertions.push(request);
};
/**
* Hock.hasRoute
*
* @description test if there is a request on the assertions queue
*
* @param {String} method the method of the request to match
* @param {String} url the route of the request to match
* @param {String} [body] optionally - use if you set a body
* @param {object} [headers] optionally - use if you set a header
* @returns {Boolean}
*/
Hock.prototype.hasRoute = function (method, url, body, headers) {
if (!body) {
body = '';
}
if (!headers) {
headers = {};
}
return this._assertions.some(function(request) {
return request.isMatch({
url,
method,
body,
headers,
})
})
};
/**
* Hock.done
*
* @description Throw an error if there are unprocessed requests in the assertions queue.
* If there are unfinsihed requests, i.e. min: 2, max 4 with a count of 2, that request will be
* ignored for the purposes of throwing an error.
*
*/
Hock.prototype.done = function (cb) {
var err;
if (this._assertions.length) {
this._assertions = this._assertions.filter(function(request) {
return request.isDone();
});
if (this._assertions.length) {
err = new Error('Unprocessed Requests in Assertions Queue: \n' + JSON.stringify(this._assertions.map(function (item) {
return item.method + ' ' + item.url;
})));
}
}
if (!err) {
return cb && cb();
}
if (!cb) {
throw err;
}
return cb(err);
};
/**
* Hock.get
*
* @description enqueue a GET request into the assertion queue
*
* @param {String} url the route of the request to match
* @param {object} [headers] optionally match the request headers
* @returns {Request}
*/
Hock.prototype.get = function (url, headers) {
return new Request(this, {
method: 'GET',
url: url,
headers: headers || {}
});
};
/**
* Hock.head
*
* @description enqueue a HEAD request into the assertion queue
*
* @param {String} url the route of the request to match
* @param {object} [headers] optionally match the request headers
* @returns {Request}
*/
Hock.prototype.head = function (url, headers) {
return new Request(this, {
method: 'HEAD',
url: url,
headers: headers || {}
});
};
/**
* Hock.put
*
* @description enqueue a PUT request into the assertion queue
*
* @param {String} url the route of the request to match
* @param {object|String} [body] the request body (if any) of the request to match
* @param {object} [headers] optionally match the request headers
* @returns {Request}
*/
Hock.prototype.put = function (url, body, headers) {
return new Request(this, {
method: 'PUT',
url: url,
body: body || '',
headers: headers || {}
});
};
/**
* Hock.patch
*
* @description enqueue a PATCH request into the assertion queue
*
* @param {String} url the route of the request to match
* @param {object|String} [body] the request body (if any) of the request to match
* @param {object} [headers] optionally match the request headers
* @returns {Request}
*/
Hock.prototype.patch = function (url, body, headers) {
return new Request(this, {
method: 'PATCH',
url: url,
body: body || '',
headers: headers || {}
});
};
/**
* Hock.post
*
* @description enqueue a POST request into the assertion queue
*
* @param {String} url the route of the request to match
* @param {object|String} [body] the request body (if any) of the request to match
* @param {object} [headers] optionally match the request headers
* @returns {Request}
*/
Hock.prototype.post = function (url, body, headers) {
return new Request(this, {
method: 'POST',
url: url,
body: body || '',
headers: headers || {}
});
};
/**
* Hock.delete
*
* @description enqueue a DELETE request into the assertion queue
*
* @param {String} url the route of the request to match
* @param {object|String} [body] the request body (if any) of the request to match
* @param {object} [headers] optionally match the request headers
* @returns {Request}
*/
Hock.prototype.delete = function (url, body, headers) {
return new Request(this, {
method: 'DELETE',
url: url,
body: body || '',
headers: headers || {}
});
};
/**
* Hock.copy
*
* @description enqueue a COPY request into the assertion queue
*
* @param {String} url the route of the request to match
* @param {object|String} [body] the request body (if any) of the request to match
* @param {object} [headers] optionally match the request headers
* @returns {Request}
*/
Hock.prototype.copy = function (url, body, headers) {
return new Request(this, {
method: 'COPY',
url: url,
headers: headers || {}
});
};
/**
* Hock.options
*
* @description enqueue a OPTIONS request into the assertion queue
*
* @param {String} url the route of the request to match
* @param {object} [headers] optionally match the request headers
* @returns {Request}
*/
Hock.prototype.options = function (url, headers) {
return new Request(this, {
method: 'OPTIONS',
url: url,
headers: headers || {}
});
};
/**
* Hock.filteringRequestBody
*
* @description Provide a function to Hock to filter the request body
*
* @param {function} filter the function to filter on
*
* @returns {Hock}
*/
Hock.prototype.filteringRequestBody = function (filter) {
this._requestFilter = filter;
return this;
};
/**
* Hock.filteringRequestBodyRegEx
*
* @description match incoming requests, and replace the body based on
* a regular expression match
*
* @param {RegEx} source The source regular expression
* @param {string} replace What to replace the source with
*
* @returns {Hock}
*/
Hock.prototype.filteringRequestBodyRegEx = function (source, replace) {
this._requestFilter = function (path) {
if (path) {
path = path.replace(source, replace);
}
return path;
};
return this;
};
/**
* Hock.filteringPath
*
* @description Provide a function to Hock to filter request path
*
* @param {function} filter the function to filter on
*
* @returns {Hock}
*/
Hock.prototype.filteringPath = function (filter) {
this._pathFilter = filter;
return this;
};
/**
* Hock.filteringPathRegEx
*
* @description match incoming requests, and replace the path based on
* a regular expression match
*
* @param {RegEx} source The source regular expression
* @param {string} replace What to replace the source with
*
* @returns {Hock}
*/
Hock.prototype.filteringPathRegEx = function (source, replace) {
this._pathFilter = function (path) {
if (path) {
path = path.replace(source, replace);
}
return path;
};
return this;
};
/**
* Hock.clearBodyFilter
*
* @description clear the body request filter, if any
*
* @returns {Hock}
*/
Hock.prototype.clearBodyFilter = function () {
delete this._requestFilter;
return this;
}
/**
* Hock.defaultReplyHeaders
*
* @description set standard headers for all responses
*
* @param {object} headers the list of headers to send by default
*
* @returns {Hock}
*/
Hock.prototype.defaultReplyHeaders = function (headers) {
this._defaultReplyHeaders = headers;
return this;
};
/**
* Hock.handler
*
* @description Handle incoming requests
*
* @returns {Function}
* @private
*/
Hock.prototype.handler = function (req, res) {
var self = this;
var matchIndex = null;
req.body = '';
req.on('data', function (data) {
req.body += data.toString();
});
req.on('end', function () {
const matchIndex = self._assertions.findIndex(assertion => assertion.isMatch(req));
if (matchIndex === -1) {
if (self._throwOnUnmatched) {
throw new Error('No Match For: ' + req.method + ' ' + req.url);
}
console.error('No Match For: ' + req.method + ' ' + req.url);
if (req.method === 'PUT' || req.method === 'PATCH' || req.method === 'POST') {
console.error(req.body);
}
res.writeHead(500, { 'Content-Type': 'text/plain' });
res.end('No Matching Response!\n');
}
else {
if (self._assertions[matchIndex].sendResponse(req, res)) {
self._assertions.splice(matchIndex, 1)[0];
}
if (self._assertions.length === 0) self.emit('done');
}
});
};
/**
* exports.createHock
*
* @description static method for creating your hock server
*
* @param {object} [options] options for your Hock server
* @param {Number} [options.port] port number for your Hock server
* @param {boolean} [options.throwOnUnmatched] Tell Hock to throw if
* receiving a request without a match (Default=true)
*
* @returns {Hock}
*/
var createHock = function(options) {
return new Hock(options);
};
module.exports = createHock;
module.exports.createHock = createHock;