1 // Protocol Buffers - Google's data interchange format
2 // Copyright 2008 Google Inc. All rights reserved.
3 //
4 // Use of this source code is governed by a BSD-style
5 // license that can be found in the LICENSE file or at
6 // https://developers.google.com/open-source/licenses/bsd
7
8 // Author: kenton@google.com (Kenton Varda)
9 // Based on original Protocol Buffers design by
10 // Sanjay Ghemawat, Jeff Dean, and others.
11 //
12 // Since the reflection interface for DynamicMessage is implemented by
13 // GenericMessageReflection, the only thing we really have to test is
14 // that DynamicMessage correctly sets up the information that
15 // GenericMessageReflection needs to use. So, we focus on that in this
16 // test. Other tests, such as generic_message_reflection_unittest and
17 // reflection_ops_unittest, cover the rest of the functionality used by
18 // DynamicMessage.
19
20 #include "google/protobuf/dynamic_message.h"
21
22 #include <cstddef>
23 #include <memory>
24 #include <string>
25 #include <vector>
26
27 #include "google/protobuf/descriptor.pb.h"
28 #include <gtest/gtest.h>
29 #include "google/protobuf/descriptor.h"
30 #include "google/protobuf/test_util.h"
31 #include "google/protobuf/unittest.pb.h"
32 #include "google/protobuf/unittest_no_field_presence.pb.h"
33
34
35 namespace google {
36 namespace protobuf {
37 namespace {
38
AddUnittestDescriptors(DescriptorPool & pool,std::vector<const FileDescriptor * > * files=nullptr)39 void AddUnittestDescriptors(
40 DescriptorPool& pool, std::vector<const FileDescriptor*>* files = nullptr) {
41 // We want to make sure that DynamicMessage works (particularly with
42 // extensions) even if we use descriptors that are *not* from compiled-in
43 // types, so we make copies of the descriptors for unittest.proto and
44 // unittest_import.proto.
45 FileDescriptorProto unittest_file;
46 FileDescriptorProto unittest_import_file;
47 FileDescriptorProto unittest_import_public_file;
48 FileDescriptorProto unittest_no_field_presence_file;
49
50 unittest::TestAllTypes::descriptor()->file()->CopyTo(&unittest_file);
51 unittest_import::ImportMessage::descriptor()->file()->CopyTo(
52 &unittest_import_file);
53 unittest_import::PublicImportMessage::descriptor()->file()->CopyTo(
54 &unittest_import_public_file);
55 proto2_nofieldpresence_unittest::TestAllTypes::descriptor()->file()->CopyTo(
56 &unittest_no_field_presence_file);
57
58 ASSERT_TRUE(pool.BuildFile(unittest_import_public_file) != nullptr);
59 ASSERT_TRUE(pool.BuildFile(unittest_import_file) != nullptr);
60 ASSERT_TRUE(pool.BuildFile(unittest_file) != nullptr);
61 ASSERT_TRUE(pool.BuildFile(unittest_no_field_presence_file) != nullptr);
62
63 if (files) {
64 files->push_back(pool.FindFileByName(unittest_file.name()));
65 files->push_back(pool.FindFileByName(unittest_import_file.name()));
66 files->push_back(pool.FindFileByName(unittest_import_public_file.name()));
67 files->push_back(
68 pool.FindFileByName(unittest_no_field_presence_file.name()));
69 }
70 }
71
72 class DynamicMessageTest : public ::testing::TestWithParam<bool> {
73 protected:
74 DescriptorPool pool_;
75 DynamicMessageFactory factory_;
76 const Descriptor* descriptor_;
77 const Message* prototype_;
78 const Descriptor* extensions_descriptor_;
79 const Message* extensions_prototype_;
80 const Descriptor* packed_extensions_descriptor_;
81 const Message* packed_extensions_prototype_;
82 const Descriptor* packed_descriptor_;
83 const Message* packed_prototype_;
84 const Descriptor* oneof_descriptor_;
85 const Message* oneof_prototype_;
86 const Descriptor* proto3_descriptor_;
87 const Message* proto3_prototype_;
88
DynamicMessageTest()89 DynamicMessageTest() : factory_(&pool_) {}
90
SetUp()91 void SetUp() override {
92 AddUnittestDescriptors(pool_);
93
94 descriptor_ = pool_.FindMessageTypeByName("protobuf_unittest.TestAllTypes");
95 ASSERT_TRUE(descriptor_ != nullptr);
96 prototype_ = factory_.GetPrototype(descriptor_);
97
98 extensions_descriptor_ =
99 pool_.FindMessageTypeByName("protobuf_unittest.TestAllExtensions");
100 ASSERT_TRUE(extensions_descriptor_ != nullptr);
101 extensions_prototype_ = factory_.GetPrototype(extensions_descriptor_);
102
103 packed_extensions_descriptor_ =
104 pool_.FindMessageTypeByName("protobuf_unittest.TestPackedExtensions");
105 ASSERT_TRUE(packed_extensions_descriptor_ != nullptr);
106 packed_extensions_prototype_ =
107 factory_.GetPrototype(packed_extensions_descriptor_);
108
109 packed_descriptor_ =
110 pool_.FindMessageTypeByName("protobuf_unittest.TestPackedTypes");
111 ASSERT_TRUE(packed_descriptor_ != nullptr);
112 packed_prototype_ = factory_.GetPrototype(packed_descriptor_);
113
114 oneof_descriptor_ =
115 pool_.FindMessageTypeByName("protobuf_unittest.TestOneof2");
116 ASSERT_TRUE(oneof_descriptor_ != nullptr);
117 oneof_prototype_ = factory_.GetPrototype(oneof_descriptor_);
118
119 proto3_descriptor_ = pool_.FindMessageTypeByName(
120 "proto2_nofieldpresence_unittest.TestAllTypes");
121 ASSERT_TRUE(proto3_descriptor_ != nullptr);
122 proto3_prototype_ = factory_.GetPrototype(proto3_descriptor_);
123 }
124 };
125
TEST_F(DynamicMessageTest,Descriptor)126 TEST_F(DynamicMessageTest, Descriptor) {
127 // Check that the descriptor on the DynamicMessage matches the descriptor
128 // passed to GetPrototype().
129 EXPECT_EQ(prototype_->GetDescriptor(), descriptor_);
130 }
131
TEST_F(DynamicMessageTest,OnePrototype)132 TEST_F(DynamicMessageTest, OnePrototype) {
133 // Check that requesting the same prototype twice produces the same object.
134 EXPECT_EQ(prototype_, factory_.GetPrototype(descriptor_));
135 }
136
TEST_F(DynamicMessageTest,Defaults)137 TEST_F(DynamicMessageTest, Defaults) {
138 // Check that all default values are set correctly in the initial message.
139 TestUtil::ReflectionTester reflection_tester(descriptor_);
140 reflection_tester.ExpectClearViaReflection(*prototype_);
141 }
142
TEST_P(DynamicMessageTest,IndependentOffsets)143 TEST_P(DynamicMessageTest, IndependentOffsets) {
144 // Check that all fields have independent offsets by setting each
145 // one to a unique value then checking that they all still have those
146 // unique values (i.e. they don't stomp each other).
147 Arena arena;
148 Message* message = prototype_->New(GetParam() ? &arena : nullptr);
149 TestUtil::ReflectionTester reflection_tester(descriptor_);
150
151 reflection_tester.SetAllFieldsViaReflection(message);
152 reflection_tester.ExpectAllFieldsSetViaReflection(*message);
153
154 if (!GetParam()) {
155 delete message;
156 }
157 }
158
TEST_P(DynamicMessageTest,Extensions)159 TEST_P(DynamicMessageTest, Extensions) {
160 // Check that extensions work.
161 Arena arena;
162 Message* message = extensions_prototype_->New(GetParam() ? &arena : nullptr);
163 TestUtil::ReflectionTester reflection_tester(extensions_descriptor_);
164
165 reflection_tester.SetAllFieldsViaReflection(message);
166 reflection_tester.ExpectAllFieldsSetViaReflection(*message);
167
168 if (!GetParam()) {
169 delete message;
170 }
171 }
172
TEST_P(DynamicMessageTest,PackedExtensions)173 TEST_P(DynamicMessageTest, PackedExtensions) {
174 // Check that extensions work.
175 Arena arena;
176 Message* message =
177 packed_extensions_prototype_->New(GetParam() ? &arena : nullptr);
178 TestUtil::ReflectionTester reflection_tester(packed_extensions_descriptor_);
179
180 reflection_tester.SetPackedFieldsViaReflection(message);
181 reflection_tester.ExpectPackedFieldsSetViaReflection(*message);
182
183 if (!GetParam()) {
184 delete message;
185 }
186 }
187
TEST_P(DynamicMessageTest,PackedFields)188 TEST_P(DynamicMessageTest, PackedFields) {
189 // Check that packed fields work properly.
190 Arena arena;
191 Message* message = packed_prototype_->New(GetParam() ? &arena : nullptr);
192 TestUtil::ReflectionTester reflection_tester(packed_descriptor_);
193
194 reflection_tester.SetPackedFieldsViaReflection(message);
195 reflection_tester.ExpectPackedFieldsSetViaReflection(*message);
196
197 if (!GetParam()) {
198 delete message;
199 }
200 }
201
TEST_P(DynamicMessageTest,Oneof)202 TEST_P(DynamicMessageTest, Oneof) {
203 // Check that oneof fields work properly.
204 Arena arena;
205 Message* message = oneof_prototype_->New(GetParam() ? &arena : nullptr);
206
207 // Check default values.
208 const Descriptor* descriptor = message->GetDescriptor();
209 const Reflection* reflection = message->GetReflection();
210 EXPECT_EQ(0, reflection->GetInt32(*message,
211 descriptor->FindFieldByName("foo_int")));
212 EXPECT_EQ("", reflection->GetString(
213 *message, descriptor->FindFieldByName("foo_string")));
214 EXPECT_EQ("", reflection->GetString(*message,
215 descriptor->FindFieldByName("foo_cord")));
216 EXPECT_EQ("", reflection->GetString(
217 *message, descriptor->FindFieldByName("foo_string_piece")));
218 EXPECT_EQ("", reflection->GetString(
219 *message, descriptor->FindFieldByName("foo_bytes")));
220 EXPECT_EQ(
221 unittest::TestOneof2::FOO,
222 reflection->GetEnum(*message, descriptor->FindFieldByName("foo_enum"))
223 ->number());
224 const Descriptor* nested_descriptor;
225 const Message* nested_prototype;
226 nested_descriptor =
227 pool_.FindMessageTypeByName("protobuf_unittest.TestOneof2.NestedMessage");
228 nested_prototype = factory_.GetPrototype(nested_descriptor);
229 EXPECT_EQ(nested_prototype,
230 &reflection->GetMessage(
231 *message, descriptor->FindFieldByName("foo_message")));
232 const Descriptor* foogroup_descriptor;
233 const Message* foogroup_prototype;
234 foogroup_descriptor =
235 pool_.FindMessageTypeByName("protobuf_unittest.TestOneof2.FooGroup");
236 foogroup_prototype = factory_.GetPrototype(foogroup_descriptor);
237 EXPECT_EQ(foogroup_prototype,
238 &reflection->GetMessage(*message,
239 descriptor->FindFieldByName("foogroup")));
240 EXPECT_NE(foogroup_prototype,
241 &reflection->GetMessage(
242 *message, descriptor->FindFieldByName("foo_lazy_message")));
243 EXPECT_EQ(5, reflection->GetInt32(*message,
244 descriptor->FindFieldByName("bar_int")));
245 EXPECT_EQ("STRING", reflection->GetString(
246 *message, descriptor->FindFieldByName("bar_string")));
247 EXPECT_EQ("CORD", reflection->GetString(
248 *message, descriptor->FindFieldByName("bar_cord")));
249 EXPECT_EQ("SPIECE",
250 reflection->GetString(
251 *message, descriptor->FindFieldByName("bar_string_piece")));
252 EXPECT_EQ("BYTES", reflection->GetString(
253 *message, descriptor->FindFieldByName("bar_bytes")));
254 EXPECT_EQ(
255 unittest::TestOneof2::BAR,
256 reflection->GetEnum(*message, descriptor->FindFieldByName("bar_enum"))
257 ->number());
258
259 // Check set functions.
260 TestUtil::ReflectionTester reflection_tester(oneof_descriptor_);
261 reflection_tester.SetOneofViaReflection(message);
262 reflection_tester.ExpectOneofSetViaReflection(*message);
263
264 if (!GetParam()) {
265 delete message;
266 }
267 }
268
TEST_P(DynamicMessageTest,SpaceUsed)269 TEST_P(DynamicMessageTest, SpaceUsed) {
270 // Test that SpaceUsedLong() works properly
271
272 // Since we share the implementation with generated messages, we don't need
273 // to test very much here. Just make sure it appears to be working.
274
275 Arena arena;
276 Message* message = prototype_->New(GetParam() ? &arena : nullptr);
277 TestUtil::ReflectionTester reflection_tester(descriptor_);
278
279 size_t initial_space_used = message->SpaceUsedLong();
280
281 reflection_tester.SetAllFieldsViaReflection(message);
282 EXPECT_LT(initial_space_used, message->SpaceUsedLong());
283
284 if (!GetParam()) {
285 delete message;
286 }
287 }
288
TEST_F(DynamicMessageTest,Arena)289 TEST_F(DynamicMessageTest, Arena) {
290 Arena arena;
291 Message* message = prototype_->New(&arena);
292 Message* extension_message = extensions_prototype_->New(&arena);
293 Message* packed_message = packed_prototype_->New(&arena);
294 Message* oneof_message = oneof_prototype_->New(&arena);
295
296 // avoid unused-variable error.
297 (void)message;
298 (void)extension_message;
299 (void)packed_message;
300 (void)oneof_message;
301 // Return without freeing: should not leak.
302 }
303
304
TEST_F(DynamicMessageTest,Proto3)305 TEST_F(DynamicMessageTest, Proto3) {
306 Message* message = proto3_prototype_->New();
307 const Reflection* refl = message->GetReflection();
308 const Descriptor* desc = message->GetDescriptor();
309
310 // Just test a single primitive and single message field here to make sure we
311 // are getting the no-field-presence semantics elsewhere. DynamicMessage uses
312 // GeneratedMessageReflection under the hood, so the rest should be fine as
313 // long as GMR recognizes that we're using a proto3 message.
314 const FieldDescriptor* optional_int32 =
315 desc->FindFieldByName("optional_int32");
316 const FieldDescriptor* optional_msg =
317 desc->FindFieldByName("optional_nested_message");
318 EXPECT_TRUE(optional_int32 != nullptr);
319 EXPECT_TRUE(optional_msg != nullptr);
320
321 EXPECT_EQ(false, refl->HasField(*message, optional_int32));
322 refl->SetInt32(message, optional_int32, 42);
323 EXPECT_EQ(true, refl->HasField(*message, optional_int32));
324 refl->SetInt32(message, optional_int32, 0);
325 EXPECT_EQ(false, refl->HasField(*message, optional_int32));
326
327 EXPECT_EQ(false, refl->HasField(*message, optional_msg));
328 refl->MutableMessage(message, optional_msg);
329 EXPECT_EQ(true, refl->HasField(*message, optional_msg));
330 delete refl->ReleaseMessage(message, optional_msg);
331 EXPECT_EQ(false, refl->HasField(*message, optional_msg));
332
333 // Also ensure that the default instance handles field presence properly.
334 EXPECT_EQ(false, refl->HasField(*proto3_prototype_, optional_msg));
335
336 delete message;
337 }
338
339 INSTANTIATE_TEST_SUITE_P(UseArena, DynamicMessageTest, ::testing::Bool());
340
341
342 } // namespace
343 } // namespace protobuf
344 } // namespace google
345