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/channel/channel_args.h"
32 #include "src/core/lib/gpr/string.h"
33 #include "src/core/lib/gpr/useful.h"
34 #include "src/core/lib/iomgr/exec_ctx.h"
35 #include "src/core/lib/transport/static_metadata.h"
36
37 #include "test/core/end2end/cq_verifier.h"
38 #include "test/core/end2end/tests/cancel_test_helpers.h"
39
tag(intptr_t t)40 static void* tag(intptr_t t) { return (void*)t; }
41
begin_test(grpc_end2end_test_config config,const char * test_name,grpc_channel_args * client_args,grpc_channel_args * server_args)42 static grpc_end2end_test_fixture begin_test(grpc_end2end_test_config config,
43 const char* test_name,
44 grpc_channel_args* client_args,
45 grpc_channel_args* server_args) {
46 grpc_end2end_test_fixture f;
47 gpr_log(GPR_INFO, "Running test: %s/%s", test_name, config.name);
48 f = config.create_fixture(client_args, server_args);
49 config.init_server(&f, server_args);
50 config.init_client(&f, client_args);
51 return f;
52 }
53
n_seconds_from_now(int n)54 static gpr_timespec n_seconds_from_now(int n) {
55 return grpc_timeout_seconds_to_deadline(n);
56 }
57
five_seconds_from_now(void)58 static gpr_timespec five_seconds_from_now(void) {
59 return n_seconds_from_now(5);
60 }
61
drain_cq(grpc_completion_queue * cq)62 static void drain_cq(grpc_completion_queue* cq) {
63 grpc_event ev;
64 do {
65 ev = grpc_completion_queue_next(cq, five_seconds_from_now(), nullptr);
66 } while (ev.type != GRPC_QUEUE_SHUTDOWN);
67 }
68
shutdown_server(grpc_end2end_test_fixture * f)69 static void shutdown_server(grpc_end2end_test_fixture* f) {
70 if (!f->server) return;
71 grpc_server_shutdown_and_notify(f->server, f->shutdown_cq, tag(1000));
72 GPR_ASSERT(grpc_completion_queue_pluck(f->shutdown_cq, tag(1000),
73 grpc_timeout_seconds_to_deadline(5),
74 nullptr)
75 .type == GRPC_OP_COMPLETE);
76 grpc_server_destroy(f->server);
77 f->server = nullptr;
78 }
79
shutdown_client(grpc_end2end_test_fixture * f)80 static void shutdown_client(grpc_end2end_test_fixture* f) {
81 if (!f->client) return;
82 grpc_channel_destroy(f->client);
83 f->client = nullptr;
84 }
85
end_test(grpc_end2end_test_fixture * f)86 static void end_test(grpc_end2end_test_fixture* f) {
87 shutdown_server(f);
88 shutdown_client(f);
89
90 grpc_completion_queue_shutdown(f->cq);
91 drain_cq(f->cq);
92 grpc_completion_queue_destroy(f->cq);
93 grpc_completion_queue_destroy(f->shutdown_cq);
94 }
95
96 // Tests that we honor server push-back delay.
97 // - 2 retries allowed for ABORTED status
98 // - first attempt gets ABORTED with a long delay
99 // - second attempt succeeds
test_retry_server_pushback_delay(grpc_end2end_test_config config)100 static void test_retry_server_pushback_delay(grpc_end2end_test_config config) {
101 grpc_call* c;
102 grpc_call* s;
103 grpc_op ops[6];
104 grpc_op* op;
105 grpc_metadata_array initial_metadata_recv;
106 grpc_metadata_array trailing_metadata_recv;
107 grpc_metadata_array request_metadata_recv;
108 grpc_call_details call_details;
109 grpc_slice request_payload_slice = grpc_slice_from_static_string("foo");
110 grpc_slice response_payload_slice = grpc_slice_from_static_string("bar");
111 grpc_byte_buffer* request_payload =
112 grpc_raw_byte_buffer_create(&request_payload_slice, 1);
113 grpc_byte_buffer* response_payload =
114 grpc_raw_byte_buffer_create(&response_payload_slice, 1);
115 grpc_byte_buffer* request_payload_recv = nullptr;
116 grpc_byte_buffer* response_payload_recv = nullptr;
117 grpc_status_code status;
118 grpc_call_error error;
119 grpc_slice details;
120 int was_cancelled = 2;
121 char* peer;
122
123 grpc_metadata pushback_md;
124 memset(&pushback_md, 0, sizeof(pushback_md));
125 pushback_md.key = GRPC_MDSTR_GRPC_RETRY_PUSHBACK_MS;
126 pushback_md.value = grpc_slice_from_static_string("2000");
127
128 grpc_arg arg;
129 arg.type = GRPC_ARG_STRING;
130 arg.key = const_cast<char*>(GRPC_ARG_SERVICE_CONFIG);
131 arg.value.string = const_cast<char*>(
132 "{\n"
133 " \"methodConfig\": [ {\n"
134 " \"name\": [\n"
135 " { \"service\": \"service\", \"method\": \"method\" }\n"
136 " ],\n"
137 " \"retryPolicy\": {\n"
138 " \"maxAttempts\": 3,\n"
139 " \"initialBackoff\": \"1s\",\n"
140 " \"maxBackoff\": \"120s\",\n"
141 " \"backoffMultiplier\": 1.6,\n"
142 " \"retryableStatusCodes\": [ \"ABORTED\" ]\n"
143 " }\n"
144 " } ]\n"
145 "}");
146 grpc_channel_args client_args = {1, &arg};
147 grpc_end2end_test_fixture f =
148 begin_test(config, "retry_server_pushback_delay", &client_args, nullptr);
149
150 cq_verifier* cqv = cq_verifier_create(f.cq);
151
152 gpr_timespec deadline = five_seconds_from_now();
153 c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
154 grpc_slice_from_static_string("/service/method"),
155 nullptr, deadline, nullptr);
156 GPR_ASSERT(c);
157
158 peer = grpc_call_get_peer(c);
159 GPR_ASSERT(peer != nullptr);
160 gpr_log(GPR_DEBUG, "client_peer_before_call=%s", peer);
161 gpr_free(peer);
162
163 grpc_metadata_array_init(&initial_metadata_recv);
164 grpc_metadata_array_init(&trailing_metadata_recv);
165 grpc_metadata_array_init(&request_metadata_recv);
166 grpc_call_details_init(&call_details);
167 grpc_slice status_details = grpc_slice_from_static_string("xyz");
168
169 memset(ops, 0, sizeof(ops));
170 op = ops;
171 op->op = GRPC_OP_SEND_INITIAL_METADATA;
172 op->data.send_initial_metadata.count = 0;
173 op++;
174 op->op = GRPC_OP_SEND_MESSAGE;
175 op->data.send_message.send_message = request_payload;
176 op++;
177 op->op = GRPC_OP_RECV_MESSAGE;
178 op->data.recv_message.recv_message = &response_payload_recv;
179 op++;
180 op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
181 op++;
182 op->op = GRPC_OP_RECV_INITIAL_METADATA;
183 op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
184 op++;
185 op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
186 op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
187 op->data.recv_status_on_client.status = &status;
188 op->data.recv_status_on_client.status_details = &details;
189 op++;
190 error = grpc_call_start_batch(c, ops, (size_t)(op - ops), tag(1), nullptr);
191 GPR_ASSERT(GRPC_CALL_OK == error);
192
193 error =
194 grpc_server_request_call(f.server, &s, &call_details,
195 &request_metadata_recv, f.cq, f.cq, tag(101));
196 GPR_ASSERT(GRPC_CALL_OK == error);
197 CQ_EXPECT_COMPLETION(cqv, tag(101), true);
198 cq_verify(cqv);
199
200 peer = grpc_call_get_peer(s);
201 GPR_ASSERT(peer != nullptr);
202 gpr_log(GPR_DEBUG, "server_peer=%s", peer);
203 gpr_free(peer);
204 peer = grpc_call_get_peer(c);
205 GPR_ASSERT(peer != nullptr);
206 gpr_log(GPR_DEBUG, "client_peer=%s", peer);
207 gpr_free(peer);
208
209 memset(ops, 0, sizeof(ops));
210 op = ops;
211 op->op = GRPC_OP_SEND_INITIAL_METADATA;
212 op->data.send_initial_metadata.count = 0;
213 op++;
214 op->op = GRPC_OP_SEND_STATUS_FROM_SERVER;
215 op->data.send_status_from_server.trailing_metadata_count = 1;
216 op->data.send_status_from_server.trailing_metadata = &pushback_md;
217 op->data.send_status_from_server.status = GRPC_STATUS_ABORTED;
218 op->data.send_status_from_server.status_details = &status_details;
219 op++;
220 op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
221 op->data.recv_close_on_server.cancelled = &was_cancelled;
222 op++;
223 error = grpc_call_start_batch(s, ops, (size_t)(op - ops), tag(102), nullptr);
224 GPR_ASSERT(GRPC_CALL_OK == error);
225
226 CQ_EXPECT_COMPLETION(cqv, tag(102), true);
227 cq_verify(cqv);
228
229 gpr_timespec before_retry = gpr_now(GPR_CLOCK_MONOTONIC);
230
231 grpc_call_unref(s);
232 grpc_metadata_array_destroy(&request_metadata_recv);
233 grpc_metadata_array_init(&request_metadata_recv);
234 grpc_call_details_destroy(&call_details);
235 grpc_call_details_init(&call_details);
236
237 error =
238 grpc_server_request_call(f.server, &s, &call_details,
239 &request_metadata_recv, f.cq, f.cq, tag(201));
240 GPR_ASSERT(GRPC_CALL_OK == error);
241 CQ_EXPECT_COMPLETION(cqv, tag(201), true);
242 cq_verify(cqv);
243
244 gpr_timespec after_retry = gpr_now(GPR_CLOCK_MONOTONIC);
245 gpr_timespec retry_delay = gpr_time_sub(after_retry, before_retry);
246 // Configured back-off was 1 second, server push-back said 2 seconds.
247 // To avoid flakiness, we allow some fudge factor here.
248 gpr_log(GPR_INFO, "retry delay was {.tv_sec=%" PRId64 ", .tv_nsec=%d}",
249 retry_delay.tv_sec, retry_delay.tv_nsec);
250 GPR_ASSERT(retry_delay.tv_sec >= 1);
251 if (retry_delay.tv_sec == 1) {
252 GPR_ASSERT(retry_delay.tv_nsec >= 800000000);
253 }
254
255 peer = grpc_call_get_peer(s);
256 GPR_ASSERT(peer != nullptr);
257 gpr_log(GPR_DEBUG, "server_peer=%s", peer);
258 gpr_free(peer);
259 peer = grpc_call_get_peer(c);
260 GPR_ASSERT(peer != nullptr);
261 gpr_log(GPR_DEBUG, "client_peer=%s", peer);
262 gpr_free(peer);
263
264 memset(ops, 0, sizeof(ops));
265 op = ops;
266 op->op = GRPC_OP_SEND_INITIAL_METADATA;
267 op->data.send_initial_metadata.count = 0;
268 op++;
269 op->op = GRPC_OP_SEND_STATUS_FROM_SERVER;
270 op->data.send_status_from_server.trailing_metadata_count = 0;
271 op->data.send_status_from_server.status = GRPC_STATUS_OK;
272 op->data.send_status_from_server.status_details = &status_details;
273 op++;
274 op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
275 op->data.recv_close_on_server.cancelled = &was_cancelled;
276 op++;
277 error = grpc_call_start_batch(s, ops, (size_t)(op - ops), tag(202), nullptr);
278 GPR_ASSERT(GRPC_CALL_OK == error);
279
280 CQ_EXPECT_COMPLETION(cqv, tag(202), true);
281 CQ_EXPECT_COMPLETION(cqv, tag(1), true);
282 cq_verify(cqv);
283
284 GPR_ASSERT(status == GRPC_STATUS_OK);
285 GPR_ASSERT(0 == grpc_slice_str_cmp(details, "xyz"));
286 GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/service/method"));
287 GPR_ASSERT(0 == call_details.flags);
288 GPR_ASSERT(was_cancelled == 0);
289
290 grpc_slice_unref(details);
291 grpc_metadata_array_destroy(&initial_metadata_recv);
292 grpc_metadata_array_destroy(&trailing_metadata_recv);
293 grpc_metadata_array_destroy(&request_metadata_recv);
294 grpc_call_details_destroy(&call_details);
295 grpc_byte_buffer_destroy(request_payload);
296 grpc_byte_buffer_destroy(response_payload);
297 grpc_byte_buffer_destroy(request_payload_recv);
298 grpc_byte_buffer_destroy(response_payload_recv);
299
300 grpc_call_unref(c);
301 grpc_call_unref(s);
302
303 cq_verifier_destroy(cqv);
304
305 end_test(&f);
306 config.tear_down_data(&f);
307 }
308
retry_server_pushback_delay(grpc_end2end_test_config config)309 void retry_server_pushback_delay(grpc_end2end_test_config config) {
310 GPR_ASSERT(config.feature_mask & FEATURE_MASK_SUPPORTS_CLIENT_CHANNEL);
311 test_retry_server_pushback_delay(config);
312 }
313
retry_server_pushback_delay_pre_init(void)314 void retry_server_pushback_delay_pre_init(void) {}
315