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 that we don't retry when throttled.
95 // - 1 retry allowed for ABORTED status
96 // - first attempt gets ABORTED but is over limit, so no retry is done
test_retry_throttled(grpc_end2end_test_config config)97 static void test_retry_throttled(grpc_end2end_test_config config) {
98 grpc_call* c;
99 grpc_call* s;
100 grpc_op ops[6];
101 grpc_op* op;
102 grpc_metadata_array initial_metadata_recv;
103 grpc_metadata_array trailing_metadata_recv;
104 grpc_metadata_array request_metadata_recv;
105 grpc_call_details call_details;
106 grpc_slice request_payload_slice = grpc_slice_from_static_string("foo");
107 grpc_slice response_payload_slice = grpc_slice_from_static_string("bar");
108 grpc_byte_buffer* request_payload =
109 grpc_raw_byte_buffer_create(&request_payload_slice, 1);
110 grpc_byte_buffer* response_payload =
111 grpc_raw_byte_buffer_create(&response_payload_slice, 1);
112 grpc_byte_buffer* request_payload_recv = nullptr;
113 grpc_byte_buffer* response_payload_recv = nullptr;
114 grpc_status_code status;
115 grpc_call_error error;
116 grpc_slice details;
117 int was_cancelled = 2;
118 char* peer;
119
120 grpc_arg args[] = {
121 grpc_channel_arg_string_create(
122 const_cast<char*>(GRPC_ARG_SERVICE_CONFIG),
123 const_cast<char*>(
124 "{\n"
125 " \"methodConfig\": [ {\n"
126 " \"name\": [\n"
127 " { \"service\": \"service\", \"method\": \"method\" }\n"
128 " ],\n"
129 " \"retryPolicy\": {\n"
130 " \"maxAttempts\": 2,\n"
131 " \"initialBackoff\": \"1s\",\n"
132 " \"maxBackoff\": \"120s\",\n"
133 " \"backoffMultiplier\": 1.6,\n"
134 " \"retryableStatusCodes\": [ \"ABORTED\" ]\n"
135 " }\n"
136 " } ],\n"
137 // A single failure will cause us to be throttled.
138 // (This is not a very realistic config, but it works for the
139 // purposes of this test.)
140 " \"retryThrottling\": {\n"
141 " \"maxTokens\": 2,\n"
142 " \"tokenRatio\": 1.0\n"
143 " }\n"
144 "}")),
145 };
146 grpc_channel_args client_args = {GPR_ARRAY_SIZE(args), args};
147 grpc_end2end_test_fixture f =
148 begin_test(config, "retry_throttled", &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, static_cast<size_t>(op - ops), tag(1),
191 nullptr);
192 GPR_ASSERT(GRPC_CALL_OK == error);
193
194 error =
195 grpc_server_request_call(f.server, &s, &call_details,
196 &request_metadata_recv, f.cq, f.cq, tag(101));
197 GPR_ASSERT(GRPC_CALL_OK == error);
198 CQ_EXPECT_COMPLETION(cqv, tag(101), true);
199 cq_verify(cqv);
200
201 peer = grpc_call_get_peer(s);
202 GPR_ASSERT(peer != nullptr);
203 gpr_log(GPR_DEBUG, "server_peer=%s", peer);
204 gpr_free(peer);
205 peer = grpc_call_get_peer(c);
206 GPR_ASSERT(peer != nullptr);
207 gpr_log(GPR_DEBUG, "client_peer=%s", peer);
208 gpr_free(peer);
209
210 memset(ops, 0, sizeof(ops));
211 op = ops;
212 op->op = GRPC_OP_SEND_INITIAL_METADATA;
213 op->data.send_initial_metadata.count = 0;
214 op++;
215 op->op = GRPC_OP_SEND_STATUS_FROM_SERVER;
216 op->data.send_status_from_server.trailing_metadata_count = 0;
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, static_cast<size_t>(op - ops), tag(102),
224 nullptr);
225 GPR_ASSERT(GRPC_CALL_OK == error);
226
227 CQ_EXPECT_COMPLETION(cqv, tag(102), true);
228 CQ_EXPECT_COMPLETION(cqv, tag(1), true);
229 cq_verify(cqv);
230
231 GPR_ASSERT(status == GRPC_STATUS_ABORTED);
232 GPR_ASSERT(0 == grpc_slice_str_cmp(details, "xyz"));
233 GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/service/method"));
234 GPR_ASSERT(0 == call_details.flags);
235 GPR_ASSERT(was_cancelled == 0);
236
237 grpc_slice_unref(details);
238 grpc_metadata_array_destroy(&initial_metadata_recv);
239 grpc_metadata_array_destroy(&trailing_metadata_recv);
240 grpc_metadata_array_destroy(&request_metadata_recv);
241 grpc_call_details_destroy(&call_details);
242 grpc_byte_buffer_destroy(request_payload);
243 grpc_byte_buffer_destroy(response_payload);
244 grpc_byte_buffer_destroy(request_payload_recv);
245 grpc_byte_buffer_destroy(response_payload_recv);
246
247 grpc_call_unref(c);
248 grpc_call_unref(s);
249
250 cq_verifier_destroy(cqv);
251
252 end_test(&f);
253 config.tear_down_data(&f);
254 }
255
retry_throttled(grpc_end2end_test_config config)256 void retry_throttled(grpc_end2end_test_config config) {
257 GPR_ASSERT(config.feature_mask & FEATURE_MASK_SUPPORTS_CLIENT_CHANNEL);
258 test_retry_throttled(config);
259 }
260
retry_throttled_pre_init(void)261 void retry_throttled_pre_init(void) {}
262