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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
|
// Protocol Buffers - Google's data interchange format
// Copyright 2008 Google Inc. All rights reserved.
// https://developers.google.com/protocol-buffers/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// Author: ksroka@google.com (Krzysztof Sroka)
#include <google/protobuf/util/field_comparator.h>
#include <google/protobuf/unittest.pb.h>
#include <google/protobuf/descriptor.h>
#include <google/protobuf/stubs/mathutil.h>
// This gtest header is put after mathutil.h intentionally. We have to do
// this because mathutil.h includes mathlimits.h which requires cmath not
// being included to compile on some versions of gcc:
// https://github.com/protocolbuffers/protobuf/blob/818c5eee08840355d70d2f3bdf1a2f17986a5e70/src/google/protobuf/stubs/mathlimits.h#L48
// and the opensource version gtest.h header includes cmath transitively
// somehow.
#include <gtest/gtest.h>
namespace google {
namespace protobuf {
namespace util {
namespace {
using protobuf_unittest::TestAllTypes;
class DefaultFieldComparatorTest : public ::testing::Test {
protected:
void SetUp() {
descriptor_ = TestAllTypes::descriptor();
}
const Descriptor* descriptor_;
DefaultFieldComparator comparator_;
TestAllTypes message_1_;
TestAllTypes message_2_;
};
TEST_F(DefaultFieldComparatorTest, RecursesIntoGroup) {
const FieldDescriptor* field =
descriptor_->FindFieldByName("optionalgroup");
EXPECT_EQ(FieldComparator::RECURSE,
comparator_.Compare(message_1_, message_2_, field, -1, -1, NULL));
}
TEST_F(DefaultFieldComparatorTest, RecursesIntoNestedMessage) {
const FieldDescriptor* field =
descriptor_->FindFieldByName("optional_nested_message");
EXPECT_EQ(FieldComparator::RECURSE,
comparator_.Compare(message_1_, message_2_, field, -1, -1, NULL));
}
TEST_F(DefaultFieldComparatorTest, RecursesIntoForeignMessage) {
const FieldDescriptor* field =
descriptor_->FindFieldByName("optional_foreign_message");
EXPECT_EQ(FieldComparator::RECURSE,
comparator_.Compare(message_1_, message_2_, field, -1, -1, NULL));
}
TEST_F(DefaultFieldComparatorTest, Int32Comparison) {
const FieldDescriptor* field = descriptor_->FindFieldByName("optional_int32");
message_1_.set_optional_int32(1);
message_2_.set_optional_int32(1);
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_, field, -1, -1, NULL));
message_2_.set_optional_int32(-1);
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_, field, -1, -1, NULL));
}
TEST_F(DefaultFieldComparatorTest, Int64Comparison) {
const FieldDescriptor* field = descriptor_->FindFieldByName("optional_int64");
message_1_.set_optional_int64(1L);
message_2_.set_optional_int64(1L);
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_, field, -1, -1, NULL));
message_2_.set_optional_int64(-1L);
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_, field, -1, -1, NULL));
}
TEST_F(DefaultFieldComparatorTest, UInt32Comparison) {
const FieldDescriptor* field =
descriptor_->FindFieldByName("optional_uint32");
message_1_.set_optional_uint32(1);
message_2_.set_optional_uint32(1);
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_, field, -1, -1, NULL));
message_2_.set_optional_uint32(2);
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_, field, -1, -1, NULL));
}
TEST_F(DefaultFieldComparatorTest, UInt64Comparison) {
const FieldDescriptor* field =
descriptor_->FindFieldByName("optional_uint64");
message_1_.set_optional_uint64(1L);
message_2_.set_optional_uint64(1L);
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_, field, -1, -1, NULL));
message_2_.set_optional_uint64(2L);
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_, field, -1, -1, NULL));
}
TEST_F(DefaultFieldComparatorTest, BooleanComparison) {
const FieldDescriptor* field =
descriptor_->FindFieldByName("optional_bool");
message_1_.set_optional_bool(true);
message_2_.set_optional_bool(true);
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_, field, -1, -1, NULL));
message_2_.set_optional_bool(false);
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_, field, -1, -1, NULL));
}
TEST_F(DefaultFieldComparatorTest, EnumComparison) {
const FieldDescriptor* field =
descriptor_->FindFieldByName("optional_nested_enum");
message_1_.set_optional_nested_enum(TestAllTypes::BAR);
message_2_.set_optional_nested_enum(TestAllTypes::BAR);
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_, field, -1, -1, NULL));
message_2_.set_optional_nested_enum(TestAllTypes::BAZ);
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_, field, -1, -1, NULL));
}
TEST_F(DefaultFieldComparatorTest, StringComparison) {
const FieldDescriptor* field =
descriptor_->FindFieldByName("optional_string");
message_1_.set_optional_string("foo");
message_2_.set_optional_string("foo");
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_, field, -1, -1, NULL));
message_2_.set_optional_string("bar");
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_, field, -1, -1, NULL));
}
TEST_F(DefaultFieldComparatorTest, FloatingPointComparisonExact) {
const FieldDescriptor* field_float =
descriptor_->FindFieldByName("optional_float");
const FieldDescriptor* field_double =
descriptor_->FindFieldByName("optional_double");
message_1_.set_optional_float(0.1f);
message_2_.set_optional_float(0.1f);
message_1_.set_optional_double(0.1);
message_2_.set_optional_double(0.1);
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_,
field_float, -1, -1, NULL));
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_,
field_double, -1, -1, NULL));
message_2_.set_optional_float(0.2f);
message_2_.set_optional_double(0.2);
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_,
field_float, -1, -1, NULL));
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_,
field_double, -1, -1, NULL));
}
TEST_F(DefaultFieldComparatorTest, FloatingPointComparisonApproximate) {
const FieldDescriptor* field_float =
descriptor_->FindFieldByName("optional_float");
const FieldDescriptor* field_double =
descriptor_->FindFieldByName("optional_double");
message_1_.set_optional_float(2.300005f);
message_2_.set_optional_float(2.300006f);
message_1_.set_optional_double(2.3000000000000003);
message_2_.set_optional_double(2.3000000000000007);
// Approximate comparison depends on MathUtil, so we assert on MathUtil
// results first to check if that's where the failure was introduced.
ASSERT_NE(message_1_.optional_float(), message_2_.optional_float());
ASSERT_NE(message_1_.optional_double(), message_2_.optional_double());
ASSERT_TRUE(MathUtil::AlmostEquals(message_1_.optional_float(),
message_2_.optional_float()));
ASSERT_TRUE(MathUtil::AlmostEquals(message_1_.optional_double(),
message_2_.optional_double()));
// DefaultFieldComparator's default float comparison mode is EXACT.
ASSERT_EQ(DefaultFieldComparator::EXACT, comparator_.float_comparison());
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_,
field_float, -1, -1, NULL));
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_,
field_double, -1, -1, NULL));
comparator_.set_float_comparison(DefaultFieldComparator::APPROXIMATE);
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_,
field_float, -1, -1, NULL));
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_,
field_double, -1, -1, NULL));
}
TEST_F(DefaultFieldComparatorTest, FloatingPointComparisonTreatNaNsAsEqual) {
const FieldDescriptor* field_float =
descriptor_->FindFieldByName("optional_float");
const FieldDescriptor* field_double =
descriptor_->FindFieldByName("optional_double");
message_1_.set_optional_float(MathLimits<float>::kNaN);
message_2_.set_optional_float(MathLimits<float>::kNaN);
message_1_.set_optional_double(MathLimits<double>::kNaN);
message_2_.set_optional_double(MathLimits<double>::kNaN);
// DefaultFieldComparator's default float comparison mode is EXACT with
// treating NaNs as different.
ASSERT_EQ(DefaultFieldComparator::EXACT, comparator_.float_comparison());
ASSERT_EQ(false, comparator_.treat_nan_as_equal());
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_,
field_float, -1, -1, NULL));
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_,
field_double, -1, -1, NULL));
comparator_.set_float_comparison(DefaultFieldComparator::APPROXIMATE);
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_,
field_float, -1, -1, NULL));
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_,
field_double, -1, -1, NULL));
comparator_.set_treat_nan_as_equal(true);
ASSERT_EQ(true, comparator_.treat_nan_as_equal());
comparator_.set_float_comparison(DefaultFieldComparator::EXACT);
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_,
field_float, -1, -1, NULL));
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_,
field_double, -1, -1, NULL));
comparator_.set_float_comparison(DefaultFieldComparator::APPROXIMATE);
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_,
field_float, -1, -1, NULL));
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_,
field_double, -1, -1, NULL));
}
TEST_F(DefaultFieldComparatorTest,
FloatingPointComparisonWithinFractionOrMargin) {
const FieldDescriptor* field_float =
descriptor_->FindFieldByName("optional_float");
const FieldDescriptor* field_double =
descriptor_->FindFieldByName("optional_double");
message_1_.set_optional_float(100.0f);
message_2_.set_optional_float(109.9f);
message_1_.set_optional_double(100.0);
message_2_.set_optional_double(109.9);
comparator_.set_float_comparison(DefaultFieldComparator::APPROXIMATE);
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_,
field_float, -1, -1, NULL));
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_,
field_double, -1, -1, NULL));
// Should fail since the fraction is too low.
comparator_.SetFractionAndMargin(field_float, 0.01, 0.0);
comparator_.SetFractionAndMargin(field_double, 0.01, 0.0);
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_,
field_float, -1, -1, NULL));
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_,
field_double, -1, -1, NULL));
// Should fail since the margin is too low.
comparator_.SetFractionAndMargin(field_float, 0.0, 9.0);
comparator_.SetFractionAndMargin(field_double, 0.0, 9.0);
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_,
field_float, -1, -1, NULL));
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_,
field_double, -1, -1, NULL));
// Should succeed since the fraction is high enough.
comparator_.SetFractionAndMargin(field_float, 0.2, 0.0);
comparator_.SetFractionAndMargin(field_double, 0.2, 0.0);
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_,
field_float, -1, -1, NULL));
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_,
field_double, -1, -1, NULL));
// Should succeed since the margin is high enough.
comparator_.SetFractionAndMargin(field_float, 0.0, 10.0);
comparator_.SetFractionAndMargin(field_double, 0.0, 10.0);
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_,
field_float, -1, -1, NULL));
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_,
field_double, -1, -1, NULL));
// Setting values for one of the fields should not affect the other.
comparator_.SetFractionAndMargin(field_double, 0.0, 0.0);
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_,
field_float, -1, -1, NULL));
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_,
field_double, -1, -1, NULL));
// +inf should be equal even though they are not technically within margin or
// fraction.
message_1_.set_optional_float(std::numeric_limits<float>::infinity());
message_2_.set_optional_float(std::numeric_limits<float>::infinity());
message_1_.set_optional_double(std::numeric_limits<double>::infinity());
message_2_.set_optional_double(std::numeric_limits<double>::infinity());
comparator_.SetFractionAndMargin(field_float, 0.0, 0.0);
comparator_.SetFractionAndMargin(field_double, 0.0, 0.0);
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_,
field_float, -1, -1, NULL));
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_,
field_double, -1, -1, NULL));
// -inf should be equal even though they are not technically within margin or
// fraction.
message_1_.set_optional_float(-std::numeric_limits<float>::infinity());
message_2_.set_optional_float(-std::numeric_limits<float>::infinity());
message_1_.set_optional_double(-std::numeric_limits<double>::infinity());
message_2_.set_optional_double(-std::numeric_limits<double>::infinity());
comparator_.SetFractionAndMargin(field_float, 0.0, 0.0);
comparator_.SetFractionAndMargin(field_double, 0.0, 0.0);
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_,
field_float, -1, -1, NULL));
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_,
field_double, -1, -1, NULL));
}
TEST_F(DefaultFieldComparatorTest,
FloatingPointComparisonWithinDefaultFractionOrMargin) {
const FieldDescriptor* field_float =
descriptor_->FindFieldByName("optional_float");
const FieldDescriptor* field_double =
descriptor_->FindFieldByName("optional_double");
message_1_.set_optional_float(100.0f);
message_2_.set_optional_float(109.9f);
message_1_.set_optional_double(100.0);
message_2_.set_optional_double(109.9);
comparator_.set_float_comparison(DefaultFieldComparator::APPROXIMATE);
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_,
field_float, -1, -1, NULL));
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_,
field_double, -1, -1, NULL));
// Set default fraction and margin.
comparator_.SetDefaultFractionAndMargin(0.01, 0.0);
// Float comparisons should fail since the fraction is too low.
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_,
field_float, -1, -1, NULL));
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_,
field_double, -1, -1, NULL));
// Set field-specific fraction and margin for one field (field_float) but not
// the other (field_double)
comparator_.SetFractionAndMargin(field_float, 0.2, 0.0);
// The field with the override should succeed, since its field-specific
// fraction is high enough.
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_,
field_float, -1, -1, NULL));
// The field with no override should fail, since the default fraction is too
// low
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_,
field_double, -1, -1, NULL));
// Set the default fraction and margin high enough so that fields that use
// the default should succeed
comparator_.SetDefaultFractionAndMargin(0.2, 0.0);
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_,
field_double, -1, -1, NULL));
// The field with an override should still be OK
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_,
field_float, -1, -1, NULL));
// Set fraction and margin for the field with an override to be too low
comparator_.SetFractionAndMargin(field_float, 0.01, 0.0);
// Now our default is high enough but field_float's override is too low.
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_,
field_float, -1, -1, NULL));
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_,
field_double, -1, -1, NULL));
}
// Simple test checking whether we compare values at correct indices.
TEST_F(DefaultFieldComparatorTest, RepeatedFieldComparison) {
const FieldDescriptor* field =
descriptor_->FindFieldByName("repeated_string");
message_1_.add_repeated_string("foo");
message_1_.add_repeated_string("bar");
message_2_.add_repeated_string("bar");
message_2_.add_repeated_string("baz");
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_, field, 0, 0, NULL));
EXPECT_EQ(FieldComparator::DIFFERENT,
comparator_.Compare(message_1_, message_2_, field, 1, 1, NULL));
EXPECT_EQ(FieldComparator::SAME,
comparator_.Compare(message_1_, message_2_, field, 1, 0, NULL));
}
} // namespace
} // namespace util
} // namespace protobuf
} // namespace google
|
