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
|
// documentsourcetests.cpp : Unit tests for DocumentSource classes.
/**
* Copyright (C) 2012-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.
*/
#include "mongo/platform/basic.h"
#include "mongo/db/catalog/collection.h"
#include "mongo/db/client.h"
#include "mongo/db/db_raii.h"
#include "mongo/db/dbdirectclient.h"
#include "mongo/db/exec/multi_plan.h"
#include "mongo/db/exec/plan_stage.h"
#include "mongo/db/pipeline/dependencies.h"
#include "mongo/db/pipeline/document_source.h"
#include "mongo/db/pipeline/document_source_cursor.h"
#include "mongo/db/pipeline/document_value_test_util.h"
#include "mongo/db/pipeline/expression_context_for_test.h"
#include "mongo/db/pipeline/pipeline.h"
#include "mongo/db/query/get_executor.h"
#include "mongo/db/query/plan_executor.h"
#include "mongo/db/query/query_planner.h"
#include "mongo/db/query/stage_builder.h"
#include "mongo/dbtests/dbtests.h"
namespace DocumentSourceCursorTests {
using boost::intrusive_ptr;
using std::unique_ptr;
using std::vector;
static const NamespaceString nss("unittests.documentsourcetests");
static const BSONObj metaTextScore = BSON("$meta"
<< "textScore");
BSONObj toBson(const intrusive_ptr<DocumentSource>& source) {
vector<Value> arr;
source->serializeToArray(arr);
ASSERT_EQUALS(arr.size(), 1UL);
return arr[0].getDocument().toBson();
}
class CollectionBase {
public:
CollectionBase() : client(&_opCtx) {}
~CollectionBase() {
client.dropCollection(nss.ns());
}
protected:
const ServiceContext::UniqueOperationContext _opCtxPtr = cc().makeOperationContext();
OperationContext& _opCtx = *_opCtxPtr;
DBDirectClient client;
};
namespace DocumentSourceCursor {
using mongo::DocumentSourceCursor;
class Base : public CollectionBase {
public:
Base() : _ctx(new ExpressionContextForTest(&_opCtx, AggregationRequest(nss, {}))) {
_ctx->tempDir = storageGlobalParams.dbpath + "/_tmp";
}
protected:
void createSource(boost::optional<BSONObj> hint = boost::none) {
// clean up first if this was called before
_source.reset();
OldClientWriteContext ctx(&_opCtx, nss.ns());
auto qr = stdx::make_unique<QueryRequest>(nss);
if (hint) {
qr->setHint(*hint);
}
auto cq = uassertStatusOK(CanonicalQuery::canonicalize(&_opCtx, std::move(qr)));
auto exec = uassertStatusOK(
getExecutor(&_opCtx, ctx.getCollection(), std::move(cq), PlanExecutor::NO_YIELD));
exec->saveState();
_source = DocumentSourceCursor::create(ctx.getCollection(), std::move(exec), _ctx);
}
intrusive_ptr<ExpressionContextForTest> ctx() {
return _ctx;
}
DocumentSourceCursor* source() {
return _source.get();
}
private:
// It is important that these are ordered to ensure correct destruction order.
intrusive_ptr<ExpressionContextForTest> _ctx;
intrusive_ptr<DocumentSourceCursor> _source;
};
/** Create a DocumentSourceCursor. */
class Empty : public Base {
public:
void run() {
createSource();
// The DocumentSourceCursor doesn't hold a read lock.
ASSERT(!_opCtx.lockState()->isReadLocked());
// The collection is empty, so the source produces no results.
ASSERT(source()->getNext().isEOF());
// Exhausting the source releases the read lock.
ASSERT(!_opCtx.lockState()->isReadLocked());
}
};
/** Iterate a DocumentSourceCursor. */
class Iterate : public Base {
public:
void run() {
client.insert(nss.ns(), BSON("a" << 1));
createSource();
// The DocumentSourceCursor doesn't hold a read lock.
ASSERT(!_opCtx.lockState()->isReadLocked());
// The cursor will produce the expected result.
auto next = source()->getNext();
ASSERT(next.isAdvanced());
ASSERT_VALUE_EQ(Value(1), next.getDocument().getField("a"));
// There are no more results.
ASSERT(source()->getNext().isEOF());
// Exhausting the source releases the read lock.
ASSERT(!_opCtx.lockState()->isReadLocked());
}
};
/** Dispose of a DocumentSourceCursor. */
class Dispose : public Base {
public:
void run() {
createSource();
// The DocumentSourceCursor doesn't hold a read lock.
ASSERT(!_opCtx.lockState()->isReadLocked());
source()->dispose();
// Releasing the cursor releases the read lock.
ASSERT(!_opCtx.lockState()->isReadLocked());
// The source is marked as exhausted.
ASSERT(source()->getNext().isEOF());
}
};
/** Iterate a DocumentSourceCursor and then dispose of it. */
class IterateDispose : public Base {
public:
void run() {
client.insert(nss.ns(), BSON("a" << 1));
client.insert(nss.ns(), BSON("a" << 2));
client.insert(nss.ns(), BSON("a" << 3));
createSource();
// The result is as expected.
auto next = source()->getNext();
ASSERT(next.isAdvanced());
ASSERT_VALUE_EQ(Value(1), next.getDocument().getField("a"));
// The next result is as expected.
next = source()->getNext();
ASSERT(next.isAdvanced());
ASSERT_VALUE_EQ(Value(2), next.getDocument().getField("a"));
// The DocumentSourceCursor doesn't hold a read lock.
ASSERT(!_opCtx.lockState()->isReadLocked());
source()->dispose();
// Disposing of the source releases the lock.
ASSERT(!_opCtx.lockState()->isReadLocked());
// The source cannot be advanced further.
ASSERT(source()->getNext().isEOF());
}
};
/** Set a value or await an expected value. */
class PendingValue {
public:
PendingValue(int initialValue) : _value(initialValue) {}
void set(int newValue) {
stdx::lock_guard<stdx::mutex> lk(_mutex);
_value = newValue;
_condition.notify_all();
}
void await(int expectedValue) const {
stdx::unique_lock<stdx::mutex> lk(_mutex);
while (_value != expectedValue) {
_condition.wait(lk);
}
}
private:
int _value;
mutable stdx::mutex _mutex;
mutable stdx::condition_variable _condition;
};
/** Test coalescing a limit into a cursor */
class LimitCoalesce : public Base {
public:
intrusive_ptr<DocumentSourceLimit> mkLimit(long long limit) {
return DocumentSourceLimit::create(ctx(), limit);
}
void run() {
client.insert(nss.ns(), BSON("a" << 1));
client.insert(nss.ns(), BSON("a" << 2));
client.insert(nss.ns(), BSON("a" << 3));
createSource();
Pipeline::SourceContainer container;
container.push_back(source());
container.push_back(mkLimit(10));
source()->optimizeAt(container.begin(), &container);
// initial limit becomes limit of cursor
ASSERT_EQUALS(container.size(), 1U);
ASSERT_EQUALS(source()->getLimit(), 10);
container.push_back(mkLimit(2));
source()->optimizeAt(container.begin(), &container);
// smaller limit lowers cursor limit
ASSERT_EQUALS(container.size(), 1U);
ASSERT_EQUALS(source()->getLimit(), 2);
container.push_back(mkLimit(3));
source()->optimizeAt(container.begin(), &container);
// higher limit doesn't effect cursor limit
ASSERT_EQUALS(container.size(), 1U);
ASSERT_EQUALS(source()->getLimit(), 2);
// The cursor allows exactly 2 documents through
ASSERT(source()->getNext().isAdvanced());
ASSERT(source()->getNext().isAdvanced());
ASSERT(source()->getNext().isEOF());
}
};
//
// Test cursor output sort.
//
class CollectionScanProvidesNoSort : public Base {
public:
void run() {
createSource(BSON("$natural" << 1));
ASSERT_EQ(source()->getOutputSorts().size(), 0U);
source()->dispose();
}
};
class IndexScanProvidesSortOnKeys : public Base {
public:
void run() {
client.createIndex(nss.ns(), BSON("a" << 1));
createSource(BSON("a" << 1));
ASSERT_EQ(source()->getOutputSorts().size(), 1U);
ASSERT_EQ(source()->getOutputSorts().count(BSON("a" << 1)), 1U);
source()->dispose();
}
};
class ReverseIndexScanProvidesSort : public Base {
public:
void run() {
client.createIndex(nss.ns(), BSON("a" << -1));
createSource(BSON("a" << -1));
ASSERT_EQ(source()->getOutputSorts().size(), 1U);
ASSERT_EQ(source()->getOutputSorts().count(BSON("a" << -1)), 1U);
source()->dispose();
}
};
class CompoundIndexScanProvidesMultipleSorts : public Base {
public:
void run() {
client.createIndex(nss.ns(), BSON("a" << 1 << "b" << -1));
createSource(BSON("a" << 1 << "b" << -1));
ASSERT_EQ(source()->getOutputSorts().size(), 2U);
ASSERT_EQ(source()->getOutputSorts().count(BSON("a" << 1)), 1U);
ASSERT_EQ(source()->getOutputSorts().count(BSON("a" << 1 << "b" << -1)), 1U);
source()->dispose();
}
};
class SerializationRespectsExplainModes : public Base {
public:
void run() {
createSource();
{
// Nothing serialized when no explain mode specified.
auto explainResult = source()->serialize();
ASSERT_TRUE(explainResult.missing());
}
{
auto explainResult = source()->serialize(ExplainOptions::Verbosity::kQueryPlanner);
ASSERT_FALSE(explainResult["$cursor"]["queryPlanner"].missing());
ASSERT_TRUE(explainResult["$cursor"]["executionStats"].missing());
}
{
auto explainResult = source()->serialize(ExplainOptions::Verbosity::kExecStats);
ASSERT_FALSE(explainResult["$cursor"]["queryPlanner"].missing());
ASSERT_FALSE(explainResult["$cursor"]["executionStats"].missing());
ASSERT_TRUE(explainResult["$cursor"]["executionStats"]["allPlansExecution"].missing());
}
{
auto explainResult =
source()->serialize(ExplainOptions::Verbosity::kExecAllPlans).getDocument();
ASSERT_FALSE(explainResult["$cursor"]["queryPlanner"].missing());
ASSERT_FALSE(explainResult["$cursor"]["executionStats"].missing());
ASSERT_FALSE(explainResult["$cursor"]["executionStats"]["allPlansExecution"].missing());
}
source()->dispose();
}
};
} // namespace DocumentSourceCursor
class All : public Suite {
public:
All() : Suite("documentsource") {}
void setupTests() {
add<DocumentSourceCursor::Empty>();
add<DocumentSourceCursor::Iterate>();
add<DocumentSourceCursor::Dispose>();
add<DocumentSourceCursor::IterateDispose>();
add<DocumentSourceCursor::LimitCoalesce>();
add<DocumentSourceCursor::CollectionScanProvidesNoSort>();
add<DocumentSourceCursor::IndexScanProvidesSortOnKeys>();
add<DocumentSourceCursor::ReverseIndexScanProvidesSort>();
add<DocumentSourceCursor::CompoundIndexScanProvidesMultipleSorts>();
add<DocumentSourceCursor::SerializationRespectsExplainModes>();
}
};
SuiteInstance<All> myall;
} // namespace DocumentSourceCursorTests
|