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
|
/**
* Copyright (C) 2013-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/client/dbclientcursor.h"
#include "mongo/db/catalog/collection.h"
#include "mongo/db/catalog/database.h"
#include "mongo/db/catalog/index_catalog.h"
#include "mongo/db/client.h"
#include "mongo/db/db_raii.h"
#include "mongo/db/dbdirectclient.h"
#include "mongo/db/exec/distinct_scan.h"
#include "mongo/db/exec/plan_stage.h"
#include "mongo/db/json.h"
#include "mongo/db/namespace_string.h"
#include "mongo/db/query/index_bounds_builder.h"
#include "mongo/db/query/plan_executor.h"
#include "mongo/dbtests/dbtests.h"
/**
* This file tests db/exec/distinct.cpp
*/
namespace QueryStageDistinct {
static const NamespaceString nss{"unittests.QueryStageDistinct"};
class DistinctBase {
public:
DistinctBase() : _client(&_opCtx) {}
virtual ~DistinctBase() {
_client.dropCollection(nss.ns());
}
void addIndex(const BSONObj& obj) {
ASSERT_OK(dbtests::createIndex(&_opCtx, nss.ns(), obj));
}
void insert(const BSONObj& obj) {
_client.insert(nss.ns(), obj);
}
/**
* Returns the projected value from the working set that would
* be returned in the 'values' field of the distinct command result.
* Limited to NumberInt BSON types because this is the only
* BSON type used in this suite of tests.
*/
static int getIntFieldDotted(const WorkingSet& ws,
WorkingSetID wsid,
const std::string& field) {
// For some reason (at least under OS X clang), we cannot refer to INVALID_ID
// inside the test assertion macro.
WorkingSetID invalid = WorkingSet::INVALID_ID;
ASSERT_NOT_EQUALS(invalid, wsid);
WorkingSetMember* member = ws.get(wsid);
// Distinct hack execution is always covered.
// Key value is retrieved from working set key data
// instead of RecordId.
ASSERT_FALSE(member->hasObj());
BSONElement keyElt;
ASSERT_TRUE(member->getFieldDotted(field, &keyElt));
ASSERT_TRUE(keyElt.isNumber());
return keyElt.numberInt();
}
protected:
const ServiceContext::UniqueOperationContext _txnPtr = cc().makeOperationContext();
OperationContext& _opCtx = *_txnPtr;
private:
DBDirectClient _client;
};
// Tests distinct with single key indices.
class QueryStageDistinctBasic : public DistinctBase {
public:
virtual ~QueryStageDistinctBasic() {}
void run() {
// Insert a ton of documents with a: 1
for (size_t i = 0; i < 1000; ++i) {
insert(BSON("a" << 1));
}
// Insert a ton of other documents with a: 2
for (size_t i = 0; i < 1000; ++i) {
insert(BSON("a" << 2));
}
// Make an index on a:1
addIndex(BSON("a" << 1));
AutoGetCollectionForReadCommand ctx(&_opCtx, nss);
Collection* coll = ctx.getCollection();
// Set up the distinct stage.
std::vector<IndexDescriptor*> indexes;
coll->getIndexCatalog()->findIndexesByKeyPattern(&_opCtx, BSON("a" << 1), false, &indexes);
ASSERT_EQ(indexes.size(), 1U);
DistinctParams params;
params.descriptor = indexes[0];
params.direction = 1;
// Distinct-ing over the 0-th field of the keypattern.
params.fieldNo = 0;
// We'll look at all values in the bounds.
params.bounds.isSimpleRange = false;
OrderedIntervalList oil("a");
oil.intervals.push_back(IndexBoundsBuilder::allValues());
params.bounds.fields.push_back(oil);
WorkingSet ws;
DistinctScan distinct(&_opCtx, params, &ws);
WorkingSetID wsid;
// Get our first result.
int firstResultWorks = 0;
while (PlanStage::ADVANCED != distinct.work(&wsid)) {
++firstResultWorks;
}
// 5 is a bogus number. There's some amount of setup done by the first few calls but
// we should return the first result relatively promptly.
ASSERT_LESS_THAN(firstResultWorks, 5);
ASSERT_EQUALS(1, getIntFieldDotted(ws, wsid, "a"));
// Getting our second result should be very quick as we just skip
// over the first result.
int secondResultWorks = 0;
while (PlanStage::ADVANCED != distinct.work(&wsid)) {
++secondResultWorks;
}
ASSERT_EQUALS(2, getIntFieldDotted(ws, wsid, "a"));
// This is 0 because we don't have to loop for several values; we just skip over
// all the 'a' values.
ASSERT_EQUALS(0, secondResultWorks);
ASSERT_EQUALS(PlanStage::IS_EOF, distinct.work(&wsid));
}
};
// Tests distinct with multikey indices.
class QueryStageDistinctMultiKey : public DistinctBase {
public:
virtual ~QueryStageDistinctMultiKey() {}
void run() {
// Insert a ton of documents with a: [1, 2, 3]
for (size_t i = 0; i < 1000; ++i) {
insert(BSON("a" << BSON_ARRAY(1 << 2 << 3)));
}
// Insert a ton of other documents with a: [4, 5, 6]
for (size_t i = 0; i < 1000; ++i) {
insert(BSON("a" << BSON_ARRAY(4 << 5 << 6)));
}
// Make an index on a:1
addIndex(BSON("a" << 1));
AutoGetCollectionForReadCommand ctx(&_opCtx, nss);
Collection* coll = ctx.getCollection();
// Set up the distinct stage.
std::vector<IndexDescriptor*> indexes;
coll->getIndexCatalog()->findIndexesByKeyPattern(&_opCtx, BSON("a" << 1), false, &indexes);
verify(indexes.size() == 1);
DistinctParams params;
params.descriptor = indexes[0];
ASSERT_TRUE(params.descriptor->isMultikey(&_opCtx));
verify(params.descriptor);
params.direction = 1;
// Distinct-ing over the 0-th field of the keypattern.
params.fieldNo = 0;
// We'll look at all values in the bounds.
params.bounds.isSimpleRange = false;
OrderedIntervalList oil("a");
oil.intervals.push_back(IndexBoundsBuilder::allValues());
params.bounds.fields.push_back(oil);
WorkingSet ws;
DistinctScan distinct(&_opCtx, params, &ws);
// We should see each number in the range [1, 6] exactly once.
std::set<int> seen;
WorkingSetID wsid;
PlanStage::StageState state;
while (PlanStage::IS_EOF != (state = distinct.work(&wsid))) {
if (PlanStage::ADVANCED == state) {
// Check int value.
int currentNumber = getIntFieldDotted(ws, wsid, "a");
ASSERT_GREATER_THAN_OR_EQUALS(currentNumber, 1);
ASSERT_LESS_THAN_OR_EQUALS(currentNumber, 6);
// Should see this number only once.
ASSERT_TRUE(seen.find(currentNumber) == seen.end());
seen.insert(currentNumber);
}
}
ASSERT_EQUALS(6U, seen.size());
}
};
class QueryStageDistinctCompoundIndex : public DistinctBase {
public:
void run() {
// insert documents with a: 1 and b: 1
for (size_t i = 0; i < 1000; ++i) {
insert(BSON("a" << 1 << "b" << 1));
}
// insert documents with a: 1 and b: 2
for (size_t i = 0; i < 1000; ++i) {
insert(BSON("a" << 1 << "b" << 2));
}
// insert documents with a: 2 and b: 1
for (size_t i = 0; i < 1000; ++i) {
insert(BSON("a" << 2 << "b" << 1));
}
// insert documents with a: 2 and b: 3
for (size_t i = 0; i < 1000; ++i) {
insert(BSON("a" << 2 << "b" << 3));
}
addIndex(BSON("a" << 1 << "b" << 1));
AutoGetCollectionForReadCommand ctx(&_opCtx, nss);
Collection* coll = ctx.getCollection();
std::vector<IndexDescriptor*> indices;
coll->getIndexCatalog()->findIndexesByKeyPattern(
&_opCtx, BSON("a" << 1 << "b" << 1), false, &indices);
ASSERT_EQ(1U, indices.size());
DistinctParams params;
params.descriptor = indices[0];
ASSERT_TRUE(params.descriptor);
params.direction = 1;
params.fieldNo = 1;
params.bounds.isSimpleRange = false;
OrderedIntervalList aOil{"a"};
aOil.intervals.push_back(IndexBoundsBuilder::allValues());
params.bounds.fields.push_back(aOil);
OrderedIntervalList bOil{"b"};
bOil.intervals.push_back(IndexBoundsBuilder::allValues());
params.bounds.fields.push_back(bOil);
WorkingSet ws;
DistinctScan distinct(&_opCtx, params, &ws);
WorkingSetID wsid;
PlanStage::StageState state;
std::vector<int> seen;
while (PlanStage::IS_EOF != (state = distinct.work(&wsid))) {
ASSERT_NE(PlanStage::FAILURE, state);
ASSERT_NE(PlanStage::DEAD, state);
if (PlanStage::ADVANCED == state) {
seen.push_back(getIntFieldDotted(ws, wsid, "b"));
}
}
ASSERT_EQUALS(4U, seen.size());
ASSERT_EQUALS(1, seen[0]);
ASSERT_EQUALS(2, seen[1]);
ASSERT_EQUALS(1, seen[2]);
ASSERT_EQUALS(3, seen[3]);
}
};
// XXX: add a test case with bounds where skipping to the next key gets us a result that's not
// valid w.r.t. our query.
class All : public Suite {
public:
All() : Suite("query_stage_distinct") {}
void setupTests() {
add<QueryStageDistinctBasic>();
add<QueryStageDistinctMultiKey>();
add<QueryStageDistinctCompoundIndex>();
}
};
SuiteInstance<All> queryStageDistinctAll;
} // namespace QueryStageDistinct
|