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
|
/*
*
* Copyright 2016 gRPC authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
#include "test/cpp/util/proto_file_parser.h"
#include <algorithm>
#include <iostream>
#include <sstream>
#include <unordered_set>
#include "absl/memory/memory.h"
#include "absl/strings/str_split.h"
#include <grpcpp/support/config.h>
namespace grpc {
namespace testing {
namespace {
// Match the user input method string to the full_name from method descriptor.
bool MethodNameMatch(const std::string& full_name, const std::string& input) {
std::string clean_input = input;
std::replace(clean_input.begin(), clean_input.end(), '/', '.');
if (clean_input.size() > full_name.size()) {
return false;
}
return full_name.compare(full_name.size() - clean_input.size(),
clean_input.size(), clean_input) == 0;
}
} // namespace
class ErrorPrinter : public protobuf::compiler::MultiFileErrorCollector {
public:
explicit ErrorPrinter(ProtoFileParser* parser) : parser_(parser) {}
void AddError(const std::string& filename, int line, int column,
const std::string& message) override {
std::ostringstream oss;
oss << "error " << filename << " " << line << " " << column << " "
<< message << "\n";
parser_->LogError(oss.str());
}
void AddWarning(const std::string& filename, int line, int column,
const std::string& message) override {
std::cerr << "warning " << filename << " " << line << " " << column << " "
<< message << std::endl;
}
private:
ProtoFileParser* parser_; // not owned
};
ProtoFileParser::ProtoFileParser(const std::shared_ptr<grpc::Channel>& channel,
const std::string& proto_path,
const std::string& protofiles)
: has_error_(false),
dynamic_factory_(new protobuf::DynamicMessageFactory()) {
std::vector<std::string> service_list;
if (channel) {
reflection_db_ =
std::make_unique<grpc::ProtoReflectionDescriptorDatabase>(channel);
reflection_db_->GetServices(&service_list);
}
std::unordered_set<std::string> known_services;
if (!protofiles.empty()) {
for (const absl::string_view single_path : absl::StrSplit(
proto_path, GRPC_CLI_PATH_SEPARATOR, absl::AllowEmpty())) {
source_tree_.MapPath("", std::string(single_path));
}
error_printer_ = std::make_unique<ErrorPrinter>(this);
importer_ = std::make_unique<protobuf::compiler::Importer>(
&source_tree_, error_printer_.get());
std::string file_name;
std::stringstream ss(protofiles);
while (std::getline(ss, file_name, ',')) {
const auto* file_desc = importer_->Import(file_name);
if (file_desc) {
for (int i = 0; i < file_desc->service_count(); i++) {
service_desc_list_.push_back(file_desc->service(i));
known_services.insert(file_desc->service(i)->full_name());
}
} else {
std::cerr << file_name << " not found" << std::endl;
}
}
file_db_ =
std::make_unique<protobuf::DescriptorPoolDatabase>(*importer_->pool());
}
if (!reflection_db_ && !file_db_) {
LogError("No available proto database");
return;
}
if (!reflection_db_) {
desc_db_ = std::move(file_db_);
} else if (!file_db_) {
desc_db_ = std::move(reflection_db_);
} else {
desc_db_ = std::make_unique<protobuf::MergedDescriptorDatabase>(
reflection_db_.get(), file_db_.get());
}
desc_pool_ = std::make_unique<protobuf::DescriptorPool>(desc_db_.get());
for (auto it = service_list.begin(); it != service_list.end(); it++) {
if (known_services.find(*it) == known_services.end()) {
if (const protobuf::ServiceDescriptor* service_desc =
desc_pool_->FindServiceByName(*it)) {
service_desc_list_.push_back(service_desc);
known_services.insert(*it);
}
}
}
}
ProtoFileParser::~ProtoFileParser() {}
std::string ProtoFileParser::GetFullMethodName(const std::string& method) {
has_error_ = false;
if (known_methods_.find(method) != known_methods_.end()) {
return known_methods_[method];
}
const protobuf::MethodDescriptor* method_descriptor = nullptr;
for (auto it = service_desc_list_.begin(); it != service_desc_list_.end();
it++) {
const auto* service_desc = *it;
for (int j = 0; j < service_desc->method_count(); j++) {
const auto* method_desc = service_desc->method(j);
if (MethodNameMatch(method_desc->full_name(), method)) {
if (method_descriptor) {
std::ostringstream error_stream;
error_stream << "Ambiguous method names: ";
error_stream << method_descriptor->full_name() << " ";
error_stream << method_desc->full_name();
LogError(error_stream.str());
}
method_descriptor = method_desc;
}
}
}
if (!method_descriptor) {
LogError("Method name not found");
}
if (has_error_) {
return "";
}
known_methods_[method] = method_descriptor->full_name();
return method_descriptor->full_name();
}
std::string ProtoFileParser::GetFormattedMethodName(const std::string& method) {
has_error_ = false;
std::string formatted_method_name = GetFullMethodName(method);
if (has_error_) {
return "";
}
size_t last_dot = formatted_method_name.find_last_of('.');
if (last_dot != std::string::npos) {
formatted_method_name[last_dot] = '/';
}
formatted_method_name.insert(formatted_method_name.begin(), '/');
return formatted_method_name;
}
std::string ProtoFileParser::GetMessageTypeFromMethod(const std::string& method,
bool is_request) {
has_error_ = false;
std::string full_method_name = GetFullMethodName(method);
if (has_error_) {
return "";
}
const protobuf::MethodDescriptor* method_desc =
desc_pool_->FindMethodByName(full_method_name);
if (!method_desc) {
LogError("Method not found");
return "";
}
return is_request ? method_desc->input_type()->full_name()
: method_desc->output_type()->full_name();
}
bool ProtoFileParser::IsStreaming(const std::string& method, bool is_request) {
has_error_ = false;
std::string full_method_name = GetFullMethodName(method);
if (has_error_) {
return false;
}
const protobuf::MethodDescriptor* method_desc =
desc_pool_->FindMethodByName(full_method_name);
if (!method_desc) {
LogError("Method not found");
return false;
}
return is_request ? method_desc->client_streaming()
: method_desc->server_streaming();
}
std::string ProtoFileParser::GetSerializedProtoFromMethod(
const std::string& method, const std::string& formatted_proto,
bool is_request, bool is_json_format) {
has_error_ = false;
std::string message_type_name = GetMessageTypeFromMethod(method, is_request);
if (has_error_) {
return "";
}
return GetSerializedProtoFromMessageType(message_type_name, formatted_proto,
is_json_format);
}
std::string ProtoFileParser::GetFormattedStringFromMethod(
const std::string& method, const std::string& serialized_proto,
bool is_request, bool is_json_format) {
has_error_ = false;
std::string message_type_name = GetMessageTypeFromMethod(method, is_request);
if (has_error_) {
return "";
}
return GetFormattedStringFromMessageType(message_type_name, serialized_proto,
is_json_format);
}
std::string ProtoFileParser::GetSerializedProtoFromMessageType(
const std::string& message_type_name, const std::string& formatted_proto,
bool is_json_format) {
has_error_ = false;
std::string serialized;
const protobuf::Descriptor* desc =
desc_pool_->FindMessageTypeByName(message_type_name);
if (!desc) {
LogError("Message type not found");
return "";
}
std::unique_ptr<grpc::protobuf::Message> msg(
dynamic_factory_->GetPrototype(desc)->New());
bool ok;
if (is_json_format) {
ok = grpc::protobuf::json::JsonStringToMessage(formatted_proto, msg.get())
.ok();
if (!ok) {
LogError("Failed to convert json format to proto.");
return "";
}
} else {
ok = protobuf::TextFormat::ParseFromString(formatted_proto, msg.get());
if (!ok) {
LogError("Failed to convert text format to proto.");
return "";
}
}
ok = msg->SerializeToString(&serialized);
if (!ok) {
LogError("Failed to serialize proto.");
return "";
}
return serialized;
}
std::string ProtoFileParser::GetFormattedStringFromMessageType(
const std::string& message_type_name, const std::string& serialized_proto,
bool is_json_format) {
has_error_ = false;
const protobuf::Descriptor* desc =
desc_pool_->FindMessageTypeByName(message_type_name);
if (!desc) {
LogError("Message type not found");
return "";
}
std::unique_ptr<grpc::protobuf::Message> msg(
dynamic_factory_->GetPrototype(desc)->New());
if (!msg->ParseFromString(serialized_proto)) {
LogError("Failed to deserialize proto.");
return "";
}
std::string formatted_string;
if (is_json_format) {
grpc::protobuf::json::JsonPrintOptions jsonPrintOptions;
jsonPrintOptions.add_whitespace = true;
if (!grpc::protobuf::json::MessageToJsonString(*msg, &formatted_string,
jsonPrintOptions)
.ok()) {
LogError("Failed to print proto message to json format");
return "";
}
} else {
if (!protobuf::TextFormat::PrintToString(*msg, &formatted_string)) {
LogError("Failed to print proto message to text format");
return "";
}
}
return formatted_string;
}
void ProtoFileParser::LogError(const std::string& error_msg) {
if (!error_msg.empty()) {
std::cerr << error_msg << std::endl;
}
has_error_ = true;
}
} // namespace testing
} // namespace grpc
|