async_end2end_test.cc 69 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953
  1. /*
  2. *
  3. * Copyright 2015 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. #include <cinttypes>
  19. #include <memory>
  20. #include <thread>
  21. #include "absl/memory/memory.h"
  22. #include <grpc/grpc.h>
  23. #include <grpc/support/alloc.h>
  24. #include <grpc/support/log.h>
  25. #include <grpc/support/time.h>
  26. #include <grpcpp/channel.h>
  27. #include <grpcpp/client_context.h>
  28. #include <grpcpp/create_channel.h>
  29. #include <grpcpp/ext/health_check_service_server_builder_option.h>
  30. #include <grpcpp/server.h>
  31. #include <grpcpp/server_builder.h>
  32. #include <grpcpp/server_context.h>
  33. #include "src/core/ext/filters/client_channel/backup_poller.h"
  34. #include "src/core/lib/gpr/tls.h"
  35. #include "src/core/lib/iomgr/port.h"
  36. #include "src/proto/grpc/health/v1/health.grpc.pb.h"
  37. #include "src/proto/grpc/testing/duplicate/echo_duplicate.grpc.pb.h"
  38. #include "src/proto/grpc/testing/echo.grpc.pb.h"
  39. #include "test/core/util/port.h"
  40. #include "test/core/util/test_config.h"
  41. #include "test/cpp/util/string_ref_helper.h"
  42. #include "test/cpp/util/test_credentials_provider.h"
  43. #ifdef GRPC_POSIX_SOCKET_EV
  44. #include "src/core/lib/iomgr/ev_posix.h"
  45. #endif // GRPC_POSIX_SOCKET_EV
  46. #include <gtest/gtest.h>
  47. using grpc::testing::EchoRequest;
  48. using grpc::testing::EchoResponse;
  49. using std::chrono::system_clock;
  50. namespace grpc {
  51. namespace testing {
  52. namespace {
  53. void* tag(int t) { return reinterpret_cast<void*>(t); }
  54. int detag(void* p) { return static_cast<int>(reinterpret_cast<intptr_t>(p)); }
  55. class Verifier {
  56. public:
  57. Verifier() : lambda_run_(false) {}
  58. // Expect sets the expected ok value for a specific tag
  59. Verifier& Expect(int i, bool expect_ok) {
  60. return ExpectUnless(i, expect_ok, false);
  61. }
  62. // ExpectUnless sets the expected ok value for a specific tag
  63. // unless the tag was already marked seen (as a result of ExpectMaybe)
  64. Verifier& ExpectUnless(int i, bool expect_ok, bool seen) {
  65. if (!seen) {
  66. expectations_[tag(i)] = expect_ok;
  67. }
  68. return *this;
  69. }
  70. // ExpectMaybe sets the expected ok value for a specific tag, but does not
  71. // require it to appear
  72. // If it does, sets *seen to true
  73. Verifier& ExpectMaybe(int i, bool expect_ok, bool* seen) {
  74. if (!*seen) {
  75. maybe_expectations_[tag(i)] = MaybeExpect{expect_ok, seen};
  76. }
  77. return *this;
  78. }
  79. // Next waits for 1 async tag to complete, checks its
  80. // expectations, and returns the tag
  81. int Next(CompletionQueue* cq, bool ignore_ok) {
  82. bool ok;
  83. void* got_tag;
  84. EXPECT_TRUE(cq->Next(&got_tag, &ok));
  85. GotTag(got_tag, ok, ignore_ok);
  86. return detag(got_tag);
  87. }
  88. template <typename T>
  89. CompletionQueue::NextStatus DoOnceThenAsyncNext(
  90. CompletionQueue* cq, void** got_tag, bool* ok, T deadline,
  91. std::function<void(void)> lambda) {
  92. if (lambda_run_) {
  93. return cq->AsyncNext(got_tag, ok, deadline);
  94. } else {
  95. lambda_run_ = true;
  96. return cq->DoThenAsyncNext(lambda, got_tag, ok, deadline);
  97. }
  98. }
  99. // Verify keeps calling Next until all currently set
  100. // expected tags are complete
  101. void Verify(CompletionQueue* cq) { Verify(cq, false); }
  102. // This version of Verify allows optionally ignoring the
  103. // outcome of the expectation
  104. void Verify(CompletionQueue* cq, bool ignore_ok) {
  105. GPR_ASSERT(!expectations_.empty() || !maybe_expectations_.empty());
  106. while (!expectations_.empty()) {
  107. Next(cq, ignore_ok);
  108. }
  109. maybe_expectations_.clear();
  110. }
  111. // This version of Verify stops after a certain deadline
  112. void Verify(CompletionQueue* cq,
  113. std::chrono::system_clock::time_point deadline) {
  114. if (expectations_.empty()) {
  115. bool ok;
  116. void* got_tag;
  117. EXPECT_EQ(cq->AsyncNext(&got_tag, &ok, deadline),
  118. CompletionQueue::TIMEOUT);
  119. } else {
  120. while (!expectations_.empty()) {
  121. bool ok;
  122. void* got_tag;
  123. EXPECT_EQ(cq->AsyncNext(&got_tag, &ok, deadline),
  124. CompletionQueue::GOT_EVENT);
  125. GotTag(got_tag, ok, false);
  126. }
  127. }
  128. maybe_expectations_.clear();
  129. }
  130. // This version of Verify stops after a certain deadline, and uses the
  131. // DoThenAsyncNext API
  132. // to call the lambda
  133. void Verify(CompletionQueue* cq,
  134. std::chrono::system_clock::time_point deadline,
  135. const std::function<void(void)>& lambda) {
  136. if (expectations_.empty()) {
  137. bool ok;
  138. void* got_tag;
  139. EXPECT_EQ(DoOnceThenAsyncNext(cq, &got_tag, &ok, deadline, lambda),
  140. CompletionQueue::TIMEOUT);
  141. } else {
  142. while (!expectations_.empty()) {
  143. bool ok;
  144. void* got_tag;
  145. EXPECT_EQ(DoOnceThenAsyncNext(cq, &got_tag, &ok, deadline, lambda),
  146. CompletionQueue::GOT_EVENT);
  147. GotTag(got_tag, ok, false);
  148. }
  149. }
  150. maybe_expectations_.clear();
  151. }
  152. private:
  153. void GotTag(void* got_tag, bool ok, bool ignore_ok) {
  154. auto it = expectations_.find(got_tag);
  155. if (it != expectations_.end()) {
  156. if (!ignore_ok) {
  157. EXPECT_EQ(it->second, ok);
  158. }
  159. expectations_.erase(it);
  160. } else {
  161. auto it2 = maybe_expectations_.find(got_tag);
  162. if (it2 != maybe_expectations_.end()) {
  163. if (it2->second.seen != nullptr) {
  164. EXPECT_FALSE(*it2->second.seen);
  165. *it2->second.seen = true;
  166. }
  167. if (!ignore_ok) {
  168. EXPECT_EQ(it2->second.ok, ok);
  169. }
  170. maybe_expectations_.erase(it2);
  171. } else {
  172. gpr_log(GPR_ERROR, "Unexpected tag: %p", got_tag);
  173. abort();
  174. }
  175. }
  176. }
  177. struct MaybeExpect {
  178. bool ok;
  179. bool* seen;
  180. };
  181. std::map<void*, bool> expectations_;
  182. std::map<void*, MaybeExpect> maybe_expectations_;
  183. bool lambda_run_;
  184. };
  185. bool plugin_has_sync_methods(std::unique_ptr<ServerBuilderPlugin>& plugin) {
  186. return plugin->has_sync_methods();
  187. }
  188. // This class disables the server builder plugins that may add sync services to
  189. // the server. If there are sync services, UnimplementedRpc test will triger
  190. // the sync unknown rpc routine on the server side, rather than the async one
  191. // that needs to be tested here.
  192. class ServerBuilderSyncPluginDisabler : public grpc::ServerBuilderOption {
  193. public:
  194. void UpdateArguments(ChannelArguments* /*arg*/) override {}
  195. void UpdatePlugins(
  196. std::vector<std::unique_ptr<ServerBuilderPlugin>>* plugins) override {
  197. plugins->erase(std::remove_if(plugins->begin(), plugins->end(),
  198. plugin_has_sync_methods),
  199. plugins->end());
  200. }
  201. };
  202. class TestScenario {
  203. public:
  204. TestScenario(bool inproc_stub, const std::string& creds_type, bool hcs,
  205. const std::string& content)
  206. : inproc(inproc_stub),
  207. health_check_service(hcs),
  208. credentials_type(creds_type),
  209. message_content(content) {}
  210. void Log() const;
  211. bool inproc;
  212. bool health_check_service;
  213. const std::string credentials_type;
  214. const std::string message_content;
  215. };
  216. std::ostream& operator<<(std::ostream& out, const TestScenario& scenario) {
  217. return out << "TestScenario{inproc=" << (scenario.inproc ? "true" : "false")
  218. << ", credentials='" << scenario.credentials_type
  219. << ", health_check_service="
  220. << (scenario.health_check_service ? "true" : "false")
  221. << "', message_size=" << scenario.message_content.size() << "}";
  222. }
  223. void TestScenario::Log() const {
  224. std::ostringstream out;
  225. out << *this;
  226. gpr_log(GPR_DEBUG, "%s", out.str().c_str());
  227. }
  228. class HealthCheck : public health::v1::Health::Service {};
  229. class AsyncEnd2endTest : public ::testing::TestWithParam<TestScenario> {
  230. protected:
  231. AsyncEnd2endTest() { GetParam().Log(); }
  232. void SetUp() override {
  233. port_ = grpc_pick_unused_port_or_die();
  234. server_address_ << "localhost:" << port_;
  235. // Setup server
  236. BuildAndStartServer();
  237. }
  238. void TearDown() override {
  239. server_->Shutdown();
  240. void* ignored_tag;
  241. bool ignored_ok;
  242. cq_->Shutdown();
  243. while (cq_->Next(&ignored_tag, &ignored_ok)) {
  244. }
  245. stub_.reset();
  246. grpc_recycle_unused_port(port_);
  247. }
  248. void BuildAndStartServer() {
  249. ServerBuilder builder;
  250. auto server_creds = GetCredentialsProvider()->GetServerCredentials(
  251. GetParam().credentials_type);
  252. builder.AddListeningPort(server_address_.str(), server_creds);
  253. service_ =
  254. absl::make_unique<grpc::testing::EchoTestService::AsyncService>();
  255. builder.RegisterService(service_.get());
  256. if (GetParam().health_check_service) {
  257. builder.RegisterService(&health_check_);
  258. }
  259. cq_ = builder.AddCompletionQueue();
  260. // TODO(zyc): make a test option to choose wheather sync plugins should be
  261. // deleted
  262. std::unique_ptr<ServerBuilderOption> sync_plugin_disabler(
  263. new ServerBuilderSyncPluginDisabler());
  264. builder.SetOption(move(sync_plugin_disabler));
  265. server_ = builder.BuildAndStart();
  266. }
  267. void ResetStub() {
  268. ChannelArguments args;
  269. auto channel_creds = GetCredentialsProvider()->GetChannelCredentials(
  270. GetParam().credentials_type, &args);
  271. std::shared_ptr<Channel> channel =
  272. !(GetParam().inproc) ? grpc::CreateCustomChannel(server_address_.str(),
  273. channel_creds, args)
  274. : server_->InProcessChannel(args);
  275. stub_ = grpc::testing::EchoTestService::NewStub(channel);
  276. }
  277. void SendRpc(int num_rpcs) {
  278. for (int i = 0; i < num_rpcs; i++) {
  279. EchoRequest send_request;
  280. EchoRequest recv_request;
  281. EchoResponse send_response;
  282. EchoResponse recv_response;
  283. Status recv_status;
  284. ClientContext cli_ctx;
  285. ServerContext srv_ctx;
  286. grpc::ServerAsyncResponseWriter<EchoResponse> response_writer(&srv_ctx);
  287. send_request.set_message(GetParam().message_content);
  288. std::unique_ptr<ClientAsyncResponseReader<EchoResponse>> response_reader(
  289. stub_->AsyncEcho(&cli_ctx, send_request, cq_.get()));
  290. service_->RequestEcho(&srv_ctx, &recv_request, &response_writer,
  291. cq_.get(), cq_.get(), tag(2));
  292. response_reader->Finish(&recv_response, &recv_status, tag(4));
  293. Verifier().Expect(2, true).Verify(cq_.get());
  294. EXPECT_EQ(send_request.message(), recv_request.message());
  295. send_response.set_message(recv_request.message());
  296. response_writer.Finish(send_response, Status::OK, tag(3));
  297. Verifier().Expect(3, true).Expect(4, true).Verify(cq_.get());
  298. EXPECT_EQ(send_response.message(), recv_response.message());
  299. EXPECT_TRUE(recv_status.ok());
  300. }
  301. }
  302. std::unique_ptr<ServerCompletionQueue> cq_;
  303. std::unique_ptr<grpc::testing::EchoTestService::Stub> stub_;
  304. std::unique_ptr<Server> server_;
  305. std::unique_ptr<grpc::testing::EchoTestService::AsyncService> service_;
  306. HealthCheck health_check_;
  307. std::ostringstream server_address_;
  308. int port_;
  309. };
  310. TEST_P(AsyncEnd2endTest, SimpleRpc) {
  311. ResetStub();
  312. SendRpc(1);
  313. }
  314. TEST_P(AsyncEnd2endTest, SimpleRpcWithExpectedError) {
  315. ResetStub();
  316. EchoRequest send_request;
  317. EchoRequest recv_request;
  318. EchoResponse send_response;
  319. EchoResponse recv_response;
  320. Status recv_status;
  321. ClientContext cli_ctx;
  322. ServerContext srv_ctx;
  323. grpc::ServerAsyncResponseWriter<EchoResponse> response_writer(&srv_ctx);
  324. ErrorStatus error_status;
  325. send_request.set_message(GetParam().message_content);
  326. error_status.set_code(1); // CANCELLED
  327. error_status.set_error_message("cancel error message");
  328. *send_request.mutable_param()->mutable_expected_error() = error_status;
  329. std::unique_ptr<ClientAsyncResponseReader<EchoResponse>> response_reader(
  330. stub_->AsyncEcho(&cli_ctx, send_request, cq_.get()));
  331. srv_ctx.AsyncNotifyWhenDone(tag(5));
  332. service_->RequestEcho(&srv_ctx, &recv_request, &response_writer, cq_.get(),
  333. cq_.get(), tag(2));
  334. response_reader->Finish(&recv_response, &recv_status, tag(4));
  335. Verifier().Expect(2, true).Verify(cq_.get());
  336. EXPECT_EQ(send_request.message(), recv_request.message());
  337. send_response.set_message(recv_request.message());
  338. response_writer.Finish(
  339. send_response,
  340. Status(
  341. static_cast<StatusCode>(recv_request.param().expected_error().code()),
  342. recv_request.param().expected_error().error_message()),
  343. tag(3));
  344. Verifier().Expect(3, true).Expect(4, true).Expect(5, true).Verify(cq_.get());
  345. EXPECT_EQ(recv_response.message(), "");
  346. EXPECT_EQ(recv_status.error_code(), error_status.code());
  347. EXPECT_EQ(recv_status.error_message(), error_status.error_message());
  348. EXPECT_FALSE(srv_ctx.IsCancelled());
  349. }
  350. TEST_P(AsyncEnd2endTest, SequentialRpcs) {
  351. ResetStub();
  352. SendRpc(10);
  353. }
  354. TEST_P(AsyncEnd2endTest, ReconnectChannel) {
  355. // GRPC_CLIENT_CHANNEL_BACKUP_POLL_INTERVAL_MS is set to 100ms in main()
  356. if (GetParam().inproc) {
  357. return;
  358. }
  359. int poller_slowdown_factor = 1;
  360. #ifdef GRPC_POSIX_SOCKET_EV
  361. // It needs 2 pollset_works to reconnect the channel with polling engine
  362. // "poll"
  363. grpc_core::UniquePtr<char> poller = GPR_GLOBAL_CONFIG_GET(grpc_poll_strategy);
  364. if (0 == strcmp(poller.get(), "poll")) {
  365. poller_slowdown_factor = 2;
  366. }
  367. #endif // GRPC_POSIX_SOCKET_EV
  368. ResetStub();
  369. SendRpc(1);
  370. server_->Shutdown();
  371. void* ignored_tag;
  372. bool ignored_ok;
  373. cq_->Shutdown();
  374. while (cq_->Next(&ignored_tag, &ignored_ok)) {
  375. }
  376. BuildAndStartServer();
  377. // It needs more than GRPC_CLIENT_CHANNEL_BACKUP_POLL_INTERVAL_MS time to
  378. // reconnect the channel.
  379. gpr_sleep_until(gpr_time_add(
  380. gpr_now(GPR_CLOCK_REALTIME),
  381. gpr_time_from_millis(
  382. 300 * poller_slowdown_factor * grpc_test_slowdown_factor(),
  383. GPR_TIMESPAN)));
  384. SendRpc(1);
  385. }
  386. // We do not need to protect notify because the use is synchronized.
  387. void ServerWait(Server* server, int* notify) {
  388. server->Wait();
  389. *notify = 1;
  390. }
  391. TEST_P(AsyncEnd2endTest, WaitAndShutdownTest) {
  392. int notify = 0;
  393. std::thread wait_thread(&ServerWait, server_.get(), &notify);
  394. ResetStub();
  395. SendRpc(1);
  396. EXPECT_EQ(0, notify);
  397. server_->Shutdown();
  398. wait_thread.join();
  399. EXPECT_EQ(1, notify);
  400. }
  401. TEST_P(AsyncEnd2endTest, ShutdownThenWait) {
  402. ResetStub();
  403. SendRpc(1);
  404. std::thread t([this]() { server_->Shutdown(); });
  405. server_->Wait();
  406. t.join();
  407. }
  408. // Test a simple RPC using the async version of Next
  409. TEST_P(AsyncEnd2endTest, AsyncNextRpc) {
  410. ResetStub();
  411. EchoRequest send_request;
  412. EchoRequest recv_request;
  413. EchoResponse send_response;
  414. EchoResponse recv_response;
  415. Status recv_status;
  416. ClientContext cli_ctx;
  417. ServerContext srv_ctx;
  418. grpc::ServerAsyncResponseWriter<EchoResponse> response_writer(&srv_ctx);
  419. send_request.set_message(GetParam().message_content);
  420. std::unique_ptr<ClientAsyncResponseReader<EchoResponse>> response_reader(
  421. stub_->AsyncEcho(&cli_ctx, send_request, cq_.get()));
  422. std::chrono::system_clock::time_point time_now(
  423. std::chrono::system_clock::now());
  424. std::chrono::system_clock::time_point time_limit(
  425. std::chrono::system_clock::now() + std::chrono::seconds(10));
  426. Verifier().Verify(cq_.get(), time_now);
  427. Verifier().Verify(cq_.get(), time_now);
  428. service_->RequestEcho(&srv_ctx, &recv_request, &response_writer, cq_.get(),
  429. cq_.get(), tag(2));
  430. response_reader->Finish(&recv_response, &recv_status, tag(4));
  431. Verifier().Expect(2, true).Verify(cq_.get(), time_limit);
  432. EXPECT_EQ(send_request.message(), recv_request.message());
  433. send_response.set_message(recv_request.message());
  434. response_writer.Finish(send_response, Status::OK, tag(3));
  435. Verifier().Expect(3, true).Expect(4, true).Verify(
  436. cq_.get(), std::chrono::system_clock::time_point::max());
  437. EXPECT_EQ(send_response.message(), recv_response.message());
  438. EXPECT_TRUE(recv_status.ok());
  439. }
  440. // Test a simple RPC using the async version of Next
  441. TEST_P(AsyncEnd2endTest, DoThenAsyncNextRpc) {
  442. ResetStub();
  443. EchoRequest send_request;
  444. EchoRequest recv_request;
  445. EchoResponse send_response;
  446. EchoResponse recv_response;
  447. Status recv_status;
  448. ClientContext cli_ctx;
  449. ServerContext srv_ctx;
  450. grpc::ServerAsyncResponseWriter<EchoResponse> response_writer(&srv_ctx);
  451. send_request.set_message(GetParam().message_content);
  452. std::unique_ptr<ClientAsyncResponseReader<EchoResponse>> response_reader(
  453. stub_->AsyncEcho(&cli_ctx, send_request, cq_.get()));
  454. std::chrono::system_clock::time_point time_now(
  455. std::chrono::system_clock::now());
  456. std::chrono::system_clock::time_point time_limit(
  457. std::chrono::system_clock::now() + std::chrono::seconds(10));
  458. Verifier().Verify(cq_.get(), time_now);
  459. Verifier().Verify(cq_.get(), time_now);
  460. auto resp_writer_ptr = &response_writer;
  461. auto lambda_2 = [&, this, resp_writer_ptr]() {
  462. service_->RequestEcho(&srv_ctx, &recv_request, resp_writer_ptr, cq_.get(),
  463. cq_.get(), tag(2));
  464. };
  465. response_reader->Finish(&recv_response, &recv_status, tag(4));
  466. Verifier().Expect(2, true).Verify(cq_.get(), time_limit, lambda_2);
  467. EXPECT_EQ(send_request.message(), recv_request.message());
  468. send_response.set_message(recv_request.message());
  469. auto lambda_3 = [resp_writer_ptr, send_response]() {
  470. resp_writer_ptr->Finish(send_response, Status::OK, tag(3));
  471. };
  472. Verifier().Expect(3, true).Expect(4, true).Verify(
  473. cq_.get(), std::chrono::system_clock::time_point::max(), lambda_3);
  474. EXPECT_EQ(send_response.message(), recv_response.message());
  475. EXPECT_TRUE(recv_status.ok());
  476. }
  477. // Two pings and a final pong.
  478. TEST_P(AsyncEnd2endTest, SimpleClientStreaming) {
  479. ResetStub();
  480. EchoRequest send_request;
  481. EchoRequest recv_request;
  482. EchoResponse send_response;
  483. EchoResponse recv_response;
  484. Status recv_status;
  485. ClientContext cli_ctx;
  486. ServerContext srv_ctx;
  487. ServerAsyncReader<EchoResponse, EchoRequest> srv_stream(&srv_ctx);
  488. send_request.set_message(GetParam().message_content);
  489. std::unique_ptr<ClientAsyncWriter<EchoRequest>> cli_stream(
  490. stub_->AsyncRequestStream(&cli_ctx, &recv_response, cq_.get(), tag(1)));
  491. service_->RequestRequestStream(&srv_ctx, &srv_stream, cq_.get(), cq_.get(),
  492. tag(2));
  493. Verifier().Expect(2, true).Expect(1, true).Verify(cq_.get());
  494. cli_stream->Write(send_request, tag(3));
  495. srv_stream.Read(&recv_request, tag(4));
  496. Verifier().Expect(3, true).Expect(4, true).Verify(cq_.get());
  497. EXPECT_EQ(send_request.message(), recv_request.message());
  498. cli_stream->Write(send_request, tag(5));
  499. srv_stream.Read(&recv_request, tag(6));
  500. Verifier().Expect(5, true).Expect(6, true).Verify(cq_.get());
  501. EXPECT_EQ(send_request.message(), recv_request.message());
  502. cli_stream->WritesDone(tag(7));
  503. srv_stream.Read(&recv_request, tag(8));
  504. Verifier().Expect(7, true).Expect(8, false).Verify(cq_.get());
  505. send_response.set_message(recv_request.message());
  506. srv_stream.Finish(send_response, Status::OK, tag(9));
  507. cli_stream->Finish(&recv_status, tag(10));
  508. Verifier().Expect(9, true).Expect(10, true).Verify(cq_.get());
  509. EXPECT_EQ(send_response.message(), recv_response.message());
  510. EXPECT_TRUE(recv_status.ok());
  511. }
  512. // Two pings and a final pong.
  513. TEST_P(AsyncEnd2endTest, SimpleClientStreamingWithCoalescingApi) {
  514. ResetStub();
  515. EchoRequest send_request;
  516. EchoRequest recv_request;
  517. EchoResponse send_response;
  518. EchoResponse recv_response;
  519. Status recv_status;
  520. ClientContext cli_ctx;
  521. ServerContext srv_ctx;
  522. ServerAsyncReader<EchoResponse, EchoRequest> srv_stream(&srv_ctx);
  523. send_request.set_message(GetParam().message_content);
  524. cli_ctx.set_initial_metadata_corked(true);
  525. // tag:1 never comes up since no op is performed
  526. std::unique_ptr<ClientAsyncWriter<EchoRequest>> cli_stream(
  527. stub_->AsyncRequestStream(&cli_ctx, &recv_response, cq_.get(), tag(1)));
  528. service_->RequestRequestStream(&srv_ctx, &srv_stream, cq_.get(), cq_.get(),
  529. tag(2));
  530. cli_stream->Write(send_request, tag(3));
  531. bool seen3 = false;
  532. Verifier().Expect(2, true).ExpectMaybe(3, true, &seen3).Verify(cq_.get());
  533. srv_stream.Read(&recv_request, tag(4));
  534. Verifier().ExpectUnless(3, true, seen3).Expect(4, true).Verify(cq_.get());
  535. EXPECT_EQ(send_request.message(), recv_request.message());
  536. cli_stream->WriteLast(send_request, WriteOptions(), tag(5));
  537. srv_stream.Read(&recv_request, tag(6));
  538. Verifier().Expect(5, true).Expect(6, true).Verify(cq_.get());
  539. EXPECT_EQ(send_request.message(), recv_request.message());
  540. srv_stream.Read(&recv_request, tag(7));
  541. Verifier().Expect(7, false).Verify(cq_.get());
  542. send_response.set_message(recv_request.message());
  543. srv_stream.Finish(send_response, Status::OK, tag(8));
  544. cli_stream->Finish(&recv_status, tag(9));
  545. Verifier().Expect(8, true).Expect(9, true).Verify(cq_.get());
  546. EXPECT_EQ(send_response.message(), recv_response.message());
  547. EXPECT_TRUE(recv_status.ok());
  548. }
  549. // One ping, two pongs.
  550. TEST_P(AsyncEnd2endTest, SimpleServerStreaming) {
  551. ResetStub();
  552. EchoRequest send_request;
  553. EchoRequest recv_request;
  554. EchoResponse send_response;
  555. EchoResponse recv_response;
  556. Status recv_status;
  557. ClientContext cli_ctx;
  558. ServerContext srv_ctx;
  559. ServerAsyncWriter<EchoResponse> srv_stream(&srv_ctx);
  560. send_request.set_message(GetParam().message_content);
  561. std::unique_ptr<ClientAsyncReader<EchoResponse>> cli_stream(
  562. stub_->AsyncResponseStream(&cli_ctx, send_request, cq_.get(), tag(1)));
  563. service_->RequestResponseStream(&srv_ctx, &recv_request, &srv_stream,
  564. cq_.get(), cq_.get(), tag(2));
  565. Verifier().Expect(1, true).Expect(2, true).Verify(cq_.get());
  566. EXPECT_EQ(send_request.message(), recv_request.message());
  567. send_response.set_message(recv_request.message());
  568. srv_stream.Write(send_response, tag(3));
  569. cli_stream->Read(&recv_response, tag(4));
  570. Verifier().Expect(3, true).Expect(4, true).Verify(cq_.get());
  571. EXPECT_EQ(send_response.message(), recv_response.message());
  572. srv_stream.Write(send_response, tag(5));
  573. cli_stream->Read(&recv_response, tag(6));
  574. Verifier().Expect(5, true).Expect(6, true).Verify(cq_.get());
  575. EXPECT_EQ(send_response.message(), recv_response.message());
  576. srv_stream.Finish(Status::OK, tag(7));
  577. cli_stream->Read(&recv_response, tag(8));
  578. Verifier().Expect(7, true).Expect(8, false).Verify(cq_.get());
  579. cli_stream->Finish(&recv_status, tag(9));
  580. Verifier().Expect(9, true).Verify(cq_.get());
  581. EXPECT_TRUE(recv_status.ok());
  582. }
  583. // One ping, two pongs. Using WriteAndFinish API
  584. TEST_P(AsyncEnd2endTest, SimpleServerStreamingWithCoalescingApiWAF) {
  585. ResetStub();
  586. EchoRequest send_request;
  587. EchoRequest recv_request;
  588. EchoResponse send_response;
  589. EchoResponse recv_response;
  590. Status recv_status;
  591. ClientContext cli_ctx;
  592. ServerContext srv_ctx;
  593. ServerAsyncWriter<EchoResponse> srv_stream(&srv_ctx);
  594. send_request.set_message(GetParam().message_content);
  595. std::unique_ptr<ClientAsyncReader<EchoResponse>> cli_stream(
  596. stub_->AsyncResponseStream(&cli_ctx, send_request, cq_.get(), tag(1)));
  597. service_->RequestResponseStream(&srv_ctx, &recv_request, &srv_stream,
  598. cq_.get(), cq_.get(), tag(2));
  599. Verifier().Expect(1, true).Expect(2, true).Verify(cq_.get());
  600. EXPECT_EQ(send_request.message(), recv_request.message());
  601. send_response.set_message(recv_request.message());
  602. srv_stream.Write(send_response, tag(3));
  603. cli_stream->Read(&recv_response, tag(4));
  604. Verifier().Expect(3, true).Expect(4, true).Verify(cq_.get());
  605. EXPECT_EQ(send_response.message(), recv_response.message());
  606. srv_stream.WriteAndFinish(send_response, WriteOptions(), Status::OK, tag(5));
  607. cli_stream->Read(&recv_response, tag(6));
  608. Verifier().Expect(5, true).Expect(6, true).Verify(cq_.get());
  609. EXPECT_EQ(send_response.message(), recv_response.message());
  610. cli_stream->Read(&recv_response, tag(7));
  611. Verifier().Expect(7, false).Verify(cq_.get());
  612. cli_stream->Finish(&recv_status, tag(8));
  613. Verifier().Expect(8, true).Verify(cq_.get());
  614. EXPECT_TRUE(recv_status.ok());
  615. }
  616. // One ping, two pongs. Using WriteLast API
  617. TEST_P(AsyncEnd2endTest, SimpleServerStreamingWithCoalescingApiWL) {
  618. ResetStub();
  619. EchoRequest send_request;
  620. EchoRequest recv_request;
  621. EchoResponse send_response;
  622. EchoResponse recv_response;
  623. Status recv_status;
  624. ClientContext cli_ctx;
  625. ServerContext srv_ctx;
  626. ServerAsyncWriter<EchoResponse> srv_stream(&srv_ctx);
  627. send_request.set_message(GetParam().message_content);
  628. std::unique_ptr<ClientAsyncReader<EchoResponse>> cli_stream(
  629. stub_->AsyncResponseStream(&cli_ctx, send_request, cq_.get(), tag(1)));
  630. service_->RequestResponseStream(&srv_ctx, &recv_request, &srv_stream,
  631. cq_.get(), cq_.get(), tag(2));
  632. Verifier().Expect(1, true).Expect(2, true).Verify(cq_.get());
  633. EXPECT_EQ(send_request.message(), recv_request.message());
  634. send_response.set_message(recv_request.message());
  635. srv_stream.Write(send_response, tag(3));
  636. cli_stream->Read(&recv_response, tag(4));
  637. Verifier().Expect(3, true).Expect(4, true).Verify(cq_.get());
  638. EXPECT_EQ(send_response.message(), recv_response.message());
  639. srv_stream.WriteLast(send_response, WriteOptions(), tag(5));
  640. cli_stream->Read(&recv_response, tag(6));
  641. srv_stream.Finish(Status::OK, tag(7));
  642. Verifier().Expect(5, true).Expect(6, true).Expect(7, true).Verify(cq_.get());
  643. EXPECT_EQ(send_response.message(), recv_response.message());
  644. cli_stream->Read(&recv_response, tag(8));
  645. Verifier().Expect(8, false).Verify(cq_.get());
  646. cli_stream->Finish(&recv_status, tag(9));
  647. Verifier().Expect(9, true).Verify(cq_.get());
  648. EXPECT_TRUE(recv_status.ok());
  649. }
  650. // One ping, one pong.
  651. TEST_P(AsyncEnd2endTest, SimpleBidiStreaming) {
  652. ResetStub();
  653. EchoRequest send_request;
  654. EchoRequest recv_request;
  655. EchoResponse send_response;
  656. EchoResponse recv_response;
  657. Status recv_status;
  658. ClientContext cli_ctx;
  659. ServerContext srv_ctx;
  660. ServerAsyncReaderWriter<EchoResponse, EchoRequest> srv_stream(&srv_ctx);
  661. send_request.set_message(GetParam().message_content);
  662. std::unique_ptr<ClientAsyncReaderWriter<EchoRequest, EchoResponse>>
  663. cli_stream(stub_->AsyncBidiStream(&cli_ctx, cq_.get(), tag(1)));
  664. service_->RequestBidiStream(&srv_ctx, &srv_stream, cq_.get(), cq_.get(),
  665. tag(2));
  666. Verifier().Expect(1, true).Expect(2, true).Verify(cq_.get());
  667. cli_stream->Write(send_request, tag(3));
  668. srv_stream.Read(&recv_request, tag(4));
  669. Verifier().Expect(3, true).Expect(4, true).Verify(cq_.get());
  670. EXPECT_EQ(send_request.message(), recv_request.message());
  671. send_response.set_message(recv_request.message());
  672. srv_stream.Write(send_response, tag(5));
  673. cli_stream->Read(&recv_response, tag(6));
  674. Verifier().Expect(5, true).Expect(6, true).Verify(cq_.get());
  675. EXPECT_EQ(send_response.message(), recv_response.message());
  676. cli_stream->WritesDone(tag(7));
  677. srv_stream.Read(&recv_request, tag(8));
  678. Verifier().Expect(7, true).Expect(8, false).Verify(cq_.get());
  679. srv_stream.Finish(Status::OK, tag(9));
  680. cli_stream->Finish(&recv_status, tag(10));
  681. Verifier().Expect(9, true).Expect(10, true).Verify(cq_.get());
  682. EXPECT_TRUE(recv_status.ok());
  683. }
  684. // One ping, one pong. Using server:WriteAndFinish api
  685. TEST_P(AsyncEnd2endTest, SimpleBidiStreamingWithCoalescingApiWAF) {
  686. ResetStub();
  687. EchoRequest send_request;
  688. EchoRequest recv_request;
  689. EchoResponse send_response;
  690. EchoResponse recv_response;
  691. Status recv_status;
  692. ClientContext cli_ctx;
  693. ServerContext srv_ctx;
  694. ServerAsyncReaderWriter<EchoResponse, EchoRequest> srv_stream(&srv_ctx);
  695. send_request.set_message(GetParam().message_content);
  696. cli_ctx.set_initial_metadata_corked(true);
  697. std::unique_ptr<ClientAsyncReaderWriter<EchoRequest, EchoResponse>>
  698. cli_stream(stub_->AsyncBidiStream(&cli_ctx, cq_.get(), tag(1)));
  699. service_->RequestBidiStream(&srv_ctx, &srv_stream, cq_.get(), cq_.get(),
  700. tag(2));
  701. cli_stream->WriteLast(send_request, WriteOptions(), tag(3));
  702. bool seen3 = false;
  703. Verifier().Expect(2, true).ExpectMaybe(3, true, &seen3).Verify(cq_.get());
  704. srv_stream.Read(&recv_request, tag(4));
  705. Verifier().ExpectUnless(3, true, seen3).Expect(4, true).Verify(cq_.get());
  706. EXPECT_EQ(send_request.message(), recv_request.message());
  707. srv_stream.Read(&recv_request, tag(5));
  708. Verifier().Expect(5, false).Verify(cq_.get());
  709. send_response.set_message(recv_request.message());
  710. srv_stream.WriteAndFinish(send_response, WriteOptions(), Status::OK, tag(6));
  711. cli_stream->Read(&recv_response, tag(7));
  712. Verifier().Expect(6, true).Expect(7, true).Verify(cq_.get());
  713. EXPECT_EQ(send_response.message(), recv_response.message());
  714. cli_stream->Finish(&recv_status, tag(8));
  715. Verifier().Expect(8, true).Verify(cq_.get());
  716. EXPECT_TRUE(recv_status.ok());
  717. }
  718. // One ping, one pong. Using server:WriteLast api
  719. TEST_P(AsyncEnd2endTest, SimpleBidiStreamingWithCoalescingApiWL) {
  720. ResetStub();
  721. EchoRequest send_request;
  722. EchoRequest recv_request;
  723. EchoResponse send_response;
  724. EchoResponse recv_response;
  725. Status recv_status;
  726. ClientContext cli_ctx;
  727. ServerContext srv_ctx;
  728. ServerAsyncReaderWriter<EchoResponse, EchoRequest> srv_stream(&srv_ctx);
  729. send_request.set_message(GetParam().message_content);
  730. cli_ctx.set_initial_metadata_corked(true);
  731. std::unique_ptr<ClientAsyncReaderWriter<EchoRequest, EchoResponse>>
  732. cli_stream(stub_->AsyncBidiStream(&cli_ctx, cq_.get(), tag(1)));
  733. service_->RequestBidiStream(&srv_ctx, &srv_stream, cq_.get(), cq_.get(),
  734. tag(2));
  735. cli_stream->WriteLast(send_request, WriteOptions(), tag(3));
  736. bool seen3 = false;
  737. Verifier().Expect(2, true).ExpectMaybe(3, true, &seen3).Verify(cq_.get());
  738. srv_stream.Read(&recv_request, tag(4));
  739. Verifier().ExpectUnless(3, true, seen3).Expect(4, true).Verify(cq_.get());
  740. EXPECT_EQ(send_request.message(), recv_request.message());
  741. srv_stream.Read(&recv_request, tag(5));
  742. Verifier().Expect(5, false).Verify(cq_.get());
  743. send_response.set_message(recv_request.message());
  744. srv_stream.WriteLast(send_response, WriteOptions(), tag(6));
  745. srv_stream.Finish(Status::OK, tag(7));
  746. cli_stream->Read(&recv_response, tag(8));
  747. Verifier().Expect(6, true).Expect(7, true).Expect(8, true).Verify(cq_.get());
  748. EXPECT_EQ(send_response.message(), recv_response.message());
  749. cli_stream->Finish(&recv_status, tag(9));
  750. Verifier().Expect(9, true).Verify(cq_.get());
  751. EXPECT_TRUE(recv_status.ok());
  752. }
  753. // Metadata tests
  754. TEST_P(AsyncEnd2endTest, ClientInitialMetadataRpc) {
  755. ResetStub();
  756. EchoRequest send_request;
  757. EchoRequest recv_request;
  758. EchoResponse send_response;
  759. EchoResponse recv_response;
  760. Status recv_status;
  761. ClientContext cli_ctx;
  762. ServerContext srv_ctx;
  763. grpc::ServerAsyncResponseWriter<EchoResponse> response_writer(&srv_ctx);
  764. send_request.set_message(GetParam().message_content);
  765. std::pair<std::string, std::string> meta1("key1", "val1");
  766. std::pair<std::string, std::string> meta2("key2", "val2");
  767. std::pair<std::string, std::string> meta3("g.r.d-bin", "xyz");
  768. cli_ctx.AddMetadata(meta1.first, meta1.second);
  769. cli_ctx.AddMetadata(meta2.first, meta2.second);
  770. cli_ctx.AddMetadata(meta3.first, meta3.second);
  771. std::unique_ptr<ClientAsyncResponseReader<EchoResponse>> response_reader(
  772. stub_->AsyncEcho(&cli_ctx, send_request, cq_.get()));
  773. response_reader->Finish(&recv_response, &recv_status, tag(4));
  774. service_->RequestEcho(&srv_ctx, &recv_request, &response_writer, cq_.get(),
  775. cq_.get(), tag(2));
  776. Verifier().Expect(2, true).Verify(cq_.get());
  777. EXPECT_EQ(send_request.message(), recv_request.message());
  778. const auto& client_initial_metadata = srv_ctx.client_metadata();
  779. EXPECT_EQ(meta1.second,
  780. ToString(client_initial_metadata.find(meta1.first)->second));
  781. EXPECT_EQ(meta2.second,
  782. ToString(client_initial_metadata.find(meta2.first)->second));
  783. EXPECT_EQ(meta3.second,
  784. ToString(client_initial_metadata.find(meta3.first)->second));
  785. EXPECT_GE(client_initial_metadata.size(), static_cast<size_t>(2));
  786. send_response.set_message(recv_request.message());
  787. response_writer.Finish(send_response, Status::OK, tag(3));
  788. Verifier().Expect(3, true).Expect(4, true).Verify(cq_.get());
  789. EXPECT_EQ(send_response.message(), recv_response.message());
  790. EXPECT_TRUE(recv_status.ok());
  791. }
  792. TEST_P(AsyncEnd2endTest, ServerInitialMetadataRpc) {
  793. ResetStub();
  794. EchoRequest send_request;
  795. EchoRequest recv_request;
  796. EchoResponse send_response;
  797. EchoResponse recv_response;
  798. Status recv_status;
  799. ClientContext cli_ctx;
  800. ServerContext srv_ctx;
  801. grpc::ServerAsyncResponseWriter<EchoResponse> response_writer(&srv_ctx);
  802. send_request.set_message(GetParam().message_content);
  803. std::pair<std::string, std::string> meta1("key1", "val1");
  804. std::pair<std::string, std::string> meta2("key2", "val2");
  805. std::unique_ptr<ClientAsyncResponseReader<EchoResponse>> response_reader(
  806. stub_->AsyncEcho(&cli_ctx, send_request, cq_.get()));
  807. response_reader->ReadInitialMetadata(tag(4));
  808. service_->RequestEcho(&srv_ctx, &recv_request, &response_writer, cq_.get(),
  809. cq_.get(), tag(2));
  810. Verifier().Expect(2, true).Verify(cq_.get());
  811. EXPECT_EQ(send_request.message(), recv_request.message());
  812. srv_ctx.AddInitialMetadata(meta1.first, meta1.second);
  813. srv_ctx.AddInitialMetadata(meta2.first, meta2.second);
  814. response_writer.SendInitialMetadata(tag(3));
  815. Verifier().Expect(3, true).Expect(4, true).Verify(cq_.get());
  816. const auto& server_initial_metadata = cli_ctx.GetServerInitialMetadata();
  817. EXPECT_EQ(meta1.second,
  818. ToString(server_initial_metadata.find(meta1.first)->second));
  819. EXPECT_EQ(meta2.second,
  820. ToString(server_initial_metadata.find(meta2.first)->second));
  821. EXPECT_EQ(static_cast<size_t>(2), server_initial_metadata.size());
  822. send_response.set_message(recv_request.message());
  823. response_writer.Finish(send_response, Status::OK, tag(5));
  824. response_reader->Finish(&recv_response, &recv_status, tag(6));
  825. Verifier().Expect(5, true).Expect(6, true).Verify(cq_.get());
  826. EXPECT_EQ(send_response.message(), recv_response.message());
  827. EXPECT_TRUE(recv_status.ok());
  828. }
  829. // 1 ping, 2 pongs.
  830. TEST_P(AsyncEnd2endTest, ServerInitialMetadataServerStreaming) {
  831. ResetStub();
  832. EchoRequest send_request;
  833. EchoRequest recv_request;
  834. EchoResponse send_response;
  835. EchoResponse recv_response;
  836. Status recv_status;
  837. ClientContext cli_ctx;
  838. ServerContext srv_ctx;
  839. ServerAsyncWriter<EchoResponse> srv_stream(&srv_ctx);
  840. std::pair<::std::string, ::std::string> meta1("key1", "val1");
  841. std::pair<::std::string, ::std::string> meta2("key2", "val2");
  842. std::unique_ptr<ClientAsyncReader<EchoResponse>> cli_stream(
  843. stub_->AsyncResponseStream(&cli_ctx, send_request, cq_.get(), tag(1)));
  844. cli_stream->ReadInitialMetadata(tag(11));
  845. service_->RequestResponseStream(&srv_ctx, &recv_request, &srv_stream,
  846. cq_.get(), cq_.get(), tag(2));
  847. Verifier().Expect(1, true).Expect(2, true).Verify(cq_.get());
  848. srv_ctx.AddInitialMetadata(meta1.first, meta1.second);
  849. srv_ctx.AddInitialMetadata(meta2.first, meta2.second);
  850. srv_stream.SendInitialMetadata(tag(10));
  851. Verifier().Expect(10, true).Expect(11, true).Verify(cq_.get());
  852. auto server_initial_metadata = cli_ctx.GetServerInitialMetadata();
  853. EXPECT_EQ(meta1.second,
  854. ToString(server_initial_metadata.find(meta1.first)->second));
  855. EXPECT_EQ(meta2.second,
  856. ToString(server_initial_metadata.find(meta2.first)->second));
  857. EXPECT_EQ(static_cast<size_t>(2), server_initial_metadata.size());
  858. srv_stream.Write(send_response, tag(3));
  859. cli_stream->Read(&recv_response, tag(4));
  860. Verifier().Expect(3, true).Expect(4, true).Verify(cq_.get());
  861. srv_stream.Write(send_response, tag(5));
  862. cli_stream->Read(&recv_response, tag(6));
  863. Verifier().Expect(5, true).Expect(6, true).Verify(cq_.get());
  864. srv_stream.Finish(Status::OK, tag(7));
  865. cli_stream->Read(&recv_response, tag(8));
  866. Verifier().Expect(7, true).Expect(8, false).Verify(cq_.get());
  867. cli_stream->Finish(&recv_status, tag(9));
  868. Verifier().Expect(9, true).Verify(cq_.get());
  869. EXPECT_TRUE(recv_status.ok());
  870. }
  871. // 1 ping, 2 pongs.
  872. // Test for server initial metadata being sent implicitly
  873. TEST_P(AsyncEnd2endTest, ServerInitialMetadataServerStreamingImplicit) {
  874. ResetStub();
  875. EchoRequest send_request;
  876. EchoRequest recv_request;
  877. EchoResponse send_response;
  878. EchoResponse recv_response;
  879. Status recv_status;
  880. ClientContext cli_ctx;
  881. ServerContext srv_ctx;
  882. ServerAsyncWriter<EchoResponse> srv_stream(&srv_ctx);
  883. send_request.set_message(GetParam().message_content);
  884. std::pair<::std::string, ::std::string> meta1("key1", "val1");
  885. std::pair<::std::string, ::std::string> meta2("key2", "val2");
  886. std::unique_ptr<ClientAsyncReader<EchoResponse>> cli_stream(
  887. stub_->AsyncResponseStream(&cli_ctx, send_request, cq_.get(), tag(1)));
  888. service_->RequestResponseStream(&srv_ctx, &recv_request, &srv_stream,
  889. cq_.get(), cq_.get(), tag(2));
  890. Verifier().Expect(1, true).Expect(2, true).Verify(cq_.get());
  891. EXPECT_EQ(send_request.message(), recv_request.message());
  892. srv_ctx.AddInitialMetadata(meta1.first, meta1.second);
  893. srv_ctx.AddInitialMetadata(meta2.first, meta2.second);
  894. send_response.set_message(recv_request.message());
  895. srv_stream.Write(send_response, tag(3));
  896. cli_stream->Read(&recv_response, tag(4));
  897. Verifier().Expect(3, true).Expect(4, true).Verify(cq_.get());
  898. EXPECT_EQ(send_response.message(), recv_response.message());
  899. auto server_initial_metadata = cli_ctx.GetServerInitialMetadata();
  900. EXPECT_EQ(meta1.second,
  901. ToString(server_initial_metadata.find(meta1.first)->second));
  902. EXPECT_EQ(meta2.second,
  903. ToString(server_initial_metadata.find(meta2.first)->second));
  904. EXPECT_EQ(static_cast<size_t>(2), server_initial_metadata.size());
  905. srv_stream.Write(send_response, tag(5));
  906. cli_stream->Read(&recv_response, tag(6));
  907. Verifier().Expect(5, true).Expect(6, true).Verify(cq_.get());
  908. srv_stream.Finish(Status::OK, tag(7));
  909. cli_stream->Read(&recv_response, tag(8));
  910. Verifier().Expect(7, true).Expect(8, false).Verify(cq_.get());
  911. cli_stream->Finish(&recv_status, tag(9));
  912. Verifier().Expect(9, true).Verify(cq_.get());
  913. EXPECT_TRUE(recv_status.ok());
  914. }
  915. TEST_P(AsyncEnd2endTest, ServerTrailingMetadataRpc) {
  916. ResetStub();
  917. EchoRequest send_request;
  918. EchoRequest recv_request;
  919. EchoResponse send_response;
  920. EchoResponse recv_response;
  921. Status recv_status;
  922. ClientContext cli_ctx;
  923. ServerContext srv_ctx;
  924. grpc::ServerAsyncResponseWriter<EchoResponse> response_writer(&srv_ctx);
  925. send_request.set_message(GetParam().message_content);
  926. std::pair<std::string, std::string> meta1("key1", "val1");
  927. std::pair<std::string, std::string> meta2("key2", "val2");
  928. std::unique_ptr<ClientAsyncResponseReader<EchoResponse>> response_reader(
  929. stub_->AsyncEcho(&cli_ctx, send_request, cq_.get()));
  930. response_reader->Finish(&recv_response, &recv_status, tag(5));
  931. service_->RequestEcho(&srv_ctx, &recv_request, &response_writer, cq_.get(),
  932. cq_.get(), tag(2));
  933. Verifier().Expect(2, true).Verify(cq_.get());
  934. EXPECT_EQ(send_request.message(), recv_request.message());
  935. response_writer.SendInitialMetadata(tag(3));
  936. Verifier().Expect(3, true).Verify(cq_.get());
  937. send_response.set_message(recv_request.message());
  938. srv_ctx.AddTrailingMetadata(meta1.first, meta1.second);
  939. srv_ctx.AddTrailingMetadata(meta2.first, meta2.second);
  940. response_writer.Finish(send_response, Status::OK, tag(4));
  941. Verifier().Expect(4, true).Expect(5, true).Verify(cq_.get());
  942. EXPECT_EQ(send_response.message(), recv_response.message());
  943. EXPECT_TRUE(recv_status.ok());
  944. const auto& server_trailing_metadata = cli_ctx.GetServerTrailingMetadata();
  945. EXPECT_EQ(meta1.second,
  946. ToString(server_trailing_metadata.find(meta1.first)->second));
  947. EXPECT_EQ(meta2.second,
  948. ToString(server_trailing_metadata.find(meta2.first)->second));
  949. EXPECT_EQ(static_cast<size_t>(2), server_trailing_metadata.size());
  950. }
  951. TEST_P(AsyncEnd2endTest, MetadataRpc) {
  952. ResetStub();
  953. EchoRequest send_request;
  954. EchoRequest recv_request;
  955. EchoResponse send_response;
  956. EchoResponse recv_response;
  957. Status recv_status;
  958. ClientContext cli_ctx;
  959. ServerContext srv_ctx;
  960. grpc::ServerAsyncResponseWriter<EchoResponse> response_writer(&srv_ctx);
  961. send_request.set_message(GetParam().message_content);
  962. std::pair<std::string, std::string> meta1("key1", "val1");
  963. std::pair<std::string, std::string> meta2(
  964. "key2-bin",
  965. std::string("\xc0\xc1\xc2\xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xcc", 13));
  966. std::pair<std::string, std::string> meta3("key3", "val3");
  967. std::pair<std::string, std::string> meta6(
  968. "key4-bin",
  969. std::string("\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d",
  970. 14));
  971. std::pair<std::string, std::string> meta5("key5", "val5");
  972. std::pair<std::string, std::string> meta4(
  973. "key6-bin",
  974. std::string(
  975. "\xe0\xe1\xe2\xe3\xe4\xe5\xe6\xe7\xe8\xe9\xea\xeb\xec\xed\xee", 15));
  976. cli_ctx.AddMetadata(meta1.first, meta1.second);
  977. cli_ctx.AddMetadata(meta2.first, meta2.second);
  978. std::unique_ptr<ClientAsyncResponseReader<EchoResponse>> response_reader(
  979. stub_->AsyncEcho(&cli_ctx, send_request, cq_.get()));
  980. response_reader->ReadInitialMetadata(tag(4));
  981. service_->RequestEcho(&srv_ctx, &recv_request, &response_writer, cq_.get(),
  982. cq_.get(), tag(2));
  983. Verifier().Expect(2, true).Verify(cq_.get());
  984. EXPECT_EQ(send_request.message(), recv_request.message());
  985. const auto& client_initial_metadata = srv_ctx.client_metadata();
  986. EXPECT_EQ(meta1.second,
  987. ToString(client_initial_metadata.find(meta1.first)->second));
  988. EXPECT_EQ(meta2.second,
  989. ToString(client_initial_metadata.find(meta2.first)->second));
  990. EXPECT_GE(client_initial_metadata.size(), static_cast<size_t>(2));
  991. srv_ctx.AddInitialMetadata(meta3.first, meta3.second);
  992. srv_ctx.AddInitialMetadata(meta4.first, meta4.second);
  993. response_writer.SendInitialMetadata(tag(3));
  994. Verifier().Expect(3, true).Expect(4, true).Verify(cq_.get());
  995. const auto& server_initial_metadata = cli_ctx.GetServerInitialMetadata();
  996. EXPECT_EQ(meta3.second,
  997. ToString(server_initial_metadata.find(meta3.first)->second));
  998. EXPECT_EQ(meta4.second,
  999. ToString(server_initial_metadata.find(meta4.first)->second));
  1000. EXPECT_GE(server_initial_metadata.size(), static_cast<size_t>(2));
  1001. send_response.set_message(recv_request.message());
  1002. srv_ctx.AddTrailingMetadata(meta5.first, meta5.second);
  1003. srv_ctx.AddTrailingMetadata(meta6.first, meta6.second);
  1004. response_writer.Finish(send_response, Status::OK, tag(5));
  1005. response_reader->Finish(&recv_response, &recv_status, tag(6));
  1006. Verifier().Expect(5, true).Expect(6, true).Verify(cq_.get());
  1007. EXPECT_EQ(send_response.message(), recv_response.message());
  1008. EXPECT_TRUE(recv_status.ok());
  1009. const auto& server_trailing_metadata = cli_ctx.GetServerTrailingMetadata();
  1010. EXPECT_EQ(meta5.second,
  1011. ToString(server_trailing_metadata.find(meta5.first)->second));
  1012. EXPECT_EQ(meta6.second,
  1013. ToString(server_trailing_metadata.find(meta6.first)->second));
  1014. EXPECT_GE(server_trailing_metadata.size(), static_cast<size_t>(2));
  1015. }
  1016. // Server uses AsyncNotifyWhenDone API to check for cancellation
  1017. TEST_P(AsyncEnd2endTest, ServerCheckCancellation) {
  1018. ResetStub();
  1019. EchoRequest send_request;
  1020. EchoRequest recv_request;
  1021. EchoResponse send_response;
  1022. EchoResponse recv_response;
  1023. Status recv_status;
  1024. ClientContext cli_ctx;
  1025. ServerContext srv_ctx;
  1026. grpc::ServerAsyncResponseWriter<EchoResponse> response_writer(&srv_ctx);
  1027. send_request.set_message(GetParam().message_content);
  1028. std::unique_ptr<ClientAsyncResponseReader<EchoResponse>> response_reader(
  1029. stub_->AsyncEcho(&cli_ctx, send_request, cq_.get()));
  1030. response_reader->Finish(&recv_response, &recv_status, tag(4));
  1031. srv_ctx.AsyncNotifyWhenDone(tag(5));
  1032. service_->RequestEcho(&srv_ctx, &recv_request, &response_writer, cq_.get(),
  1033. cq_.get(), tag(2));
  1034. Verifier().Expect(2, true).Verify(cq_.get());
  1035. EXPECT_EQ(send_request.message(), recv_request.message());
  1036. cli_ctx.TryCancel();
  1037. Verifier().Expect(5, true).Expect(4, true).Verify(cq_.get());
  1038. EXPECT_TRUE(srv_ctx.IsCancelled());
  1039. EXPECT_EQ(StatusCode::CANCELLED, recv_status.error_code());
  1040. }
  1041. // Server uses AsyncNotifyWhenDone API to check for normal finish
  1042. TEST_P(AsyncEnd2endTest, ServerCheckDone) {
  1043. ResetStub();
  1044. EchoRequest send_request;
  1045. EchoRequest recv_request;
  1046. EchoResponse send_response;
  1047. EchoResponse recv_response;
  1048. Status recv_status;
  1049. ClientContext cli_ctx;
  1050. ServerContext srv_ctx;
  1051. grpc::ServerAsyncResponseWriter<EchoResponse> response_writer(&srv_ctx);
  1052. send_request.set_message(GetParam().message_content);
  1053. std::unique_ptr<ClientAsyncResponseReader<EchoResponse>> response_reader(
  1054. stub_->AsyncEcho(&cli_ctx, send_request, cq_.get()));
  1055. response_reader->Finish(&recv_response, &recv_status, tag(4));
  1056. srv_ctx.AsyncNotifyWhenDone(tag(5));
  1057. service_->RequestEcho(&srv_ctx, &recv_request, &response_writer, cq_.get(),
  1058. cq_.get(), tag(2));
  1059. Verifier().Expect(2, true).Verify(cq_.get());
  1060. EXPECT_EQ(send_request.message(), recv_request.message());
  1061. send_response.set_message(recv_request.message());
  1062. response_writer.Finish(send_response, Status::OK, tag(3));
  1063. Verifier().Expect(3, true).Expect(4, true).Expect(5, true).Verify(cq_.get());
  1064. EXPECT_FALSE(srv_ctx.IsCancelled());
  1065. EXPECT_EQ(send_response.message(), recv_response.message());
  1066. EXPECT_TRUE(recv_status.ok());
  1067. }
  1068. TEST_P(AsyncEnd2endTest, UnimplementedRpc) {
  1069. ChannelArguments args;
  1070. const auto& channel_creds = GetCredentialsProvider()->GetChannelCredentials(
  1071. GetParam().credentials_type, &args);
  1072. std::shared_ptr<Channel> channel =
  1073. !(GetParam().inproc) ? grpc::CreateCustomChannel(server_address_.str(),
  1074. channel_creds, args)
  1075. : server_->InProcessChannel(args);
  1076. std::unique_ptr<grpc::testing::UnimplementedEchoService::Stub> stub;
  1077. stub = grpc::testing::UnimplementedEchoService::NewStub(channel);
  1078. EchoRequest send_request;
  1079. EchoResponse recv_response;
  1080. Status recv_status;
  1081. ClientContext cli_ctx;
  1082. send_request.set_message(GetParam().message_content);
  1083. std::unique_ptr<ClientAsyncResponseReader<EchoResponse>> response_reader(
  1084. stub->AsyncUnimplemented(&cli_ctx, send_request, cq_.get()));
  1085. response_reader->Finish(&recv_response, &recv_status, tag(4));
  1086. Verifier().Expect(4, true).Verify(cq_.get());
  1087. EXPECT_EQ(StatusCode::UNIMPLEMENTED, recv_status.error_code());
  1088. EXPECT_EQ("", recv_status.error_message());
  1089. }
  1090. // This class is for testing scenarios where RPCs are cancelled on the server
  1091. // by calling ServerContext::TryCancel(). Server uses AsyncNotifyWhenDone
  1092. // API to check for cancellation
  1093. class AsyncEnd2endServerTryCancelTest : public AsyncEnd2endTest {
  1094. protected:
  1095. typedef enum {
  1096. DO_NOT_CANCEL = 0,
  1097. CANCEL_BEFORE_PROCESSING,
  1098. CANCEL_DURING_PROCESSING,
  1099. CANCEL_AFTER_PROCESSING
  1100. } ServerTryCancelRequestPhase;
  1101. // Helper for testing client-streaming RPCs which are cancelled on the server.
  1102. // Depending on the value of server_try_cancel parameter, this will test one
  1103. // of the following three scenarios:
  1104. // CANCEL_BEFORE_PROCESSING: Rpc is cancelled by the server before reading
  1105. // any messages from the client
  1106. //
  1107. // CANCEL_DURING_PROCESSING: Rpc is cancelled by the server while reading
  1108. // messages from the client
  1109. //
  1110. // CANCEL_AFTER PROCESSING: Rpc is cancelled by server after reading all
  1111. // messages from the client (but before sending any status back to the
  1112. // client)
  1113. void TestClientStreamingServerCancel(
  1114. ServerTryCancelRequestPhase server_try_cancel) {
  1115. ResetStub();
  1116. EchoRequest recv_request;
  1117. EchoResponse send_response;
  1118. EchoResponse recv_response;
  1119. Status recv_status;
  1120. ClientContext cli_ctx;
  1121. ServerContext srv_ctx;
  1122. ServerAsyncReader<EchoResponse, EchoRequest> srv_stream(&srv_ctx);
  1123. // Initiate the 'RequestStream' call on client
  1124. CompletionQueue cli_cq;
  1125. std::unique_ptr<ClientAsyncWriter<EchoRequest>> cli_stream(
  1126. stub_->AsyncRequestStream(&cli_ctx, &recv_response, &cli_cq, tag(1)));
  1127. // On the server, request to be notified of 'RequestStream' calls
  1128. // and receive the 'RequestStream' call just made by the client
  1129. srv_ctx.AsyncNotifyWhenDone(tag(11));
  1130. service_->RequestRequestStream(&srv_ctx, &srv_stream, cq_.get(), cq_.get(),
  1131. tag(2));
  1132. std::thread t1([&cli_cq] { Verifier().Expect(1, true).Verify(&cli_cq); });
  1133. Verifier().Expect(2, true).Verify(cq_.get());
  1134. t1.join();
  1135. bool expected_server_cq_result = true;
  1136. bool expected_client_cq_result = true;
  1137. if (server_try_cancel == CANCEL_BEFORE_PROCESSING) {
  1138. srv_ctx.TryCancel();
  1139. Verifier().Expect(11, true).Verify(cq_.get());
  1140. EXPECT_TRUE(srv_ctx.IsCancelled());
  1141. // Since cancellation is done before server reads any results, we know
  1142. // for sure that all server cq results will return false from this
  1143. // point forward
  1144. expected_server_cq_result = false;
  1145. expected_client_cq_result = false;
  1146. }
  1147. bool ignore_client_cq_result =
  1148. (server_try_cancel == CANCEL_DURING_PROCESSING) ||
  1149. (server_try_cancel == CANCEL_BEFORE_PROCESSING);
  1150. std::thread cli_thread([&cli_cq, &cli_stream, &expected_client_cq_result,
  1151. &ignore_client_cq_result] {
  1152. EchoRequest send_request;
  1153. // Client sends 3 messages (tags 3, 4 and 5)
  1154. for (int tag_idx = 3; tag_idx <= 5; tag_idx++) {
  1155. send_request.set_message("Ping " + std::to_string(tag_idx));
  1156. cli_stream->Write(send_request, tag(tag_idx));
  1157. Verifier()
  1158. .Expect(tag_idx, expected_client_cq_result)
  1159. .Verify(&cli_cq, ignore_client_cq_result);
  1160. }
  1161. cli_stream->WritesDone(tag(6));
  1162. // Ignore ok on WritesDone since cancel can affect it
  1163. Verifier()
  1164. .Expect(6, expected_client_cq_result)
  1165. .Verify(&cli_cq, ignore_client_cq_result);
  1166. });
  1167. bool ignore_cq_result = false;
  1168. bool want_done_tag = false;
  1169. std::thread* server_try_cancel_thd = nullptr;
  1170. auto verif = Verifier();
  1171. if (server_try_cancel == CANCEL_DURING_PROCESSING) {
  1172. server_try_cancel_thd =
  1173. new std::thread([&srv_ctx] { srv_ctx.TryCancel(); });
  1174. // Server will cancel the RPC in a parallel thread while reading the
  1175. // requests from the client. Since the cancellation can happen at anytime,
  1176. // some of the cq results (i.e those until cancellation) might be true but
  1177. // its non deterministic. So better to ignore the cq results
  1178. ignore_cq_result = true;
  1179. // Expect that we might possibly see the done tag that
  1180. // indicates cancellation completion in this case
  1181. want_done_tag = true;
  1182. verif.Expect(11, true);
  1183. }
  1184. // Server reads 3 messages (tags 6, 7 and 8)
  1185. // But if want_done_tag is true, we might also see tag 11
  1186. for (int tag_idx = 6; tag_idx <= 8; tag_idx++) {
  1187. srv_stream.Read(&recv_request, tag(tag_idx));
  1188. // Note that we'll add something to the verifier and verify that
  1189. // something was seen, but it might be tag 11 and not what we
  1190. // just added
  1191. int got_tag = verif.Expect(tag_idx, expected_server_cq_result)
  1192. .Next(cq_.get(), ignore_cq_result);
  1193. GPR_ASSERT((got_tag == tag_idx) || (got_tag == 11 && want_done_tag));
  1194. if (got_tag == 11) {
  1195. EXPECT_TRUE(srv_ctx.IsCancelled());
  1196. want_done_tag = false;
  1197. // Now get the other entry that we were waiting on
  1198. EXPECT_EQ(verif.Next(cq_.get(), ignore_cq_result), tag_idx);
  1199. }
  1200. }
  1201. cli_thread.join();
  1202. if (server_try_cancel_thd != nullptr) {
  1203. server_try_cancel_thd->join();
  1204. delete server_try_cancel_thd;
  1205. }
  1206. if (server_try_cancel == CANCEL_AFTER_PROCESSING) {
  1207. srv_ctx.TryCancel();
  1208. want_done_tag = true;
  1209. verif.Expect(11, true);
  1210. }
  1211. if (want_done_tag) {
  1212. verif.Verify(cq_.get());
  1213. EXPECT_TRUE(srv_ctx.IsCancelled());
  1214. want_done_tag = false;
  1215. }
  1216. // The RPC has been cancelled at this point for sure (i.e irrespective of
  1217. // the value of `server_try_cancel` is). So, from this point forward, we
  1218. // know that cq results are supposed to return false on server.
  1219. // Server sends the final message and cancelled status (but the RPC is
  1220. // already cancelled at this point. So we expect the operation to fail)
  1221. srv_stream.Finish(send_response, Status::CANCELLED, tag(9));
  1222. Verifier().Expect(9, false).Verify(cq_.get());
  1223. // Client will see the cancellation
  1224. cli_stream->Finish(&recv_status, tag(10));
  1225. Verifier().Expect(10, true).Verify(&cli_cq);
  1226. EXPECT_FALSE(recv_status.ok());
  1227. EXPECT_EQ(grpc::StatusCode::CANCELLED, recv_status.error_code());
  1228. cli_cq.Shutdown();
  1229. void* phony_tag;
  1230. bool phony_ok;
  1231. while (cli_cq.Next(&phony_tag, &phony_ok)) {
  1232. }
  1233. }
  1234. // Helper for testing server-streaming RPCs which are cancelled on the server.
  1235. // Depending on the value of server_try_cancel parameter, this will test one
  1236. // of the following three scenarios:
  1237. // CANCEL_BEFORE_PROCESSING: Rpc is cancelled by the server before sending
  1238. // any messages to the client
  1239. //
  1240. // CANCEL_DURING_PROCESSING: Rpc is cancelled by the server while sending
  1241. // messages to the client
  1242. //
  1243. // CANCEL_AFTER PROCESSING: Rpc is cancelled by server after sending all
  1244. // messages to the client (but before sending any status back to the
  1245. // client)
  1246. void TestServerStreamingServerCancel(
  1247. ServerTryCancelRequestPhase server_try_cancel) {
  1248. ResetStub();
  1249. EchoRequest send_request;
  1250. EchoRequest recv_request;
  1251. EchoResponse send_response;
  1252. Status recv_status;
  1253. ClientContext cli_ctx;
  1254. ServerContext srv_ctx;
  1255. ServerAsyncWriter<EchoResponse> srv_stream(&srv_ctx);
  1256. send_request.set_message("Ping");
  1257. // Initiate the 'ResponseStream' call on the client
  1258. CompletionQueue cli_cq;
  1259. std::unique_ptr<ClientAsyncReader<EchoResponse>> cli_stream(
  1260. stub_->AsyncResponseStream(&cli_ctx, send_request, &cli_cq, tag(1)));
  1261. // On the server, request to be notified of 'ResponseStream' calls and
  1262. // receive the call just made by the client
  1263. srv_ctx.AsyncNotifyWhenDone(tag(11));
  1264. service_->RequestResponseStream(&srv_ctx, &recv_request, &srv_stream,
  1265. cq_.get(), cq_.get(), tag(2));
  1266. std::thread t1([&cli_cq] { Verifier().Expect(1, true).Verify(&cli_cq); });
  1267. Verifier().Expect(2, true).Verify(cq_.get());
  1268. t1.join();
  1269. EXPECT_EQ(send_request.message(), recv_request.message());
  1270. bool expected_cq_result = true;
  1271. bool ignore_cq_result = false;
  1272. bool want_done_tag = false;
  1273. bool expected_client_cq_result = true;
  1274. bool ignore_client_cq_result =
  1275. (server_try_cancel != CANCEL_BEFORE_PROCESSING);
  1276. if (server_try_cancel == CANCEL_BEFORE_PROCESSING) {
  1277. srv_ctx.TryCancel();
  1278. Verifier().Expect(11, true).Verify(cq_.get());
  1279. EXPECT_TRUE(srv_ctx.IsCancelled());
  1280. // We know for sure that all cq results will be false from this point
  1281. // since the server cancelled the RPC
  1282. expected_cq_result = false;
  1283. expected_client_cq_result = false;
  1284. }
  1285. std::thread cli_thread([&cli_cq, &cli_stream, &expected_client_cq_result,
  1286. &ignore_client_cq_result] {
  1287. // Client attempts to read the three messages from the server
  1288. for (int tag_idx = 6; tag_idx <= 8; tag_idx++) {
  1289. EchoResponse recv_response;
  1290. cli_stream->Read(&recv_response, tag(tag_idx));
  1291. Verifier()
  1292. .Expect(tag_idx, expected_client_cq_result)
  1293. .Verify(&cli_cq, ignore_client_cq_result);
  1294. }
  1295. });
  1296. std::thread* server_try_cancel_thd = nullptr;
  1297. auto verif = Verifier();
  1298. if (server_try_cancel == CANCEL_DURING_PROCESSING) {
  1299. server_try_cancel_thd =
  1300. new std::thread([&srv_ctx] { srv_ctx.TryCancel(); });
  1301. // Server will cancel the RPC in a parallel thread while writing responses
  1302. // to the client. Since the cancellation can happen at anytime, some of
  1303. // the cq results (i.e those until cancellation) might be true but it is
  1304. // non deterministic. So better to ignore the cq results
  1305. ignore_cq_result = true;
  1306. // Expect that we might possibly see the done tag that
  1307. // indicates cancellation completion in this case
  1308. want_done_tag = true;
  1309. verif.Expect(11, true);
  1310. }
  1311. // Server sends three messages (tags 3, 4 and 5)
  1312. // But if want_done tag is true, we might also see tag 11
  1313. for (int tag_idx = 3; tag_idx <= 5; tag_idx++) {
  1314. send_response.set_message("Pong " + std::to_string(tag_idx));
  1315. srv_stream.Write(send_response, tag(tag_idx));
  1316. // Note that we'll add something to the verifier and verify that
  1317. // something was seen, but it might be tag 11 and not what we
  1318. // just added
  1319. int got_tag = verif.Expect(tag_idx, expected_cq_result)
  1320. .Next(cq_.get(), ignore_cq_result);
  1321. GPR_ASSERT((got_tag == tag_idx) || (got_tag == 11 && want_done_tag));
  1322. if (got_tag == 11) {
  1323. EXPECT_TRUE(srv_ctx.IsCancelled());
  1324. want_done_tag = false;
  1325. // Now get the other entry that we were waiting on
  1326. EXPECT_EQ(verif.Next(cq_.get(), ignore_cq_result), tag_idx);
  1327. }
  1328. }
  1329. if (server_try_cancel_thd != nullptr) {
  1330. server_try_cancel_thd->join();
  1331. delete server_try_cancel_thd;
  1332. }
  1333. if (server_try_cancel == CANCEL_AFTER_PROCESSING) {
  1334. srv_ctx.TryCancel();
  1335. want_done_tag = true;
  1336. verif.Expect(11, true);
  1337. }
  1338. if (want_done_tag) {
  1339. verif.Verify(cq_.get());
  1340. EXPECT_TRUE(srv_ctx.IsCancelled());
  1341. want_done_tag = false;
  1342. }
  1343. cli_thread.join();
  1344. // The RPC has been cancelled at this point for sure (i.e irrespective of
  1345. // the value of `server_try_cancel` is). So, from this point forward, we
  1346. // know that cq results are supposed to return false on server.
  1347. // Server finishes the stream (but the RPC is already cancelled)
  1348. srv_stream.Finish(Status::CANCELLED, tag(9));
  1349. Verifier().Expect(9, false).Verify(cq_.get());
  1350. // Client will see the cancellation
  1351. cli_stream->Finish(&recv_status, tag(10));
  1352. Verifier().Expect(10, true).Verify(&cli_cq);
  1353. EXPECT_FALSE(recv_status.ok());
  1354. EXPECT_EQ(grpc::StatusCode::CANCELLED, recv_status.error_code());
  1355. cli_cq.Shutdown();
  1356. void* phony_tag;
  1357. bool phony_ok;
  1358. while (cli_cq.Next(&phony_tag, &phony_ok)) {
  1359. }
  1360. }
  1361. // Helper for testing bidirectinal-streaming RPCs which are cancelled on the
  1362. // server.
  1363. //
  1364. // Depending on the value of server_try_cancel parameter, this will
  1365. // test one of the following three scenarios:
  1366. // CANCEL_BEFORE_PROCESSING: Rpc is cancelled by the server before reading/
  1367. // writing any messages from/to the client
  1368. //
  1369. // CANCEL_DURING_PROCESSING: Rpc is cancelled by the server while reading
  1370. // messages from the client
  1371. //
  1372. // CANCEL_AFTER PROCESSING: Rpc is cancelled by server after reading all
  1373. // messages from the client (but before sending any status back to the
  1374. // client)
  1375. void TestBidiStreamingServerCancel(
  1376. ServerTryCancelRequestPhase server_try_cancel) {
  1377. ResetStub();
  1378. EchoRequest send_request;
  1379. EchoRequest recv_request;
  1380. EchoResponse send_response;
  1381. EchoResponse recv_response;
  1382. Status recv_status;
  1383. ClientContext cli_ctx;
  1384. ServerContext srv_ctx;
  1385. ServerAsyncReaderWriter<EchoResponse, EchoRequest> srv_stream(&srv_ctx);
  1386. // Initiate the call from the client side
  1387. std::unique_ptr<ClientAsyncReaderWriter<EchoRequest, EchoResponse>>
  1388. cli_stream(stub_->AsyncBidiStream(&cli_ctx, cq_.get(), tag(1)));
  1389. // On the server, request to be notified of the 'BidiStream' call and
  1390. // receive the call just made by the client
  1391. srv_ctx.AsyncNotifyWhenDone(tag(11));
  1392. service_->RequestBidiStream(&srv_ctx, &srv_stream, cq_.get(), cq_.get(),
  1393. tag(2));
  1394. Verifier().Expect(1, true).Expect(2, true).Verify(cq_.get());
  1395. auto verif = Verifier();
  1396. // Client sends the first and the only message
  1397. send_request.set_message("Ping");
  1398. cli_stream->Write(send_request, tag(3));
  1399. verif.Expect(3, true);
  1400. bool expected_cq_result = true;
  1401. bool ignore_cq_result = false;
  1402. bool want_done_tag = false;
  1403. int got_tag, got_tag2;
  1404. bool tag_3_done = false;
  1405. if (server_try_cancel == CANCEL_BEFORE_PROCESSING) {
  1406. srv_ctx.TryCancel();
  1407. verif.Expect(11, true);
  1408. // We know for sure that all server cq results will be false from
  1409. // this point since the server cancelled the RPC. However, we can't
  1410. // say for sure about the client
  1411. expected_cq_result = false;
  1412. ignore_cq_result = true;
  1413. do {
  1414. got_tag = verif.Next(cq_.get(), ignore_cq_result);
  1415. GPR_ASSERT(((got_tag == 3) && !tag_3_done) || (got_tag == 11));
  1416. if (got_tag == 3) {
  1417. tag_3_done = true;
  1418. }
  1419. } while (got_tag != 11);
  1420. EXPECT_TRUE(srv_ctx.IsCancelled());
  1421. }
  1422. std::thread* server_try_cancel_thd = nullptr;
  1423. if (server_try_cancel == CANCEL_DURING_PROCESSING) {
  1424. server_try_cancel_thd =
  1425. new std::thread([&srv_ctx] { srv_ctx.TryCancel(); });
  1426. // Since server is going to cancel the RPC in a parallel thread, some of
  1427. // the cq results (i.e those until the cancellation) might be true. Since
  1428. // that number is non-deterministic, it is better to ignore the cq results
  1429. ignore_cq_result = true;
  1430. // Expect that we might possibly see the done tag that
  1431. // indicates cancellation completion in this case
  1432. want_done_tag = true;
  1433. verif.Expect(11, true);
  1434. }
  1435. srv_stream.Read(&recv_request, tag(4));
  1436. verif.Expect(4, expected_cq_result);
  1437. got_tag = tag_3_done ? 3 : verif.Next(cq_.get(), ignore_cq_result);
  1438. got_tag2 = verif.Next(cq_.get(), ignore_cq_result);
  1439. GPR_ASSERT((got_tag == 3) || (got_tag == 4) ||
  1440. (got_tag == 11 && want_done_tag));
  1441. GPR_ASSERT((got_tag2 == 3) || (got_tag2 == 4) ||
  1442. (got_tag2 == 11 && want_done_tag));
  1443. // If we get 3 and 4, we don't need to wait for 11, but if
  1444. // we get 11, we should also clear 3 and 4
  1445. if (got_tag + got_tag2 != 7) {
  1446. EXPECT_TRUE(srv_ctx.IsCancelled());
  1447. want_done_tag = false;
  1448. got_tag = verif.Next(cq_.get(), ignore_cq_result);
  1449. GPR_ASSERT((got_tag == 3) || (got_tag == 4));
  1450. }
  1451. send_response.set_message("Pong");
  1452. srv_stream.Write(send_response, tag(5));
  1453. verif.Expect(5, expected_cq_result);
  1454. cli_stream->Read(&recv_response, tag(6));
  1455. verif.Expect(6, expected_cq_result);
  1456. got_tag = verif.Next(cq_.get(), ignore_cq_result);
  1457. got_tag2 = verif.Next(cq_.get(), ignore_cq_result);
  1458. GPR_ASSERT((got_tag == 5) || (got_tag == 6) ||
  1459. (got_tag == 11 && want_done_tag));
  1460. GPR_ASSERT((got_tag2 == 5) || (got_tag2 == 6) ||
  1461. (got_tag2 == 11 && want_done_tag));
  1462. // If we get 5 and 6, we don't need to wait for 11, but if
  1463. // we get 11, we should also clear 5 and 6
  1464. if (got_tag + got_tag2 != 11) {
  1465. EXPECT_TRUE(srv_ctx.IsCancelled());
  1466. want_done_tag = false;
  1467. got_tag = verif.Next(cq_.get(), ignore_cq_result);
  1468. GPR_ASSERT((got_tag == 5) || (got_tag == 6));
  1469. }
  1470. // This is expected to succeed in all cases
  1471. cli_stream->WritesDone(tag(7));
  1472. verif.Expect(7, true);
  1473. // TODO(vjpai): Consider whether the following is too flexible
  1474. // or whether it should just be reset to ignore_cq_result
  1475. bool ignore_cq_wd_result =
  1476. ignore_cq_result || (server_try_cancel == CANCEL_BEFORE_PROCESSING);
  1477. got_tag = verif.Next(cq_.get(), ignore_cq_wd_result);
  1478. GPR_ASSERT((got_tag == 7) || (got_tag == 11 && want_done_tag));
  1479. if (got_tag == 11) {
  1480. EXPECT_TRUE(srv_ctx.IsCancelled());
  1481. want_done_tag = false;
  1482. // Now get the other entry that we were waiting on
  1483. EXPECT_EQ(verif.Next(cq_.get(), ignore_cq_wd_result), 7);
  1484. }
  1485. // This is expected to fail in all cases i.e for all values of
  1486. // server_try_cancel. This is because at this point, either there are no
  1487. // more msgs from the client (because client called WritesDone) or the RPC
  1488. // is cancelled on the server
  1489. srv_stream.Read(&recv_request, tag(8));
  1490. verif.Expect(8, false);
  1491. got_tag = verif.Next(cq_.get(), ignore_cq_result);
  1492. GPR_ASSERT((got_tag == 8) || (got_tag == 11 && want_done_tag));
  1493. if (got_tag == 11) {
  1494. EXPECT_TRUE(srv_ctx.IsCancelled());
  1495. want_done_tag = false;
  1496. // Now get the other entry that we were waiting on
  1497. EXPECT_EQ(verif.Next(cq_.get(), ignore_cq_result), 8);
  1498. }
  1499. if (server_try_cancel_thd != nullptr) {
  1500. server_try_cancel_thd->join();
  1501. delete server_try_cancel_thd;
  1502. }
  1503. if (server_try_cancel == CANCEL_AFTER_PROCESSING) {
  1504. srv_ctx.TryCancel();
  1505. want_done_tag = true;
  1506. verif.Expect(11, true);
  1507. }
  1508. if (want_done_tag) {
  1509. verif.Verify(cq_.get());
  1510. EXPECT_TRUE(srv_ctx.IsCancelled());
  1511. want_done_tag = false;
  1512. }
  1513. // The RPC has been cancelled at this point for sure (i.e irrespective of
  1514. // the value of `server_try_cancel` is). So, from this point forward, we
  1515. // know that cq results are supposed to return false on server.
  1516. srv_stream.Finish(Status::CANCELLED, tag(9));
  1517. Verifier().Expect(9, false).Verify(cq_.get());
  1518. cli_stream->Finish(&recv_status, tag(10));
  1519. Verifier().Expect(10, true).Verify(cq_.get());
  1520. EXPECT_FALSE(recv_status.ok());
  1521. EXPECT_EQ(grpc::StatusCode::CANCELLED, recv_status.error_code());
  1522. }
  1523. };
  1524. TEST_P(AsyncEnd2endServerTryCancelTest, ClientStreamingServerTryCancelBefore) {
  1525. TestClientStreamingServerCancel(CANCEL_BEFORE_PROCESSING);
  1526. }
  1527. TEST_P(AsyncEnd2endServerTryCancelTest, ClientStreamingServerTryCancelDuring) {
  1528. TestClientStreamingServerCancel(CANCEL_DURING_PROCESSING);
  1529. }
  1530. TEST_P(AsyncEnd2endServerTryCancelTest, ClientStreamingServerTryCancelAfter) {
  1531. TestClientStreamingServerCancel(CANCEL_AFTER_PROCESSING);
  1532. }
  1533. TEST_P(AsyncEnd2endServerTryCancelTest, ServerStreamingServerTryCancelBefore) {
  1534. TestServerStreamingServerCancel(CANCEL_BEFORE_PROCESSING);
  1535. }
  1536. TEST_P(AsyncEnd2endServerTryCancelTest, ServerStreamingServerTryCancelDuring) {
  1537. TestServerStreamingServerCancel(CANCEL_DURING_PROCESSING);
  1538. }
  1539. TEST_P(AsyncEnd2endServerTryCancelTest, ServerStreamingServerTryCancelAfter) {
  1540. TestServerStreamingServerCancel(CANCEL_AFTER_PROCESSING);
  1541. }
  1542. TEST_P(AsyncEnd2endServerTryCancelTest, ServerBidiStreamingTryCancelBefore) {
  1543. TestBidiStreamingServerCancel(CANCEL_BEFORE_PROCESSING);
  1544. }
  1545. TEST_P(AsyncEnd2endServerTryCancelTest, ServerBidiStreamingTryCancelDuring) {
  1546. TestBidiStreamingServerCancel(CANCEL_DURING_PROCESSING);
  1547. }
  1548. TEST_P(AsyncEnd2endServerTryCancelTest, ServerBidiStreamingTryCancelAfter) {
  1549. TestBidiStreamingServerCancel(CANCEL_AFTER_PROCESSING);
  1550. }
  1551. std::vector<TestScenario> CreateTestScenarios(bool /*test_secure*/,
  1552. bool test_message_size_limit) {
  1553. std::vector<TestScenario> scenarios;
  1554. std::vector<std::string> credentials_types;
  1555. std::vector<std::string> messages;
  1556. auto insec_ok = [] {
  1557. // Only allow insecure credentials type when it is registered with the
  1558. // provider. User may create providers that do not have insecure.
  1559. return GetCredentialsProvider()->GetChannelCredentials(
  1560. kInsecureCredentialsType, nullptr) != nullptr;
  1561. };
  1562. if (insec_ok()) {
  1563. credentials_types.push_back(kInsecureCredentialsType);
  1564. }
  1565. auto sec_list = GetCredentialsProvider()->GetSecureCredentialsTypeList();
  1566. for (auto sec = sec_list.begin(); sec != sec_list.end(); sec++) {
  1567. credentials_types.push_back(*sec);
  1568. }
  1569. GPR_ASSERT(!credentials_types.empty());
  1570. messages.push_back("Hello");
  1571. if (test_message_size_limit) {
  1572. for (size_t k = 1; k < GRPC_DEFAULT_MAX_RECV_MESSAGE_LENGTH / 1024;
  1573. k *= 32) {
  1574. std::string big_msg;
  1575. for (size_t i = 0; i < k * 1024; ++i) {
  1576. char c = 'a' + (i % 26);
  1577. big_msg += c;
  1578. }
  1579. messages.push_back(big_msg);
  1580. }
  1581. if (!BuiltUnderMsan()) {
  1582. // 4MB message processing with SSL is very slow under msan
  1583. // (causes timeouts) and doesn't really increase the signal from tests.
  1584. // Reserve 100 bytes for other fields of the message proto.
  1585. messages.push_back(
  1586. std::string(GRPC_DEFAULT_MAX_RECV_MESSAGE_LENGTH - 100, 'a'));
  1587. }
  1588. }
  1589. // TODO (sreek) Renable tests with health check service after the issue
  1590. // https://github.com/grpc/grpc/issues/11223 is resolved
  1591. for (auto health_check_service : {false}) {
  1592. for (auto msg = messages.begin(); msg != messages.end(); msg++) {
  1593. for (auto cred = credentials_types.begin();
  1594. cred != credentials_types.end(); ++cred) {
  1595. scenarios.emplace_back(false, *cred, health_check_service, *msg);
  1596. }
  1597. if (insec_ok()) {
  1598. scenarios.emplace_back(true, kInsecureCredentialsType,
  1599. health_check_service, *msg);
  1600. }
  1601. }
  1602. }
  1603. return scenarios;
  1604. }
  1605. INSTANTIATE_TEST_SUITE_P(AsyncEnd2end, AsyncEnd2endTest,
  1606. ::testing::ValuesIn(CreateTestScenarios(true, true)));
  1607. INSTANTIATE_TEST_SUITE_P(AsyncEnd2endServerTryCancel,
  1608. AsyncEnd2endServerTryCancelTest,
  1609. ::testing::ValuesIn(CreateTestScenarios(false,
  1610. false)));
  1611. } // namespace
  1612. } // namespace testing
  1613. } // namespace grpc
  1614. int main(int argc, char** argv) {
  1615. // Change the backup poll interval from 5s to 100ms to speed up the
  1616. // ReconnectChannel test
  1617. GPR_GLOBAL_CONFIG_SET(grpc_client_channel_backup_poll_interval_ms, 100);
  1618. grpc::testing::TestEnvironment env(argc, argv);
  1619. ::testing::InitGoogleTest(&argc, argv);
  1620. int ret = RUN_ALL_TESTS();
  1621. return ret;
  1622. }