/* * * Copyright 2016, Google Inc. * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are * met: * * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above * copyright notice, this list of conditions and the following disclaimer * in the documentation and/or other materials provided with the * distribution. * * Neither the name of Google Inc. nor the names of its * contributors may be used to endorse or promote products derived from * this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include "src/proto/grpc/testing/echo.grpc.pb.h" #include "test/core/util/port.h" #include "test/core/util/test_config.h" #include "test/cpp/end2end/test_service_impl.h" #define PLUGIN_NAME "TestServerBuilderPlugin" namespace grpc { namespace testing { class TestServerBuilderPlugin : public ServerBuilderPlugin { public: TestServerBuilderPlugin() : service_(new TestServiceImpl()) { init_server_is_called_ = false; finish_is_called_ = false; change_arguments_is_called_ = false; } grpc::string name() GRPC_OVERRIDE { return PLUGIN_NAME; } void InitServer(ServerInitializer* si) GRPC_OVERRIDE { init_server_is_called_ = true; if (register_service_) { si->RegisterService(service_); } } void Finish(ServerInitializer* si) GRPC_OVERRIDE { finish_is_called_ = true; } void ChangeArguments(const grpc::string& name, void* value) GRPC_OVERRIDE { change_arguments_is_called_ = true; } bool has_async_methods() const GRPC_OVERRIDE { if (register_service_) { return service_->has_async_methods(); } return false; } bool has_sync_methods() const GRPC_OVERRIDE { if (register_service_) { return service_->has_synchronous_methods(); } return false; } void SetRegisterService() { register_service_ = true; } bool init_server_is_called() { return init_server_is_called_; } bool finish_is_called() { return finish_is_called_; } bool change_arguments_is_called() { return change_arguments_is_called_; } private: bool init_server_is_called_; bool finish_is_called_; bool change_arguments_is_called_; bool register_service_; std::shared_ptr service_; }; class InsertPluginServerBuilderOption : public ServerBuilderOption { public: InsertPluginServerBuilderOption() { register_service_ = false; } void UpdateArguments(ChannelArguments* arg) GRPC_OVERRIDE {} void UpdatePlugins( std::map>* plugins) GRPC_OVERRIDE { plugins->clear(); std::unique_ptr plugin( new TestServerBuilderPlugin()); if (register_service_) plugin->SetRegisterService(); (*plugins)[plugin->name()] = std::move(plugin); } void SetRegisterService() { register_service_ = true; } private: bool register_service_; }; std::unique_ptr CreateTestServerBuilderPlugin() { return std::unique_ptr(new TestServerBuilderPlugin()); } void AddTestServerBuilderPlugin() { static bool already_here = false; if (already_here) return; already_here = true; ::grpc::ServerBuilder::InternalAddPluginFactory( &CreateTestServerBuilderPlugin); } // Force AddServerBuilderPlugin() to be called at static initialization time. struct StaticTestPluginInitializer { StaticTestPluginInitializer() { AddTestServerBuilderPlugin(); } } static_plugin_initializer_test_; // When the param boolean is true, the ServerBuilder plugin will be added at the // time of static initialization. When it's false, the ServerBuilder plugin will // be added using ServerBuilder::SetOption(). class ServerBuilderPluginTest : public ::testing::TestWithParam { public: ServerBuilderPluginTest() {} void SetUp() GRPC_OVERRIDE { port_ = grpc_pick_unused_port_or_die(); builder_.reset(new ServerBuilder()); } void InsertPlugin() { if (GetParam()) { // Add ServerBuilder plugin in static initialization EXPECT_TRUE(builder_->plugins_[PLUGIN_NAME] != nullptr); } else { // Add ServerBuilder plugin using ServerBuilder::SetOption() builder_->SetOption(std::unique_ptr( new InsertPluginServerBuilderOption())); } } void InsertPluginWithTestService() { if (GetParam()) { // Add ServerBuilder plugin in static initialization EXPECT_TRUE(builder_->plugins_[PLUGIN_NAME] != nullptr); auto plugin = static_cast( builder_->plugins_[PLUGIN_NAME].get()); EXPECT_TRUE(plugin != nullptr); plugin->SetRegisterService(); } else { // Add ServerBuilder plugin using ServerBuilder::SetOption() std::unique_ptr option( new InsertPluginServerBuilderOption()); option->SetRegisterService(); builder_->SetOption(std::move(option)); } } void StartServer() { grpc::string server_address = "localhost:" + to_string(port_); builder_->AddListeningPort(server_address, InsecureServerCredentials()); server_ = builder_->BuildAndStart(); EXPECT_TRUE(builder_->plugins_[PLUGIN_NAME] != nullptr); } void ResetStub() { string target = "dns:localhost:" + to_string(port_); channel_ = CreateChannel(target, InsecureChannelCredentials()); stub_ = grpc::testing::EchoTestService::NewStub(channel_); } void TearDown() GRPC_OVERRIDE { EXPECT_TRUE(builder_->plugins_[PLUGIN_NAME] != nullptr); auto plugin = static_cast( builder_->plugins_[PLUGIN_NAME].get()); EXPECT_TRUE(plugin != nullptr); EXPECT_TRUE(plugin->init_server_is_called()); EXPECT_TRUE(plugin->finish_is_called()); } string to_string(const int number) { std::stringstream strs; strs << number; return strs.str(); } protected: std::shared_ptr channel_; std::unique_ptr builder_; std::unique_ptr stub_; std::unique_ptr server_; TestServiceImpl service_; int port_; }; TEST_P(ServerBuilderPluginTest, PluginWithoutServiceTest) { InsertPlugin(); StartServer(); } TEST_P(ServerBuilderPluginTest, PluginWithServiceTest) { InsertPluginWithTestService(); StartServer(); ResetStub(); EchoRequest request; EchoResponse response; request.set_message("Hello hello hello hello"); ClientContext context; context.set_compression_algorithm(GRPC_COMPRESS_GZIP); Status s = stub_->Echo(&context, request, &response); EXPECT_EQ(response.message(), request.message()); EXPECT_TRUE(s.ok()); } INSTANTIATE_TEST_CASE_P(ServerBuilderPluginTest, ServerBuilderPluginTest, ::testing::Values(false, true)); } // namespace testing } // namespace grpc int main(int argc, char** argv) { grpc_test_init(argc, argv); ::testing::InitGoogleTest(&argc, argv); return RUN_ALL_TESTS(); }