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 "test/core/end2end/cq_verifier.h"
28 #include "test/core/end2end/end2end_tests.h"
29
tag(intptr_t t)30 static void* tag(intptr_t t) { return reinterpret_cast<void*>(t); }
31
begin_test(grpc_end2end_test_config config,const char * test_name,grpc_channel_args * client_args,grpc_channel_args * server_args)32 static grpc_end2end_test_fixture begin_test(grpc_end2end_test_config config,
33 const char* test_name,
34 grpc_channel_args* client_args,
35 grpc_channel_args* server_args) {
36 grpc_end2end_test_fixture f;
37 gpr_log(GPR_INFO, "Running test: %s/%s", test_name, config.name);
38 f = config.create_fixture(client_args, server_args);
39 config.init_server(&f, server_args);
40 config.init_client(&f, client_args);
41 return f;
42 }
43
n_seconds_from_now(int n)44 static gpr_timespec n_seconds_from_now(int n) {
45 return grpc_timeout_seconds_to_deadline(n);
46 }
47
five_seconds_from_now(void)48 static gpr_timespec five_seconds_from_now(void) {
49 return n_seconds_from_now(5);
50 }
51
drain_cq(grpc_completion_queue * cq)52 static void drain_cq(grpc_completion_queue* cq) {
53 grpc_event ev;
54 do {
55 ev = grpc_completion_queue_next(cq, five_seconds_from_now(), nullptr);
56 } while (ev.type != GRPC_QUEUE_SHUTDOWN);
57 }
58
shutdown_server(grpc_end2end_test_fixture * f)59 static void shutdown_server(grpc_end2end_test_fixture* f) {
60 if (!f->server) return;
61 grpc_server_destroy(f->server);
62 f->server = nullptr;
63 }
64
shutdown_client(grpc_end2end_test_fixture * f)65 static void shutdown_client(grpc_end2end_test_fixture* f) {
66 if (!f->client) return;
67 grpc_channel_destroy(f->client);
68 f->client = nullptr;
69 }
70
end_test(grpc_end2end_test_fixture * f)71 static void end_test(grpc_end2end_test_fixture* f) {
72 shutdown_server(f);
73 shutdown_client(f);
74
75 grpc_completion_queue_shutdown(f->cq);
76 drain_cq(f->cq);
77 grpc_completion_queue_destroy(f->cq);
78 /* Note: shutdown_cq is not used in this test */
79 grpc_completion_queue_destroy(f->shutdown_cq);
80 }
81
test_early_server_shutdown_finishes_inflight_calls(grpc_end2end_test_config config)82 static void test_early_server_shutdown_finishes_inflight_calls(
83 grpc_end2end_test_config config) {
84 grpc_call* c;
85 grpc_call* s;
86 grpc_end2end_test_fixture f =
87 begin_test(config, "test_early_server_shutdown_finishes_inflight_calls",
88 nullptr, nullptr);
89 cq_verifier* cqv = cq_verifier_create(f.cq);
90 grpc_op ops[6];
91 grpc_op* op;
92 grpc_metadata_array initial_metadata_recv;
93 grpc_metadata_array trailing_metadata_recv;
94 grpc_metadata_array request_metadata_recv;
95 grpc_call_details call_details;
96 grpc_status_code status;
97 grpc_call_error error;
98 grpc_slice details;
99 int was_cancelled = 2;
100
101 gpr_timespec deadline = n_seconds_from_now(10);
102 c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
103 grpc_slice_from_static_string("/foo"), nullptr,
104 deadline, nullptr);
105 GPR_ASSERT(c);
106
107 grpc_metadata_array_init(&initial_metadata_recv);
108 grpc_metadata_array_init(&trailing_metadata_recv);
109 grpc_metadata_array_init(&request_metadata_recv);
110 grpc_call_details_init(&call_details);
111
112 memset(ops, 0, sizeof(ops));
113 op = ops;
114 op->op = GRPC_OP_SEND_INITIAL_METADATA;
115 op->data.send_initial_metadata.count = 0;
116 op->data.send_initial_metadata.metadata = nullptr;
117 op->flags = 0;
118 op->reserved = nullptr;
119 op++;
120 op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
121 op->flags = 0;
122 op->reserved = nullptr;
123 op++;
124 op->op = GRPC_OP_RECV_INITIAL_METADATA;
125 op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
126 op->flags = 0;
127 op->reserved = nullptr;
128 op++;
129 op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
130 op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
131 op->data.recv_status_on_client.status = &status;
132 op->data.recv_status_on_client.status_details = &details;
133 op->flags = 0;
134 op->reserved = nullptr;
135 op++;
136 error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(1),
137 nullptr);
138 GPR_ASSERT(GRPC_CALL_OK == error);
139
140 error =
141 grpc_server_request_call(f.server, &s, &call_details,
142 &request_metadata_recv, f.cq, f.cq, tag(101));
143 GPR_ASSERT(GRPC_CALL_OK == error);
144 CQ_EXPECT_COMPLETION(cqv, tag(101), 1);
145 cq_verify(cqv);
146
147 /* shutdown and destroy the server */
148 grpc_server_shutdown_and_notify(f.server, f.cq, tag(0xdead));
149 cq_verify_empty(cqv);
150
151 memset(ops, 0, sizeof(ops));
152 op = ops;
153 op->op = GRPC_OP_SEND_INITIAL_METADATA;
154 op->data.send_initial_metadata.count = 0;
155 op->flags = 0;
156 op->reserved = nullptr;
157 op++;
158 op->op = GRPC_OP_SEND_STATUS_FROM_SERVER;
159 op->data.send_status_from_server.trailing_metadata_count = 0;
160 op->data.send_status_from_server.status = GRPC_STATUS_UNIMPLEMENTED;
161 grpc_slice status_details = grpc_slice_from_static_string("xyz");
162 op->data.send_status_from_server.status_details = &status_details;
163 op->flags = 0;
164 op->reserved = nullptr;
165 op++;
166 op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
167 op->data.recv_close_on_server.cancelled = &was_cancelled;
168 op->flags = 0;
169 op->reserved = nullptr;
170 op++;
171 error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(102),
172 nullptr);
173 GPR_ASSERT(GRPC_CALL_OK == error);
174
175 CQ_EXPECT_COMPLETION(cqv, tag(102), 1);
176 CQ_EXPECT_COMPLETION(cqv, tag(0xdead), 1);
177 CQ_EXPECT_COMPLETION(cqv, tag(1), 1);
178 cq_verify(cqv);
179
180 grpc_call_unref(s);
181
182 GPR_ASSERT(status == GRPC_STATUS_UNIMPLEMENTED);
183 GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/foo"));
184 GPR_ASSERT(was_cancelled == 0);
185
186 grpc_slice_unref(details);
187 grpc_metadata_array_destroy(&initial_metadata_recv);
188 grpc_metadata_array_destroy(&trailing_metadata_recv);
189 grpc_metadata_array_destroy(&request_metadata_recv);
190 grpc_call_details_destroy(&call_details);
191
192 grpc_call_unref(c);
193
194 cq_verifier_destroy(cqv);
195
196 end_test(&f);
197 config.tear_down_data(&f);
198 }
199
graceful_server_shutdown(grpc_end2end_test_config config)200 void graceful_server_shutdown(grpc_end2end_test_config config) {
201 test_early_server_shutdown_finishes_inflight_calls(config);
202 }
203
graceful_server_shutdown_pre_init(void)204 void graceful_server_shutdown_pre_init(void) {}
205