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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
|
/*
* Copyright 2022-present MongoDB, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "mc-range-encoding-private.h"
#include "mc-rangeopts-private.h"
#include "test-mongocrypt.h"
#define RAW_STRING(...) #__VA_ARGS__
static void test_mc_RangeOpts_parse(_mongocrypt_tester_t *tester) {
typedef struct {
const char *desc;
const char *in;
const char *expectError;
mc_optional_int32_t expectMin;
mc_optional_int32_t expectMax;
int64_t expectSparsity;
mc_optional_uint32_t expectPrecision;
mc_optional_int32_t expectTrimFactor;
} testcase;
testcase tests[] = {
{.desc = "Works",
.in = RAW_STRING({"min" : 123, "max" : 456, "sparsity" : {"$numberLong" : "1"}}),
.expectSparsity = 1,
.expectMin = OPT_I32_C(123),
.expectMax = OPT_I32_C(456)},
{.desc = "Errors if precision is set with int min/max",
.in = RAW_STRING({"min" : 123, "max" : 456, "precision" : 2, "sparsity" : {"$numberLong" : "1"}}),
.expectError = "expected 'precision' to be set with double or decimal128 index"},
{.desc = "Errors on extra fields",
.in = RAW_STRING({"min" : 123, "max" : 456, "sparsity" : {"$numberLong" : "1"}, "foo" : 1}),
.expectError = "Unrecognized field: 'foo'"},
{.desc = "Errors if min/max types mismatch",
.in = RAW_STRING({"min" : 123, "max" : 456.0, "sparsity" : {"$numberLong" : "1"}}),
.expectError = "expected 'min' and 'max' to be same type"},
{
.desc = "Does not require min/max",
.in = RAW_STRING({"sparsity" : {"$numberLong" : "1"}}),
.expectSparsity = 1,
},
{.desc = "Requires precision for double when min/max is set",
.in = RAW_STRING({"min" : 0.0, "max" : 1.0, "sparsity" : {"$numberLong" : "1"}}),
.expectError = "expected 'precision'"},
{.desc = "Requires min/max for double when precision is set",
.in = RAW_STRING({"precision" : 1, "sparsity" : {"$numberLong" : "1"}}),
.expectError = "setting precision requires min"},
{.desc = "Requires precision for double when only min is set",
.in = RAW_STRING({"min" : 0.0, "sparsity" : {"$numberLong" : "1"}}),
.expectError = "expected 'precision'"},
{.desc = "Works when trim factor is set and Range V2 is enabled",
.in = RAW_STRING({"trimFactor" : 1, "sparsity" : {"$numberLong" : "1"}}),
.expectSparsity = 1,
.expectTrimFactor = OPT_I32(1)},
{.desc = "Does not require sparsity",
.in = RAW_STRING({"min" : 123, "max" : 456}),
.expectSparsity = mc_FLERangeSparsityDefault,
.expectMin = OPT_I32_C(123),
.expectMax = OPT_I32_C(456)},
{.desc = "Errors on negative trim factor",
.in = RAW_STRING({"trimFactor" : -1, "sparsity" : {"$numberLong" : "1"}}),
.expectError = "'trimFactor' must be non-negative"},
};
for (size_t i = 0; i < sizeof(tests) / sizeof(tests[0]); i++) {
testcase *test = tests + i;
mongocrypt_status_t *status = mongocrypt_status_new();
mc_RangeOpts_t ro;
TEST_PRINTF("running test_mc_RangeOpts_parse subtest: %s\n", test->desc);
bool ret = mc_RangeOpts_parse(&ro, TMP_BSON_STR(test->in), status);
if (!test->expectError) {
ASSERT_OK_STATUS(ret, status);
ASSERT_CMPINT(test->expectMin.set, ==, ro.min.set);
if (test->expectMin.set) {
ASSERT_CMPINT32(test->expectMin.value, ==, bson_iter_int32(&ro.min.value));
}
ASSERT_CMPINT(test->expectMax.set, ==, ro.max.set);
if (test->expectMax.set) {
ASSERT_CMPINT32(test->expectMax.value, ==, bson_iter_int32(&ro.max.value));
}
ASSERT_CMPINT64(test->expectSparsity, ==, ro.sparsity);
ASSERT_CMPINT(test->expectPrecision.set, ==, ro.precision.set);
ASSERT_CMPINT(test->expectPrecision.value, ==, ro.precision.value);
ASSERT_CMPINT(test->expectTrimFactor.set, ==, ro.trimFactor.set);
ASSERT_CMPINT(test->expectTrimFactor.value, ==, ro.trimFactor.value);
} else {
ASSERT_FAILS_STATUS(ret, status, test->expectError);
}
mc_RangeOpts_cleanup(&ro);
mongocrypt_status_destroy(status);
}
}
static void test_mc_RangeOpts_to_FLE2RangeInsertSpec(_mongocrypt_tester_t *tester) {
typedef struct {
const char *desc;
const char *in;
const char *v;
const char *expectError;
const char *expect;
} testcase;
testcase tests[] = {
{.desc = "Works",
.in = RAW_STRING({"min" : 123, "max" : 456, "sparsity" : {"$numberLong" : "1"}}),
.v = RAW_STRING({"v" : 789}),
.expect = RAW_STRING({"v" : {"v" : 789, "min" : 123, "max" : 456}})},
{.desc = "Works with precision",
.in = RAW_STRING({"min" : 123.0, "max" : 456.0, "precision" : 2, "sparsity" : {"$numberLong" : "1"}}),
.v = RAW_STRING({"v" : 789.0}),
.expect = RAW_STRING({"v" : {"v" : 789.0, "min" : 123.0, "max" : 456.0, "precision" : 2}})},
{.desc = "Errors with missing 'v'",
.in = RAW_STRING({"min" : 123, "max" : 456, "sparsity" : {"$numberLong" : "1"}}),
.v = RAW_STRING({"foo" : "bar"}),
.expectError = "Unable to find 'v'"},
// Tests of trim factor
{.desc = "tf = 0 works",
.in = RAW_STRING({"trimFactor" : 0, "min" : 0, "max" : 1, "sparsity" : {"$numberLong" : "1"}}),
.v = RAW_STRING({"v" : 0}),
.expect = RAW_STRING({"v" : {"v" : 0, "min" : 0, "max" : 1, "trimFactor" : 0}})},
{.desc = "tf = 1 fails when domain size is 2 = 2^1",
.in = RAW_STRING({"trimFactor" : 1, "min" : 0, "max" : 1, "sparsity" : {"$numberLong" : "1"}}),
.v = RAW_STRING({"v" : 0}),
.expectError = "Trim factor (1) must be less than the total number of bits (1) used to represent any element "
"in the domain."},
{.desc = "tf = 1 works when domain size is 3 > 2^1",
.in = RAW_STRING({"trimFactor" : 1, "min" : 0, "max" : 2, "sparsity" : {"$numberLong" : "1"}}),
.v = RAW_STRING({"v" : 0}),
.expect = RAW_STRING({"v" : {"v" : 0, "min" : 0, "max" : 2, "trimFactor" : 1}})},
{.desc = "tf = 2 fails when domain size is 3 <= 2^2",
.in = RAW_STRING({"trimFactor" : 2, "min" : 0, "max" : 2, "sparsity" : {"$numberLong" : "1"}}),
.v = RAW_STRING({"v" : 0}),
.expectError = "Trim factor (2) must be less than the total number of bits (2) used to represent any element "
"in the domain."},
// min = INT32_MIN, max = INT32_MAX
{.desc = "tf = 31 works for unbounded int32 (domain size = 2^32)",
.in = RAW_STRING(
{"trimFactor" : 31, "min" : -2147483648, "max" : 2147483647, "sparsity" : {"$numberLong" : "1"}}),
.v = RAW_STRING({"v" : 0}),
.expect = RAW_STRING({"v" : {"v" : 0, "min" : -2147483648, "max" : 2147483647, "trimFactor" : 31}})},
{.desc = "tf = 32 fails for unbounded int32 (domain size = 2^32)",
.in = RAW_STRING(
{"trimFactor" : 32, "min" : -2147483648, "max" : 2147483647, "sparsity" : {"$numberLong" : "1"}}),
.v = RAW_STRING({"v" : 0}),
.expectError = "Trim factor (32) must be less than the total number of bits (32) used to represent any "
"element in the domain."},
// min = INT64_MIN, max = INT64_MAX
{.desc = "tf = 63 works for int64 with no min/max (domain size = 2^64)",
.in = RAW_STRING({
"trimFactor" : 63,
"min" : -9223372036854775808,
"max" : 9223372036854775807,
"sparsity" : {"$numberLong" : "1"}
}),
.v = RAW_STRING({"v" : {"$numberLong" : "0"}}),
.expect = RAW_STRING({
"v" : {
"v" : {"$numberLong" : "0"},
"min" : {"$numberLong" : "-9223372036854775808"},
"max" : {"$numberLong" : "9223372036854775807"},
"trimFactor" : 63
}
})},
{.desc = "tf = 64 fails for int64 with no min/max (domain size = 2^64)",
.in = RAW_STRING({
"trimFactor" : 64,
"min" : -9223372036854775808,
"max" : 9223372036854775807,
"sparsity" : {"$numberLong" : "1"}
}),
.v = RAW_STRING({"v" : {"$numberLong" : "0"}}),
.expectError = "Trim factor (64) must be less than the total number of bits (64) used to represent any "
"element in the domain."},
{.desc = "tf = 63 works for date with no min/max (domain size = 2^64)",
.in = RAW_STRING({
"trimFactor" : 63,
"min" : {"$date" : {"$numberLong" : "-9223372036854775808"}},
"max" : {"$date" : {"$numberLong" : "9223372036854775807"}},
"sparsity" : {"$numberLong" : "1"}
}),
.v = RAW_STRING({"v" : {"$date" : {"$numberLong" : "0"}}}),
.expect = RAW_STRING({
"v" : {
"v" : {"$date" : {"$numberLong" : "0"}},
"min" : {"$date" : {"$numberLong" : "-9223372036854775808"}},
"max" : {"$date" : {"$numberLong" : "9223372036854775807"}},
"trimFactor" : 63
}
})},
{.desc = "tf = 64 fails for date with no min/max (domain size = 2^64)",
.in = RAW_STRING({
"trimFactor" : 64,
"min" : {"$date" : {"$numberLong" : "-9223372036854775808"}},
"max" : {"$date" : {"$numberLong" : "9223372036854775807"}},
"sparsity" : {"$numberLong" : "1"}
}),
.v = RAW_STRING({"v" : {"$date" : {"$numberLong" : "0"}}}),
.expectError = "Trim factor (64) must be less than the total number of bits (64) used to represent any "
"element in the domain."},
{.desc = "tf bound check passes correctly for double with min, max, precision set (tf = 9, 2^9 < domain size < "
"2^10)",
.in = RAW_STRING(
{"trimFactor" : 9, "min" : 0.0, "max" : 100.0, "precision" : 1, "sparsity" : {"$numberLong" : "1"}}),
.v = RAW_STRING({"v" : 0.0}),
.expect = RAW_STRING({"v" : {"v" : 0.0, "min" : 0.0, "max" : 100.0, "precision" : 1, "trimFactor" : 9}})},
{.desc = "tf bound check fails correctly for double with min, max, precision set (tf = 10, domain size < 2^10)",
.in = RAW_STRING(
{"trimFactor" : 10, "min" : 0.0, "max" : 100.0, "precision" : 1, "sparsity" : {"$numberLong" : "1"}}),
.v = RAW_STRING({"v" : 0.0}),
.expectError = "Trim factor (10) must be less than the total number of bits (10) used to represent any "
"element in the domain."},
{.desc = "tf = 63 works for unbounded double (domain size = 2^64)",
.in = RAW_STRING({"trimFactor" : 63, "sparsity" : {"$numberLong" : "1"}}),
.v = RAW_STRING({"v" : 0.0}),
// note - when min and max are unset, they are added into the insert spec.
.expect = RAW_STRING({
"v" : {
"v" : 0.0,
"min" : {"$numberDouble" : "-1.7976931348623157081e+308"},
"max" : {"$numberDouble" : "1.7976931348623157081e+308"},
"trimFactor" : 63
}
})},
{.desc = "tf = 64 fails for unbounded double (domain size = 2^64))",
.in = RAW_STRING({"trimFactor" : 64, "sparsity" : {"$numberLong" : "1"}}),
.v = RAW_STRING({"v" : 0.0}),
.expectError = "Trim factor (64) must be less than the total number of bits (64) used to represent any "
"element in the domain."},
#if MONGOCRYPT_HAVE_DECIMAL128_SUPPORT()
{.desc = "tf bound check passes correctly for decimal with min, max, precision set (tf = 9, 2^9 < domain size "
"< 2^10)",
.in = RAW_STRING({
"trimFactor" : 9,
"min" : {"$numberDecimal" : "0"},
"max" : {"$numberDecimal" : "100"},
"precision" : 1,
"sparsity" : {"$numberLong" : "1"}
}),
.v = RAW_STRING({"v" : {"$numberDecimal" : "0"}}),
.expect = RAW_STRING({
"v" : {
"v" : {"$numberDecimal" : "0"},
"min" : {"$numberDecimal" : "0"},
"max" : {"$numberDecimal" : "100"},
"precision" : 1,
"trimFactor" : 9
}
})},
{.desc =
"tf bound check fails correctly for decimal with min, max, precision set (tf = 10, domain size < 2^10)",
.in = RAW_STRING({
"trimFactor" : 10,
"min" : {"$numberDecimal" : "0"},
"max" : {"$numberDecimal" : "100"},
"precision" : 1,
"sparsity" : {"$numberLong" : "1"}
}),
.v = RAW_STRING({"v" : {"$numberDecimal" : "0"}}),
.expectError = "Trim factor (10) must be less than the total number of bits (10) used to represent any "
"element in the domain."},
{.desc = "tf = 127 works for unbounded decimal (domain size = 2^128)",
.in = RAW_STRING({"trimFactor" : 127, "sparsity" : {"$numberLong" : "1"}}),
.v = RAW_STRING({"v" : {"$numberDecimal" : "0"}}),
.expect = RAW_STRING({
"v" : {
"v" : {"$numberDecimal" : "0"},
"min" : {"$numberDecimal" : "-9.999999999999999999999999999999999E+6144"},
"max" : {"$numberDecimal" : "9.999999999999999999999999999999999E+6144"},
"trimFactor" : 127
}
})},
{.desc = "tf = 128 fails for unbounded decimal (domain size = 2^128)",
.in = RAW_STRING({"trimFactor" : 128, "sparsity" : {"$numberLong" : "1"}}),
.v = RAW_STRING({"v" : {"$numberDecimal" : "0"}}),
.expectError = "Trim factor (128) must be less than the total number of bits (128) used to represent any "
"element in the domain."},
#endif
};
for (size_t i = 0; i < sizeof(tests) / sizeof(tests[0]); i++) {
testcase *test = tests + i;
mongocrypt_status_t *status = mongocrypt_status_new();
mc_RangeOpts_t ro;
TEST_PRINTF("running test_mc_RangeOpts_to_FLE2RangeInsertSpec subtest: %s\n", test->desc);
ASSERT_OK_STATUS(mc_RangeOpts_parse(&ro, TMP_BSON_STR(test->in), status), status);
bson_t out = BSON_INITIALIZER;
bool ret = mc_RangeOpts_to_FLE2RangeInsertSpec(&ro, TMP_BSON_STR(test->v), &out, status);
if (!test->expectError) {
ASSERT_OK_STATUS(ret, status);
ASSERT_EQUAL_BSON(TMP_BSON_STR(test->expect), &out);
} else {
ASSERT_FAILS_STATUS(ret, status, test->expectError);
}
bson_destroy(&out);
mc_RangeOpts_cleanup(&ro);
mongocrypt_status_destroy(status);
}
}
void _mongocrypt_tester_install_mc_RangeOpts(_mongocrypt_tester_t *tester) {
INSTALL_TEST(test_mc_RangeOpts_parse);
INSTALL_TEST(test_mc_RangeOpts_to_FLE2RangeInsertSpec);
}
|
