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
|
/**
* 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.
*/
#include "mongo/platform/basic.h"
#include "mongo/db/op_observer_registry.h"
#include "mongo/db/op_observer_noop.h"
#include "mongo/db/operation_context_noop.h"
#include "mongo/db/repl/optime.h"
#include "mongo/unittest/death_test.h"
#include "mongo/unittest/unittest.h"
namespace mongo {
namespace {
int testObservers = 0;
struct TestObserver : public OpObserverNoop {
TestObserver() {
testObservers++;
}
virtual ~TestObserver() {
testObservers--;
}
int drops = 0;
repl::OpTime opTime;
void onDropDatabase(OperationContext* opCtx, const std::string& dbName) {
drops++;
}
repl::OpTime onDropCollection(OperationContext* opCtx,
const NamespaceString& collectionName,
OptionalCollectionUUID uuid,
std::uint64_t numRecords,
const CollectionDropType dropType) {
drops++;
OpObserver::Times::get(opCtx).reservedOpTimes.push_back(opTime);
return {};
}
void onRenameCollection(OperationContext* opCtx,
const NamespaceString& fromCollection,
const NamespaceString& toCollection,
OptionalCollectionUUID uuid,
OptionalCollectionUUID dropTargetUUID,
std::uint64_t numRecords,
bool stayTemp) {
preRenameCollection(
opCtx, fromCollection, toCollection, uuid, dropTargetUUID, numRecords, stayTemp);
postRenameCollection(opCtx, fromCollection, toCollection, uuid, dropTargetUUID, stayTemp);
}
repl::OpTime preRenameCollection(OperationContext* opCtx,
const NamespaceString& fromCollection,
const NamespaceString& toCollection,
OptionalCollectionUUID uuid,
OptionalCollectionUUID dropTargetUUID,
std::uint64_t numRecords,
bool stayTemp) {
OpObserver::Times::get(opCtx).reservedOpTimes.push_back(opTime);
return {};
}
void postRenameCollection(OperationContext* opCtx,
const NamespaceString& fromCollection,
const NamespaceString& toCollection,
OptionalCollectionUUID uuid,
OptionalCollectionUUID dropTargetUUID,
bool stayTemp) {}
};
struct ThrowingObserver : public TestObserver {
void onDropDatabase(OperationContext* opCtx, const std::string& dbName) {
drops++;
uasserted(ErrorCodes::InternalError, "throwing observer");
}
};
struct OpObserverRegistryTest : public unittest::Test {
NamespaceString testNss = {"test", "coll"};
std::unique_ptr<TestObserver> unique1 = std::make_unique<TestObserver>();
std::unique_ptr<TestObserver> unique2 = std::make_unique<TestObserver>();
TestObserver* observer1 = unique1.get();
TestObserver* observer2 = unique2.get();
OpObserverRegistry registry;
/**
* The 'op' function calls an observer method on the registry that returns an OpTime.
* The method checks that the registry correctly returns only the first observer's `OpTime`.
*/
void checkConsistentOpTime(std::function<repl::OpTime()> op) {
const repl::OpTime myTime(Timestamp(1, 1), 1);
ASSERT(op() == repl::OpTime());
observer1->opTime = myTime;
ASSERT(op() == myTime);
observer2->opTime = repl::OpTime(Timestamp(1, 1), 2);
ASSERT(op() == myTime);
observer1->opTime = {};
ASSERT(op() == repl::OpTime{});
}
/**
* The 'op' function calls an observer method on the registry that returns an OpTime.
* The method checks that the registry invariants if the observers return multiple times.
*/
void checkInconsistentOpTime(std::function<repl::OpTime()> op) {
observer1->opTime = repl::OpTime(Timestamp(1, 1), 1);
observer2->opTime = repl::OpTime(Timestamp(2, 2), 2);
op(); // This will invariant because of inconsistent timestamps: for death test.
}
};
TEST_F(OpObserverRegistryTest, NoObservers) {
OperationContextNoop opCtx;
// Check that it's OK to call observer methods with no observers registered.
registry.onDropDatabase(&opCtx, "test");
}
TEST_F(OpObserverRegistryTest, TwoObservers) {
OperationContextNoop opCtx;
ASSERT_EQUALS(testObservers, 2);
registry.addObserver(std::move(unique1));
registry.addObserver(std::move(unique2));
registry.onDropDatabase(&opCtx, "test");
ASSERT_EQUALS(observer1->drops, 1);
ASSERT_EQUALS(observer2->drops, 1);
}
TEST_F(OpObserverRegistryTest, ThrowingObserver1) {
OperationContextNoop opCtx;
unique1 = std::make_unique<ThrowingObserver>();
observer1 = unique1.get();
registry.addObserver(std::move(unique1));
registry.addObserver(std::move(unique2));
ASSERT_THROWS(registry.onDropDatabase(&opCtx, "test"), AssertionException);
ASSERT_EQUALS(observer1->drops, 1);
ASSERT_EQUALS(observer2->drops, 0);
}
TEST_F(OpObserverRegistryTest, ThrowingObserver2) {
OperationContextNoop opCtx;
unique2 = std::make_unique<ThrowingObserver>();
observer2 = unique1.get();
registry.addObserver(std::move(unique1));
registry.addObserver(std::move(unique2));
ASSERT_THROWS(registry.onDropDatabase(&opCtx, "test"), AssertionException);
ASSERT_EQUALS(observer1->drops, 1);
ASSERT_EQUALS(observer2->drops, 1);
}
TEST_F(OpObserverRegistryTest, OnDropCollectionObserverResultReturnsRightTime) {
OperationContextNoop opCtx;
registry.addObserver(std::move(unique1));
registry.addObserver(std::make_unique<OpObserverNoop>());
auto op = [&]() -> repl::OpTime {
return registry.onDropCollection(
&opCtx, testNss, {}, 0U, OpObserver::CollectionDropType::kOnePhase);
};
checkConsistentOpTime(op);
}
TEST_F(OpObserverRegistryTest, PreRenameCollectionObserverResultReturnsRightTime) {
OperationContextNoop opCtx;
registry.addObserver(std::move(unique1));
registry.addObserver(std::make_unique<OpObserverNoop>());
auto op = [&]() -> repl::OpTime {
auto opTime = registry.preRenameCollection(&opCtx, testNss, testNss, {}, {}, 0U, false);
registry.postRenameCollection(&opCtx, testNss, testNss, {}, {}, false);
return opTime;
};
checkConsistentOpTime(op);
}
DEATH_TEST_F(OpObserverRegistryTest, OnDropCollectionReturnsInconsistentTime, "invariant") {
OperationContextNoop opCtx;
registry.addObserver(std::move(unique1));
registry.addObserver(std::move(unique2));
auto op = [&]() -> repl::OpTime {
return registry.onDropCollection(
&opCtx, testNss, {}, 0U, OpObserver::CollectionDropType::kOnePhase);
};
checkInconsistentOpTime(op);
}
DEATH_TEST_F(OpObserverRegistryTest, PreRenameCollectionReturnsInconsistentTime, "invariant") {
OperationContextNoop opCtx;
registry.addObserver(std::move(unique1));
registry.addObserver(std::move(unique2));
auto op = [&]() -> repl::OpTime {
auto opTime = registry.preRenameCollection(&opCtx, testNss, testNss, {}, {}, 0U, false);
registry.postRenameCollection(&opCtx, testNss, testNss, {}, {}, false);
return opTime;
};
checkInconsistentOpTime(op);
}
} // namespace
} // namespace mongo
|
