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