grpc/test/cpp/util/proto_file_parser.h

//
//
// 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.
//
//

#ifndef GRPC_TEST_CPP_UTIL_PROTO_FILE_PARSER_H
#define GRPC_TEST_CPP_UTIL_PROTO_FILE_PARSER_H

#include <memory>

#include <grpcpp/channel.h>

#include "test/cpp/util/config_grpc_cli.h"
#include "test/cpp/util/proto_reflection_descriptor_database.h"

#if defined(_WIN32) && !defined(__CYGWIN__)
#define GRPC_CLI_PATH_SEPARATOR ";"
#else
#define GRPC_CLI_PATH_SEPARATOR ":"
#endif

namespace grpc {
namespace testing {
class ErrorPrinter;

// Find method and associated request/response types.
class ProtoFileParser {
 public:
  // The parser will search proto files using the server reflection service
  // provided on the given channel. The given protofiles in a source tree rooted
  // from proto_path will also be searched.
  ProtoFileParser(const std::shared_ptr<grpc::Channel>& channel,
                  const std::string& proto_path, const std::string& protofiles);

  ~ProtoFileParser();

  // The input method name in the following four functions could be a partial
  // string such as Service.Method or even just Method. It will log an error if
  // there is ambiguity.
  // Full method name is in the form of Service.Method, it's good to be used in
  // descriptor database queries.
  std::string GetFullMethodName(const std::string& method);

  // Formatted method name is in the form of /Service/Method, it's good to be
  // used as the argument of Stub::Call()
  std::string GetFormattedMethodName(const std::string& method);

  /// Converts a text or json string to its binary proto representation for the
  /// given method's input or return type.
  /// \param method the name of the method (does not need to be fully qualified
  ///        name)
  /// \param formatted_proto the text- or json-formatted proto string
  /// \param is_request if \c true the resolved type is that of the input
  ///        parameter of the method, otherwise it is the output type
  /// \param is_json_format if \c true the \c formatted_proto is treated as a
  ///        json-formatted proto, otherwise it is treated as a text-formatted
  ///        proto
  /// \return the serialised binary proto representation of \c formatted_proto
  std::string GetSerializedProtoFromMethod(const std::string& method,
                                           const std::string& formatted_proto,
                                           bool is_request,
                                           bool is_json_format);

  /// Converts a text or json string to its proto representation for the given
  /// message type.
  /// \param formatted_proto the text- or json-formatted proto string
  /// \return the serialised binary proto representation of \c formatted_proto
  std::string GetSerializedProtoFromMessageType(
      const std::string& message_type_name, const std::string& formatted_proto,
      bool is_json_format);

  /// Converts a binary proto string to its text or json string representation
  /// for the given method's input or return type.
  /// \param method the name of the method (does not need to be a fully
  ///        qualified name)
  /// \param the serialised binary proto representation of type
  ///        \c message_type_name
  /// \return the text- or json-formatted proto string of \c serialized_proto
  std::string GetFormattedStringFromMethod(const std::string& method,
                                           const std::string& serialized_proto,
                                           bool is_request,
                                           bool is_json_format);

  /// Converts a binary proto string to its text or json string representation
  /// for the given message type.
  /// \param the serialised binary proto representation of type
  ///        \c message_type_name
  /// \return the text- or json-formatted proto string of \c serialized_proto
  std::string GetFormattedStringFromMessageType(
      const std::string& message_type_name, const std::string& serialized_proto,
      bool is_json_format);

  bool IsStreaming(const std::string& method, bool is_request);

  bool HasError() const { return has_error_; }

  void LogError(const std::string& error_msg);

 private:
  std::string GetMessageTypeFromMethod(const std::string& method,
                                       bool is_request);

  bool has_error_;
  std::string request_text_;
  protobuf::compiler::DiskSourceTree source_tree_;
  std::unique_ptr<ErrorPrinter> error_printer_;
  std::unique_ptr<protobuf::compiler::Importer> importer_;
  std::unique_ptr<grpc::ProtoReflectionDescriptorDatabase> reflection_db_;
  std::unique_ptr<protobuf::DescriptorPoolDatabase> file_db_;
  std::unique_ptr<protobuf::DescriptorDatabase> desc_db_;
  std::unique_ptr<protobuf::DescriptorPool> desc_pool_;
  std::unique_ptr<protobuf::DynamicMessageFactory> dynamic_factory_;
  std::unique_ptr<grpc::protobuf::Message> request_prototype_;
  std::unique_ptr<grpc::protobuf::Message> response_prototype_;
  std::unordered_map<std::string, std::string> known_methods_;
  std::vector<const protobuf::ServiceDescriptor*> service_desc_list_;
};

}  // namespace testing
}  // namespace grpc

#endif  // GRPC_TEST_CPP_UTIL_PROTO_FILE_PARSER_H