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 don't make any further attempts after we exceed the
97 // max buffer size.
98 // - 1 retry allowed for ABORTED status
99 // - buffer size set to 2 bytes
100 // - client sends a 3-byte message
101 // - first attempt gets ABORTED but is not retried
test_retry_exceeds_buffer_size_in_initial_batch(grpc_end2end_test_config config)102 static void test_retry_exceeds_buffer_size_in_initial_batch(
103 grpc_end2end_test_config config) {
104 grpc_call* c;
105 grpc_call* s;
106 grpc_op ops[6];
107 grpc_op* op;
108 grpc_metadata_array initial_metadata_recv;
109 grpc_metadata_array trailing_metadata_recv;
110 grpc_metadata_array request_metadata_recv;
111 grpc_call_details call_details;
112 grpc_slice request_payload_slice = grpc_slice_from_static_string("foo");
113 grpc_slice response_payload_slice = grpc_slice_from_static_string("bar");
114 grpc_byte_buffer* request_payload =
115 grpc_raw_byte_buffer_create(&request_payload_slice, 1);
116 grpc_byte_buffer* response_payload =
117 grpc_raw_byte_buffer_create(&response_payload_slice, 1);
118 grpc_byte_buffer* request_payload_recv = nullptr;
119 grpc_byte_buffer* response_payload_recv = nullptr;
120 grpc_status_code status;
121 grpc_call_error error;
122 grpc_slice details;
123 int was_cancelled = 2;
124 char* peer;
125
126 grpc_arg args[2];
127 args[0].type = GRPC_ARG_STRING;
128 args[0].key = const_cast<char*>(GRPC_ARG_SERVICE_CONFIG);
129 args[0].value.string = const_cast<char*>(
130 "{\n"
131 " \"methodConfig\": [ {\n"
132 " \"name\": [\n"
133 " { \"service\": \"service\", \"method\": \"method\" }\n"
134 " ],\n"
135 " \"retryPolicy\": {\n"
136 " \"maxAttempts\": 2,\n"
137 " \"initialBackoff\": \"1s\",\n"
138 " \"maxBackoff\": \"120s\",\n"
139 " \"backoffMultiplier\": 1.6,\n"
140 " \"retryableStatusCodes\": [ \"ABORTED\" ]\n"
141 " }\n"
142 " } ]\n"
143 "}");
144 args[1].type = GRPC_ARG_INTEGER;
145 args[1].key = const_cast<char*>(GRPC_ARG_PER_RPC_RETRY_BUFFER_SIZE);
146 args[1].value.integer = 2;
147 grpc_channel_args client_args = {GPR_ARRAY_SIZE(args), args};
148 grpc_end2end_test_fixture f =
149 begin_test(config, "retry_exceeds_buffer_size_in_initial_batch",
150 &client_args, nullptr);
151
152 cq_verifier* cqv = cq_verifier_create(f.cq);
153
154 gpr_timespec deadline = five_seconds_from_now();
155 c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
156 grpc_slice_from_static_string("/service/method"),
157 nullptr, deadline, nullptr);
158 GPR_ASSERT(c);
159
160 peer = grpc_call_get_peer(c);
161 GPR_ASSERT(peer != nullptr);
162 gpr_log(GPR_DEBUG, "client_peer_before_call=%s", peer);
163 gpr_free(peer);
164
165 grpc_metadata_array_init(&initial_metadata_recv);
166 grpc_metadata_array_init(&trailing_metadata_recv);
167 grpc_metadata_array_init(&request_metadata_recv);
168 grpc_call_details_init(&call_details);
169 grpc_slice status_details = grpc_slice_from_static_string("xyz");
170
171 memset(ops, 0, sizeof(ops));
172 op = ops;
173 op->op = GRPC_OP_SEND_INITIAL_METADATA;
174 op->data.send_initial_metadata.count = 0;
175 op++;
176 op->op = GRPC_OP_SEND_MESSAGE;
177 op->data.send_message.send_message = request_payload;
178 op++;
179 op->op = GRPC_OP_RECV_MESSAGE;
180 op->data.recv_message.recv_message = &response_payload_recv;
181 op++;
182 op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
183 op++;
184 op->op = GRPC_OP_RECV_INITIAL_METADATA;
185 op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
186 op++;
187 op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
188 op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
189 op->data.recv_status_on_client.status = &status;
190 op->data.recv_status_on_client.status_details = &details;
191 op++;
192 error = grpc_call_start_batch(c, ops, (size_t)(op - ops), tag(1), nullptr);
193 GPR_ASSERT(GRPC_CALL_OK == error);
194
195 error =
196 grpc_server_request_call(f.server, &s, &call_details,
197 &request_metadata_recv, f.cq, f.cq, tag(101));
198 GPR_ASSERT(GRPC_CALL_OK == error);
199 CQ_EXPECT_COMPLETION(cqv, tag(101), true);
200 cq_verify(cqv);
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, (size_t)(op - ops), tag(102), 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 == 1);
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_exceeds_buffer_size_in_initial_batch(grpc_end2end_test_config config)256 void retry_exceeds_buffer_size_in_initial_batch(
257 grpc_end2end_test_config config) {
258 GPR_ASSERT(config.feature_mask & FEATURE_MASK_SUPPORTS_CLIENT_CHANNEL);
259 test_retry_exceeds_buffer_size_in_initial_batch(config);
260 }
261
retry_exceeds_buffer_size_in_initial_batch_pre_init(void)262 void retry_exceeds_buffer_size_in_initial_batch_pre_init(void) {}
263