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
|
/**
* Copyright (C) 2022-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 "mongo/db/bson/dotted_path_support.h"
#include "mongo/db/query/ce/hinted_estimator.h"
#include "mongo/db/query/cost_model/cost_model_gen.h"
#include "mongo/db/query/optimizer/defs.h"
#include "mongo/db/query/optimizer/explain.h"
#include "mongo/db/query/optimizer/opt_phase_manager.h"
#include "mongo/db/query/optimizer/utils/utils.h"
namespace mongo::optimizer {
void maybePrintABT(const ABT& abt);
std::string getPropsStrForExplain(const OptPhaseManager& phaseManager);
bool handleAutoUpdate(const std::string& expected,
const std::string& actual,
const std::string& fileName,
size_t lineNumber);
/**
* Auto update result back in the source file if the assert fails.
* The expected result must be a multi-line string in the following form:
*
* ASSERT_EXPLAIN_V2_AUTO( // NOLINT
* "BinaryOp [Add]\n"
* "| Const [2]\n"
* "Const [1]\n",
* tree);
*
* Limitations:
* 1. There should not be any comments or other formatting inside the multi-line string
* constant other than 'NOLINT'. If we have a single-line constant, the auto-updating will
* generate a 'NOLINT' at the end of the line.
* 2. The expression which we are explaining ('tree' in the example above) must fit on a single
* line. The macro should be indented by 4 spaces.
*
* TODO: SERVER-71004: Extend the usability of the auto-update macro.
*/
#define ASSERT_STR_EQ_AUTO(expected, actual) \
ASSERT(handleAutoUpdate(expected, actual, __FILE__, __LINE__))
#define ASSERT_EXPLAIN(expected, abt) \
maybePrintABT(abt); \
ASSERT_EQ(expected, ExplainGenerator::explain(abt))
// Do not remove macro even if unused: used to update tests before committing code.
#define ASSERT_EXPLAIN_AUTO(expected, abt) \
maybePrintABT(abt); \
ASSERT_STR_EQ(expected, ExplainGenerator::explain(abt))
#define ASSERT_EXPLAIN_V2(expected, abt) \
maybePrintABT(abt); \
ASSERT_EQ(expected, ExplainGenerator::explainV2(abt))
// Do not remove macro even if unused: used to update tests before committing code.
#define ASSERT_EXPLAIN_V2_AUTO(expected, abt) \
maybePrintABT(abt); \
ASSERT_STR_EQ_AUTO(expected, ExplainGenerator::explainV2(abt))
#define ASSERT_EXPLAIN_V2Compact(expected, abt) \
maybePrintABT(abt); \
ASSERT_EQ(expected, ExplainGenerator::explainV2Compact(abt))
// Do not remove macro even if unused: used to update tests before committing code.
#define ASSERT_EXPLAIN_V2Compact_AUTO(expected, abt) \
maybePrintABT(abt); \
ASSERT_STR_EQ_AUTO(expected, ExplainGenerator::explainV2Compact(abt))
#define ASSERT_EXPLAIN_BSON(expected, abt) \
maybePrintABT(abt); \
ASSERT_EQ(expected, ExplainGenerator::explainBSONStr(abt))
// Do not remove macro even if unused: used to update tests before committing code.
#define ASSERT_EXPLAIN_BSON_AUTO(expected, abt) \
maybePrintABT(abt); \
ASSERT_STR_EQ_AUTO(expected, ExplainGenerator::explainBSONStr(abt))
#define ASSERT_EXPLAIN_PROPS_V2(expected, phaseManager) \
ASSERT_EQ(expected, getPropsStrForExplain(phaseManager))
// Do not remove macro even if unused: used to update tests before committing code.
#define ASSERT_EXPLAIN_PROPS_V2_AUTO(expected, phaseManager) \
ASSERT_STR_EQ_AUTO(expected, getPropsStrForExplain(phaseManager))
#define ASSERT_EXPLAIN_MEMO(expected, memo) ASSERT_EQ(expected, ExplainGenerator::explainMemo(memo))
// Do not remove macro even if unused: used to update tests before committing code.
#define ASSERT_EXPLAIN_MEMO_AUTO(expected, memo) \
ASSERT_STR_EQ_AUTO(expected, ExplainGenerator::explainMemo(memo))
#define ASSERT_INTERVAL(expected, interval) \
ASSERT_EQ(expected, ExplainGenerator::explainIntervalExpr(interval))
// Do not remove macro even if unused: used to update tests before committing code.
#define ASSERT_INTERVAL_AUTO(expected, interval) \
ASSERT_STR_EQ_AUTO(expected, ExplainGenerator::explainIntervalExpr(interval))
#define ASSERT_BSON_PATH(expected, bson, path) \
ASSERT_EQ(expected, \
dotted_path_support::extractElementAtPath(bson, path) \
.toString(false /*includeFieldName*/));
#define ASSERT_BETWEEN(a, b, value) \
ASSERT_LTE(a, value); \
ASSERT_GTE(b, value);
struct TestIndexField {
FieldNameType fieldName;
CollationOp op;
bool isMultiKey;
};
ABT makeIndexPath(FieldPathType fieldPath, bool isMultiKey = true);
ABT makeIndexPath(FieldNameType fieldName);
ABT makeNonMultikeyIndexPath(FieldNameType fieldName);
/**
* Constructs metadata for an an index on a single, non-dotted field.
*/
IndexDefinition makeIndexDefinition(FieldNameType fieldName,
CollationOp op,
bool isMultiKey = true);
IndexDefinition makeCompositeIndexDefinition(std::vector<TestIndexField> indexFields,
bool isMultiKey = true);
/**
* A factory function to create a heuristic-based cardinality estimator.
*/
std::unique_ptr<CardinalityEstimator> makeHeuristicCE();
/**
* A factory function to create a hint-based cardinality estimator.
*/
std::unique_ptr<CardinalityEstimator> makeHintedCE(ce::PartialSchemaSelHints hints);
/**
* A convenience factory function to create costing.
*/
std::unique_ptr<CostEstimator> makeCostEstimator();
/**
* A convenience factory function to create OptPhaseManager for unit tests.
*/
OptPhaseManager makePhaseManager(OptPhaseManager::PhaseSet phaseSet,
PrefixId& prefixId,
Metadata metadata,
DebugInfo debugInfo,
QueryHints queryHints = {});
/**
* A convenience factory function to create OptPhaseManager for unit tests with CE hints.
*/
OptPhaseManager makePhaseManager(OptPhaseManager::PhaseSet phaseSet,
PrefixId& prefixId,
Metadata metadata,
std::unique_ptr<CardinalityEstimator> ce,
DebugInfo debugInfo,
QueryHints queryHints = {});
/**
* A convenience factory function to create OptPhaseManager for unit tests with cost models.
*/
OptPhaseManager makePhaseManager(OptPhaseManager::PhaseSet phaseSet,
PrefixId& prefixId,
Metadata metadata,
DebugInfo debugInfo,
mongo::cost_model::CostModelCoefficients coefs,
QueryHints queryHints = {});
/**
* A convenience factory function to create OptPhaseManager for unit tests which requires RID.
*/
OptPhaseManager makePhaseManagerRequireRID(OptPhaseManager::PhaseSet phaseSet,
PrefixId& prefixId,
Metadata metadata,
DebugInfo debugInfo,
QueryHints queryHints = {});
} // namespace mongo::optimizer
|
