1 /*
2 *
3 * Copyright 2017 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
19 #include "test/core/end2end/end2end_tests.h"
20
21 #include <stdio.h>
22 #include <string.h>
23
24 #include <grpc/byte_buffer.h>
25 #include <grpc/grpc.h>
26 #include <grpc/support/alloc.h>
27 #include <grpc/support/log.h>
28 #include <grpc/support/string_util.h>
29 #include <grpc/support/time.h>
30
31 #include "src/core/lib/surface/channel.h"
32 #include "src/core/lib/surface/server.h"
33
34 #include "src/core/lib/channel/channel_args.h"
35 #include "src/core/lib/gpr/string.h"
36 #include "src/core/lib/gpr/useful.h"
37 #include "src/core/lib/iomgr/exec_ctx.h"
38 #include "src/core/lib/transport/static_metadata.h"
39
40 #include "test/core/end2end/cq_verifier.h"
41 #include "test/core/end2end/tests/cancel_test_helpers.h"
42
tag(intptr_t t)43 static void* tag(intptr_t t) { return (void*)t; }
44
begin_test(grpc_end2end_test_config config,const char * test_name,grpc_channel_args * client_args,grpc_channel_args * server_args)45 static grpc_end2end_test_fixture begin_test(grpc_end2end_test_config config,
46 const char* test_name,
47 grpc_channel_args* client_args,
48 grpc_channel_args* server_args) {
49 grpc_end2end_test_fixture f;
50 gpr_log(GPR_INFO, "Running test: %s/%s", test_name, config.name);
51 f = config.create_fixture(client_args, server_args);
52 config.init_server(&f, server_args);
53 config.init_client(&f, client_args);
54 return f;
55 }
56
n_seconds_from_now(int n)57 static gpr_timespec n_seconds_from_now(int n) {
58 return grpc_timeout_seconds_to_deadline(n);
59 }
60
five_seconds_from_now(void)61 static gpr_timespec five_seconds_from_now(void) {
62 return n_seconds_from_now(5);
63 }
64
drain_cq(grpc_completion_queue * cq)65 static void drain_cq(grpc_completion_queue* cq) {
66 grpc_event ev;
67 do {
68 ev = grpc_completion_queue_next(cq, five_seconds_from_now(), nullptr);
69 } while (ev.type != GRPC_QUEUE_SHUTDOWN);
70 }
71
shutdown_server(grpc_end2end_test_fixture * f)72 static void shutdown_server(grpc_end2end_test_fixture* f) {
73 if (!f->server) return;
74 grpc_server_shutdown_and_notify(f->server, f->shutdown_cq, tag(1000));
75 GPR_ASSERT(grpc_completion_queue_pluck(f->shutdown_cq, tag(1000),
76 grpc_timeout_seconds_to_deadline(5),
77 nullptr)
78 .type == GRPC_OP_COMPLETE);
79 grpc_server_destroy(f->server);
80 f->server = nullptr;
81 }
82
shutdown_client(grpc_end2end_test_fixture * f)83 static void shutdown_client(grpc_end2end_test_fixture* f) {
84 if (!f->client) return;
85 grpc_channel_destroy(f->client);
86 f->client = nullptr;
87 }
88
end_test(grpc_end2end_test_fixture * f)89 static void end_test(grpc_end2end_test_fixture* f) {
90 shutdown_server(f);
91 shutdown_client(f);
92
93 grpc_completion_queue_shutdown(f->cq);
94 drain_cq(f->cq);
95 grpc_completion_queue_destroy(f->cq);
96 grpc_completion_queue_destroy(f->shutdown_cq);
97 }
98
99 // Tests retrying a streaming RPC. This is the same as
100 // the basic retry test, except that the client sends two messages on the
101 // call before the initial attempt fails.
102 // FIXME: We should also test the case where the retry is committed after
103 // replaying 1 of 2 previously-completed send_message ops. However,
104 // there's no way to trigger that from an end2end test, because the
105 // replayed ops happen under the hood -- they are not surfaced to the
106 // C-core API, and therefore we have no way to inject the commit at the
107 // right point.
test_retry_streaming(grpc_end2end_test_config config)108 static void test_retry_streaming(grpc_end2end_test_config config) {
109 grpc_call* c;
110 grpc_call* s;
111 grpc_op ops[6];
112 grpc_op* op;
113 grpc_metadata_array initial_metadata_recv;
114 grpc_metadata_array trailing_metadata_recv;
115 grpc_metadata_array request_metadata_recv;
116 grpc_call_details call_details;
117 grpc_slice request_payload_slice = grpc_slice_from_static_string("foo");
118 grpc_slice request2_payload_slice = grpc_slice_from_static_string("bar");
119 grpc_slice request3_payload_slice = grpc_slice_from_static_string("baz");
120 grpc_slice response_payload_slice = grpc_slice_from_static_string("quux");
121 grpc_byte_buffer* request_payload =
122 grpc_raw_byte_buffer_create(&request_payload_slice, 1);
123 grpc_byte_buffer* request2_payload =
124 grpc_raw_byte_buffer_create(&request2_payload_slice, 1);
125 grpc_byte_buffer* request3_payload =
126 grpc_raw_byte_buffer_create(&request3_payload_slice, 1);
127 grpc_byte_buffer* response_payload =
128 grpc_raw_byte_buffer_create(&response_payload_slice, 1);
129 grpc_byte_buffer* request_payload_recv = nullptr;
130 grpc_byte_buffer* request2_payload_recv = nullptr;
131 grpc_byte_buffer* request3_payload_recv = nullptr;
132 grpc_byte_buffer* response_payload_recv = nullptr;
133 grpc_status_code status;
134 grpc_call_error error;
135 grpc_slice details;
136 int was_cancelled = 2;
137 char* peer;
138
139 grpc_arg args[] = {
140 grpc_channel_arg_integer_create(
141 const_cast<char*>(GRPC_ARG_MAX_CHANNEL_TRACE_EVENT_MEMORY_PER_NODE),
142 1024 * 8),
143 grpc_channel_arg_integer_create(
144 const_cast<char*>(GRPC_ARG_ENABLE_CHANNELZ), true),
145 grpc_channel_arg_string_create(
146 const_cast<char*>(GRPC_ARG_SERVICE_CONFIG),
147 const_cast<char*>(
148 "{\n"
149 " \"methodConfig\": [ {\n"
150 " \"name\": [\n"
151 " { \"service\": \"service\", \"method\": \"method\" }\n"
152 " ],\n"
153 " \"retryPolicy\": {\n"
154 " \"maxAttempts\": 3,\n"
155 " \"initialBackoff\": \"1s\",\n"
156 " \"maxBackoff\": \"120s\",\n"
157 " \"backoffMultiplier\": 1.6,\n"
158 " \"retryableStatusCodes\": [ \"ABORTED\" ]\n"
159 " }\n"
160 " } ]\n"
161 "}"))};
162 grpc_channel_args client_args = {GPR_ARRAY_SIZE(args), args};
163 grpc_end2end_test_fixture f =
164 begin_test(config, "retry_streaming", &client_args, nullptr);
165
166 cq_verifier* cqv = cq_verifier_create(f.cq);
167
168 gpr_timespec deadline = five_seconds_from_now();
169 c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
170 grpc_slice_from_static_string("/service/method"),
171 nullptr, deadline, nullptr);
172 grpc_core::channelz::ChannelNode* channelz_channel =
173 grpc_channel_get_channelz_node(f.client);
174
175 GPR_ASSERT(c);
176
177 peer = grpc_call_get_peer(c);
178 GPR_ASSERT(peer != nullptr);
179 gpr_log(GPR_DEBUG, "client_peer_before_call=%s", peer);
180 gpr_free(peer);
181
182 grpc_metadata_array_init(&initial_metadata_recv);
183 grpc_metadata_array_init(&trailing_metadata_recv);
184 grpc_metadata_array_init(&request_metadata_recv);
185 grpc_call_details_init(&call_details);
186 grpc_slice status_details = grpc_slice_from_static_string("xyz");
187
188 // Client starts a batch for receiving initial metadata, a message,
189 // and trailing metadata.
190 memset(ops, 0, sizeof(ops));
191 op = ops;
192 op->op = GRPC_OP_RECV_INITIAL_METADATA;
193 op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
194 op++;
195 op->op = GRPC_OP_RECV_MESSAGE;
196 op->data.recv_message.recv_message = &response_payload_recv;
197 op++;
198 op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
199 op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
200 op->data.recv_status_on_client.status = &status;
201 op->data.recv_status_on_client.status_details = &details;
202 op++;
203 error = grpc_call_start_batch(c, ops, (size_t)(op - ops), tag(1), nullptr);
204 GPR_ASSERT(GRPC_CALL_OK == error);
205
206 // Client sends initial metadata and a message.
207 memset(ops, 0, sizeof(ops));
208 op = ops;
209 op->op = GRPC_OP_SEND_INITIAL_METADATA;
210 op->data.send_initial_metadata.count = 0;
211 op++;
212 op->op = GRPC_OP_SEND_MESSAGE;
213 op->data.send_message.send_message = request_payload;
214 op++;
215 error = grpc_call_start_batch(c, ops, (size_t)(op - ops), tag(2), nullptr);
216 GPR_ASSERT(GRPC_CALL_OK == error);
217 CQ_EXPECT_COMPLETION(cqv, tag(2), true);
218 cq_verify(cqv);
219
220 // Server gets a call with received initial metadata.
221 error =
222 grpc_server_request_call(f.server, &s, &call_details,
223 &request_metadata_recv, f.cq, f.cq, tag(101));
224 GPR_ASSERT(GRPC_CALL_OK == error);
225 CQ_EXPECT_COMPLETION(cqv, tag(101), true);
226 cq_verify(cqv);
227
228 peer = grpc_call_get_peer(s);
229 GPR_ASSERT(peer != nullptr);
230 gpr_log(GPR_DEBUG, "server_peer=%s", peer);
231 gpr_free(peer);
232 peer = grpc_call_get_peer(c);
233 GPR_ASSERT(peer != nullptr);
234 gpr_log(GPR_DEBUG, "client_peer=%s", peer);
235 gpr_free(peer);
236
237 // Server receives a message.
238 memset(ops, 0, sizeof(ops));
239 op = ops;
240 op->op = GRPC_OP_RECV_MESSAGE;
241 op->data.recv_message.recv_message = &request_payload_recv;
242 op++;
243 error = grpc_call_start_batch(s, ops, (size_t)(op - ops), tag(102), nullptr);
244 GPR_ASSERT(GRPC_CALL_OK == error);
245 CQ_EXPECT_COMPLETION(cqv, tag(102), true);
246 cq_verify(cqv);
247
248 // Client sends a second message.
249 memset(ops, 0, sizeof(ops));
250 op = ops;
251 op->op = GRPC_OP_SEND_MESSAGE;
252 op->data.send_message.send_message = request2_payload;
253 op++;
254 error = grpc_call_start_batch(c, ops, (size_t)(op - ops), tag(3), nullptr);
255 GPR_ASSERT(GRPC_CALL_OK == error);
256 CQ_EXPECT_COMPLETION(cqv, tag(3), true);
257 cq_verify(cqv);
258
259 // Server receives the second message.
260 memset(ops, 0, sizeof(ops));
261 op = ops;
262 op->op = GRPC_OP_RECV_MESSAGE;
263 op->data.recv_message.recv_message = &request2_payload_recv;
264 op++;
265 error = grpc_call_start_batch(s, ops, (size_t)(op - ops), tag(103), nullptr);
266 GPR_ASSERT(GRPC_CALL_OK == error);
267 CQ_EXPECT_COMPLETION(cqv, tag(103), true);
268 cq_verify(cqv);
269
270 // Server sends both initial and trailing metadata.
271 memset(ops, 0, sizeof(ops));
272 op = ops;
273 op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
274 op->data.recv_close_on_server.cancelled = &was_cancelled;
275 op++;
276 op->op = GRPC_OP_SEND_INITIAL_METADATA;
277 op->data.send_initial_metadata.count = 0;
278 op++;
279 op->op = GRPC_OP_SEND_STATUS_FROM_SERVER;
280 op->data.send_status_from_server.trailing_metadata_count = 0;
281 op->data.send_status_from_server.status = GRPC_STATUS_ABORTED;
282 op->data.send_status_from_server.status_details = &status_details;
283 op++;
284 error = grpc_call_start_batch(s, ops, (size_t)(op - ops), tag(104), nullptr);
285 GPR_ASSERT(GRPC_CALL_OK == error);
286 CQ_EXPECT_COMPLETION(cqv, tag(104), true);
287 cq_verify(cqv);
288
289 // Clean up from first attempt.
290 grpc_call_unref(s);
291 grpc_metadata_array_destroy(&request_metadata_recv);
292 grpc_metadata_array_init(&request_metadata_recv);
293 grpc_call_details_destroy(&call_details);
294 grpc_call_details_init(&call_details);
295 GPR_ASSERT(byte_buffer_eq_slice(request_payload_recv, request_payload_slice));
296 grpc_byte_buffer_destroy(request_payload_recv);
297 request_payload_recv = nullptr;
298 GPR_ASSERT(
299 byte_buffer_eq_slice(request2_payload_recv, request2_payload_slice));
300 grpc_byte_buffer_destroy(request2_payload_recv);
301 request2_payload_recv = nullptr;
302
303 // Server gets a second call (the retry).
304 error =
305 grpc_server_request_call(f.server, &s, &call_details,
306 &request_metadata_recv, f.cq, f.cq, tag(201));
307 GPR_ASSERT(GRPC_CALL_OK == error);
308 CQ_EXPECT_COMPLETION(cqv, tag(201), true);
309 cq_verify(cqv);
310
311 peer = grpc_call_get_peer(s);
312 GPR_ASSERT(peer != nullptr);
313 gpr_log(GPR_DEBUG, "server_peer=%s", peer);
314 gpr_free(peer);
315 peer = grpc_call_get_peer(c);
316 GPR_ASSERT(peer != nullptr);
317 gpr_log(GPR_DEBUG, "client_peer=%s", peer);
318 gpr_free(peer);
319
320 // Server receives a message.
321 memset(ops, 0, sizeof(ops));
322 op = ops;
323 op->op = GRPC_OP_RECV_MESSAGE;
324 op->data.recv_message.recv_message = &request_payload_recv;
325 op++;
326 error = grpc_call_start_batch(s, ops, (size_t)(op - ops), tag(202), nullptr);
327 GPR_ASSERT(GRPC_CALL_OK == error);
328 CQ_EXPECT_COMPLETION(cqv, tag(202), true);
329 cq_verify(cqv);
330
331 // Server receives a second message.
332 memset(ops, 0, sizeof(ops));
333 op = ops;
334 op->op = GRPC_OP_RECV_MESSAGE;
335 op->data.recv_message.recv_message = &request2_payload_recv;
336 op++;
337 error = grpc_call_start_batch(s, ops, (size_t)(op - ops), tag(203), nullptr);
338 GPR_ASSERT(GRPC_CALL_OK == error);
339 CQ_EXPECT_COMPLETION(cqv, tag(203), true);
340 cq_verify(cqv);
341
342 // Client sends a third message and a close.
343 memset(ops, 0, sizeof(ops));
344 op = ops;
345 op->op = GRPC_OP_SEND_MESSAGE;
346 op->data.send_message.send_message = request3_payload;
347 op++;
348 op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
349 op++;
350 error = grpc_call_start_batch(c, ops, (size_t)(op - ops), tag(4), nullptr);
351 GPR_ASSERT(GRPC_CALL_OK == error);
352 CQ_EXPECT_COMPLETION(cqv, tag(4), true);
353 cq_verify(cqv);
354
355 // Server receives a third message.
356 memset(ops, 0, sizeof(ops));
357 op = ops;
358 op->op = GRPC_OP_RECV_MESSAGE;
359 op->data.recv_message.recv_message = &request3_payload_recv;
360 op++;
361 error = grpc_call_start_batch(s, ops, (size_t)(op - ops), tag(204), nullptr);
362 GPR_ASSERT(GRPC_CALL_OK == error);
363 CQ_EXPECT_COMPLETION(cqv, tag(204), true);
364 cq_verify(cqv);
365
366 // Server receives a close and sends initial metadata, a message, and
367 // trailing metadata.
368 memset(ops, 0, sizeof(ops));
369 op = ops;
370 op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
371 op->data.recv_close_on_server.cancelled = &was_cancelled;
372 op++;
373 op->op = GRPC_OP_SEND_INITIAL_METADATA;
374 op->data.send_initial_metadata.count = 0;
375 op++;
376 op->op = GRPC_OP_SEND_MESSAGE;
377 op->data.send_message.send_message = response_payload;
378 op++;
379 op->op = GRPC_OP_SEND_STATUS_FROM_SERVER;
380 op->data.send_status_from_server.trailing_metadata_count = 0;
381 // Returning a retriable code, but because we are also sending a
382 // message, the client will commit instead of retrying again.
383 op->data.send_status_from_server.status = GRPC_STATUS_ABORTED;
384 op->data.send_status_from_server.status_details = &status_details;
385 op++;
386 error = grpc_call_start_batch(s, ops, (size_t)(op - ops), tag(205), nullptr);
387 GPR_ASSERT(GRPC_CALL_OK == error);
388 CQ_EXPECT_COMPLETION(cqv, tag(205), true);
389 CQ_EXPECT_COMPLETION(cqv, tag(1), true);
390 cq_verify(cqv);
391
392 GPR_ASSERT(status == GRPC_STATUS_ABORTED);
393 GPR_ASSERT(0 == grpc_slice_str_cmp(details, "xyz"));
394 GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/service/method"));
395 GPR_ASSERT(0 == call_details.flags);
396 GPR_ASSERT(was_cancelled == 0);
397
398 GPR_ASSERT(channelz_channel != nullptr);
399 std::string json = channelz_channel->RenderJsonString();
400 gpr_log(GPR_INFO, "%s", json.c_str());
401 GPR_ASSERT(json.find("\"trace\"") != json.npos);
402 GPR_ASSERT(json.find("\"description\":\"Channel created\"") != json.npos);
403 GPR_ASSERT(json.find("\"severity\":\"CT_INFO\"") != json.npos);
404 GPR_ASSERT(json.find("Resolution event") != json.npos);
405 GPR_ASSERT(json.find("Created new LB policy") != json.npos);
406 GPR_ASSERT(json.find("Service config changed") != json.npos);
407 GPR_ASSERT(json.find("Address list became non-empty") != json.npos);
408 GPR_ASSERT(json.find("Channel state change to CONNECTING") != json.npos);
409
410 grpc_slice_unref(details);
411 grpc_metadata_array_destroy(&initial_metadata_recv);
412 grpc_metadata_array_destroy(&trailing_metadata_recv);
413 grpc_metadata_array_destroy(&request_metadata_recv);
414 grpc_call_details_destroy(&call_details);
415 grpc_byte_buffer_destroy(request_payload);
416 grpc_byte_buffer_destroy(request2_payload);
417 grpc_byte_buffer_destroy(request3_payload);
418 grpc_byte_buffer_destroy(response_payload);
419 GPR_ASSERT(byte_buffer_eq_slice(request_payload_recv, request_payload_slice));
420 grpc_byte_buffer_destroy(request_payload_recv);
421 GPR_ASSERT(
422 byte_buffer_eq_slice(request2_payload_recv, request2_payload_slice));
423 grpc_byte_buffer_destroy(request2_payload_recv);
424 GPR_ASSERT(
425 byte_buffer_eq_slice(request3_payload_recv, request3_payload_slice));
426 grpc_byte_buffer_destroy(request3_payload_recv);
427 grpc_byte_buffer_destroy(response_payload_recv);
428
429 grpc_call_unref(c);
430 grpc_call_unref(s);
431
432 cq_verifier_destroy(cqv);
433
434 end_test(&f);
435 config.tear_down_data(&f);
436 }
437
retry_streaming(grpc_end2end_test_config config)438 void retry_streaming(grpc_end2end_test_config config) {
439 GPR_ASSERT(config.feature_mask & FEATURE_MASK_SUPPORTS_CLIENT_CHANNEL);
440
441 test_retry_streaming(config);
442 }
443
retry_streaming_pre_init(void)444 void retry_streaming_pre_init(void) {}
445