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
|
/**
* 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 <functional>
#include "mongo/base/status_with.h"
#include "mongo/platform/mutex.h"
#include "mongo/s/catalog/dist_lock_catalog.h"
#include "mongo/s/catalog/type_lockpings.h"
#include "mongo/s/catalog/type_locks.h"
namespace mongo {
/**
* Mock implementation of DistLockCatalog for testing.
*
* Example usage:
*
* DistLockCatalogMock mock;
* LocksType badLock;
* mock.expectGrabLock([](StringData lockID,
* const OID& lockSessionID,
* StringData who,
* StringData processId,
* Date_t time,
* StringData why) {
* ASSERT_EQUALS("test", lockID);
* }, badLock);
*
* mock.grabLock("test", OID(), "me", "x", Date_t::now(), "end");
*
* It is also possible to chain the callbacks. For example, if we want to set the test
* such that grabLock can only be called once, you can do this:
*
* DistLockCatalogMock mock;
* mock.expectGrabLock([&mock](...) {
* mock.expectNoGrabLock();
* }, Status::OK());
*/
class DistLockCatalogMock : public DistLockCatalog {
public:
DistLockCatalogMock();
virtual ~DistLockCatalogMock();
using GrabLockFunc = std::function<void(StringData lockID,
const OID& lockSessionID,
StringData who,
StringData processId,
Date_t time,
StringData why)>;
using OvertakeLockFunc = std::function<void(StringData lockID,
const OID& lockSessionID,
const OID& currentHolderTS,
StringData who,
StringData processId,
Date_t time,
StringData why)>;
using UnlockFunc = std::function<void(const OID& lockSessionID)>;
using PingFunc = std::function<void(StringData processID, Date_t ping)>;
using StopPingFunc = std::function<void(StringData processID)>;
using GetPingFunc = StopPingFunc;
using GetLockByTSFunc = std::function<void(const OID& ts)>;
using GetLockByNameFunc = std::function<void(StringData name)>;
using GetServerInfoFunc = std::function<void()>;
virtual StatusWith<LockpingsType> getPing(OperationContext* opCtx,
StringData processID) override;
virtual Status ping(OperationContext* opCtx, StringData processID, Date_t ping) override;
virtual StatusWith<LocksType> grabLock(OperationContext* opCtx,
StringData lockID,
const OID& lockSessionID,
StringData who,
StringData processId,
Date_t time,
StringData why,
const WriteConcernOptions& writeConcern) override;
virtual StatusWith<LocksType> overtakeLock(OperationContext* opCtx,
StringData lockID,
const OID& lockSessionID,
const OID& currentHolderTS,
StringData who,
StringData processId,
Date_t time,
StringData why) override;
virtual Status unlock(OperationContext* opCtx, const OID& lockSessionID) override;
virtual Status unlock(OperationContext* opCtx,
const OID& lockSessionID,
StringData name) override;
virtual Status unlockAll(OperationContext* opCtx, const std::string& processID) override;
virtual StatusWith<ServerInfo> getServerInfo(OperationContext* opCtx) override;
virtual StatusWith<LocksType> getLockByTS(OperationContext* opCtx,
const OID& lockSessionID) override;
virtual StatusWith<LocksType> getLockByName(OperationContext* opCtx, StringData name) override;
virtual Status stopPing(OperationContext* opCtx, StringData processId) override;
/**
* Sets the checker method to use and the return value for grabLock to return every
* time it is called.
*/
void expectGrabLock(GrabLockFunc checkerFunc, StatusWith<LocksType> returnThis);
/**
* Expect grabLock to never be called after this is called.
*/
void expectNoGrabLock();
/**
* Sets the checker method to use and the return value for unlock to return every
* time it is called.
*/
void expectUnLock(UnlockFunc checkerFunc, Status returnThis);
/**
* Sets the checker method to use and its return value the every time ping is called.
*/
void expectPing(PingFunc checkerFunc, Status returnThis);
/**
* Sets the checker method to use and its return value the every time stopPing is called.
*/
void expectStopPing(StopPingFunc checkerFunc, Status returnThis);
/**
* Sets the checker method to use and its return value the every time
* getLockByTS is called.
*/
void expectGetLockByTS(GetLockByTSFunc checkerFunc, StatusWith<LocksType> returnThis);
/**
* Sets the checker method to use and its return value the every time
* getLockByName is called.
*/
void expectGetLockByName(GetLockByNameFunc checkerFunc, StatusWith<LocksType> returnThis);
/**
* Sets the checker method to use and its return value the every time
* overtakeLock is called.
*/
void expectOvertakeLock(OvertakeLockFunc checkerFunc, StatusWith<LocksType> returnThis);
/**
* Sets the checker method to use and its return value the every time
* getPing is called.
*/
void expectGetPing(GetPingFunc checkerFunc, StatusWith<LockpingsType> returnThis);
/**
* Sets the checker method to use and its return value the every time
* getServerInfo is called.
*/
void expectGetServerInfo(GetServerInfoFunc checkerFunc,
StatusWith<DistLockCatalog::ServerInfo> returnThis);
private:
// Protects all the member variables.
Mutex _mutex = MONGO_MAKE_LATCH("DistLockCatalogMock::_mutex");
GrabLockFunc _grabLockChecker;
StatusWith<LocksType> _grabLockReturnValue;
UnlockFunc _unlockChecker;
Status _unlockReturnValue;
PingFunc _pingChecker;
Status _pingReturnValue;
StopPingFunc _stopPingChecker;
Status _stopPingReturnValue;
GetLockByTSFunc _getLockByTSChecker;
StatusWith<LocksType> _getLockByTSReturnValue;
GetLockByNameFunc _getLockByNameChecker;
StatusWith<LocksType> _getLockByNameReturnValue;
OvertakeLockFunc _overtakeLockChecker;
StatusWith<LocksType> _overtakeLockReturnValue;
GetPingFunc _getPingChecker;
StatusWith<LockpingsType> _getPingReturnValue;
GetServerInfoFunc _getServerInfoChecker;
StatusWith<DistLockCatalog::ServerInfo> _getServerInfoReturnValue;
};
} // namespace mongo
|
