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
|
/**
* Copyright (C) 2015 10gen 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.
*/
#pragma once
#include <memory>
#include <ostream>
#include <string>
#include <vector>
#include "mongo/base/owned_pointer_vector.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/json.h"
#include "mongo/db/query/query_solution.h"
#include "mongo/unittest/unittest.h"
namespace mongo {
class QueryPlannerTest : public mongo::unittest::Test {
protected:
void setUp();
//
// Build up test.
//
void addIndex(BSONObj keyPattern, bool multikey = false);
void addIndex(BSONObj keyPattern, bool multikey, bool sparse);
void addIndex(BSONObj keyPattern, bool multikey, bool sparse, bool unique);
void addIndex(BSONObj keyPattern, BSONObj infoObj);
//
// Execute planner.
//
void runQuery(BSONObj query);
void runQuerySortProj(const BSONObj& query, const BSONObj& sort, const BSONObj& proj);
void runQuerySkipLimit(const BSONObj& query, long long skip, long long limit);
void runQueryHint(const BSONObj& query, const BSONObj& hint);
void runQuerySortProjSkipLimit(const BSONObj& query,
const BSONObj& sort,
const BSONObj& proj,
long long skip,
long long limit);
void runQuerySortHint(const BSONObj& query, const BSONObj& sort, const BSONObj& hint);
void runQueryHintMinMax(const BSONObj& query,
const BSONObj& hint,
const BSONObj& minObj,
const BSONObj& maxObj);
void runQuerySortProjSkipLimitHint(const BSONObj& query,
const BSONObj& sort,
const BSONObj& proj,
long long skip,
long long limit,
const BSONObj& hint);
void runQuerySnapshot(const BSONObj& query);
void runQueryFull(const BSONObj& query,
const BSONObj& sort,
const BSONObj& proj,
long long skip,
long long limit,
const BSONObj& hint,
const BSONObj& minObj,
const BSONObj& maxObj,
bool snapshot);
//
// Same as runQuery* functions except we expect a failed status from the planning stage.
//
void runInvalidQuery(const BSONObj& query);
void runInvalidQuerySortProj(const BSONObj& query, const BSONObj& sort, const BSONObj& proj);
void runInvalidQuerySortProjSkipLimit(const BSONObj& query,
const BSONObj& sort,
const BSONObj& proj,
long long skip,
long long limit);
void runInvalidQueryHint(const BSONObj& query, const BSONObj& hint);
void runInvalidQueryHintMinMax(const BSONObj& query,
const BSONObj& hint,
const BSONObj& minObj,
const BSONObj& maxObj);
void runInvalidQuerySortProjSkipLimitHint(const BSONObj& query,
const BSONObj& sort,
const BSONObj& proj,
long long skip,
long long limit,
const BSONObj& hint);
void runInvalidQueryFull(const BSONObj& query,
const BSONObj& sort,
const BSONObj& proj,
long long skip,
long long limit,
const BSONObj& hint,
const BSONObj& minObj,
const BSONObj& maxObj,
bool snapshot);
/**
* The other runQuery* methods run the query as through it is an OP_QUERY style find. This
* version goes through find command parsing, and will be planned like a find command.
*/
void runQueryAsCommand(const BSONObj& cmdObj);
//
// Introspect solutions.
//
size_t getNumSolutions() const;
void dumpSolutions() const;
void dumpSolutions(mongoutils::str::stream& ost) const;
/**
* Checks number solutions. Generates assertion message
* containing solution dump if applicable.
*/
void assertNumSolutions(size_t expectSolutions) const;
size_t numSolutionMatches(const std::string& solnJson) const;
/**
* Verifies that the solution tree represented in json by 'solnJson' is
* one of the solutions generated by QueryPlanner.
*
* The number of expected matches, 'numMatches', could be greater than
* 1 if solutions differ only by the pattern of index tags on a filter.
*/
void assertSolutionExists(const std::string& solnJson, size_t numMatches = 1) const;
/**
* Given a vector of string-based solution tree representations 'solnStrs',
* verifies that the query planner generated exactly one of these solutions.
*/
void assertHasOneSolutionOf(const std::vector<std::string>& solnStrs) const;
//
// Data members.
//
static const char* ns;
BSONObj queryObj;
std::unique_ptr<CanonicalQuery> cq;
QueryPlannerParams params;
OwnedPointerVector<QuerySolution> solns;
};
} // namespace mongo
|
