Skip to content

Add --allow_unknown_extensions flag to protoc for encode mode to allow unknown extensions when parsing textformat. #25417

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
copybara-service wants to merge 1 commit into
base: main
Choose a base branch
from
+179 −2
Draft

Add --allow_unknown_extensions flag to protoc for encode mode to allow unknown extensions when parsing textformat. #25417

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions src/google/protobuf/compiler/command_line_interface.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1817,6 +1817,7 @@ void CommandLineInterface::Clear() {
disallow_services_ = false;
direct_dependencies_explicitly_set_ = false;
deterministic_output_ = false;
allow_unknown_extensions_ = false;
}

bool CommandLineInterface::MakeProtoProtoPathRelative(
Expand Down Expand Up @@ -2154,8 +2155,9 @@ bool CommandLineInterface::ParseArgument(const char* arg, std::string* name,
*name == "--experimental_editions" ||
*name == "--print_free_field_numbers" ||
*name == "--experimental_allow_proto3_optional" ||
*name == "--deterministic_output" || *name == "--fatal_warnings") {
// HACK: These are the only flags that don't take a value.
*name == "--deterministic_output" || *name == "--fatal_warnings" ||
*name == "--allow_unknown_extensions") {
// HACK: These are flags that don't take a value.
// They probably should not be hard-coded like this but for now it's
// not worth doing better.
return false;
Expand Down Expand Up @@ -2425,6 +2427,9 @@ CommandLineInterface::InterpretArgument(const std::string& name,
} else if (name == "--deterministic_output") {
deterministic_output_ = true;

} else if (name == "--allow_unknown_extensions") {
allow_unknown_extensions_ = true;

} else if (name == "--error_format") {
if (value == "gcc") {
error_format_ = ERROR_FORMAT_GCC;
Expand Down Expand Up @@ -2667,6 +2672,9 @@ Parse PROTO_FILES and generate output based on the options given:
--error_format=FORMAT Set the format in which to print errors.
FORMAT may be 'gcc' (the default) or 'msvs'
(Microsoft Visual Studio format).
--allow_unknown_extensions When using --encode, parse text-format
message in lenient mode, allowing unknown
fields and extensions.
--fatal_warnings Make warnings be fatal (similar to -Werr in
gcc). This flag will make protoc return
with a non-zero exit code if any warnings
Expand Down Expand Up @@ -3161,6 +3169,9 @@ bool CommandLineInterface::EncodeOrDecode(const DescriptorPool* pool) {
TextFormat::Parser parser;
parser.RecordErrorsTo(&error_collector);
parser.AllowPartialMessage(true);
if (allow_unknown_extensions_) {
parser.AllowUnknownExtension(allow_unknown_extensions_);
}

if (!parser.Parse(&in, message.get())) {
std::cerr << "Failed to parse input." << std::endl;
Expand Down
3 changes: 3 additions & 0 deletions src/google/protobuf/compiler/command_line_interface.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -501,6 +501,9 @@ class PROTOC_EXPORT CommandLineInterface {
// When using --encode, this will be passed to SetSerializationDeterministic.
bool deterministic_output_ = false;

// When using --encode, this will be passed to AllowUnknownExtensions.
bool allow_unknown_extensions_ = false;

bool opensource_runtime_ = google::protobuf::internal::IsOss();

};
Expand Down
24 changes: 24 additions & 0 deletions src/google/protobuf/compiler/command_line_interface_unittest.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5558,6 +5558,13 @@ static void WriteGoldenMessage(const std::string& filename) {
ABSL_CHECK_OK(File::SetContents(filename, golden, true));
}

static void WriteGoldenExtensionsMessage(const std::string& filename) {
proto2_unittest::TestAllExtensions message;
TestUtil::SetAllExtensions(&message);
std::string golden = message.SerializeAsString();
ABSL_CHECK_OK(File::SetContents(filename, golden, true));
}

TEST_P(EncodeDecodeTest, Encode) {
std::string golden_path = absl::StrCat(TestTempDir(), "/golden_message");
WriteGoldenMessage(golden_path);
Expand Down Expand Up @@ -5645,6 +5652,23 @@ TEST_P(EncodeDecodeTest, EncodeDeterministicOutput) {
ExpectNoErrors();
}

TEST_P(EncodeDecodeTest, AllowUnknownExtensions) {
std::string golden_path = absl::StrCat(TestTempDir(), "/golden_message");
WriteGoldenExtensionsMessage(golden_path);
RedirectStdinFromFile(TestUtil::GetTestDataPath(
"google/protobuf/"
"testdata/text_format_unittest_extensions_data_with_unknown.txt"));
std::string args;
if (GetParam() != DESCRIPTOR_SET_IN) {
args.append("google/protobuf/unittest.proto");
}
EXPECT_TRUE(Run(absl::StrCat(args,
" --encode=proto2_unittest.TestAllExtensions "
"--allow_unknown_extensions")));
ExpectStdoutMatchesBinaryFile(golden_path);
ExpectNoErrors();
}

TEST_P(EncodeDecodeTest, DecodeDeterministicOutput) {
std::string golden_path = absl::StrCat(TestTempDir(), "/golden_message");
WriteGoldenMessage(golden_path);
Expand Down
139 changes: 139 additions & 0 deletions src/google/protobuf/testdata/text_format_unittest_extensions_data_with_unknown.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
[proto2_unittest.optional_int32_extension]: 101
[proto2_unittest.optional_int64_extension]: 102
[proto2_unittest.optional_uint32_extension]: 103
[proto2_unittest.optional_uint64_extension]: 104
[proto2_unittest.optional_sint32_extension]: 105
[proto2_unittest.optional_sint64_extension]: 106
[proto2_unittest.optional_fixed32_extension]: 107
[proto2_unittest.optional_fixed64_extension]: 108
[proto2_unittest.optional_sfixed32_extension]: 109
[proto2_unittest.optional_sfixed64_extension]: 110
[proto2_unittest.optional_float_extension]: 111
[proto2_unittest.optional_double_extension]: 112
[proto2_unittest.optional_bool_extension]: true
[proto2_unittest.optional_string_extension]: "115"
[proto2_unittest.optional_bytes_extension]: "116"
[proto2_unittest.optionalgroup_extension] {
a: 117
}
[proto2_unittest.optional_nested_message_extension] {
bb: 118
}
[proto2_unittest.optional_foreign_message_extension] {
c: 119
}
[proto2_unittest.optional_import_message_extension] {
d: 120
}
[proto2_unittest.optional_nested_enum_extension]: BAZ
[proto2_unittest.optional_foreign_enum_extension]: FOREIGN_BAZ
[proto2_unittest.optional_import_enum_extension]: IMPORT_BAZ
[proto2_unittest.optional_string_piece_extension]: "124"
[proto2_unittest.optional_cord_extension]: "125"
[proto2_unittest.optional_public_import_message_extension] {
e: 126
}
[proto2_unittest.optional_lazy_message_extension] {
bb: 127
}
[proto2_unittest.optional_unverified_lazy_message_extension] {
bb: 128
}
[proto2_unittest.repeated_int32_extension]: 201
[proto2_unittest.repeated_int32_extension]: 301
[proto2_unittest.repeated_int64_extension]: 202
[proto2_unittest.repeated_int64_extension]: 302
[proto2_unittest.repeated_uint32_extension]: 203
[proto2_unittest.repeated_uint32_extension]: 303
[proto2_unittest.repeated_uint64_extension]: 204
[proto2_unittest.repeated_uint64_extension]: 304
[proto2_unittest.repeated_sint32_extension]: 205
[proto2_unittest.repeated_sint32_extension]: 305
[proto2_unittest.repeated_sint64_extension]: 206
[proto2_unittest.repeated_sint64_extension]: 306
[proto2_unittest.repeated_fixed32_extension]: 207
[proto2_unittest.repeated_fixed32_extension]: 307
[proto2_unittest.repeated_fixed64_extension]: 208
[proto2_unittest.repeated_fixed64_extension]: 308
[proto2_unittest.repeated_sfixed32_extension]: 209
[proto2_unittest.repeated_sfixed32_extension]: 309
[proto2_unittest.repeated_sfixed64_extension]: 210
[proto2_unittest.repeated_sfixed64_extension]: 310
[proto2_unittest.repeated_float_extension]: 211
[proto2_unittest.repeated_float_extension]: 311
[proto2_unittest.repeated_double_extension]: 212
[proto2_unittest.repeated_double_extension]: 312
[proto2_unittest.repeated_bool_extension]: true
[proto2_unittest.repeated_bool_extension]: false
[proto2_unittest.repeated_string_extension]: "215"
[proto2_unittest.repeated_string_extension]: "315"
[proto2_unittest.repeated_bytes_extension]: "216"
[proto2_unittest.repeated_bytes_extension]: "316"
[proto2_unittest.repeatedgroup_extension] {
a: 217
}
[proto2_unittest.repeatedgroup_extension] {
a: 317
}
[proto2_unittest.repeated_nested_message_extension] {
bb: 218
}
[proto2_unittest.repeated_nested_message_extension] {
bb: 318
}
[proto2_unittest.repeated_foreign_message_extension] {
c: 219
}
[proto2_unittest.repeated_foreign_message_extension] {
c: 319
}
[proto2_unittest.repeated_import_message_extension] {
d: 220
}
[proto2_unittest.repeated_import_message_extension] {
d: 320
}
[proto2_unittest.repeated_nested_enum_extension]: BAR
[proto2_unittest.repeated_nested_enum_extension]: BAZ
[proto2_unittest.repeated_foreign_enum_extension]: FOREIGN_BAR
[proto2_unittest.repeated_foreign_enum_extension]: FOREIGN_BAZ
[proto2_unittest.repeated_import_enum_extension]: IMPORT_BAR
[proto2_unittest.repeated_import_enum_extension]: IMPORT_BAZ
[proto2_unittest.repeated_string_piece_extension]: "224"
[proto2_unittest.repeated_string_piece_extension]: "324"
[proto2_unittest.repeated_cord_extension]: "225"
[proto2_unittest.repeated_cord_extension]: "325"
[proto2_unittest.repeated_lazy_message_extension] {
bb: 227
}
[proto2_unittest.repeated_lazy_message_extension] {
bb: 327
}
[proto2_unittest.default_int32_extension]: 401
[proto2_unittest.default_int64_extension]: 402
[proto2_unittest.default_uint32_extension]: 403
[proto2_unittest.default_uint64_extension]: 404
[proto2_unittest.default_sint32_extension]: 405
[proto2_unittest.default_sint64_extension]: 406
[proto2_unittest.default_fixed32_extension]: 407
[proto2_unittest.default_fixed64_extension]: 408
[proto2_unittest.default_sfixed32_extension]: 409
[proto2_unittest.default_sfixed64_extension]: 410
[proto2_unittest.default_float_extension]: 411
[proto2_unittest.default_double_extension]: 412
[proto2_unittest.default_bool_extension]: false
[proto2_unittest.default_string_extension]: "415"
[proto2_unittest.default_bytes_extension]: "416"
[proto2_unittest.default_nested_enum_extension]: FOO
[proto2_unittest.default_foreign_enum_extension]: FOREIGN_FOO
[proto2_unittest.default_import_enum_extension]: IMPORT_FOO
[proto2_unittest.default_string_piece_extension]: "424"
[proto2_unittest.default_cord_extension]: "425"
[proto2_unittest.optional_bytes_cord_extension]: "optional bytes cord"
[proto2_unittest.oneof_uint32_extension]: 601
[proto2_unittest.oneof_nested_message_extension] {
bb: 602
}
[proto2_unittest.oneof_string_extension]: "603"
[proto2_unittest.oneof_bytes_extension]: "604"
[proto2_unittest.unknown_extension]: 1000
Loading