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
|
/**
* Copyright (C) 2018-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.
*/
#pragma once
#include <string>
#include <vector>
#include "mongo/client/dbclient_connection.h"
#include "mongo/db/query/cursor_response.h"
#include "mongo/dbtests/mock/mock_remote_db_server.h"
namespace mongo {
/**
* A simple class for mocking mongo::DBClientConnection.
*
* Also check out sample usage in dbtests/mock_dbclient_conn_test.cpp
*/
class MockDBClientConnection : public mongo::DBClientConnection {
public:
/**
* An OP_MSG response to a 'find' command.
*/
static Message mockFindResponse(NamespaceString nss,
long long cursorId,
const std::vector<BSONObj>& firstBatch,
const BSONObj& metadata) {
auto cursorRes = CursorResponse(nss, cursorId, firstBatch);
BSONObjBuilder bob(cursorRes.toBSON(CursorResponse::ResponseType::InitialResponse));
bob.appendElementsUnique(metadata);
return OpMsg{bob.obj()}.serialize();
}
/**
* An OP_MSG response to a 'getMore' command.
*/
static Message mockGetMoreResponse(NamespaceString nss,
long long cursorId,
const std::vector<BSONObj>& batch,
const BSONObj& metadata,
bool moreToCome = false) {
auto cursorRes = CursorResponse(nss, cursorId, batch);
BSONObjBuilder bob(cursorRes.toBSON(CursorResponse::ResponseType::SubsequentResponse));
bob.appendElementsUnique(metadata);
auto m = OpMsg{bob.obj()}.serialize();
if (moreToCome) {
OpMsg::setFlag(&m, OpMsg::kMoreToCome);
}
return m;
}
/**
* A generic non-ok OP_MSG command response.
*/
static Message mockErrorResponse(ErrorCodes::Error err) {
OpMsgBuilder builder;
BSONObjBuilder bodyBob;
bodyBob.append("ok", 0);
bodyBob.append("code", err);
builder.setBody(bodyBob.done());
return builder.finish();
}
/**
* Create a mock connection to a mock server.
*
* @param remoteServer the remote server to connect to. The caller is
* responsible for making sure that the life of remoteServer is
* longer than this connection.
* @param autoReconnect will automatically re-establish connection the
* next time an operation is requested when the last operation caused
* this connection to fall into a failed state.
*/
MockDBClientConnection(MockRemoteDBServer* remoteServer, bool autoReconnect = false);
virtual ~MockDBClientConnection();
//
// DBClientBase methods
//
using DBClientBase::query;
bool connect(const char* hostName, StringData applicationName, std::string& errmsg);
Status connect(const HostAndPort& host,
StringData applicationName,
boost::optional<TransientSSLParams> transientSSLParams) override {
std::string errmsg;
if (!connect(host.toString().c_str(), applicationName, errmsg)) {
return {ErrorCodes::HostUnreachable, errmsg};
}
return Status::OK();
}
using DBClientBase::runCommandWithTarget;
std::pair<rpc::UniqueReply, DBClientBase*> runCommandWithTarget(OpMsgRequest request) override;
std::unique_ptr<DBClientCursor> find(FindCommandRequest findRequest,
const ReadPreferenceSetting& readPref) override;
std::unique_ptr<mongo::DBClientCursor> query(
const NamespaceStringOrUUID& nsOrUuid,
const BSONObj& filter = BSONObj{},
const Query& querySettings = Query(),
int limit = 0,
int nToSkip = 0,
const mongo::BSONObj* fieldsToReturn = nullptr,
int queryOptions = 0,
int batchSize = 0,
boost::optional<BSONObj> readConcernObj = boost::none) override;
uint64_t getSockCreationMicroSec() const override;
void insert(const std::string& ns,
BSONObj obj,
bool ordered = true,
boost::optional<BSONObj> writeConcernObj = boost::none) override;
void insert(const std::string& ns,
const std::vector<BSONObj>& objList,
bool ordered = true,
boost::optional<BSONObj> writeConcernObj = boost::none) override;
void remove(const std::string& ns,
const BSONObj& filter,
bool removeMany = true,
boost::optional<BSONObj> writeConcernObj = boost::none) override;
bool call(mongo::Message& toSend,
mongo::Message& response,
bool assertOk,
std::string* actualServer) override;
Status recv(mongo::Message& m, int lastRequestId) override;
void shutdown() override;
void shutdownAndDisallowReconnect() override;
// Methods to simulate network responses.
using Responses = std::vector<StatusWith<mongo::Message>>;
void setCallResponses(Responses responses);
void setRecvResponses(Responses responses);
//
// Getters
//
mongo::ConnectionString::ConnectionType type() const override;
Message getLastSentMessage() {
stdx::lock_guard lk(_netMutex);
return _lastSentMessage;
}
bool isBlockedOnNetwork() {
stdx::lock_guard lk(_netMutex);
return _blockedOnNetwork;
}
//
// Unsupported methods (defined to get rid of virtual function was hidden error)
//
unsigned long long query(std::function<void(mongo::DBClientCursorBatchIterator&)> f,
const NamespaceStringOrUUID& nsOrUuid,
const BSONObj& filter,
const Query& querySettings,
const mongo::BSONObj* fieldsToReturn = nullptr,
int queryOptions = 0,
int batchSize = 0,
boost::optional<BSONObj> readConcernObj = boost::none) override;
//
// Unsupported methods (these are pure virtuals in the base class)
//
void killCursor(const NamespaceString& ns, long long cursorID) override;
void say(mongo::Message& toSend,
bool isRetry = false,
std::string* actualServer = nullptr) override;
private:
void checkConnection() override;
std::unique_ptr<DBClientCursor> bsonArrayToCursor(BSONArray results,
int nToSkip,
bool provideResumeToken,
int batchSize);
MockRemoteDBServer::InstanceID _remoteServerInstanceID;
MockRemoteDBServer* const _remoteServer;
uint64_t _sockCreationTime;
boost::optional<OpMsgRequest> _lastCursorMessage;
Mutex _netMutex = MONGO_MAKE_LATCH("MockDBClientConnection");
stdx::condition_variable _mockCallResponsesCV;
Responses _mockCallResponses;
Responses::iterator _callIter;
stdx::condition_variable _mockRecvResponsesCV;
Responses _mockRecvResponses;
Responses::iterator _recvIter;
Message _lastSentMessage;
bool _blockedOnNetwork = false;
};
} // namespace mongo
|
