Client context test peer (#25610)

* Create client_context_test_peer.h

mock-up class for ClientContext

* Add ClientContextTestPeer as a friend for test

* Update client_context_test_peer.h

* Update client_context_test_peer.h

* unit test for client_context_test_peer.h

* unit test for client_context_test_peer.h

* fix for tools/buildgen/generate_projects.sh

* Revert "fix for tools/buildgen/generate_projects.sh"

This reverts commit b007aa8c2b.

* re-fix for tools/buildgen/generate_projects.sh

* Remove an empty line

Co-authored-by: Vijay Pai <vpai@google.com>
pull/26369/head
shangwu-google 4 years ago committed by GitHub
parent 66253c521a
commit 8b3f4fca25
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 1
      BUILD
  2. 38
      CMakeLists.txt
  3. 11
      build_autogenerated.yaml
  4. 2
      include/grpcpp/impl/codegen/client_context.h
  5. 62
      include/grpcpp/test/client_context_test_peer.h
  6. 16
      test/cpp/test/BUILD
  7. 81
      test/cpp/test/client_context_test_peer_test.cc
  8. 24
      tools/run_tests/generated/tests.json

@ -2706,6 +2706,7 @@ grpc_cc_library(
"include/grpc++/test/mock_stream.h",
"include/grpc++/test/server_context_test_spouse.h",
"include/grpcpp/test/channel_test_peer.h",
"include/grpcpp/test/client_context_test_peer.h",
"include/grpcpp/test/default_reactor_test_peer.h",
"include/grpcpp/test/mock_stream.h",
"include/grpcpp/test/server_context_test_spouse.h",

@ -826,6 +826,7 @@ if(gRPC_BUILD_TESTS)
if(_gRPC_PLATFORM_LINUX OR _gRPC_PLATFORM_MAC OR _gRPC_PLATFORM_POSIX)
add_dependencies(buildtests_cxx client_channel_stress_test)
endif()
add_dependencies(buildtests_cxx client_context_test_peer_test)
add_dependencies(buildtests_cxx client_interceptors_end2end_test)
if(_gRPC_PLATFORM_LINUX OR _gRPC_PLATFORM_MAC OR _gRPC_PLATFORM_POSIX)
add_dependencies(buildtests_cxx client_lb_end2end_test)
@ -3261,6 +3262,7 @@ foreach(_hdr
include/grpc++/test/mock_stream.h
include/grpc++/test/server_context_test_spouse.h
include/grpcpp/test/channel_test_peer.h
include/grpcpp/test/client_context_test_peer.h
include/grpcpp/test/default_reactor_test_peer.h
include/grpcpp/test/mock_stream.h
include/grpcpp/test/server_context_test_spouse.h
@ -9690,6 +9692,42 @@ endif()
endif()
if(gRPC_BUILD_TESTS)
add_executable(client_context_test_peer_test
test/cpp/test/client_context_test_peer_test.cc
third_party/googletest/googletest/src/gtest-all.cc
third_party/googletest/googlemock/src/gmock-all.cc
)
target_include_directories(client_context_test_peer_test
PRIVATE
${CMAKE_CURRENT_SOURCE_DIR}
${CMAKE_CURRENT_SOURCE_DIR}/include
${_gRPC_ADDRESS_SORTING_INCLUDE_DIR}
${_gRPC_RE2_INCLUDE_DIR}
${_gRPC_SSL_INCLUDE_DIR}
${_gRPC_UPB_GENERATED_DIR}
${_gRPC_UPB_GRPC_GENERATED_DIR}
${_gRPC_UPB_INCLUDE_DIR}
${_gRPC_XXHASH_INCLUDE_DIR}
${_gRPC_ZLIB_INCLUDE_DIR}
third_party/googletest/googletest/include
third_party/googletest/googletest
third_party/googletest/googlemock/include
third_party/googletest/googlemock
${_gRPC_PROTO_GENS_DIR}
)
target_link_libraries(client_context_test_peer_test
${_gRPC_PROTOBUF_LIBRARIES}
${_gRPC_ALLTARGETS_LIBRARIES}
grpc++_test
grpc++_test_util
)
endif()
if(gRPC_BUILD_TESTS)
add_executable(client_interceptors_end2end_test
${_gRPC_PROTO_GENS_DIR}/src/proto/grpc/testing/echo.pb.cc
${_gRPC_PROTO_GENS_DIR}/src/proto/grpc/testing/echo.grpc.pb.cc

@ -2428,6 +2428,7 @@ libs:
- include/grpc++/test/mock_stream.h
- include/grpc++/test/server_context_test_spouse.h
- include/grpcpp/test/channel_test_peer.h
- include/grpcpp/test/client_context_test_peer.h
- include/grpcpp/test/default_reactor_test_peer.h
- include/grpcpp/test/mock_stream.h
- include/grpcpp/test/server_context_test_spouse.h
@ -4843,6 +4844,16 @@ targets:
- linux
- posix
- mac
- name: client_context_test_peer_test
gtest: true
build: test
language: c++
headers: []
src:
- test/cpp/test/client_context_test_peer_test.cc
deps:
- grpc++_test
- grpc++_test_util
- name: client_fuzzer
build: fuzzer
language: c++

@ -92,6 +92,7 @@ class ClientAsyncResponseReader;
namespace testing {
class InteropClientContextInspector;
class ClientContextTestPeer;
} // namespace testing
namespace internal {
@ -423,6 +424,7 @@ class ClientContext {
ClientContext& operator=(const ClientContext&);
friend class ::grpc::testing::InteropClientContextInspector;
friend class ::grpc::testing::ClientContextTestPeer;
friend class ::grpc::internal::CallOpClientRecvStatus;
friend class ::grpc::internal::CallOpRecvInitialMetadata;
friend class ::grpc::Channel;

@ -0,0 +1,62 @@
/*
*
* Copyright 2021 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 GRPCPP_TEST_CLIENT_CONTEXT_TEST_PEER_H
#define GRPCPP_TEST_CLIENT_CONTEXT_TEST_PEER_H
#include <grpcpp/client_context.h>
#include <map>
namespace grpc {
namespace testing {
/// A test-only class to access private members and methods of ClientContext.
class ClientContextTestPeer {
public:
explicit ClientContextTestPeer(ClientContext* const ctx) : ctx_(ctx) {}
/// Inject metadata to the ClientContext for the test. The test peer
/// must be alive when a ClientContext::GetServerInitialMetadata is called.
void AddServerInitialMetadata(const std::string& key,
const std::string& value) {
server_initial_metadata_storage_.insert(
std::pair<std::string, std::string>(key, value));
ctx_->initial_metadata_received_ = true;
ctx_->recv_initial_metadata_.map()->clear();
for (const auto& item : server_initial_metadata_storage_) {
ctx_->recv_initial_metadata_.map()->insert(
std::pair<grpc::string_ref, grpc::string_ref>(
item.first.c_str(),
grpc::string_ref(item.second.data(), item.second.size())));
}
}
std::multimap<std::string, std::string> GetSendInitialMetadata() const {
return ctx_->send_initial_metadata_;
}
private:
ClientContext* const ctx_; // not owned
std::multimap<std::string, std::string> server_initial_metadata_storage_;
};
} // namespace testing
} // namespace grpc
#endif // GRPCPP_TEST_CLIENT_CONTEXT_TEST_PEER_H

@ -38,6 +38,22 @@ grpc_cc_test(
],
)
grpc_cc_test(
name = "client_context_test_peer_test",
srcs = ["client_context_test_peer_test.cc"],
external_deps = [
"gtest",
],
deps = [
"//:gpr",
"//:grpc",
"//:grpc++",
"//:grpc++_test",
"//test/core/util:grpc_test_util",
"//test/cpp/util:test_util",
],
)
grpc_cc_test(
name = "server_context_test_spouse_test",
srcs = ["server_context_test_spouse_test.cc"],

@ -0,0 +1,81 @@
/*
*
* Copyright 2021 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 <grpcpp/test/client_context_test_peer.h>
#include <cstring>
#include <vector>
#include <grpcpp/impl/grpc_library.h>
#include <gtest/gtest.h>
namespace grpc {
namespace testing {
static internal::GrpcLibraryInitializer g_initializer;
const char key1[] = "metadata-key1";
const char key2[] = "metadata-key2";
const char val1[] = "metadata-val1";
const char val2[] = "metadata-val2";
bool ServerInitialMetadataContains(const ClientContext& context,
const grpc::string_ref& key,
const grpc::string_ref& value) {
const auto& server_metadata = context.GetServerInitialMetadata();
for (auto iter = server_metadata.begin(); iter != server_metadata.end();
++iter) {
if (iter->first == key && iter->second == value) {
return true;
}
}
return true;
}
TEST(ClientContextTestPeerTest, AddServerInitialMetadata) {
ClientContext context;
ClientContextTestPeer peer(&context);
peer.AddServerInitialMetadata(key1, val1);
ASSERT_TRUE(ServerInitialMetadataContains(context, key1, val1));
peer.AddServerInitialMetadata(key2, val2);
ASSERT_TRUE(ServerInitialMetadataContains(context, key1, val1));
ASSERT_TRUE(ServerInitialMetadataContains(context, key2, val2));
}
TEST(ClientContextTestPeerTest, GetSendInitialMetadata) {
ClientContext context;
ClientContextTestPeer peer(&context);
std::multimap<std::string, std::string> metadata;
context.AddMetadata(key1, val1);
metadata.insert(std::pair<std::string, std::string>(key1, val1));
ASSERT_EQ(metadata, peer.GetSendInitialMetadata());
context.AddMetadata(key2, val2);
metadata.insert(std::pair<std::string, std::string>(key2, val2));
ASSERT_EQ(metadata, peer.GetSendInitialMetadata());
}
} // namespace testing
} // namespace grpc
int main(int argc, char** argv) {
::testing::InitGoogleTest(&argc, argv);
return RUN_ALL_TESTS();
}

@ -4103,6 +4103,30 @@
],
"uses_polling": true
},
{
"args": [],
"benchmark": false,
"ci_platforms": [
"linux",
"mac",
"posix",
"windows"
],
"cpu_cost": 1.0,
"exclude_configs": [],
"exclude_iomgrs": [],
"flaky": false,
"gtest": true,
"language": "c++",
"name": "client_context_test_peer_test",
"platforms": [
"linux",
"mac",
"posix",
"windows"
],
"uses_polling": true
},
{
"args": [],
"benchmark": false,

Loading…
Cancel
Save