Skip to content

Add test cases for undocumented transcoder behaviors #114

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

Open
petedmarsh wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Add test cases for undocumented transcoder behaviors #114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7951fef
Add tests for non-spec-compliant scalar bool string parsing
petedmarsh Jun 5, 2026
4bc746b
Add tests for non-spec-compliant wrapper type object form parsing
petedmarsh Jun 5, 2026
eaa76e3
Add tests for body/binding collision detection using proto field name
petedmarsh Jun 5, 2026
d3fbbde
Add tests for float/double integer values rendered without decimal point
petedmarsh Jun 5, 2026
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
1 change: 1 addition & 0 deletions test/BUILD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ proto_library(
name = "bookstore_proto",
testonly = 1,
srcs = ["bookstore.proto"],
deps = ["@com_google_protobuf//:wrappers_proto"],
)

cc_proto_library(
Expand Down
39 changes: 39 additions & 0 deletions test/bookstore.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
// Test proto for transcoding
syntax = "proto3";
package google.grpc.transcoding;
import "google/protobuf/wrappers.proto";
message Biography {
int64 year_born = 1;
int64 year_died = 2;
Expand Down Expand Up @@ -73,3 +74,41 @@ message DeleteBookRequest {
int64 shelf = 1;
int64 book = 2;
}
message ScalarBoolMessage {
bool b = 1;
}
message BoolValueMessage {
google.protobuf.BoolValue b = 1;
}
message StringValueMessage {
google.protobuf.StringValue s = 1;
}
message BytesValueMessage {
google.protobuf.BytesValue b = 1;
}
message Int32ValueMessage {
google.protobuf.Int32Value i = 1;
}
message Int64ValueMessage {
google.protobuf.Int64Value i = 1;
}
message UInt32ValueMessage {
google.protobuf.UInt32Value u = 1;
}
message UInt64ValueMessage {
google.protobuf.UInt64Value u = 1;
}
message FloatValueMessage {
google.protobuf.FloatValue f = 1;
}
message DoubleValueMessage {
google.protobuf.DoubleValue d = 1;
}
message FieldNamingMessage {
string snake_case_field = 1;
string custom_field = 2 [json_name = "myCustomName"];
}
message FloatDoubleMessage {
float f = 1;
double d = 2;
}
277 changes: 277 additions & 0 deletions test/json_request_translator_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -794,6 +794,283 @@ TEST_F(JsonRequestTranslatorTest, StreamingErrorNotAnArray) {
absl::StatusCode::kInvalidArgument));
}

// Scalar bool fields accept string values.
// The proto JSON spec requires bool fields to only accept JSON true/false
// literals, but the transcoder also accepts string values like "true", "yes",
// "false", "no" (case-insensitive).
TEST_F(JsonRequestTranslatorTest, ScalarBoolAcceptsStringTrue) {
LoadService("bookstore_service.pb.txt");
SetMessageType("ScalarBoolMessage");
TranslationTestCase tc(false);
tc.AddMessage(R"({"b": "true"})", "b: true");
tc.Build();
EXPECT_TRUE((RunTest<ScalarBoolMessage>(1, 1.0, &tc)));
}

TEST_F(JsonRequestTranslatorTest, ScalarBoolAcceptsStringFalse) {
LoadService("bookstore_service.pb.txt");
SetMessageType("ScalarBoolMessage");
TranslationTestCase tc(false);
tc.AddMessage(R"({"b": "false"})", "b: false");
tc.Build();
EXPECT_TRUE((RunTest<ScalarBoolMessage>(1, 1.0, &tc)));
}

TEST_F(JsonRequestTranslatorTest, ScalarBoolAcceptsStringYes) {
LoadService("bookstore_service.pb.txt");
SetMessageType("ScalarBoolMessage");
TranslationTestCase tc(false);
tc.AddMessage(R"({"b": "yes"})", "b: true");
tc.Build();
EXPECT_TRUE((RunTest<ScalarBoolMessage>(1, 1.0, &tc)));
}

TEST_F(JsonRequestTranslatorTest, ScalarBoolAcceptsStringNo) {
LoadService("bookstore_service.pb.txt");
SetMessageType("ScalarBoolMessage");
TranslationTestCase tc(false);
tc.AddMessage(R"({"b": "no"})", "b: false");
tc.Build();
EXPECT_TRUE((RunTest<ScalarBoolMessage>(1, 1.0, &tc)));
}

TEST_F(JsonRequestTranslatorTest, ScalarBoolAcceptsStringCaseInsensitive) {
LoadService("bookstore_service.pb.txt");
SetMessageType("ScalarBoolMessage");
TranslationTestCase tc(false);
tc.AddMessage(R"({"b": "TrUe"})", "b: true");
tc.Build();
EXPECT_TRUE((RunTest<ScalarBoolMessage>(1, 1.0, &tc)));
}

TEST_F(JsonRequestTranslatorTest, ScalarBoolAcceptsStringNOUpperCase) {
LoadService("bookstore_service.pb.txt");
SetMessageType("ScalarBoolMessage");
TranslationTestCase tc(false);
tc.AddMessage(R"({"b": "NO"})", "b: false");
tc.Build();
EXPECT_TRUE((RunTest<ScalarBoolMessage>(1, 1.0, &tc)));
}

// Wrapper types accept the object/message form {"value": ...}.
// The proto JSON spec requires wrapper types (e.g. google.protobuf.BoolValue)
// to be represented as their underlying scalar, not as {"value": <scalar>}.

TEST_F(JsonRequestTranslatorTest, BoolValueAcceptsObjectFormTrue) {
LoadService("bookstore_service.pb.txt");
SetMessageType("BoolValueMessage");
TranslationTestCase tc(false);
tc.AddMessage(R"({"b": {"value": true}})", "b { value: true }");
tc.Build();
EXPECT_TRUE((RunTest<BoolValueMessage>(1, 1.0, &tc)));
}

TEST_F(JsonRequestTranslatorTest, BoolValueAcceptsObjectFormFalse) {
LoadService("bookstore_service.pb.txt");
SetMessageType("BoolValueMessage");
TranslationTestCase tc(false);
tc.AddMessage(R"({"b": {"value": false}})", "b { value: false }");
tc.Build();
EXPECT_TRUE((RunTest<BoolValueMessage>(1, 1.0, &tc)));
}

TEST_F(JsonRequestTranslatorTest, StringValueAcceptsObjectForm) {
LoadService("bookstore_service.pb.txt");
SetMessageType("StringValueMessage");
TranslationTestCase tc(false);
tc.AddMessage(R"({"s": {"value": "oh no"}})", R"(s { value: "oh no" })");
tc.Build();
EXPECT_TRUE((RunTest<StringValueMessage>(1, 1.0, &tc)));
}

TEST_F(JsonRequestTranslatorTest, BytesValueAcceptsObjectForm) {
LoadService("bookstore_service.pb.txt");
SetMessageType("BytesValueMessage");
TranslationTestCase tc(false);
tc.AddMessage(R"({"b": {"value": "dGVzdA=="}})", R"(b { value: "test" })");
tc.Build();
EXPECT_TRUE((RunTest<BytesValueMessage>(1, 1.0, &tc)));
}

TEST_F(JsonRequestTranslatorTest, Int32ValueAcceptsObjectForm) {
LoadService("bookstore_service.pb.txt");
SetMessageType("Int32ValueMessage");
TranslationTestCase tc(false);
tc.AddMessage(R"({"i": {"value": 42}})", "i { value: 42 }");
tc.Build();
EXPECT_TRUE((RunTest<Int32ValueMessage>(1, 1.0, &tc)));
}

TEST_F(JsonRequestTranslatorTest, Int64ValueAcceptsObjectForm) {
LoadService("bookstore_service.pb.txt");
SetMessageType("Int64ValueMessage");
TranslationTestCase tc(false);
tc.AddMessage(R"({"i": {"value": "42"}})", "i { value: 42 }");
tc.Build();
EXPECT_TRUE((RunTest<Int64ValueMessage>(1, 1.0, &tc)));
}

TEST_F(JsonRequestTranslatorTest, UInt32ValueAcceptsObjectForm) {
LoadService("bookstore_service.pb.txt");
SetMessageType("UInt32ValueMessage");
TranslationTestCase tc(false);
tc.AddMessage(R"({"u": {"value": 42}})", "u { value: 42 }");
tc.Build();
EXPECT_TRUE((RunTest<UInt32ValueMessage>(1, 1.0, &tc)));
}

TEST_F(JsonRequestTranslatorTest, UInt64ValueAcceptsObjectForm) {
LoadService("bookstore_service.pb.txt");
SetMessageType("UInt64ValueMessage");
TranslationTestCase tc(false);
tc.AddMessage(R"({"u": {"value": "42"}})", "u { value: 42 }");
tc.Build();
EXPECT_TRUE((RunTest<UInt64ValueMessage>(1, 1.0, &tc)));
}

TEST_F(JsonRequestTranslatorTest, FloatValueAcceptsObjectForm) {
LoadService("bookstore_service.pb.txt");
SetMessageType("FloatValueMessage");
TranslationTestCase tc(false);
tc.AddMessage(R"({"f": {"value": 3.14}})", "f { value: 3.14 }");
tc.Build();
EXPECT_TRUE((RunTest<FloatValueMessage>(1, 1.0, &tc)));
}

TEST_F(JsonRequestTranslatorTest, DoubleValueAcceptsObjectForm) {
LoadService("bookstore_service.pb.txt");
SetMessageType("DoubleValueMessage");
TranslationTestCase tc(false);
tc.AddMessage(R"({"d": {"value": 2.718}})", "d { value: 2.718 }");
tc.Build();
EXPECT_TRUE((RunTest<DoubleValueMessage>(1, 1.0, &tc)));
}

// Behaviors 1+2 combined: wrapper types in object form also accept string
// bool values.
TEST_F(JsonRequestTranslatorTest, BoolValueObjectFormAcceptsStringYes) {
LoadService("bookstore_service.pb.txt");
SetMessageType("BoolValueMessage");
TranslationTestCase tc(false);
tc.AddMessage(R"({"b": {"value": "yes"}})", "b { value: true }");
tc.Build();
EXPECT_TRUE((RunTest<BoolValueMessage>(1, 1.0, &tc)));
}

TEST_F(JsonRequestTranslatorTest, BoolValueObjectFormAcceptsStringNo) {
LoadService("bookstore_service.pb.txt");
SetMessageType("BoolValueMessage");
TranslationTestCase tc(false);
tc.AddMessage(R"({"b": {"value": "no"}})", "b { value: false }");
tc.Build();
EXPECT_TRUE((RunTest<BoolValueMessage>(1, 1.0, &tc)));
}

// Extra keys alongside "value" are silently ignored.
TEST_F(JsonRequestTranslatorTest, BoolValueObjectFormExtraKeysIgnored) {
LoadService("bookstore_service.pb.txt");
SetMessageType("BoolValueMessage");
TranslationTestCase tc(false);
tc.AddMessage(R"({"b": {"value": true, "extra": "ignored"}})",
"b { value: true }");
tc.Build();
EXPECT_TRUE((RunTest<BoolValueMessage>(1, 1.0, &tc)));
}

// When a wrapper type field receives an object with NO "value" key, the
// transcoder correctly rejects it with INVALID_ARGUMENT.
TEST_F(JsonRequestTranslatorTest, BoolValueRejectsArbitraryObject) {
LoadService("bookstore_service.pb.txt");
SetMessageType("BoolValueMessage");
Build();
AddChunk(R"({"b": {"foo": "bar", "baz": 123}})");
Finish();
EXPECT_TRUE(Tester().ExpectNone());
EXPECT_TRUE(
Tester().ExpectStatusEq(absl::StatusCode::kInvalidArgument));
}

TEST_F(JsonRequestTranslatorTest, StringValueRejectsArbitraryObject) {
LoadService("bookstore_service.pb.txt");
SetMessageType("StringValueMessage");
Build();
AddChunk(R"({"s": {"name": "test", "count": 42}})");
Finish();
EXPECT_TRUE(Tester().ExpectNone());
EXPECT_TRUE(
Tester().ExpectStatusEq(absl::StatusCode::kInvalidArgument));
}

// Body presence detection with variable bindings (query parameters).
// When a JSON body and a query parameter target the same field, the weaver's
// CollisionCheck determines which value wins. CollisionCheck compares the raw
// JSON key name against the binding's proto field name (Field::name()). This
// means collision is only detected when the body uses the proto field name, not
// the json_name.

// Proto field name in body → collision detected → body wins.
TEST_F(JsonRequestTranslatorTest, BodyProtoNameWinsOverBinding) {
LoadService("bookstore_service.pb.txt");
SetMessageType("FieldNamingMessage");
AddVariableBinding("snake_case_field", "query");
TranslationTestCase tc(false);
tc.AddMessage(R"({"snake_case_field": "body"})",
R"(snake_case_field: "body")");
tc.Build();
EXPECT_TRUE((RunTest<FieldNamingMessage>(1, 1.0, &tc)));
}

// json_name (camelCase) in body → collision NOT detected → binding is weaved
// after body → query param silently overrides body value.
TEST_F(JsonRequestTranslatorTest, BodyJsonNameOverriddenByBinding) {
LoadService("bookstore_service.pb.txt");
SetMessageType("FieldNamingMessage");
AddVariableBinding("snake_case_field", "query");
TranslationTestCase tc(false);
tc.AddMessage(R"({"snakeCaseField": "body"})",
R"(snake_case_field: "query")");
tc.Build();
EXPECT_TRUE((RunTest<FieldNamingMessage>(1, 1.0, &tc)));
}

// Custom json_name in body → collision NOT detected → binding overrides.
TEST_F(JsonRequestTranslatorTest, BodyCustomJsonNameOverriddenByBinding) {
LoadService("bookstore_service.pb.txt");
SetMessageType("FieldNamingMessage");
AddVariableBinding("custom_field", "query");
TranslationTestCase tc(false);
tc.AddMessage(R"({"myCustomName": "body"})",
R"(custom_field: "query")");
tc.Build();
EXPECT_TRUE((RunTest<FieldNamingMessage>(1, 1.0, &tc)));
}

// Empty string body value using proto name → collision detected → body wins
// (default value is still considered present).
TEST_F(JsonRequestTranslatorTest, BodyEmptyStringWinsOverBinding) {
LoadService("bookstore_service.pb.txt");
SetMessageType("FieldNamingMessage");
AddVariableBinding("snake_case_field", "query");
TranslationTestCase tc(false);
tc.AddMessage(R"({"snake_case_field": ""})",
R"(snake_case_field: "")");
tc.Build();
EXPECT_TRUE((RunTest<FieldNamingMessage>(1, 1.0, &tc)));
}

// Null body value → RenderNull does not call CollisionCheck → binding survives
// and is weaved → query param wins.
TEST_F(JsonRequestTranslatorTest, BodyNullAllowsBindingToWin) {
LoadService("bookstore_service.pb.txt");
SetMessageType("FieldNamingMessage");
AddVariableBinding("snake_case_field", "query");
TranslationTestCase tc(false);
tc.AddMessage(R"({"snake_case_field": null})",
R"(snake_case_field: "query")");
tc.Build();
EXPECT_TRUE((RunTest<FieldNamingMessage>(1, 1.0, &tc)));
}

} // namespace
} // namespace testing
} // namespace transcoding
Expand Down
Loading