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
|
/**
* Copyright (C) 2020-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* 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
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* 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 Server Side 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_LOGV2_DEFAULT_COMPONENT ::mongo::logv2::LogComponent::kTest
#include "mongo/platform/basic.h"
#include "mongo/base/status.h"
#include "mongo/executor/mock_network_fixture.h"
#include "mongo/executor/network_interface.h"
#include "mongo/executor/network_interface_mock.h"
#include "mongo/executor/network_interface_mock_test_fixture.h"
#include "mongo/executor/thread_pool_mock.h"
#include "mongo/logv2/log.h"
#include "mongo/unittest/unittest.h"
namespace mongo {
namespace {
using namespace executor;
using namespace test::mock;
class MockNetworkTest : public NetworkInterfaceMockTest {
public:
MockNetworkTest() : NetworkInterfaceMockTest(), _mock(&NetworkInterfaceMockTest::net()){};
MockNetwork& mock() {
return _mock;
}
void setUp() override {
NetworkInterfaceMockTest::setUp();
NetworkInterfaceMockTest::startNetwork();
}
void tearDown() override {
NetworkInterfaceMockTest::tearDown();
// Will check for unsatisfied expectations.
mock().verifyAndClearExpectations();
}
Status startCommand(RemoteCommandRequestOnAny& request) {
TaskExecutor::CallbackHandle cb;
return net().startCommand(cb, request, [&](const auto& resp) {
LOGV2(5015503, "Test got command response", "resp"_attr = resp);
_responses.push_back(resp);
});
}
// Assumes standard responses (kExampleResponse).
void evaluateResponses(const int numExpected) {
ASSERT_EQUALS(numExpected, _responses.size());
for (const auto& resp : _responses) {
ASSERT(resp.isOK());
ASSERT(SimpleBSONObjComparator::kInstance.evaluate(kExampleResponse == resp.data));
}
}
std::string kExampleCmdName = "someCommandName";
std::string kExampleCmdNameTwo = kExampleCmdName + "_two";
std::string kExampleCmdNameThree = kExampleCmdName + "_three";
std::string kExampleCmdNameFour = kExampleCmdName + "_four";
RemoteCommandRequestOnAny kExampleRequest{
{testHost()}, "testDB", BSON(kExampleCmdName << 1), rpc::makeEmptyMetadata(), nullptr};
RemoteCommandRequestOnAny kExampleRequestTwo{
{testHost()}, "testDB", BSON(kExampleCmdNameTwo << 1), rpc::makeEmptyMetadata(), nullptr};
RemoteCommandRequestOnAny kExampleRequestThree{
{testHost()}, "testDB", BSON(kExampleCmdNameThree << 1), rpc::makeEmptyMetadata(), nullptr};
RemoteCommandRequestOnAny kExampleRequestFour{
{testHost()}, "testDB", BSON(kExampleCmdNameFour << 1), rpc::makeEmptyMetadata(), nullptr};
BSONObj kExampleResponse = BSON("some"
<< "response");
RemoteCommandRequestOnAny makeRequest(std::string cmdName) {
return {{testHost()}, "testDB", BSON(cmdName << 1), rpc::makeEmptyMetadata(), nullptr};
}
RemoteCommandRequestOnAny makeRequest(BSONObj obj) {
return {{testHost()}, "testDB", obj, rpc::makeEmptyMetadata(), nullptr};
}
private:
MockNetwork _mock;
std::vector<RemoteCommandOnAnyResponse> _responses;
};
TEST_F(MockNetworkTest, MockFixtureBasicTest) {
mock().expect(kExampleCmdName, kExampleResponse);
RemoteCommandRequestOnAny request{kExampleRequest};
ASSERT_OK(startCommand(request));
mock().runUntilExpectationsSatisfied();
evaluateResponses(1 /* numExpected */);
}
TEST_F(MockNetworkTest, MockFixtureBasicTestWithMatcherFn) {
mock().expect(
[&](auto& request) { return request.firstElementFieldNameStringData() == kExampleCmdName; },
kExampleResponse);
RemoteCommandRequestOnAny request{kExampleRequest};
ASSERT_OK(startCommand(request));
mock().runUntilExpectationsSatisfied();
evaluateResponses(1 /* numExpected */);
}
TEST_F(MockNetworkTest, MockFixtureBasicTestSameCommandMultipleTimes) {
mock().expect(kExampleCmdName, kExampleResponse).times(3);
RemoteCommandRequestOnAny request{kExampleRequest};
// Run command three times.
ASSERT_OK(startCommand(request));
ASSERT_OK(startCommand(request));
ASSERT_OK(startCommand(request));
mock().runUntilExpectationsSatisfied();
evaluateResponses(3 /* numExpected */);
}
TEST_F(MockNetworkTest, MockFixtureSeveralExpectationsUnordered) {
// We will interleave requests for these expectations.
// Order of requests will be: Two, One, Two, Two, One.
mock().expect(kExampleCmdName, kExampleResponse).times(2);
mock().expect(kExampleCmdNameTwo, kExampleResponse).times(3);
RemoteCommandRequestOnAny requestOne{kExampleRequest};
RemoteCommandRequestOnAny requestTwo{kExampleRequestTwo};
// Run commands in this specific order.
ASSERT_OK(startCommand(requestTwo));
ASSERT_OK(startCommand(requestOne));
ASSERT_OK(startCommand(requestTwo));
ASSERT_OK(startCommand(requestTwo));
ASSERT_OK(startCommand(requestOne));
mock().runUntilExpectationsSatisfied();
evaluateResponses(5 /* numExpected */);
}
TEST_F(MockNetworkTest, MockFixtureSimilarExpectationsSpecialization) {
// These expectations both share the same command name, but the second one has more info.
// Generally, latter expectations should override previous ones if they are similar enough.
// We are testing here that they both are still satisfied as we end up evaluating the more
// specific one first.
mock().expect(kExampleCmdName, kExampleResponse).times(1);
mock().expect(BSON(kExampleCmdName << 1 << "extradata" << 1), kExampleResponse).times(1);
RemoteCommandRequestOnAny cmdNameRequest{kExampleRequest};
RemoteCommandRequestOnAny bsonRequest{
makeRequest(BSON(kExampleCmdName << 1 << "extradata" << 1))};
// Run commands starting with the one for the older (potentially overridden) expectations.
ASSERT_OK(startCommand(cmdNameRequest));
ASSERT_OK(startCommand(bsonRequest));
mock().runUntilExpectationsSatisfied();
evaluateResponses(2 /* numExpected */);
}
TEST_F(MockNetworkTest, MockFixtureSimilarExpectationsOverride) {
// Add a default expectation so we can still cover the overridden command.
// This is necessary as unanswered requests will cause the test to hang.
mock().defaultExpect(kExampleCmdName, kExampleResponse);
// These expectations both share the same command name, but the first one has more info.
// This test demonstrates the case where we override a specific expectation with a more
// general one. Namely, it shows the pitfalls of doing so - the more general request
// will match greedily here, displacing the more specific one.
auto specificExp =
mock().expect(BSON(kExampleCmdName << 1 << "extradata" << 1), kExampleResponse).times(1);
mock().expect(kExampleCmdName, kExampleResponse).times(1);
RemoteCommandRequestOnAny bsonRequest{
makeRequest(BSON(kExampleCmdName << 1 << "extradata" << 1))};
RemoteCommandRequestOnAny cmdNameRequest{kExampleRequest};
// Run commands starting with the one for the older (potentially overridden) expectations.
// The first request is meant for the older expectation, however it fulfills the matching
// requirements for the more recent one. This is a problem as the remaining user expectation
// will be unable to match the second request (as it is missing the extra field).
ASSERT_OK(startCommand(bsonRequest));
// We will not be able to match this request to a user expectation at this point, so it will
// have to use the default expectation.
ASSERT_OK(startCommand(cmdNameRequest));
const auto deadline = net().now() + Milliseconds(100);
mock().runUntil(deadline);
// The command matcher superceded the BSON matcher so we have an some unmatched expectation.
ASSERT_THROWS_CODE(mock().verifyExpectations(), DBException, (ErrorCodes::Error)5015501);
ASSERT(!specificExp.isSatisfied());
// Fix the tally to meet all expectations.
ASSERT_OK(startCommand(bsonRequest));
mock().runUntilExpectationsSatisfied();
evaluateResponses(3 /* numExpected */);
}
TEST_F(MockNetworkTest, MockFixtureRunUntilReadyRequest) {
mock().expect(kExampleCmdName, kExampleResponse);
RemoteCommandRequestOnAny request{kExampleRequest};
ASSERT_OK(startCommand(request));
TaskExecutor::CallbackHandle cbAlarm;
bool alarmFired = false;
const auto deadline = net().now() + Milliseconds(100);
ASSERT_OK(net().setAlarm(cbAlarm, deadline, [&](Status status) {
ASSERT(status.isOK());
alarmFired = true;
}));
ASSERT_FALSE(alarmFired);
mock().runUntil(deadline);
ASSERT_TRUE(alarmFired);
// We will have run our expected request as it was ready.
mock().verifyExpectations();
evaluateResponses(1 /* numExpected */);
}
TEST_F(MockNetworkTest, MockFixtureRunUntilNotAllExpectationsSatisfied) {
mock().expect(kExampleCmdName, kExampleResponse);
mock().expect(kExampleCmdNameTwo, kExampleResponse);
RemoteCommandRequestOnAny request{kExampleRequest};
ASSERT_OK(startCommand(request));
TaskExecutor::CallbackHandle cbAlarm;
bool alarmFired = false;
const auto deadline = net().now() + Milliseconds(100);
ASSERT_OK(net().setAlarm(cbAlarm, deadline, [&](Status status) {
ASSERT(status.isOK());
alarmFired = true;
}));
ASSERT_FALSE(alarmFired);
mock().runUntil(deadline);
ASSERT_TRUE(alarmFired);
// We had only one ready request to run. The one corresponding to the other
// expectation does not exist yet.
ASSERT_THROWS_CODE(mock().verifyExpectations(), DBException, (ErrorCodes::Error)5015501);
// Satisfy the other expectation to terminate the test.
RemoteCommandRequestOnAny requestTwo{kExampleRequestTwo};
ASSERT_OK(startCommand(requestTwo));
mock().runUntilExpectationsSatisfied();
evaluateResponses(2 /* numExpected */);
}
TEST_F(MockNetworkTest, MockFixtureNotEnoughTimesMatched) {
mock().expect(kExampleCmdName, kExampleResponse).times(2);
RemoteCommandRequestOnAny request{kExampleRequest};
ASSERT_OK(startCommand(request));
const auto deadline = net().now() + Milliseconds(100);
mock().runUntil(deadline);
// We expect to serve the same request twice but we've only received it once so far.
ASSERT_THROWS_CODE(mock().verifyExpectations(), DBException, (ErrorCodes::Error)5015501);
ASSERT_OK(startCommand(request));
mock().runUntilExpectationsSatisfied();
evaluateResponses(2 /* numExpected */);
}
TEST_F(MockNetworkTest, MockFixtureSequenceTestCorrectOrder) {
// The requests will come in the expected order.
{
MockNetwork::InSequence seq(mock());
mock().expect(kExampleCmdName, kExampleResponse).times(1);
mock().expect(kExampleCmdNameTwo, kExampleResponse).times(1);
}
RemoteCommandRequestOnAny requestOne{kExampleRequest};
RemoteCommandRequestOnAny requestTwo{kExampleRequestTwo};
// Run commands in this specific order.
ASSERT_OK(startCommand(requestOne));
ASSERT_OK(startCommand(requestTwo));
mock().runUntilExpectationsSatisfied();
evaluateResponses(2 /* numExpected */);
}
TEST_F(MockNetworkTest, MockFixtureSequenceTestOppositeOrder) {
// We expect One -> Two, but the requests will come in the opposite order.
// We will refuse to match Two to its user expectation if One is not satisfied,
// so we make a default expectation to fall back to so the test can move forward.
mock().defaultExpect(kExampleCmdNameTwo, kExampleResponse);
{
MockNetwork::InSequence seq(mock());
mock().expect(kExampleCmdName, kExampleResponse).times(1);
mock().expect(kExampleCmdNameTwo, kExampleResponse).times(1);
}
RemoteCommandRequestOnAny requestOne{kExampleRequest};
RemoteCommandRequestOnAny requestTwo{kExampleRequestTwo};
// Run commands in this specific order.
ASSERT_OK(startCommand(requestTwo));
ASSERT_OK(startCommand(requestOne));
mock().runUntil(net().now() + Milliseconds(100));
// The second expectation will not have been satisfied, as the first one has not yet been
// met at that time it came in.
ASSERT_THROWS_CODE(mock().verifyExpectations(), DBException, (ErrorCodes::Error)5015501);
// Now we can send a request for expectation Two again.
ASSERT_OK(startCommand(requestTwo));
mock().runUntilExpectationsSatisfied();
evaluateResponses(3 /* numExpected */);
}
TEST_F(MockNetworkTest, MockFixtureSequenceTestCorrectPartialOrder) {
// We only require One -> Two, so One -> Three -> Two is valid.
{
MockNetwork::InSequence seq(mock());
mock().expect(kExampleCmdName, kExampleResponse).times(1);
mock().expect(kExampleCmdNameTwo, kExampleResponse).times(1);
}
mock().expect(kExampleCmdNameThree, kExampleResponse).times(1);
RemoteCommandRequestOnAny requestOne{kExampleRequest};
RemoteCommandRequestOnAny requestTwo{kExampleRequestTwo};
RemoteCommandRequestOnAny requestThree{kExampleRequestThree};
// Run commands in this specific order.
ASSERT_OK(startCommand(requestOne));
ASSERT_OK(startCommand(requestThree));
ASSERT_OK(startCommand(requestTwo));
mock().runUntilExpectationsSatisfied();
evaluateResponses(3 /* numExpected */);
}
TEST_F(MockNetworkTest, MockFixtureSequenceTestTwoSequencesNoOverlap) {
// We have One -> Two and Three -> Four. We run One -> Two -> Three -> Four;
{
MockNetwork::InSequence seqOne(mock());
mock().expect(kExampleCmdName, kExampleResponse).times(1);
mock().expect(kExampleCmdNameTwo, kExampleResponse).times(1);
}
{
MockNetwork::InSequence seqTwo(mock());
mock().expect(kExampleCmdNameThree, kExampleResponse).times(1);
mock().expect(kExampleCmdNameFour, kExampleResponse).times(1);
}
RemoteCommandRequestOnAny requestOne{kExampleRequest};
RemoteCommandRequestOnAny requestTwo{kExampleRequestTwo};
RemoteCommandRequestOnAny requestThree{kExampleRequestThree};
RemoteCommandRequestOnAny requestFour{kExampleRequestFour};
// Run commands in this specific order.
ASSERT_OK(startCommand(requestOne));
ASSERT_OK(startCommand(requestTwo));
ASSERT_OK(startCommand(requestThree));
ASSERT_OK(startCommand(requestFour));
mock().runUntilExpectationsSatisfied();
evaluateResponses(4 /* numExpected */);
}
TEST_F(MockNetworkTest, MockFixtureSequenceTestTwoSequencesPartialOrder) {
// We have One -> Two and Three -> Four. We run One -> Three -> Two -> Four;
{
MockNetwork::InSequence seqOne(mock());
mock().expect(kExampleCmdName, kExampleResponse).times(1);
mock().expect(kExampleCmdNameTwo, kExampleResponse).times(1);
}
{
MockNetwork::InSequence seqTwo(mock());
mock().expect(kExampleCmdNameThree, kExampleResponse).times(1);
mock().expect(kExampleCmdNameFour, kExampleResponse).times(1);
}
RemoteCommandRequestOnAny requestOne{kExampleRequest};
RemoteCommandRequestOnAny requestTwo{kExampleRequestTwo};
RemoteCommandRequestOnAny requestThree{kExampleRequestThree};
RemoteCommandRequestOnAny requestFour{kExampleRequestFour};
// Run commands in this specific order.
ASSERT_OK(startCommand(requestOne));
ASSERT_OK(startCommand(requestThree));
ASSERT_OK(startCommand(requestTwo));
ASSERT_OK(startCommand(requestFour));
mock().runUntilExpectationsSatisfied();
evaluateResponses(4 /* numExpected */);
}
TEST_F(MockNetworkTest, MockFixtureSequenceTestLongerChain) {
// One -> Two -> Three -> Four required.
{
MockNetwork::InSequence seqOne(mock());
mock().expect(kExampleCmdName, kExampleResponse).times(1);
mock().expect(kExampleCmdNameTwo, kExampleResponse).times(1);
mock().expect(kExampleCmdNameThree, kExampleResponse).times(1);
mock().expect(kExampleCmdNameFour, kExampleResponse).times(1);
}
RemoteCommandRequestOnAny requestOne{kExampleRequest};
RemoteCommandRequestOnAny requestTwo{kExampleRequestTwo};
RemoteCommandRequestOnAny requestThree{kExampleRequestThree};
RemoteCommandRequestOnAny requestFour{kExampleRequestFour};
// Run commands in this specific order.
ASSERT_OK(startCommand(requestOne));
ASSERT_OK(startCommand(requestTwo));
ASSERT_OK(startCommand(requestThree));
ASSERT_OK(startCommand(requestFour));
mock().runUntilExpectationsSatisfied();
evaluateResponses(4 /* numExpected */);
}
} // namespace
} // namespace mongo
|