• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 receiving initial metadata commits the call.
97 // - 1 retry allowed for ABORTED status
98 // - first attempt receives initial metadata before trailing metadata,
99 //   so no retry is done even though status was ABORTED
test_retry_recv_initial_metadata(grpc_end2end_test_config config)100 static void test_retry_recv_initial_metadata(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_arg arg;
124   arg.type = GRPC_ARG_STRING;
125   arg.key = const_cast<char*>(GRPC_ARG_SERVICE_CONFIG);
126   arg.value.string = const_cast<char*>(
127       "{\n"
128       "  \"methodConfig\": [ {\n"
129       "    \"name\": [\n"
130       "      { \"service\": \"service\", \"method\": \"method\" }\n"
131       "    ],\n"
132       "    \"retryPolicy\": {\n"
133       "      \"maxAttempts\": 2,\n"
134       "      \"initialBackoff\": \"1s\",\n"
135       "      \"maxBackoff\": \"120s\",\n"
136       "      \"backoffMultiplier\": 1.6,\n"
137       "      \"retryableStatusCodes\": [ \"ABORTED\" ]\n"
138       "    }\n"
139       "  } ]\n"
140       "}");
141   grpc_channel_args client_args = {1, &arg};
142   grpc_end2end_test_fixture f =
143       begin_test(config, "retry_recv_initial_metadata", &client_args, nullptr);
144 
145   cq_verifier* cqv = cq_verifier_create(f.cq);
146 
147   gpr_timespec deadline = five_seconds_from_now();
148   c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
149                                grpc_slice_from_static_string("/service/method"),
150                                nullptr, deadline, nullptr);
151   GPR_ASSERT(c);
152 
153   peer = grpc_call_get_peer(c);
154   GPR_ASSERT(peer != nullptr);
155   gpr_log(GPR_DEBUG, "client_peer_before_call=%s", peer);
156   gpr_free(peer);
157 
158   grpc_metadata_array_init(&initial_metadata_recv);
159   grpc_metadata_array_init(&trailing_metadata_recv);
160   grpc_metadata_array_init(&request_metadata_recv);
161   grpc_call_details_init(&call_details);
162   grpc_slice status_details = grpc_slice_from_static_string("xyz");
163 
164   memset(ops, 0, sizeof(ops));
165   op = ops;
166   op->op = GRPC_OP_SEND_INITIAL_METADATA;
167   op->data.send_initial_metadata.count = 0;
168   op++;
169   op->op = GRPC_OP_SEND_MESSAGE;
170   op->data.send_message.send_message = request_payload;
171   op++;
172   op->op = GRPC_OP_RECV_MESSAGE;
173   op->data.recv_message.recv_message = &response_payload_recv;
174   op++;
175   op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
176   op++;
177   op->op = GRPC_OP_RECV_INITIAL_METADATA;
178   op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
179   op++;
180   op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
181   op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
182   op->data.recv_status_on_client.status = &status;
183   op->data.recv_status_on_client.status_details = &details;
184   op++;
185   error = grpc_call_start_batch(c, ops, (size_t)(op - ops), tag(1), 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   peer = grpc_call_get_peer(s);
196   GPR_ASSERT(peer != nullptr);
197   gpr_log(GPR_DEBUG, "server_peer=%s", peer);
198   gpr_free(peer);
199   peer = grpc_call_get_peer(c);
200   GPR_ASSERT(peer != nullptr);
201   gpr_log(GPR_DEBUG, "client_peer=%s", peer);
202   gpr_free(peer);
203 
204   // Server sends initial metadata in its own batch, before sending
205   // trailing metadata.
206   memset(ops, 0, sizeof(ops));
207   op = ops;
208   op->op = GRPC_OP_SEND_INITIAL_METADATA;
209   op->data.send_initial_metadata.count = 0;
210   op++;
211   error = grpc_call_start_batch(s, ops, (size_t)(op - ops), tag(102), nullptr);
212   GPR_ASSERT(GRPC_CALL_OK == error);
213 
214   CQ_EXPECT_COMPLETION(cqv, tag(102), true);
215   cq_verify(cqv);
216 
217   memset(ops, 0, sizeof(ops));
218   op = ops;
219   op->op = GRPC_OP_SEND_STATUS_FROM_SERVER;
220   op->data.send_status_from_server.trailing_metadata_count = 0;
221   op->data.send_status_from_server.status = GRPC_STATUS_ABORTED;
222   op->data.send_status_from_server.status_details = &status_details;
223   op++;
224   op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
225   op->data.recv_close_on_server.cancelled = &was_cancelled;
226   op++;
227   error = grpc_call_start_batch(s, ops, (size_t)(op - ops), tag(103), nullptr);
228   GPR_ASSERT(GRPC_CALL_OK == error);
229 
230   CQ_EXPECT_COMPLETION(cqv, tag(103), true);
231   CQ_EXPECT_COMPLETION(cqv, tag(1), true);
232   cq_verify(cqv);
233 
234   GPR_ASSERT(status == GRPC_STATUS_ABORTED);
235   GPR_ASSERT(0 == grpc_slice_str_cmp(details, "xyz"));
236   GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/service/method"));
237   GPR_ASSERT(0 == call_details.flags);
238   GPR_ASSERT(was_cancelled == 1);
239 
240   grpc_slice_unref(details);
241   grpc_metadata_array_destroy(&initial_metadata_recv);
242   grpc_metadata_array_destroy(&trailing_metadata_recv);
243   grpc_metadata_array_destroy(&request_metadata_recv);
244   grpc_call_details_destroy(&call_details);
245   grpc_byte_buffer_destroy(request_payload);
246   grpc_byte_buffer_destroy(response_payload);
247   grpc_byte_buffer_destroy(request_payload_recv);
248   grpc_byte_buffer_destroy(response_payload_recv);
249 
250   grpc_call_unref(c);
251   grpc_call_unref(s);
252 
253   cq_verifier_destroy(cqv);
254 
255   end_test(&f);
256   config.tear_down_data(&f);
257 }
258 
retry_recv_initial_metadata(grpc_end2end_test_config config)259 void retry_recv_initial_metadata(grpc_end2end_test_config config) {
260   GPR_ASSERT(config.feature_mask & FEATURE_MASK_SUPPORTS_CLIENT_CHANNEL);
261   test_retry_recv_initial_metadata(config);
262 }
263 
retry_recv_initial_metadata_pre_init(void)264 void retry_recv_initial_metadata_pre_init(void) {}
265