hooker_test.js
19.7 KB
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
/*global require:true */
var hooker = require('../lib/hooker');
exports['hook'] = {
setUp: function(done) {
this.order = [];
this.track = function() {
[].push.apply(this.order, arguments);
};
this.prop = 1;
this.add = function(a, b) {
this.track("add", this.prop, a, b);
return this.prop + a + b;
};
this.obj = {
that: this,
prop: 1,
add1: function(a, b) {
this.that.track("add1", this.prop, a, b);
return this.prop + a + b;
},
add2: function(a, b) {
this.that.track("add2", this.prop, a, b);
return this.prop + a + b;
},
add3: function(a, b) {
this.that.track("add3", this.prop, a, b);
return this.prop + a + b;
}
};
done();
},
'orig': function(test) {
test.expect(1);
var orig = this.add;
hooker.hook(this, "add", function() {});
test.strictEqual(hooker.orig(this, "add"), orig, "should return a refernce to the original function.");
test.done();
},
'once': function(test) {
test.expect(5);
var orig = this.add;
hooker.hook(this, "add", {
once: true,
pre: function(a, b) {
// Arguments are passed into pre-hook as specified.
this.track("before", this.prop, a, b);
}
});
test.strictEqual(this.add(2, 3), 6, "should return the original function's result.");
test.deepEqual(this.order, ["before", 1, 2, 3, "add", 1, 2, 3], "functions should execute in-order.");
test.strictEqual(this.add, orig, "should automatically unhook when once is specified.");
this.order = [];
test.strictEqual(this.add(2, 3), 6, "should return the original function's result.");
test.deepEqual(this.order, ["add", 1, 2, 3], "only the original function should execute.");
test.done();
},
'pre-hook (simple syntax)': function(test) {
test.expect(3);
// Pre-hook.
var result = hooker.hook(this, "add", function(a, b) {
// Arguments are passed into pre-hook as specified.
this.track("before", this.prop, a, b);
});
test.deepEqual(result, ["add"], "add should have been hooked.");
test.strictEqual(this.add(2, 3), 6, "should return the original function's result.");
test.deepEqual(this.order, ["before", 1, 2, 3, "add", 1, 2, 3], "functions should execute in-order.");
test.done();
},
'pre-hook': function(test) {
test.expect(3);
// Pre-hook.
var result = hooker.hook(this, "add", {
pre: function(a, b) {
// Arguments are passed into pre-hook as specified.
this.track("before", this.prop, a, b);
}
});
test.deepEqual(result, ["add"], "add should have been hooked.");
test.strictEqual(this.add(2, 3), 6, "should return the original function's result.");
test.deepEqual(this.order, ["before", 1, 2, 3, "add", 1, 2, 3], "functions should execute in-order.");
test.done();
},
'post-hook': function(test) {
test.expect(3);
// Post-hook.
var result = hooker.hook(this, "add", {
post: function(result, a, b) {
// Arguments to post-hook are the original function's return value,
// followed by the specified function arguments.
this.track("after", this.prop, a, b, result);
}
});
test.deepEqual(result, ["add"], "add should have been hooked.");
test.strictEqual(this.add(2, 3), 6, "should return the original function's result.");
test.deepEqual(this.order, ["add", 1, 2, 3, "after", 1, 2, 3, 6], "functions should execute in-order.");
test.done();
},
'pre- & post-hook': function(test) {
test.expect(2);
// Pre- & post-hook.
hooker.hook(this, "add", {
pre: function(a, b) {
// Arguments are passed into pre-hook as specified.
this.track("before", this.prop, a, b);
},
post: function(result, a, b) {
// Arguments to post-hook are the original function's return value,
// followed by the specified function arguments.
this.track("after", this.prop, a, b, result);
}
});
test.strictEqual(this.add(2, 3), 6, "should return the original function's result.");
test.deepEqual(this.order, ["before", 1, 2, 3, "add", 1, 2, 3, "after", 1, 2, 3, 6], "functions should execute in-order.");
test.done();
},
'pre-hook, return value override': function(test) {
test.expect(2);
// Pre-hook.
hooker.hook(this, "add", {
pre: function(a, b) {
// Arguments are passed into pre-hook as specified.
this.track("before", this.prop, a, b);
// This return value will override the original function's return value.
return hooker.override("b" + this.prop + a + b);
}
});
test.strictEqual(this.add(2, 3), "b123", "should return the overridden result.");
test.deepEqual(this.order, ["before", 1, 2, 3, "add", 1, 2, 3], "functions should execute in-order.");
test.done();
},
'post-hook, return value override': function(test) {
test.expect(2);
// Post-hook.
hooker.hook(this, "add", {
post: function(result, a, b) {
// Arguments to post-hook are the original function's return value,
// followed by the specified function arguments.
this.track("after", this.prop, a, b, result);
// This return value will override the original function's return value.
return hooker.override("a" + this.prop + a + b + result);
}
});
test.strictEqual(this.add(2, 3), "a1236", "should return the post-hook overridden result.");
test.deepEqual(this.order, ["add", 1, 2, 3, "after", 1, 2, 3, 6], "functions should execute in-order.");
test.done();
},
'pre- & post-hook, return value override': function(test) {
test.expect(2);
// Pre- & post-hook.
hooker.hook(this, "add", {
pre: function(a, b) {
// Arguments are passed into pre-hook as specified.
this.track("before", this.prop, a, b);
// This return value will override the original function's return value.
return hooker.override("b" + this.prop + a + b);
},
post: function(result, a, b) {
// Arguments to post-hook are the original function's return value,
// followed by the specified function arguments.
this.track("after", this.prop, a, b, result);
// This return value will override the original function's return value
// AND the pre-hook's return value.
return hooker.override("a" + this.prop + a + b + result);
}
});
test.strictEqual(this.add(2, 3), "a1236", "should return the overridden result, and post-hook result should take precedence over pre-hook result.");
test.deepEqual(this.order, ["before", 1, 2, 3, "add", 1, 2, 3, "after", 1, 2, 3, 6], "functions should execute in-order.");
test.done();
},
'pre-hook, filtering arguments': function(test) {
test.expect(2);
// Pre-hook.
hooker.hook(this, "add", {
pre: function(a, b) {
// Arguments are passed into pre-hook as specified.
this.track("before", this.prop, a, b);
// Return hooker.filter(context, arguments) and they will be passed into
// the original function. The "track" and "order" propterites are just
// set here for the same of this unit test.
return hooker.filter({prop: "x", track: this.track, order: this.order}, ["y", "z"]);
}
});
test.strictEqual(this.add(2, 3), "xyz", "should return the original function's result, given filtered context and arguments.");
test.deepEqual(this.order, ["before", 1, 2, 3, "add", "x", "y", "z"], "functions should execute in-order.");
test.done();
},
'pre- & post-hook, filtering arguments': function(test) {
test.expect(2);
// Pre- & post-hook.
hooker.hook(this, "add", {
pre: function(a, b) {
// Arguments are passed into pre-hook as specified.
this.track("before", this.prop, a, b);
// Return hooker.filter(context, arguments) and they will be passed into
// the original function. The "track" and "order" propterites are just
// set here for the same of this unit test.
return hooker.filter({prop: "x", track: this.track, order: this.order}, ["y", "z"]);
},
post: function(result, a, b) {
// Arguments to post-hook are the original function's return value,
// followed by the specified function arguments.
this.track("after", this.prop, a, b, result);
}
});
test.strictEqual(this.add(2, 3), "xyz", "should return the original function's result, given filtered context and arguments.");
test.deepEqual(this.order, ["before", 1, 2, 3, "add", "x", "y", "z", "after", 1, 2, 3, "xyz"], "functions should execute in-order.");
test.done();
},
'pre- & post-hook, filtering arguments, return value override': function(test) {
test.expect(2);
// Pre- & post-hook.
hooker.hook(this, "add", {
pre: function(a, b) {
// Arguments are passed into pre-hook as specified.
this.track("before", this.prop, a, b);
// Return hooker.filter(context, arguments) and they will be passed into
// the original function. The "track" and "order" propterites are just
// set here for the same of this unit test.
return hooker.filter({prop: "x", track: this.track, order: this.order}, ["y", "z"]);
},
post: function(result, a, b) {
// Arguments to post-hook are the original function's return value,
// followed by the specified function arguments.
this.track("after", this.prop, a, b, result);
// This return value will override the original function's return value
// AND the pre-hook's return value.
return hooker.override("a" + this.prop + a + b + result);
}
});
test.strictEqual(this.add(2, 3), "a123xyz", "should return the post-hook overridden result.");
test.deepEqual(this.order, ["before", 1, 2, 3, "add", "x", "y", "z", "after", 1, 2, 3, "xyz"], "functions should execute in-order.");
test.done();
},
'pre-hook, preempt original function': function(test) {
test.expect(2);
// Pre-hook.
hooker.hook(this, "add", {
pre: function(a, b) {
// Arguments are passed into pre-hook as specified.
this.track("before", this.prop, a, b);
// Returning hooker.preempt will prevent the original function from being
// invoked and optionally set a return value.
return hooker.preempt();
}
});
test.strictEqual(this.add(2, 3), undefined, "should return the value passed to preempt.");
test.deepEqual(this.order, ["before", 1, 2, 3], "functions should execute in-order.");
test.done();
},
'pre-hook, preempt original function with value': function(test) {
test.expect(2);
// Pre-hook.
hooker.hook(this, "add", {
pre: function(a, b) {
// Arguments are passed into pre-hook as specified.
this.track("before", this.prop, a, b);
// Returning hooker.preempt will prevent the original function from being
// invoked and optionally set a return value.
return hooker.preempt(9000);
}
});
test.strictEqual(this.add(2, 3), 9000, "should return the value passed to preempt.");
test.deepEqual(this.order, ["before", 1, 2, 3], "functions should execute in-order.");
test.done();
},
'pre- & post-hook, preempt original function with value': function(test) {
test.expect(2);
// Pre- & post-hook.
hooker.hook(this, "add", {
pre: function(a, b) {
// Arguments are passed into pre-hook as specified.
this.track("before", this.prop, a, b);
// Returning hooker.preempt will prevent the original function from being
// invoked and optionally set a return value.
return hooker.preempt(9000);
},
post: function(result, a, b) {
// Arguments to post-hook are the original function's return value,
// followed by the specified function arguments.
this.track("after", this.prop, a, b, result);
}
});
test.strictEqual(this.add(2, 3), 9000, "should return the value passed to preempt.");
test.deepEqual(this.order, ["before", 1, 2, 3, "after", 1, 2, 3, 9000], "functions should execute in-order.");
test.done();
},
'pre- & post-hook, preempt original function with value, return value override': function(test) {
test.expect(2);
// Pre- & post-hook.
hooker.hook(this, "add", {
pre: function(a, b) {
// Arguments are passed into pre-hook as specified.
this.track("before", this.prop, a, b);
// Returning hooker.preempt will prevent the original function from being
// invoked and optionally set a return value.
return hooker.preempt(9000);
},
post: function(result, a, b) {
// Arguments to post-hook are the original function's return value,
// followed by the specified function arguments.
this.track("after", this.prop, a, b, result);
// This return value will override any preempt value set in pre-hook.
return hooker.override("a" + this.prop + a + b + result);
}
});
test.strictEqual(this.add(2, 3), "a1239000", "should return the overridden result, and post-hook result should take precedence over preempt value.");
test.deepEqual(this.order, ["before", 1, 2, 3, "after", 1, 2, 3, 9000], "functions should execute in-order.");
test.done();
},
'pre- & post-hook, some properties': function(test) {
test.expect(7);
// Pre- & post-hook.
var result = hooker.hook(this.obj, ["add1", "add2"], {
pre: function(a, b) {
// Arguments are passed into pre-hook as specified.
this.that.track("before", this.prop, a, b);
},
post: function(result, a, b) {
// Arguments to post-hook are the original function's return value,
// followed by the specified function arguments.
this.that.track("after", this.prop, a, b, result);
}
});
test.deepEqual(result.sort(), ["add1", "add2"], "both functions should have been hooked.");
test.strictEqual(this.obj.add1(2, 3), 6, "should return the original function's result.");
test.deepEqual(this.order, ["before", 1, 2, 3, "add1", 1, 2, 3, "after", 1, 2, 3, 6], "functions should execute in-order.");
this.order = [];
test.strictEqual(this.obj.add2(2, 3), 6, "should return the original function's result.");
test.deepEqual(this.order, ["before", 1, 2, 3, "add2", 1, 2, 3, "after", 1, 2, 3, 6], "functions should execute in-order.");
this.order = [];
test.strictEqual(this.obj.add3(2, 3), 6, "should return the original function's result.");
test.deepEqual(this.order, ["add3", 1, 2, 3], "functions should execute in-order.");
test.done();
},
'pre- & post-hook, all properties': function(test) {
test.expect(7);
// Pre- & post-hook.
var result = hooker.hook(this.obj, {
pre: function(a, b) {
// Arguments are passed into pre-hook as specified.
this.that.track("before", this.prop, a, b);
},
post: function(result, a, b) {
// Arguments to post-hook are the original function's return value,
// followed by the specified function arguments.
this.that.track("after", this.prop, a, b, result);
}
});
test.deepEqual(result.sort(), ["add1", "add2", "add3"], "all functions should have been hooked.");
test.strictEqual(this.obj.add1(2, 3), 6, "should return the original function's result.");
test.deepEqual(this.order, ["before", 1, 2, 3, "add1", 1, 2, 3, "after", 1, 2, 3, 6], "functions should execute in-order.");
this.order = [];
test.strictEqual(this.obj.add2(2, 3), 6, "should return the original function's result.");
test.deepEqual(this.order, ["before", 1, 2, 3, "add2", 1, 2, 3, "after", 1, 2, 3, 6], "functions should execute in-order.");
this.order = [];
test.strictEqual(this.obj.add3(2, 3), 6, "should return the original function's result.");
test.deepEqual(this.order, ["before", 1, 2, 3, "add3", 1, 2, 3, "after", 1, 2, 3, 6], "functions should execute in-order.");
test.done();
},
'pre- & post-hook, all properties, passName': function(test) {
test.expect(6);
// Pre- & post-hook.
hooker.hook(this.obj, {
passName: true,
pre: function(name, a, b) {
// Arguments are passed into pre-hook as specified.
this.that.track("before", this.prop, name, a, b);
},
post: function(result, name, a, b) {
// Arguments to post-hook are the original function's return value,
// followed by the specified function arguments.
this.that.track("after", this.prop, name, a, b, result);
}
});
test.strictEqual(this.obj.add1(2, 3), 6, "should return the original function's result.");
test.deepEqual(this.order, ["before", 1, "add1", 2, 3, "add1", 1, 2, 3, "after", 1, "add1", 2, 3, 6], "functions should execute in-order.");
this.order = [];
test.strictEqual(this.obj.add2(2, 3), 6, "should return the original function's result.");
test.deepEqual(this.order, ["before", 1, "add2", 2, 3, "add2", 1, 2, 3, "after", 1, "add2", 2, 3, 6], "functions should execute in-order.");
this.order = [];
test.strictEqual(this.obj.add3(2, 3), 6, "should return the original function's result.");
test.deepEqual(this.order, ["before", 1, "add3", 2, 3, "add3", 1, 2, 3, "after", 1, "add3", 2, 3, 6], "functions should execute in-order.");
test.done();
},
'unhook one property': function(test) {
test.expect(5);
var orig = this.add;
hooker.hook(this, "add", function() {});
var result = hooker.unhook(this, "add");
test.deepEqual(result, ["add"], "one function should have been unhooked.");
test.strictEqual(this.add, orig, "should have unhooked, restoring the original function");
result = hooker.unhook(this, "add");
test.deepEqual(result, [], "nothing should have been unhooked.");
test.strictEqual(this.add, orig, "shouldn't explode if already unhooked");
test.strictEqual(this.add.orig, undefined, "original function shouldn't have an orig property");
test.done();
},
'unhook some properties': function(test) {
test.expect(6);
var add1 = this.obj.add1;
var add2 = this.obj.add2;
hooker.hook(this.obj, ["add1", "add2"], function() {});
test.strictEqual(hooker.orig(this.obj, "add1"), add1, "should return a refernce to the original function");
test.strictEqual(hooker.orig(this.obj, "add2"), add2, "should return a refernce to the original function");
test.strictEqual(hooker.orig(this.obj, "add3"), undefined, "should not have been hooked, so should not have an original function");
var result = hooker.unhook(this.obj, ["add1", "add2"]);
test.deepEqual(result.sort(), ["add1", "add2"], "both functions should have been unhooked.");
test.strictEqual(this.obj.add1, add1, "should have unhooked, restoring the original function");
test.strictEqual(this.obj.add2, add2, "should have unhooked, restoring the original function");
test.done();
},
'unhook all properties': function(test) {
test.expect(7);
var add1 = this.obj.add1;
var add2 = this.obj.add2;
var add3 = this.obj.add3;
hooker.hook(this.obj, function() {});
test.strictEqual(hooker.orig(this.obj, "add1"), add1, "should return a refernce to the original function");
test.strictEqual(hooker.orig(this.obj, "add2"), add2, "should return a refernce to the original function");
test.strictEqual(hooker.orig(this.obj, "add3"), add3, "should return a refernce to the original function");
var result = hooker.unhook(this.obj);
test.deepEqual(result.sort(), ["add1", "add2", "add3"], "all functions should have been unhooked.");
test.strictEqual(this.obj.add1, add1, "should have unhooked, restoring the original function");
test.strictEqual(this.obj.add2, add2, "should have unhooked, restoring the original function");
test.strictEqual(this.obj.add3, add3, "should have unhooked, restoring the original function");
test.done();
}
};