-
Notifications
You must be signed in to change notification settings - Fork 1.8k
/
spec.test.js
274 lines (228 loc) · 8.39 KB
/
spec.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
'use strict';
const fs = require('fs');
const path = require('path');
const Topology = require('../../../lib/core/sdam/topology').Topology;
const Server = require('../../../lib/core/sdam/server').Server;
const ServerDescription = require('../../../lib/core/sdam/server_description').ServerDescription;
const sdamEvents = require('../../../lib/core/sdam/events');
const parse = require('../../../lib/core/uri_parser');
const sinon = require('sinon');
const EJSON = require('mongodb-extjson');
const chai = require('chai');
chai.use(require('chai-subset'));
chai.use(require('../../functional/spec-runner/matcher').default);
const expect = chai.expect;
const specDir = path.resolve(__dirname, '../../spec/server-discovery-and-monitoring');
function collectTests() {
const testTypes = fs
.readdirSync(specDir)
.filter(d => fs.statSync(path.resolve(specDir, d)).isDirectory());
const tests = {};
testTypes.forEach(testType => {
tests[testType] = fs
.readdirSync(path.join(specDir, testType))
.filter(f => path.extname(f) === '.json')
.map(f => {
const result = EJSON.parse(fs.readFileSync(path.join(specDir, testType, f)), {
relaxed: true
});
result.type = testType;
return result;
});
});
return tests;
}
describe('Server Discovery and Monitoring (spec)', function() {
let serverConnect;
before(() => {
serverConnect = sinon.stub(Server.prototype, 'connect').callsFake(function() {
this.s.state = 'connected';
this.emit('connect');
});
});
after(() => {
serverConnect.restore();
});
const specTests = collectTests();
Object.keys(specTests).forEach(specTestName => {
describe(specTestName, () => {
specTests[specTestName].forEach(testData => {
it(testData.description, {
metadata: { requires: { topology: 'single' } },
test: function(done) {
executeSDAMTest(testData, done);
}
});
});
});
});
});
const OUTCOME_TRANSLATIONS = new Map();
OUTCOME_TRANSLATIONS.set('topologyType', 'type');
function translateOutcomeKey(key) {
if (OUTCOME_TRANSLATIONS.has(key)) {
return OUTCOME_TRANSLATIONS.get(key);
}
return key;
}
function convertOutcomeEvents(events) {
return events.map(event => {
const eventType = Object.keys(event)[0];
const args = [];
Object.keys(event[eventType]).forEach(key => {
let argument = event[eventType][key];
if (argument.servers) {
argument.servers = argument.servers.reduce((result, server) => {
result[server.address] = normalizeServerDescription(server);
return result;
}, {});
}
Object.keys(argument).forEach(key => {
if (OUTCOME_TRANSLATIONS.has(key)) {
argument[OUTCOME_TRANSLATIONS.get(key)] = argument[key];
delete argument[key];
}
});
args.push(argument);
});
// convert snake case to camelCase with capital first letter
let eventClass = eventType.replace(/_\w/g, c => c[1].toUpperCase());
eventClass = eventClass.charAt(0).toUpperCase() + eventClass.slice(1);
args.unshift(null);
const eventConstructor = sdamEvents[eventClass];
const eventInstance = new (Function.prototype.bind.apply(eventConstructor, args))();
return eventInstance;
});
}
// iterates through expectation building a path of keys that should not exist (null), and
// removes them from the expectation (NOTE: this mutates the expectation)
function findOmittedFields(expected) {
const result = [];
Object.keys(expected).forEach(key => {
if (expected[key] == null) {
result.push(key);
delete expected[key];
}
});
return result;
}
function normalizeServerDescription(serverDescription) {
if (serverDescription.type === 'PossiblePrimary') {
// Some single-threaded drivers care a lot about ordering potential primary
// servers, in order to speed up selection. We don't care, so we'll just mark
// it as `Unknown`.
serverDescription.type = 'Unknown';
}
return serverDescription;
}
function cloneMap(map) {
const result = Object.create(null);
for (let key of map.keys()) {
result[key] = JSON.parse(JSON.stringify(map.get(key)));
}
return result;
}
function cloneForCompare(event) {
const result = JSON.parse(JSON.stringify(event));
['previousDescription', 'newDescription'].forEach(key => {
if (event[key] != null && event[key].servers != null) {
result[key].servers = cloneMap(event[key].servers);
}
});
return result;
}
function executeSDAMTest(testData, testDone) {
parse(testData.uri, (err, parsedUri) => {
if (err) return done(err);
// create the topology
const topology = new Topology(parsedUri.hosts, parsedUri.options);
// Each test will attempt to connect by doing server selection. We want to make the first
// call to `selectServers` call a fake, and then immediately restore the original behavior.
let topologySelectServers = sinon
.stub(Topology.prototype, 'selectServer')
.callsFake(function(selector, options, callback) {
topologySelectServers.restore();
const fakeServer = { s: { state: 'connected' }, removeListener: () => {} };
callback(undefined, fakeServer);
});
// listen for SDAM monitoring events
let events = [];
[
'serverOpening',
'serverClosed',
'serverDescriptionChanged',
'topologyOpening',
'topologyClosed',
'topologyDescriptionChanged',
'serverHeartbeatStarted',
'serverHeartbeatSucceeded',
'serverHeartbeatFailed'
].forEach(eventName => {
topology.on(eventName, event => events.push(event));
});
function done(err) {
topology.close(e => testDone(e || err));
}
const incompatabilityHandler = err => {
if (err.message.match(/but this version of the driver/)) return;
throw err;
};
// connect the topology
topology.connect(testData.uri, err => {
expect(err).to.not.exist;
testData.phases.forEach(phase => {
const incompatibilityExpected = phase.outcome ? !phase.outcome.comptabile : false;
if (incompatibilityExpected) {
topology.on('error', incompatabilityHandler);
}
// simulate each ismaster response
phase.responses.forEach(response =>
topology.serverUpdateHandler(new ServerDescription(response[0], response[1]))
);
// then verify the resulting outcome
const description = topology.description;
Object.keys(phase.outcome).forEach(key => {
const outcomeValue = phase.outcome[key];
const translatedKey = translateOutcomeKey(key);
if (key === 'servers') {
expect(description).to.include.keys(translatedKey);
const expectedServers = outcomeValue;
const actualServers = description[translatedKey];
Object.keys(expectedServers).forEach(serverName => {
expect(actualServers).to.include.keys(serverName);
const expectedServer = normalizeServerDescription(expectedServers[serverName]);
const omittedFields = findOmittedFields(expectedServer);
const actualServer = actualServers.get(serverName);
expect(actualServer).to.matchMongoSpec(expectedServer);
if (omittedFields.length) {
expect(actualServer).to.not.have.all.keys(omittedFields);
}
});
return;
}
if (key === 'events') {
const expectedEvents = convertOutcomeEvents(outcomeValue);
expect(events).to.have.length(expectedEvents.length);
for (let i = 0; i < events.length; ++i) {
const expectedEvent = expectedEvents[i];
const actualEvent = cloneForCompare(events[i]);
expect(actualEvent).to.matchMongoSpec(expectedEvent);
}
return;
}
if (key === 'compatible' || key === 'setName') {
expect(topology.description[key]).to.equal(outcomeValue);
return;
}
expect(description).to.include.keys(translatedKey);
expect(description[translatedKey]).to.eql(outcomeValue, `(key="${translatedKey}")`);
});
// remove error handler
topology.removeListener('error', incompatabilityHandler);
// reset the captured events for each phase
events = [];
});
topology.close(done);
});
});
}