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
|
/**
* Copyright (C) 2014 MongoDB Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the GNU Affero General Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#define MONGO_LOG_DEFAULT_COMPONENT ::mongo::logger::LogComponent::kReplication
#include "mongo/platform/basic.h"
#include "mongo/db/repl/replication_coordinator_test_fixture.h"
#include "mongo/db/logical_clock.h"
#include "mongo/db/operation_context_noop.h"
#include "mongo/db/repl/is_master_response.h"
#include "mongo/db/repl/repl_set_heartbeat_args.h"
#include "mongo/db/repl/repl_set_heartbeat_args_v1.h"
#include "mongo/db/repl/repl_settings.h"
#include "mongo/db/repl/replication_coordinator_external_state_mock.h"
#include "mongo/db/repl/replication_coordinator_impl.h"
#include "mongo/db/repl/storage_interface_mock.h"
#include "mongo/db/repl/topology_coordinator_impl.h"
#include "mongo/db/time_proof_service.h"
#include "mongo/executor/network_interface_mock.h"
#include "mongo/stdx/functional.h"
#include "mongo/stdx/memory.h"
#include "mongo/unittest/unittest.h"
#include "mongo/util/log.h"
namespace mongo {
namespace repl {
using executor::NetworkInterfaceMock;
using executor::RemoteCommandRequest;
using executor::RemoteCommandResponse;
ReplicationExecutor* ReplCoordTest::getReplExec() {
return _repl->getExecutor();
}
ReplSetConfig ReplCoordTest::assertMakeRSConfig(const BSONObj& configBson) {
ReplSetConfig config;
ASSERT_OK(config.initialize(configBson));
ASSERT_OK(config.validate());
return config;
}
ReplSetConfig ReplCoordTest::assertMakeRSConfigV0(const BSONObj& configBson) {
return assertMakeRSConfig(addProtocolVersion(configBson, 0));
}
BSONObj ReplCoordTest::addProtocolVersion(const BSONObj& configDoc, int protocolVersion) {
BSONObjBuilder builder;
builder << "protocolVersion" << protocolVersion;
builder.appendElementsUnique(configDoc);
return builder.obj();
}
void ReplCoordTest::setUp() {
_settings.setReplSetString("mySet/node1:12345,node2:54321");
_settings.setMajorityReadConcernEnabled(true);
}
void ReplCoordTest::tearDown() {
if (_externalState) {
_externalState->setStoreLocalConfigDocumentToHang(false);
}
if (_callShutdown) {
auto opCtx = makeOperationContext();
shutdown(opCtx.get());
}
}
void ReplCoordTest::assertRunUntil(Date_t newTime) {
this->_net->runUntil(newTime);
ASSERT_EQUALS(newTime, getNet()->now());
}
void ReplCoordTest::enterNetwork() {
getNet()->enterNetwork();
}
void ReplCoordTest::exitNetwork() {
getNet()->exitNetwork();
}
void ReplCoordTest::addSelf(const HostAndPort& selfHost) {
getExternalState()->addSelf(selfHost);
}
void ReplCoordTest::init() {
invariant(!_repl);
invariant(!_callShutdown);
auto service = getGlobalServiceContext();
StorageInterface* storageInterface = new StorageInterfaceMock();
StorageInterface::set(service, std::unique_ptr<StorageInterface>(storageInterface));
ASSERT_TRUE(storageInterface == StorageInterface::get(service));
// PRNG seed for tests.
const int64_t seed = 0;
std::array<std::uint8_t, 20> tempKey = {};
TimeProofService::Key key(std::move(tempKey));
auto timeProofService = stdx::make_unique<TimeProofService>(std::move(key));
auto logicalClock =
stdx::make_unique<LogicalClock>(service, std::move(timeProofService), false);
LogicalClock::set(service, std::move(logicalClock));
TopologyCoordinatorImpl::Options settings;
auto topo = stdx::make_unique<TopologyCoordinatorImpl>(settings);
_topo = topo.get();
auto net = stdx::make_unique<NetworkInterfaceMock>();
_net = net.get();
auto externalState = stdx::make_unique<ReplicationCoordinatorExternalStateMock>();
_externalState = externalState.get();
_repl = stdx::make_unique<ReplicationCoordinatorImpl>(service,
_settings,
std::move(externalState),
std::move(net),
std::move(topo),
storageInterface,
seed);
service->setFastClockSource(stdx::make_unique<executor::NetworkInterfaceMockClockSource>(_net));
service->setPreciseClockSource(
stdx::make_unique<executor::NetworkInterfaceMockClockSource>(_net));
}
void ReplCoordTest::init(const ReplSettings& settings) {
_settings = settings;
init();
}
void ReplCoordTest::init(const std::string& replSet) {
_settings.setReplSetString(replSet);
init();
}
void ReplCoordTest::start() {
invariant(!_callShutdown);
// if we haven't initialized yet, do that first.
if (!_repl) {
init();
}
const auto opCtx = makeOperationContext();
_repl->startup(opCtx.get());
_repl->waitForStartUpComplete_forTest();
_callShutdown = true;
}
void ReplCoordTest::start(const BSONObj& configDoc, const HostAndPort& selfHost) {
if (!_repl) {
init();
}
_externalState->setLocalConfigDocument(StatusWith<BSONObj>(configDoc));
_externalState->addSelf(selfHost);
start();
}
void ReplCoordTest::start(const HostAndPort& selfHost) {
if (!_repl) {
init();
}
_externalState->addSelf(selfHost);
start();
}
void ReplCoordTest::assertStartSuccess(const BSONObj& configDoc, const HostAndPort& selfHost) {
// Set default protocol version to 1.
if (!configDoc.hasField("protocolVersion")) {
start(addProtocolVersion(configDoc, 1), selfHost);
} else {
start(configDoc, selfHost);
}
ASSERT_NE(MemberState::RS_STARTUP, getReplCoord()->getMemberState().s);
}
ResponseStatus ReplCoordTest::makeResponseStatus(const BSONObj& doc, Milliseconds millis) {
return makeResponseStatus(doc, BSONObj(), millis);
}
ResponseStatus ReplCoordTest::makeResponseStatus(const BSONObj& doc,
const BSONObj& metadata,
Milliseconds millis) {
log() << "Responding with " << doc << " (metadata: " << metadata << "; elapsed: " << millis
<< ")";
return ResponseStatus(RemoteCommandResponse(doc, metadata, millis));
}
void ReplCoordTest::simulateEnoughHeartbeatsForAllNodesUp() {
ReplicationCoordinatorImpl* replCoord = getReplCoord();
ReplSetConfig rsConfig = replCoord->getReplicaSetConfig_forTest();
NetworkInterfaceMock* net = getNet();
net->enterNetwork();
for (int i = 0; i < rsConfig.getNumMembers() - 1; ++i) {
const NetworkInterfaceMock::NetworkOperationIterator noi = net->getNextReadyRequest();
const RemoteCommandRequest& request = noi->getRequest();
log() << request.target.toString() << " processing " << request.cmdObj;
ReplSetHeartbeatArgsV1 hbArgs;
ReplSetHeartbeatArgs hbArgsPV0;
if (hbArgs.initialize(request.cmdObj).isOK() ||
hbArgsPV0.initialize(request.cmdObj).isOK()) {
ReplSetHeartbeatResponse hbResp;
hbResp.setSetName(rsConfig.getReplSetName());
hbResp.setState(MemberState::RS_SECONDARY);
hbResp.setConfigVersion(rsConfig.getConfigVersion());
hbResp.setAppliedOpTime(OpTime(Timestamp(100, 2), 0));
BSONObjBuilder respObj;
net->scheduleResponse(noi, net->now(), makeResponseStatus(hbResp.toBSON(true)));
} else {
error() << "Black holing unexpected request to " << request.target << ": "
<< request.cmdObj;
net->blackHole(noi);
}
net->runReadyNetworkOperations();
}
net->exitNetwork();
}
void ReplCoordTest::simulateSuccessfulDryRun(
stdx::function<void(const RemoteCommandRequest& request)> onDryRunRequest) {
ReplicationCoordinatorImpl* replCoord = getReplCoord();
ReplSetConfig rsConfig = replCoord->getReplicaSetConfig_forTest();
NetworkInterfaceMock* net = getNet();
auto electionTimeoutWhen = replCoord->getElectionTimeout_forTest();
ASSERT_NOT_EQUALS(Date_t(), electionTimeoutWhen);
log() << "Election timeout scheduled at " << electionTimeoutWhen << " (simulator time)";
int voteRequests = 0;
int votesExpected = rsConfig.getNumMembers() / 2;
log() << "Simulating dry run responses - expecting " << votesExpected
<< " replSetRequestVotes requests";
net->enterNetwork();
while (voteRequests < votesExpected) {
if (net->now() < electionTimeoutWhen) {
net->runUntil(electionTimeoutWhen);
}
const NetworkInterfaceMock::NetworkOperationIterator noi = net->getNextReadyRequest();
const RemoteCommandRequest& request = noi->getRequest();
log() << request.target.toString() << " processing " << request.cmdObj;
if (request.cmdObj.firstElement().fieldNameStringData() == "replSetRequestVotes") {
ASSERT_TRUE(request.cmdObj.getBoolField("dryRun"));
onDryRunRequest(request);
net->scheduleResponse(noi,
net->now(),
makeResponseStatus(BSON("ok" << 1 << "reason"
<< ""
<< "term"
<< request.cmdObj["term"].Long()
<< "voteGranted"
<< true)));
voteRequests++;
} else {
error() << "Black holing unexpected request to " << request.target << ": "
<< request.cmdObj;
net->blackHole(noi);
}
net->runReadyNetworkOperations();
}
net->exitNetwork();
log() << "Simulating dry run responses - scheduled " << voteRequests
<< " replSetRequestVotes responses";
getReplCoord()->waitForElectionDryRunFinish_forTest();
log() << "Simulating dry run responses - dry run completed";
}
void ReplCoordTest::simulateSuccessfulDryRun() {
auto onDryRunRequest = [](const RemoteCommandRequest& request) {};
simulateSuccessfulDryRun(onDryRunRequest);
}
void ReplCoordTest::simulateSuccessfulV1Election() {
auto electionTimeoutWhen = getReplCoord()->getElectionTimeout_forTest();
ASSERT_NOT_EQUALS(Date_t(), electionTimeoutWhen);
log() << "Election timeout scheduled at " << electionTimeoutWhen << " (simulator time)";
simulateSuccessfulV1ElectionAt(electionTimeoutWhen);
}
void ReplCoordTest::simulateSuccessfulV1ElectionAt(Date_t electionTime) {
ReplicationCoordinatorImpl* replCoord = getReplCoord();
NetworkInterfaceMock* net = getNet();
ReplSetConfig rsConfig = replCoord->getReplicaSetConfig_forTest();
ASSERT(replCoord->getMemberState().secondary()) << replCoord->getMemberState().toString();
bool hasReadyRequests = true;
// Process requests until we're primary and consume the heartbeats for the notification
// of election win.
while (!replCoord->getMemberState().primary() || hasReadyRequests) {
log() << "Waiting on network in state " << replCoord->getMemberState();
getNet()->enterNetwork();
if (net->now() < electionTime) {
net->runUntil(electionTime);
}
const NetworkInterfaceMock::NetworkOperationIterator noi = net->getNextReadyRequest();
const RemoteCommandRequest& request = noi->getRequest();
log() << request.target.toString() << " processing " << request.cmdObj;
ReplSetHeartbeatArgsV1 hbArgs;
Status status = hbArgs.initialize(request.cmdObj);
if (hbArgs.initialize(request.cmdObj).isOK()) {
ReplSetHeartbeatResponse hbResp;
hbResp.setSetName(rsConfig.getReplSetName());
hbResp.setState(MemberState::RS_SECONDARY);
hbResp.setConfigVersion(rsConfig.getConfigVersion());
net->scheduleResponse(noi, net->now(), makeResponseStatus(hbResp.toBSON(true)));
} else if (request.cmdObj.firstElement().fieldNameStringData() == "replSetRequestVotes") {
net->scheduleResponse(noi,
net->now(),
makeResponseStatus(BSON("ok" << 1 << "reason"
<< ""
<< "term"
<< request.cmdObj["term"].Long()
<< "voteGranted"
<< true)));
} else if (request.cmdObj.firstElement().fieldNameStringData() == "replSetGetStatus") {
// OpTime part of replSetGetStatus for use by FreshnessScanner during catch-up period.
BSONObj response = BSON("optimes" << BSON("appliedOpTime" << OpTime().toBSON()));
net->scheduleResponse(noi, net->now(), makeResponseStatus(response));
} else {
error() << "Black holing unexpected request to " << request.target << ": "
<< request.cmdObj;
net->blackHole(noi);
}
net->runReadyNetworkOperations();
// Successful elections need to write the last vote to disk, which is done by DB worker.
// Wait until DB worker finishes its job to ensure the synchronization with the
// executor.
getReplExec()->waitForDBWork_forTest();
net->runReadyNetworkOperations();
hasReadyRequests = net->hasReadyRequests();
getNet()->exitNetwork();
}
ASSERT(replCoord->getApplierState() == ReplicationCoordinator::ApplierState::Draining);
ASSERT(replCoord->getMemberState().primary()) << replCoord->getMemberState().toString();
IsMasterResponse imResponse;
replCoord->fillIsMasterForReplSet(&imResponse);
ASSERT_FALSE(imResponse.isMaster()) << imResponse.toBSON().toString();
ASSERT_TRUE(imResponse.isSecondary()) << imResponse.toBSON().toString();
{
auto opCtx = makeOperationContext();
replCoord->signalDrainComplete(opCtx.get(), replCoord->getTerm());
}
ASSERT(replCoord->getApplierState() == ReplicationCoordinator::ApplierState::Stopped);
replCoord->fillIsMasterForReplSet(&imResponse);
ASSERT_TRUE(imResponse.isMaster()) << imResponse.toBSON().toString();
ASSERT_FALSE(imResponse.isSecondary()) << imResponse.toBSON().toString();
ASSERT(replCoord->getMemberState().primary()) << replCoord->getMemberState().toString();
}
void ReplCoordTest::simulateSuccessfulElection() {
ReplicationCoordinatorImpl* replCoord = getReplCoord();
NetworkInterfaceMock* net = getNet();
ReplSetConfig rsConfig = replCoord->getReplicaSetConfig_forTest();
ASSERT(replCoord->getMemberState().secondary()) << replCoord->getMemberState().toString();
bool hasReadyRequests = true;
// Process requests until we're primary and consume the heartbeats for the notification
// of election win.
while (!replCoord->getMemberState().primary() || hasReadyRequests) {
log() << "Waiting on network in state " << replCoord->getMemberState();
getNet()->enterNetwork();
const NetworkInterfaceMock::NetworkOperationIterator noi = net->getNextReadyRequest();
const RemoteCommandRequest& request = noi->getRequest();
log() << request.target.toString() << " processing " << request.cmdObj;
ReplSetHeartbeatArgs hbArgs;
if (hbArgs.initialize(request.cmdObj).isOK()) {
ReplSetHeartbeatResponse hbResp;
hbResp.setSetName(rsConfig.getReplSetName());
hbResp.setState(MemberState::RS_SECONDARY);
hbResp.setConfigVersion(rsConfig.getConfigVersion());
BSONObjBuilder respObj;
respObj << "ok" << 1;
hbResp.addToBSON(&respObj, false);
net->scheduleResponse(noi, net->now(), makeResponseStatus(respObj.obj()));
} else if (request.cmdObj.firstElement().fieldNameStringData() == "replSetFresh") {
net->scheduleResponse(
noi,
net->now(),
makeResponseStatus(BSON(
"ok" << 1 << "fresher" << false << "opTime" << Date_t() << "veto" << false)));
} else if (request.cmdObj.firstElement().fieldNameStringData() == "replSetElect") {
net->scheduleResponse(noi,
net->now(),
makeResponseStatus(BSON("ok" << 1 << "vote" << 1 << "round"
<< request.cmdObj["round"].OID())));
} else {
error() << "Black holing unexpected request to " << request.target << ": "
<< request.cmdObj;
net->blackHole(noi);
}
net->runReadyNetworkOperations();
hasReadyRequests = net->hasReadyRequests();
getNet()->exitNetwork();
}
ASSERT(replCoord->getApplierState() == ReplicationCoordinator::ApplierState::Draining);
ASSERT(replCoord->getMemberState().primary()) << replCoord->getMemberState().toString();
IsMasterResponse imResponse;
replCoord->fillIsMasterForReplSet(&imResponse);
ASSERT_FALSE(imResponse.isMaster()) << imResponse.toBSON().toString();
ASSERT_TRUE(imResponse.isSecondary()) << imResponse.toBSON().toString();
{
auto opCtx = makeOperationContext();
replCoord->signalDrainComplete(opCtx.get(), replCoord->getTerm());
}
replCoord->fillIsMasterForReplSet(&imResponse);
ASSERT_TRUE(imResponse.isMaster()) << imResponse.toBSON().toString();
ASSERT_FALSE(imResponse.isSecondary()) << imResponse.toBSON().toString();
ASSERT(replCoord->getMemberState().primary()) << replCoord->getMemberState().toString();
}
void ReplCoordTest::shutdown(OperationContext* opCtx) {
invariant(_callShutdown);
_net->exitNetwork();
_repl->shutdown(opCtx);
_callShutdown = false;
}
void ReplCoordTest::replyToReceivedHeartbeat() {
NetworkInterfaceMock* net = getNet();
net->enterNetwork();
const NetworkInterfaceMock::NetworkOperationIterator noi = net->getNextReadyRequest();
const RemoteCommandRequest& request = noi->getRequest();
const ReplSetConfig rsConfig = getReplCoord()->getReplicaSetConfig_forTest();
repl::ReplSetHeartbeatArgs hbArgs;
ASSERT_OK(hbArgs.initialize(request.cmdObj));
repl::ReplSetHeartbeatResponse hbResp;
hbResp.setSetName(rsConfig.getReplSetName());
hbResp.setState(MemberState::RS_SECONDARY);
hbResp.setConfigVersion(rsConfig.getConfigVersion());
BSONObjBuilder respObj;
respObj << "ok" << 1;
hbResp.addToBSON(&respObj, false);
net->scheduleResponse(noi, net->now(), makeResponseStatus(respObj.obj()));
net->runReadyNetworkOperations();
getNet()->exitNetwork();
}
void ReplCoordTest::replyToReceivedHeartbeatV1() {
NetworkInterfaceMock* net = getNet();
net->enterNetwork();
const NetworkInterfaceMock::NetworkOperationIterator noi = net->getNextReadyRequest();
const RemoteCommandRequest& request = noi->getRequest();
const ReplSetConfig rsConfig = getReplCoord()->getReplicaSetConfig_forTest();
repl::ReplSetHeartbeatArgsV1 hbArgs;
ASSERT_OK(hbArgs.initialize(request.cmdObj));
repl::ReplSetHeartbeatResponse hbResp;
hbResp.setSetName(rsConfig.getReplSetName());
hbResp.setState(MemberState::RS_SECONDARY);
hbResp.setConfigVersion(rsConfig.getConfigVersion());
BSONObjBuilder respObj;
respObj << "ok" << 1;
hbResp.addToBSON(&respObj, false);
net->scheduleResponse(noi, net->now(), makeResponseStatus(respObj.obj()));
net->runReadyNetworkOperations();
getNet()->exitNetwork();
}
void ReplCoordTest::disableReadConcernMajoritySupport() {
_externalState->setIsReadCommittedEnabled(false);
}
void ReplCoordTest::disableSnapshots() {
_externalState->setAreSnapshotsEnabled(false);
}
void ReplCoordTest::simulateCatchUpTimeout() {
NetworkInterfaceMock* net = getNet();
auto catchUpTimeoutWhen = net->now() + getReplCoord()->getConfig().getCatchUpTimeoutPeriod();
bool hasRequest = false;
net->enterNetwork();
if (net->now() < catchUpTimeoutWhen) {
net->runUntil(catchUpTimeoutWhen);
}
hasRequest = net->hasReadyRequests();
net->exitNetwork();
while (hasRequest) {
net->enterNetwork();
auto noi = net->getNextReadyRequest();
auto request = noi->getRequest();
// Black hole heartbeat requests caused by time advance.
log() << "Black holing request to " << request.target.toString() << " : " << request.cmdObj;
net->blackHole(noi);
if (net->now() < catchUpTimeoutWhen) {
net->runUntil(catchUpTimeoutWhen);
} else {
net->runReadyNetworkOperations();
}
hasRequest = net->hasReadyRequests();
net->exitNetwork();
}
}
} // namespace repl
} // namespace mongo
|