1 //
2 //
3 // Copyright 2018 gRPC authors.
4 //
5 // Licensed under the Apache License, Version 2.0 (the "License");
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
8 //
9 // http://www.apache.org/licenses/LICENSE-2.0
10 //
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
16 //
17 //
18
19 #include "test/cpp/util/channel_trace_proto_helper.h"
20
21 #include <grpc/grpc.h>
22 #include <grpc/support/port_platform.h>
23 #include <grpcpp/impl/codegen/config_protobuf.h>
24 #include <grpcpp/support/config.h>
25 #include <gtest/gtest.h>
26
27 #include "src/core/lib/iomgr/error.h"
28 #include "src/core/util/crash.h"
29 #include "src/core/util/json/json.h"
30 #include "src/core/util/json/json_reader.h"
31 #include "src/core/util/json/json_writer.h"
32 #include "src/proto/grpc/channelz/channelz.pb.h"
33
34 namespace grpc {
35
36 namespace {
37
38 // Generic helper that takes in a json string, converts it to a proto, and
39 // then back to json. This ensures that the json string was correctly formatted
40 // according to https://developers.google.com/protocol-buffers/docs/proto3#json
41 template <typename Message>
ValidateProtoJsonTranslation(absl::string_view json_str)42 void ValidateProtoJsonTranslation(absl::string_view json_str) {
43 Message msg;
44 grpc::protobuf::json::JsonParseOptions parse_options;
45 // If the following line is failing, then uncomment the last line of the
46 // comment, and uncomment the lines that print the two strings. You can
47 // then compare the output, and determine what fields are missing.
48 //
49 // parse_options.ignore_unknown_fields = true;
50 grpc::protobuf::util::Status s =
51 grpc::protobuf::json::JsonStringToMessage(json_str, &msg, parse_options);
52 EXPECT_TRUE(s.ok());
53 std::string proto_json_str;
54 grpc::protobuf::json::JsonPrintOptions print_options;
55 // We usually do not want this to be true, however it can be helpful to
56 // uncomment and see the output produced then all fields are printed.
57 // print_options.always_print_primitive_fields = true;
58 s = grpc::protobuf::json::MessageToJsonString(msg, &proto_json_str,
59 print_options);
60 EXPECT_TRUE(s.ok());
61 // Parse JSON and re-dump to string, to make sure formatting is the
62 // same as what would be generated by our JSON library.
63 auto parsed_json = grpc_core::JsonParse(proto_json_str.c_str());
64 ASSERT_TRUE(parsed_json.ok()) << parsed_json.status();
65 ASSERT_EQ(parsed_json->type(), grpc_core::Json::Type::kObject);
66 proto_json_str = grpc_core::JsonDump(*parsed_json);
67 EXPECT_EQ(json_str, proto_json_str);
68 }
69
70 } // namespace
71
72 namespace testing {
73
ValidateChannelTraceProtoJsonTranslation(absl::string_view json_string)74 void ValidateChannelTraceProtoJsonTranslation(absl::string_view json_string) {
75 ValidateProtoJsonTranslation<grpc::channelz::v1::ChannelTrace>(json_string);
76 }
77
ValidateChannelProtoJsonTranslation(absl::string_view json_string)78 void ValidateChannelProtoJsonTranslation(absl::string_view json_string) {
79 ValidateProtoJsonTranslation<grpc::channelz::v1::Channel>(json_string);
80 }
81
ValidateGetTopChannelsResponseProtoJsonTranslation(absl::string_view json_string)82 void ValidateGetTopChannelsResponseProtoJsonTranslation(
83 absl::string_view json_string) {
84 ValidateProtoJsonTranslation<grpc::channelz::v1::GetTopChannelsResponse>(
85 json_string);
86 }
87
ValidateGetChannelResponseProtoJsonTranslation(absl::string_view json_string)88 void ValidateGetChannelResponseProtoJsonTranslation(
89 absl::string_view json_string) {
90 ValidateProtoJsonTranslation<grpc::channelz::v1::GetChannelResponse>(
91 json_string);
92 }
93
ValidateGetServerResponseProtoJsonTranslation(absl::string_view json_string)94 void ValidateGetServerResponseProtoJsonTranslation(
95 absl::string_view json_string) {
96 ValidateProtoJsonTranslation<grpc::channelz::v1::GetServerResponse>(
97 json_string);
98 }
99
ValidateSubchannelProtoJsonTranslation(absl::string_view json_string)100 void ValidateSubchannelProtoJsonTranslation(absl::string_view json_string) {
101 ValidateProtoJsonTranslation<grpc::channelz::v1::Subchannel>(json_string);
102 }
103
ValidateServerProtoJsonTranslation(absl::string_view json_string)104 void ValidateServerProtoJsonTranslation(absl::string_view json_string) {
105 ValidateProtoJsonTranslation<grpc::channelz::v1::Server>(json_string);
106 }
107
ValidateGetServersResponseProtoJsonTranslation(absl::string_view json_string)108 void ValidateGetServersResponseProtoJsonTranslation(
109 absl::string_view json_string) {
110 ValidateProtoJsonTranslation<grpc::channelz::v1::GetServersResponse>(
111 json_string);
112 }
113
114 } // namespace testing
115 } // namespace grpc
116