forked from linagora/hublin
-
Notifications
You must be signed in to change notification settings - Fork 0
/
helpers.js
422 lines (376 loc) · 11.2 KB
/
helpers.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 async = require('async'),
chai = require('chai'),
expect = chai.expect,
MongoClient = require('mongodb').MongoClient,
mockery = require('mockery'),
crypto = require('crypto'),
domain = require('domain');
/*
* Mocks esnConf(<key>) object.
* get: callback of the esnConf(<key>).get(get) method.
*/
function mockEsnConfig(get) {
var mockedEsnConfig = {
'esn-config': function() {
return {
get: get
};
}
};
var mockedEsnConfigFunction = function() {
return {
get: get
};
};
mockery.registerMock('../../core', mockedEsnConfig);
mockery.registerMock('../esn-config', mockedEsnConfigFunction);
}
/*
* mockedModels = {
* 'User': function User() {
* ...
* },
* 'Domain': function Domain() {
* ...
* }
* }
*
*/
function mockModels(mockedModels) {
var types = {
ObjectId: function(id) {
return {id: id};
},
Mixed: ''
};
var schema = function() {};
schema.Types = types;
var mongooseMock = {
Types: types,
Schema: schema,
model: function(model) {
return mockedModels[model];
},
__replaceObjectId: function(newObjectId) {
types.ObjectId = newObjectId;
}
};
mockery.registerMock('mongoose', mongooseMock);
return mongooseMock;
}
/*
* stub.topics is an Array which contains every topic.
* stub.topics[topic].data is an Array named topic and contains every published data for the 'topic' topic.
* stub.topics[topic].handler is the handler for the 'topic' topic.
*/
function mockPubSub(path, localStub, globalStub) {
localStub.topics = [];
localStub.subscribe = {};
if (!globalStub) {
globalStub = {};
}
globalStub.topics = [];
globalStub.subscribe = {};
var mockedPubSub = {
local: {
topic: function(topic) {
if (!localStub.topics[topic]) {
localStub.topics.push(topic);
localStub.topics[topic] = {
data: [],
handler: []
};
}
return {
publish: function(data) {
var t = localStub.topics[topic];
t.data.push(data);
t.handler.forEach(function(handler) {
handler(data);
});
},
subscribe: function(handler) {
localStub.topics[topic].handler.push(handler);
},
forward: function(pubsub, data) {
this.publish(data);
globalStub.topics.push(topic);
globalStub.topics[topic] = {
data: [],
handler: function() {}
};
globalStub.topics[topic].data.push(data);
}
};
}
},
global: {
topic: function(topic) {
if (!globalStub.topics[topic]) {
globalStub.topics.push(topic);
globalStub.topics[topic] = {
data: [],
handler: []
};
}
return {
publish: function(data) {
var t = globalStub.topics[topic];
t.data.push(data);
t.handler.forEach(function(handler) {
handler(data);
});
},
subscribe: function(handler) {
globalStub.topics[topic].handler.push(handler);
}
};
}
}
};
mockery.registerMock(path, mockedPubSub);
}
function checkAPImemberAgainstMongooseDocument(member, mongooseDoc) {
var memberDoc = {
_id: mongooseDoc._id.toString(),
objectType: mongooseDoc.objectType,
displayName: mongooseDoc.displayName,
status: mongooseDoc.status
};
expect(member).to.deep.equal(memberDoc);
}
/**
*
* @param {object} mixin
* @param {object} testEnv
*/
module.exports = function(mixin, testEnv) {
mixin.mongo = {
connect: function(callback) {
require('mongoose').connect(testEnv.mongoUrl, callback);
},
disconnect: function(callback) {
require('mongoose').disconnect(callback);
},
dropDatabase: function(callback) {
MongoClient.connect(testEnv.mongoUrl, function(err, db) {
db.dropDatabase(function(err) {
db.close(function() {});
callback(err);
});
});
},
clearCollection: function(collectionName, callback) {
require('mongoose').connection.db.collection(collectionName).remove(callback);
},
dropCollections: function(callback) {
require('mongoose').connection.db.collections(function(err, collections) {
if (err) { return callback(err); }
collections = collections.filter(function(collection) {
return collection.collectionName !== 'system.indexes';
});
async.forEach(collections, function(collection, done) {
require('mongoose').connection.db.dropCollection(collection.collectionName, done);
}, callback);
});
},
saveDoc: function(collection, doc, done) {
MongoClient.connect(testEnv.mongoUrl, function(err, db) {
function close(err) { db.close(function() { done(err); }); }
if (err) { return done(err); }
db.collection(collection).save(doc, close);
});
},
/*
*check a mongodb document
* @param collection string - the mongodb collection to get the doc
* @param id string|object - the doc _id (string) or the find criteria (object)
* @param check function|object - the function that checks the doc (function). This function should return something in case of error
* or the doc to check against (object)
* @param done function - the callback. No arguments on success, error on error
*/
checkDoc: function(collection, id, check, done) {
MongoClient.connect(testEnv.mongoUrl, function(err, db) {
function close(err) {
db.close(function() {
done(err);
});
}
if (err) {
return done(err);
}
if (typeof id === 'string') {
id = {_id: id};
}
db.collection(collection).findOne(id, function(err, doc) {
if (err) {
return close(err);
}
expect(doc).to.exist;
if (typeof check === 'function') {
var checkErr = check(doc);
if (checkErr) {
return close(checkErr);
}
} else {
doc = JSON.parse(JSON.stringify(doc));
expect(doc).to.deep.equal(check);
}
close();
});
});
}
};
mixin.mock = {
models: mockModels,
pubsub: mockPubSub,
esnConfig: mockEsnConfig
};
mixin.requireBackend = function(path) {
return require(testEnv.basePath + '/backend/' + path);
};
mixin.requireFixture = function(path) {
return require(testEnv.fixtures + '/' + path);
};
mixin.httpStatusCodeValidatingJsonResponse = function(status, done) {
return {
json: function(s, data) {
expect(s).to.equal(status);
done(data);
}
};
};
/**
* Helper function to ensure that a HttpError is provoked, either because it
* was thrown directly or by comparing the result sent via res.json.
*
* The inner function is called with two parameters: res and next. The `res`
* parameter is a mock for an express Result object that should be passed to
* the controller or middleware to ensure that the error is being sent. The
* `next` parameter can be passed to controller or middleware in case it
* should be asserted that the next function should never be called, which is
* usually the case when an error occurs.
*
* The `options` parameter is an optional object with properties that should
* be compared with the occurring error, e.g. code or details. This parameter
* may be left out.
*
* @param {Function} ErrorType One of the HttpError subclasses.
* @param {Function} func The inner function to call.
* @param {Object} options (optional) Properties to compare the error with.
* @param {Function} done (optional) The completion function to call.
*/
mixin.expectHttpError = function(ErrorType, func, options, done) {
if (typeof options === 'function') {
done = options;
options = {};
}
var res = {
json: function(code, body) {
clearTimeout(timer);
expect(body.error).to.exist;
var err = body.error;
for (var key in (options || {})) {
var detail = 'Expected ' + key + ' to equal ' + options[key] +
', but got ' + err[key];
expect(err[key], detail).to.equal(options[key]);
}
var mockError = new ErrorType('mock');
if (!('code' in options)) {
expect(err.code).to.equal(mockError.code);
expect(code).to.equal(mockError.code);
} else {
expect(code).to.equal(options.code);
}
if (!('message' in options)) {
expect(err.message).to.equal(mockError.message);
}
httpdomain.exit();
if (done) {
done();
}
}
};
var timer = setTimeout(function() {
var detail = 'Expected ' + func + ' to cause ' + ErrorType.name;
if (done) {
httpdomain.exit();
done(new Error(detail));
} else {
expect(false, detail).to.be.ok;
}
}, 10000);
var next = function() {
clearTimeout(timer);
expect(false, 'Unexpectedly called next()').to.be.ok;
};
var errorHandler = function(e) {
clearTimeout(timer);
if (e instanceof chai.AssertionError ||
e instanceof ReferenceError ||
e instanceof TypeError) {
throw e;
}
expect(e.name).to.equal(ErrorType.name);
for (var key in (options || {})) {
var detail = 'Expected ' + key + ' to equal ' + options[key] +
', but got ' + e[key];
expect(e[key], detail).to.equal(options[key]);
}
httpdomain.exit();
if (done) {
done();
}
};
var httpdomain = domain.create();
httpdomain.on('error', errorHandler);
httpdomain.enter();
try {
func(res, next);
httpdomain.exit();
} catch (e) {
errorHandler(e);
}
};
/**
* Helper that retuns an express Result object mock and ensures that the
* given method is not called.
*
* @param {Function} done The completion function.
* @param {String} method The method that shouldn't be called, (default: json)
*/
mixin.expectNotCalled = function(done, method) {
var obj = {};
obj[method || 'json'] = function() {
done(new Error('Unexpectedly called ' + method));
};
};
mixin.checkAPImemberAgainstMongooseDocument = checkAPImemberAgainstMongooseDocument;
mixin.callbacks = {
noError: function(done) {
return function(err) {
expect(err).to.not.exist;
done();
};
},
error: function(done) {
return function(err) {
expect(err).to.exist;
done();
};
},
errorWithMessage: function(done, message) {
return function(err) {
expect(err).to.exist;
expect(err.message).to.equals(message);
done();
};
}
};
mixin.utils = {
generateStringWithLength: function(length) {
return crypto.randomBytes(Math.ceil(length / 2)).toString('hex').slice(0, length);
}
};
};