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
|
/**
* Copyright (C) 2019-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/platform/basic.h"
#include "mongo/bson/bsontypes.h"
#include "mongo/db/storage/duplicate_key_error_info.h"
#include "mongo/db/storage/index_entry_comparison.h"
#include "mongo/unittest/unittest.h"
#include "mongo/util/hex.h"
namespace mongo {
void buildDupKeyErrorStatusProducesExpectedErrorObject(
DuplicateKeyErrorInfo::FoundValue&& foundValue) {
NamespaceString collNss("test.foo");
std::string indexName("a_1_b_1");
auto keyPattern = BSON("a" << 1 << "b" << 1);
auto keyValue = BSON("" << 10 << ""
<< "abc");
auto keyValueWithFieldName = BSON("a" << 10 << "b"
<< "abc");
BSONObjBuilder expectedObjBuilder;
expectedObjBuilder.append("keyPattern", keyPattern);
expectedObjBuilder.append("keyValue", keyValueWithFieldName);
stdx::visit(
OverloadedVisitor{
[](stdx::monostate) {},
[&](const RecordId& rid) { rid.serializeToken("foundValue", &expectedObjBuilder); },
[&](const BSONObj& obj) { expectedObjBuilder.append("foundValue", obj); },
},
foundValue);
auto expectedObj = expectedObjBuilder.obj();
auto dupKeyStatus = buildDupKeyErrorStatus(
keyValue, collNss, indexName, keyPattern, BSONObj{}, std::move(foundValue));
ASSERT_NOT_OK(dupKeyStatus);
ASSERT_EQUALS(dupKeyStatus.code(), ErrorCodes::DuplicateKey);
auto extraInfo = dupKeyStatus.extraInfo<DuplicateKeyErrorInfo>();
ASSERT(extraInfo);
ASSERT_BSONOBJ_EQ(extraInfo->getKeyPattern(), keyPattern);
ASSERT_BSONOBJ_EQ(extraInfo->getDuplicatedKeyValue(), keyValueWithFieldName);
BSONObjBuilder objBuilder;
extraInfo->serialize(&objBuilder);
auto obj = objBuilder.obj();
ASSERT_BSONOBJ_EQ(obj, expectedObj);
// Ensure the object is the same after parsing and serializing again.
auto parsedExtraInfo =
std::dynamic_pointer_cast<const DuplicateKeyErrorInfo>(DuplicateKeyErrorInfo::parse(obj));
BSONObjBuilder afterParseObjBuilder;
parsedExtraInfo->serialize(&afterParseObjBuilder);
ASSERT_BSONOBJ_EQ(afterParseObjBuilder.obj(), expectedObj);
}
TEST(IndexEntryComparison, BuildDupKeyErrorStatusProducesExpectedErrorObject) {
buildDupKeyErrorStatusProducesExpectedErrorObject(stdx::monostate{});
buildDupKeyErrorStatusProducesExpectedErrorObject(RecordId{1});
buildDupKeyErrorStatusProducesExpectedErrorObject(BSON("c" << 1));
}
void duplicateKeyErrorSerializationAndParseReturnTheSameObject(
BSONObj keyPattern,
BSONObj keyValue,
BSONObj collation,
BSONObj keyValueWithFieldName,
BSONObj expectedEncodedKeyValueField) {
NamespaceString collNss("test.foo");
std::string indexName("a_1_b_1");
auto dupKeyStatus = buildDupKeyErrorStatus(keyValue, collNss, indexName, keyPattern, collation);
auto extraInfo = dupKeyStatus.extraInfo<DuplicateKeyErrorInfo>();
ASSERT(extraInfo);
ASSERT_BSONOBJ_EQ(extraInfo->getDuplicatedKeyValue(), keyValueWithFieldName);
// Build a serialized representation of the 'DuplicateKeyErrorInfo'.
BSONObjBuilder objBuilder;
extraInfo->serialize(&objBuilder);
auto duplicateKeyErrorDoc = objBuilder.obj();
ASSERT_BSONOBJ_EQ(duplicateKeyErrorDoc.getField("keyValue").Obj(),
expectedEncodedKeyValueField);
// Verify that parsing of the serialized representation of the 'DuplicateKeyErrorInfo' object
// results in an identical 'DuplicateKeyErrorInfo' object.
auto parsedDuplicatedErrorInfo = std::dynamic_pointer_cast<const DuplicateKeyErrorInfo>(
DuplicateKeyErrorInfo::parse(duplicateKeyErrorDoc));
ASSERT(parsedDuplicatedErrorInfo.get());
ASSERT_BSONOBJ_EQ(parsedDuplicatedErrorInfo->getKeyPattern(), keyPattern);
ASSERT_BSONOBJ_EQ(parsedDuplicatedErrorInfo->getDuplicatedKeyValue(), keyValueWithFieldName);
}
TEST(IndexEntryComparison, BuildDupKeyErrorSerializeAndParseReturnTheSameObjectWithCollation) {
auto keyPattern = BSON("a" << 1 << "b" << 1);
auto str = "abc";
auto keyValue = BSON("" << 10 << "" << str);
auto collation = BSON("x"
<< "y");
auto keyValueWithFieldName = BSON("a" << 10 << "b" << str);
auto expectedEncodedKeyValueField =
BSON("a" << 10 << "b" << StringData(hexblob::encodeLower(str)));
duplicateKeyErrorSerializationAndParseReturnTheSameObject(
keyPattern, keyValue, collation, keyValueWithFieldName, expectedEncodedKeyValueField);
}
TEST(IndexEntryComparison, BuildDupKeyErrorSerializeAndParseReturnTheSameObjectForInvalidUtf8) {
auto keyPattern = BSON("a" << 1 << "b" << 1);
auto str = StringData("\xc3\x28");
auto keyValue = BSON("" << 10 << "" << str);
auto collation = BSONObj();
auto keyValueWithFieldName = BSON("a" << 10 << "b" << str);
auto expectedEncodedKeyValueField =
BSON("a" << 10 << "b" << StringData(hexblob::encodeLower(str)));
duplicateKeyErrorSerializationAndParseReturnTheSameObject(
keyPattern, keyValue, collation, keyValueWithFieldName, expectedEncodedKeyValueField);
}
TEST(IndexEntryComparison, BuildDupKeyErrorMessageIncludesCollationAndHexEncodedCollationKey) {
StringData mockCollationKey("bar");
NamespaceString collNss("test.foo");
std::string indexName("a_1");
auto keyPattern = BSON("a" << 1);
auto keyValue = BSON("" << mockCollationKey);
auto collation = BSON("locale"
<< "en_US");
auto dupKeyStatus = buildDupKeyErrorStatus(keyValue, collNss, indexName, keyPattern, collation);
ASSERT_NOT_OK(dupKeyStatus);
ASSERT_EQUALS(dupKeyStatus.code(), ErrorCodes::DuplicateKey);
ASSERT(dupKeyStatus.reason().find("collation:") != std::string::npos);
// Verify that the collation key is hex encoded in the error message.
std::string expectedHexEncoding = "0x" + hexblob::encodeLower(mockCollationKey);
ASSERT(dupKeyStatus.reason().find(expectedHexEncoding) != std::string::npos);
// But no hex encoding should have taken place inside the key attached to the extra error info.
auto extraInfo = dupKeyStatus.extraInfo<DuplicateKeyErrorInfo>();
ASSERT(extraInfo);
ASSERT_BSONOBJ_EQ(extraInfo->getKeyPattern(), keyPattern);
ASSERT_BSONOBJ_EQ(extraInfo->getDuplicatedKeyValue(), BSON("a" << mockCollationKey));
}
TEST(IndexEntryComparison, BuildDupKeyErrorMessageHexEncodesInvalidUTF8ForIndexWithoutCollation) {
NamespaceString collNss("test.foo");
std::string indexName("a_1");
auto keyPattern = BSON("a" << 1);
// The byte sequence c0 16 is invalid UTF-8 since this is an overlong encoding of the letter
// "a", which should be represented as simply 0x16. The byte 0xc0 is always illegal in UTF-8
// since it would only ever be used for an overload two-byte encoding of an ASCII character.
auto keyValue = BSON(""
<< "\xc0\x16");
auto dupKeyStatus = buildDupKeyErrorStatus(keyValue, collNss, indexName, keyPattern, BSONObj{});
ASSERT_NOT_OK(dupKeyStatus);
ASSERT_EQUALS(dupKeyStatus.code(), ErrorCodes::DuplicateKey);
// We expect to find a hex-encoded version of the illegal UTF-8 byte sequence inside the error
// string.
ASSERT(dupKeyStatus.reason().find("0xc016") != std::string::npos);
// In the extra error info, we expect that no hex encoding has taken place.
auto extraInfo = dupKeyStatus.extraInfo<DuplicateKeyErrorInfo>();
ASSERT(extraInfo);
ASSERT_BSONOBJ_EQ(extraInfo->getKeyPattern(), keyPattern);
ASSERT_BSONOBJ_EQ(extraInfo->getDuplicatedKeyValue(),
BSON("a"
<< "\xc0\x16"));
}
} // namespace mongo
|
