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
|
/**
* Copyright (C) 2016 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.
*/
#define MONGO_LOG_DEFAULT_COMPONENT ::mongo::logger::LogComponent::kDefault
#include "mongo/platform/basic.h"
#include "mongo/rpc/metadata/client_metadata.h"
#include <boost/filesystem.hpp>
#include <map>
#include "mongo/bson/bsonobj.h"
#include "mongo/bson/bsonobjbuilder.h"
#include "mongo/unittest/unittest.h"
#include "mongo/util/log.h"
namespace mongo {
constexpr auto kMetadataDoc = "client"_sd;
constexpr auto kApplication = "application"_sd;
constexpr auto kDriver = "driver"_sd;
constexpr auto kName = "name"_sd;
constexpr auto kType = "type"_sd;
constexpr auto kVersion = "version"_sd;
constexpr auto kOperatingSystem = "os"_sd;
constexpr auto kArchitecture = "architecture"_sd;
constexpr auto kUnknown = "unkown"_sd;
#define ASSERT_DOC_OK(...) \
do { \
auto _swParseStatus = \
ClientMetadata::parse(BSON(kMetadataDoc << BSON(__VA_ARGS__))[kMetadataDoc]); \
ASSERT_OK(_swParseStatus.getStatus()); \
} while (0)
#define ASSERT_DOC_NOT_OK(...) \
do { \
auto _swParseStatus = \
ClientMetadata::parse(BSON(kMetadataDoc << BSON(__VA_ARGS__))[kMetadataDoc]); \
ASSERT_NOT_OK(_swParseStatus.getStatus()); \
} while (0)
TEST(ClientMetadatTest, TestLoopbackTest) {
// Serialize without application name
{
BSONObjBuilder builder;
ASSERT_OK(ClientMetadata::serializePrivate("a", "b", "c", "d", "e", "f", "g", &builder));
auto obj = builder.obj();
auto swParseStatus = ClientMetadata::parse(obj[kMetadataDoc]);
ASSERT_OK(swParseStatus.getStatus());
ASSERT_EQUALS("g", swParseStatus.getValue().get().getApplicationName());
BSONObj outDoc =
BSON(kMetadataDoc << BSON(
kApplication << BSON(kName << "g") << kDriver
<< BSON(kName << "a" << kVersion << "b")
<< kOperatingSystem
<< BSON(kType << "c" << kName << "d" << kArchitecture << "e"
<< kVersion
<< "f")));
ASSERT_EQUALS(obj, outDoc);
}
// Serialize without application name
{
BSONObjBuilder builder;
ClientMetadata::serializePrivate("a", "b", "c", "d", "e", "f", &builder);
auto obj = builder.obj();
auto swParseStatus = ClientMetadata::parse(obj[kMetadataDoc]);
ASSERT_OK(swParseStatus.getStatus());
BSONObj outDoc = BSON(
kMetadataDoc << BSON(
kDriver << BSON(kName << "a" << kVersion << "b") << kOperatingSystem
<< BSON(kType << "c" << kName << "d" << kArchitecture << "e" << kVersion
<< "f")));
ASSERT_EQUALS(obj, outDoc);
}
// Serialize with the os information automatically computed
{
BSONObjBuilder builder;
ASSERT_OK(ClientMetadata::serialize("a", "b", "f", &builder));
auto obj = builder.obj();
auto swParse = ClientMetadata::parse(obj[kMetadataDoc]);
ASSERT_OK(swParse.getStatus());
ASSERT_EQUALS("f", swParse.getValue().get().getApplicationName());
}
}
// Mixed: no client metadata document
TEST(ClientMetadatTest, TestEmptyDoc) {
{
auto parseStatus = ClientMetadata::parse(BSONElement());
ASSERT_OK(parseStatus.getStatus());
}
{
auto obj = BSON("client" << BSONObj());
auto parseStatus = ClientMetadata::parse(obj[kMetadataDoc]);
ASSERT_NOT_OK(parseStatus.getStatus());
}
}
// Positive: test with only required fields
TEST(ClientMetadatTest, TestRequiredOnlyFields) {
// Without app name
ASSERT_DOC_OK(kDriver << BSON(kName << "n1" << kVersion << "v1") << kOperatingSystem
<< BSON(kType << kUnknown));
// With AppName
ASSERT_DOC_OK(kApplication << BSON(kName << "1") << kDriver
<< BSON(kName << "n1" << kVersion << "v1")
<< kOperatingSystem
<< BSON(kType << kUnknown));
}
// Positive: test with app_name spelled wrong fields
TEST(ClientMetadatTest, TestWithAppNameSpelledWrong) {
ASSERT_DOC_OK(kApplication << BSON("extra"
<< "1")
<< kDriver
<< BSON(kName << "n1" << kVersion << "v1")
<< kOperatingSystem
<< BSON(kType << kUnknown));
}
// Positive: test with empty application document
TEST(ClientMetadatTest, TestWithEmptyApplication) {
ASSERT_DOC_OK(kApplication << BSONObj() << kDriver << BSON(kName << "n1" << kVersion << "v1")
<< kOperatingSystem
<< BSON(kType << kUnknown));
}
// Negative: test with appplication wrong type
TEST(ClientMetadatTest, TestNegativeWithAppNameWrongType) {
ASSERT_DOC_NOT_OK(kApplication << "1" << kDriver << BSON(kName << "n1" << kVersion << "v1")
<< kOperatingSystem
<< BSON(kType << kUnknown));
}
// Positive: test with extra fields
TEST(ClientMetadatTest, TestExtraFields) {
ASSERT_DOC_OK(kApplication << BSON(kName << "1"
<< "extra"
<< "v1")
<< kDriver
<< BSON(kName << "n1" << kVersion << "v1")
<< kOperatingSystem
<< BSON(kType << kUnknown));
ASSERT_DOC_OK(kApplication << BSON(kName << "1"
<< "extra"
<< "v1")
<< kDriver
<< BSON(kName << "n1" << kVersion << "v1"
<< "extra"
<< "v1")
<< kOperatingSystem
<< BSON(kType << kUnknown));
ASSERT_DOC_OK(kApplication << BSON(kName << "1"
<< "extra"
<< "v1")
<< kDriver
<< BSON(kName << "n1" << kVersion << "v1")
<< kOperatingSystem
<< BSON(kType << kUnknown << "extra"
<< "v1"));
ASSERT_DOC_OK(kApplication << BSON(kName << "1"
<< "extra"
<< "v1")
<< kDriver
<< BSON(kName << "n1" << kVersion << "v1")
<< kOperatingSystem
<< BSON(kType << kUnknown)
<< "extra"
<< "v1");
}
// Negative: only application specified
TEST(ClientMetadatTest, TestNegativeOnlyApplication) {
ASSERT_DOC_NOT_OK(kApplication << BSON(kName << "1"
<< "extra"
<< "v1"));
}
// Negative: all combinations of only missing 1 required field
TEST(ClientMetadatTest, TestNegativeMissingRequiredOneField) {
ASSERT_DOC_NOT_OK(kDriver << BSON(kVersion << "v1") << kOperatingSystem
<< BSON(kType << kUnknown));
ASSERT_DOC_NOT_OK(kDriver << BSON(kName << "n1") << kOperatingSystem
<< BSON(kType << kUnknown));
ASSERT_DOC_NOT_OK(kDriver << BSON(kName << "n1" << kVersion << "v1"));
}
// Negative: document with wrong types for required fields
TEST(ClientMetadatTest, TestNegativeWrongTypes) {
ASSERT_DOC_NOT_OK(kApplication << BSON(kName << 1) << kDriver
<< BSON(kName << "n1" << kVersion << "v1")
<< kOperatingSystem
<< BSON(kType << kUnknown));
ASSERT_DOC_NOT_OK(kApplication << BSON(kName << "1") << kDriver
<< BSON(kName << 1 << kVersion << "v1")
<< kOperatingSystem
<< BSON(kType << kUnknown));
ASSERT_DOC_NOT_OK(kApplication << BSON(kName << "1") << kDriver
<< BSON(kName << "n1" << kVersion << 1)
<< kOperatingSystem
<< BSON(kType << kUnknown));
ASSERT_DOC_NOT_OK(kApplication << BSON(kName << "1") << kDriver
<< BSON(kName << "n1" << kVersion << "v1")
<< kOperatingSystem
<< BSON(kType << 1));
}
// Negative: document larger than 512 bytes
TEST(ClientMetadatTest, TestNegativeLargeDocument) {
{
std::string str(350, 'x');
ASSERT_DOC_OK(kApplication << BSON(kName << "1") << kDriver
<< BSON(kName << "n1" << kVersion << "1")
<< kOperatingSystem
<< BSON(kType << kUnknown)
<< "extra"
<< str);
}
{
std::string str(512, 'x');
ASSERT_DOC_NOT_OK(kApplication << BSON(kName << "1") << kDriver
<< BSON(kName << "n1" << kVersion << "1")
<< kOperatingSystem
<< BSON(kType << kUnknown)
<< "extra"
<< str);
}
}
// Negative: document with app_name larger than 128 bytes
TEST(ClientMetadatTest, TestNegativeLargeAppName) {
{
std::string str(128, 'x');
ASSERT_DOC_OK(kApplication << BSON(kName << str) << kDriver
<< BSON(kName << "n1" << kVersion << "1")
<< kOperatingSystem
<< BSON(kType << kUnknown));
BSONObjBuilder builder;
ASSERT_OK(ClientMetadata::serialize("n1", "1", str, &builder));
}
{
std::string str(129, 'x');
ASSERT_DOC_NOT_OK(kApplication << BSON(kName << str) << kDriver
<< BSON(kName << "n1" << kVersion << "1")
<< kOperatingSystem
<< BSON(kType << kUnknown));
BSONObjBuilder builder;
ASSERT_NOT_OK(ClientMetadata::serialize("n1", "1", str, &builder));
}
}
} // namespace mongo
|
