1 /*
2 *
3 * Copyright 2015 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/support/alloc.h>
24 #include <grpc/support/log.h>
25 #include <grpc/support/time.h>
26
27 #include "src/core/lib/gpr/useful.h"
28 #include "test/core/end2end/cq_verifier.h"
29 #include "test/core/end2end/end2end_tests.h"
30 #include "test/core/end2end/tests/cancel_test_helpers.h"
31
tag(intptr_t t)32 static void* tag(intptr_t t) { return reinterpret_cast<void*>(t); }
33
begin_test(grpc_end2end_test_config config,const char * test_name,cancellation_mode mode,grpc_channel_args * client_args,grpc_channel_args * server_args)34 static grpc_end2end_test_fixture begin_test(grpc_end2end_test_config config,
35 const char* test_name,
36 cancellation_mode mode,
37 grpc_channel_args* client_args,
38 grpc_channel_args* server_args) {
39 grpc_end2end_test_fixture f;
40 gpr_log(GPR_INFO, "Running test: %s/%s/%s", test_name, config.name,
41 mode.name);
42 f = config.create_fixture(client_args, server_args);
43 config.init_server(&f, server_args);
44 config.init_client(&f, client_args);
45 return f;
46 }
47
n_seconds_from_now(int n)48 static gpr_timespec n_seconds_from_now(int n) {
49 return grpc_timeout_seconds_to_deadline(n);
50 }
51
five_seconds_from_now(void)52 static gpr_timespec five_seconds_from_now(void) {
53 return n_seconds_from_now(5);
54 }
55
drain_cq(grpc_completion_queue * cq)56 static void drain_cq(grpc_completion_queue* cq) {
57 grpc_event ev;
58 do {
59 ev = grpc_completion_queue_next(cq, five_seconds_from_now(), nullptr);
60 } while (ev.type != GRPC_QUEUE_SHUTDOWN);
61 }
62
shutdown_server(grpc_end2end_test_fixture * f)63 static void shutdown_server(grpc_end2end_test_fixture* f) {
64 if (!f->server) return;
65 grpc_server_shutdown_and_notify(f->server, f->shutdown_cq, tag(1000));
66 GPR_ASSERT(grpc_completion_queue_pluck(f->shutdown_cq, tag(1000),
67 grpc_timeout_seconds_to_deadline(5),
68 nullptr)
69 .type == GRPC_OP_COMPLETE);
70 grpc_server_destroy(f->server);
71 f->server = nullptr;
72 }
73
shutdown_client(grpc_end2end_test_fixture * f)74 static void shutdown_client(grpc_end2end_test_fixture* f) {
75 if (!f->client) return;
76 grpc_channel_destroy(f->client);
77 f->client = nullptr;
78 }
79
end_test(grpc_end2end_test_fixture * f)80 static void end_test(grpc_end2end_test_fixture* f) {
81 shutdown_server(f);
82 shutdown_client(f);
83
84 grpc_completion_queue_shutdown(f->cq);
85 drain_cq(f->cq);
86 grpc_completion_queue_destroy(f->cq);
87 grpc_completion_queue_destroy(f->shutdown_cq);
88 }
89
90 /* Cancel after accept with a writes closed, no payload */
test_cancel_after_accept_and_writes_closed(grpc_end2end_test_config config,cancellation_mode mode)91 static void test_cancel_after_accept_and_writes_closed(
92 grpc_end2end_test_config config, cancellation_mode mode) {
93 grpc_op ops[6];
94 grpc_op* op;
95 grpc_call* c;
96 grpc_call* s;
97 grpc_end2end_test_fixture f =
98 begin_test(config, "test_cancel_after_accept_and_writes_closed", mode,
99 nullptr, nullptr);
100 cq_verifier* cqv = cq_verifier_create(f.cq);
101 grpc_metadata_array initial_metadata_recv;
102 grpc_metadata_array trailing_metadata_recv;
103 grpc_metadata_array request_metadata_recv;
104 grpc_call_details call_details;
105 grpc_status_code status;
106 grpc_call_error error;
107 grpc_slice details;
108 grpc_byte_buffer* request_payload_recv = nullptr;
109 grpc_byte_buffer* response_payload_recv = nullptr;
110 grpc_slice request_payload_slice =
111 grpc_slice_from_copied_string("hello world");
112 grpc_slice response_payload_slice =
113 grpc_slice_from_copied_string("hello you");
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 int was_cancelled = 2;
119
120 gpr_timespec deadline = five_seconds_from_now();
121 c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
122 grpc_slice_from_static_string("/foo"), nullptr,
123 deadline, nullptr);
124 GPR_ASSERT(c);
125
126 grpc_metadata_array_init(&initial_metadata_recv);
127 grpc_metadata_array_init(&trailing_metadata_recv);
128 grpc_metadata_array_init(&request_metadata_recv);
129 grpc_call_details_init(&call_details);
130
131 memset(ops, 0, sizeof(ops));
132 op = ops;
133 op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
134 op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
135 op->data.recv_status_on_client.status = &status;
136 op->data.recv_status_on_client.status_details = &details;
137 op->flags = 0;
138 op->reserved = nullptr;
139 op++;
140 op->op = GRPC_OP_SEND_INITIAL_METADATA;
141 op->data.send_initial_metadata.count = 0;
142 op->flags = 0;
143 op->reserved = nullptr;
144 op++;
145 op->op = GRPC_OP_SEND_MESSAGE;
146 op->data.send_message.send_message = request_payload;
147 op->flags = 0;
148 op->reserved = nullptr;
149 op++;
150 op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
151 op->flags = 0;
152 op->reserved = nullptr;
153 op++;
154 op->op = GRPC_OP_RECV_INITIAL_METADATA;
155 op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
156 op->flags = 0;
157 op->reserved = nullptr;
158 op++;
159 op->op = GRPC_OP_RECV_MESSAGE;
160 op->data.recv_message.recv_message = &response_payload_recv;
161 op->flags = 0;
162 op->reserved = nullptr;
163 op++;
164 error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(1),
165 nullptr);
166 GPR_ASSERT(GRPC_CALL_OK == error);
167
168 error = grpc_server_request_call(f.server, &s, &call_details,
169 &request_metadata_recv, f.cq, f.cq, tag(2));
170 GPR_ASSERT(GRPC_CALL_OK == error);
171 CQ_EXPECT_COMPLETION(cqv, tag(2), 1);
172 cq_verify(cqv);
173
174 memset(ops, 0, sizeof(ops));
175 op = ops;
176 op->op = GRPC_OP_RECV_MESSAGE;
177 op->data.recv_message.recv_message = &request_payload_recv;
178 op->flags = 0;
179 op->reserved = nullptr;
180 op++;
181 op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
182 op->data.recv_close_on_server.cancelled = &was_cancelled;
183 op->flags = 0;
184 op->reserved = nullptr;
185 op++;
186 op->op = GRPC_OP_SEND_INITIAL_METADATA;
187 op->data.send_initial_metadata.count = 0;
188 op->flags = 0;
189 op->reserved = nullptr;
190 op++;
191 op->op = GRPC_OP_SEND_MESSAGE;
192 op->data.send_message.send_message = response_payload;
193 op->flags = 0;
194 op->reserved = nullptr;
195 op++;
196 error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(3),
197 nullptr);
198 GPR_ASSERT(GRPC_CALL_OK == error);
199
200 GPR_ASSERT(GRPC_CALL_OK == mode.initiate_cancel(c, nullptr));
201
202 CQ_EXPECT_COMPLETION(cqv, tag(3), 1);
203 CQ_EXPECT_COMPLETION(cqv, tag(1), 1);
204 cq_verify(cqv);
205
206 GPR_ASSERT(status == mode.expect_status || status == GRPC_STATUS_INTERNAL);
207 GPR_ASSERT(was_cancelled == 1);
208
209 grpc_metadata_array_destroy(&initial_metadata_recv);
210 grpc_metadata_array_destroy(&trailing_metadata_recv);
211 grpc_metadata_array_destroy(&request_metadata_recv);
212 grpc_call_details_destroy(&call_details);
213
214 grpc_byte_buffer_destroy(request_payload);
215 grpc_byte_buffer_destroy(response_payload);
216 grpc_byte_buffer_destroy(request_payload_recv);
217 grpc_byte_buffer_destroy(response_payload_recv);
218 grpc_slice_unref(details);
219
220 grpc_call_unref(c);
221 grpc_call_unref(s);
222
223 cq_verifier_destroy(cqv);
224 end_test(&f);
225 config.tear_down_data(&f);
226 }
227
cancel_after_client_done(grpc_end2end_test_config config)228 void cancel_after_client_done(grpc_end2end_test_config config) {
229 unsigned i;
230
231 for (i = 0; i < GPR_ARRAY_SIZE(cancellation_modes); i++) {
232 test_cancel_after_accept_and_writes_closed(config, cancellation_modes[i]);
233 }
234 }
235
cancel_after_client_done_pre_init(void)236 void cancel_after_client_done_pre_init(void) {}
237