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
|
/**
* 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.
*/
#include "mongo/db/index/column_cell.h"
#include "mongo/db/storage/column_store.h"
#include "mongo/unittest/unittest.h"
#include "mongo/util/hex.h"
#include "mongo/util/str.h"
namespace mongo {
TEST(ColumnCell, AppendElementToCellTest) {
auto referenceBson =
BSON_ARRAY(int32_t(0) << int64_t(5000) << "Help, I'm trapped in a columnar index."
<< Decimal128("123.456"));
// Initialize a buffer with the expected output of translating 'referenceBson' in the columnar
// index format.
auto [expectedCell, expectedCellLength] = []() {
BufBuilder expectedBuffer;
// Write 0 as an int32.
expectedBuffer.appendChar(ColumnStore::Bytes::TinyNum::kTinyIntZero);
// Write 5000 as an int64 (represented in 2 bytes).
expectedBuffer.appendChar(ColumnStore::Bytes::kLong2);
expectedBuffer.appendNum(short(5000));
// Write a strange message.
const char* message = "Help, I'm trapped in a columnar index.";
expectedBuffer.appendChar(ColumnStore::Bytes::kStringSizeMin + strlen(message));
expectedBuffer.appendStr(message, false /* includeEndingNull */);
Decimal128 decimalNum("123.456");
expectedBuffer.appendChar(ColumnStore::Bytes::kDecimal128);
expectedBuffer.appendNum(decimalNum);
auto expectedCellLength = expectedBuffer.len();
return std::make_pair(expectedBuffer.release(), expectedCellLength);
}();
// Use the 'appendElementToCell()' function, which is the function being tested, to compute the
// transformed 'referenceBson' in columnar index format.
BufBuilder cellBuffer;
for (auto&& element : referenceBson) {
column_keygen::appendElementToCell(element, &cellBuffer);
}
// Ensure that the output of 'appendElementToCell()' matches the expected output.
ASSERT_EQ(hexblob::encode(cellBuffer.buf(), cellBuffer.len()),
hexblob::encode(expectedCell.get(), expectedCellLength));
// Repeat the test, but this time we manually construct the expected string of bytes instead of
// building it out of the constansts in the 'ColumnStore::Bytes' class. The column cell format
// is an on-disk format and should never change.
ASSERT_EQ(
"4A3D8813A648656C702C2049276D207472617070656420696E206120636F6C756D6E617220696E6465782E3040"
"E20100000000000000000000003A30",
hexblob::encode(cellBuffer.buf(), cellBuffer.len()));
}
namespace {
std::vector<BSONElement> getBsonElements(const BSONArray& obj) {
std::vector<BSONElement> elementsVector;
obj.elems(elementsVector);
return elementsVector;
}
} // namespace
TEST(ColumnCellAppendElement, WriteEncodedCellWithHasSubPathsTest) {
// Test document: {a: [null, {b: 1}]}.
auto referenceBson = BSON_ARRAY(BSONNULL);
// What the cell would look like with "a" as the path.
column_keygen::UnencodedCellView unencodedCell = {
getBsonElements(referenceBson),
"[|o"_sd,
false, // hasDuplicateFields
true, // hasSubPaths
false, // isSparse
false, // hasDoubleNestedArrays
};
BufBuilder cellBuffer;
writeEncodedCell(unencodedCell, &cellBuffer);
ASSERT_EQ("FDD2205B7C6F", hexblob::encode(cellBuffer.buf(), cellBuffer.len()));
}
TEST(ColumnCellAppendElement, WriteEncodedCellWithHasIsSparseAndHasDoubleNestedArraysTest) {
// Test document: {a: [[{b: null}], {b: null}, {c: 1}]}
auto referenceBson = BSON_ARRAY(BSONNULL << BSONNULL);
// What the cell would look like with "a.b" as the path.
column_keygen::UnencodedCellView unencodedCell = {
getBsonElements(referenceBson),
"[[|]"_sd,
false, // hasDuplicateFields
false, // hasSubPaths
true, // isSparse
true, // hasDoubleNestedArrays
};
BufBuilder cellBuffer;
writeEncodedCell(unencodedCell, &cellBuffer);
ASSERT_EQ("FEFFD320205B5B7C5D", hexblob::encode(cellBuffer.buf(), cellBuffer.len()));
}
TEST(ColumnCellAppendElement, WriteEncodedCellWithDuplicateFieldsTest) {
// Test document: {a: null, a: null} (Note: INVALID document in context of index storage)
auto referenceBson = BSON_ARRAY(BSONNULL << BSONNULL);
// What the invalid cell would look like with "a" as the path.
column_keygen::UnencodedCellView unencodedCell = {
// These should _not_ get included in the output.
getBsonElements(referenceBson),
"{"_sd,
// This flag is the only thing that gets included.
true, // hasDuplicateFields
false, // hasSubPaths
false, // isSparse
false, // hasDoubleNestedArrays
};
BufBuilder cellBuffer;
writeEncodedCell(unencodedCell, &cellBuffer);
ASSERT_EQ("FC", hexblob::encode(cellBuffer.buf(), cellBuffer.len()));
}
TEST(ColumnCellAppendElement, WriteEncodedCellWithArrInfoSize1) {
// This test does not use a realistic cell. A cell with a 100-byte arrayInfo would be great fun
// but also needlessly complicated for a unit test.
std::string arrayInfo(100, '{');
column_keygen::UnencodedCellView unencodedCell = {{}, arrayInfo, false, false, false, false};
BufBuilder cellBuffer;
writeEncodedCell(unencodedCell, &cellBuffer);
ASSERT_EQ(102, cellBuffer.len());
ASSERT_EQ("ED64", hexblob::encode(cellBuffer.buf(), 2));
ASSERT_EQ(std::string(&cellBuffer.buf()[2], 100), arrayInfo);
}
TEST(ColumnCellAppendElement, WriteEncodedCellWithArrInfoSize2) {
// This test does not use a realistic cell. A cell with a 1KB arrayInfo would be delightful but
// also needlessly complicated for a unit test.
std::string arrayInfo(1024, '{');
column_keygen::UnencodedCellView unencodedCell = {{}, arrayInfo, false, false, false, false};
BufBuilder cellBuffer;
writeEncodedCell(unencodedCell, &cellBuffer);
ASSERT_EQ(1027, cellBuffer.len());
ASSERT_EQ("EE0004", hexblob::encode(cellBuffer.buf(), 3));
ASSERT_EQ(std::string(&cellBuffer.buf()[3], 1024), arrayInfo);
}
TEST(ColumnCellAppendElement, WriteEncodedCellWithArrInfoSize4) {
// This test does not use a realistic cell. A cell with a 100KB arrayInfo would be hilarious but
// also needlessly complicated for a unit test.
std::string arrayInfo(102400, '{');
column_keygen::UnencodedCellView unencodedCell = {{}, arrayInfo, false, false, false, false};
BufBuilder cellBuffer;
writeEncodedCell(unencodedCell, &cellBuffer);
ASSERT_EQ(102405, cellBuffer.len());
ASSERT_EQ("EF00900100", hexblob::encode(cellBuffer.buf(), 5));
ASSERT_EQ(std::string(&cellBuffer.buf()[5], 102400), arrayInfo);
}
} // namespace mongo
|
