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 "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/support/alloc.h>
26 #include <grpc/support/log.h>
27 #include <grpc/support/time.h>
28 #include "test/core/end2end/cq_verifier.h"
29
tag(intptr_t t)30 static void* tag(intptr_t t) { return (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_client(grpc_end2end_test_fixture * f)59 static void shutdown_client(grpc_end2end_test_fixture* f) {
60 if (!f->client) return;
61 grpc_channel_destroy(f->client);
62 f->client = nullptr;
63 }
64
end_test(grpc_end2end_test_fixture * f)65 static void end_test(grpc_end2end_test_fixture* f) {
66 shutdown_client(f);
67
68 grpc_completion_queue_shutdown(f->cq);
69 drain_cq(f->cq);
70 grpc_completion_queue_destroy(f->cq);
71 /* f->shutdown_cq is not used in this test */
72 grpc_completion_queue_destroy(f->shutdown_cq);
73 }
74
test_early_server_shutdown_finishes_inflight_calls(grpc_end2end_test_config config)75 static void test_early_server_shutdown_finishes_inflight_calls(
76 grpc_end2end_test_config config) {
77 grpc_call* c;
78 grpc_call* s;
79 grpc_end2end_test_fixture f =
80 begin_test(config, "test_early_server_shutdown_finishes_inflight_calls",
81 nullptr, nullptr);
82 cq_verifier* cqv = cq_verifier_create(f.cq);
83 grpc_op ops[6];
84 grpc_op* op;
85 grpc_metadata_array initial_metadata_recv;
86 grpc_metadata_array trailing_metadata_recv;
87 grpc_metadata_array request_metadata_recv;
88 grpc_call_details call_details;
89 grpc_status_code status;
90 grpc_call_error error;
91 grpc_slice details;
92 int was_cancelled = 2;
93
94 gpr_timespec deadline = five_seconds_from_now();
95 c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
96 grpc_slice_from_static_string("/foo"), nullptr,
97 deadline, nullptr);
98 GPR_ASSERT(c);
99
100 grpc_metadata_array_init(&initial_metadata_recv);
101 grpc_metadata_array_init(&trailing_metadata_recv);
102 grpc_metadata_array_init(&request_metadata_recv);
103 grpc_call_details_init(&call_details);
104
105 memset(ops, 0, sizeof(ops));
106 op = ops;
107 op->op = GRPC_OP_SEND_INITIAL_METADATA;
108 op->data.send_initial_metadata.count = 0;
109 op->data.send_initial_metadata.metadata = nullptr;
110 op->flags = 0;
111 op->reserved = nullptr;
112 op++;
113 op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
114 op->flags = 0;
115 op->reserved = nullptr;
116 op++;
117 op->op = GRPC_OP_RECV_INITIAL_METADATA;
118 op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
119 op->flags = 0;
120 op->reserved = nullptr;
121 op++;
122 op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
123 op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
124 op->data.recv_status_on_client.status = &status;
125 op->data.recv_status_on_client.status_details = &details;
126 op->flags = 0;
127 op->reserved = nullptr;
128 op++;
129 error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(1),
130 nullptr);
131 GPR_ASSERT(GRPC_CALL_OK == error);
132
133 error =
134 grpc_server_request_call(f.server, &s, &call_details,
135 &request_metadata_recv, f.cq, f.cq, tag(101));
136 GPR_ASSERT(GRPC_CALL_OK == error);
137 CQ_EXPECT_COMPLETION(cqv, tag(101), 1);
138 cq_verify(cqv);
139
140 memset(ops, 0, sizeof(ops));
141 op = ops;
142 op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
143 op->data.recv_close_on_server.cancelled = &was_cancelled;
144 op->flags = 0;
145 op->reserved = nullptr;
146 op++;
147 error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(102),
148 nullptr);
149 GPR_ASSERT(GRPC_CALL_OK == error);
150
151 /* Make sure we don't shutdown the server while HTTP/2 PING frames are still
152 * being exchanged on the newly established connection. It can lead to
153 * failures when testing with HTTP proxy. See
154 * https://github.com/grpc/grpc/issues/14471
155 */
156 gpr_sleep_until(n_seconds_from_now(1));
157
158 /* shutdown and destroy the server */
159 grpc_server_shutdown_and_notify(f.server, f.cq, tag(1000));
160 grpc_server_cancel_all_calls(f.server);
161
162 CQ_EXPECT_COMPLETION(cqv, tag(1000), 1);
163 CQ_EXPECT_COMPLETION(cqv, tag(102), 1);
164 CQ_EXPECT_COMPLETION(cqv, tag(1), 1);
165 cq_verify(cqv);
166
167 grpc_server_destroy(f.server);
168
169 // new code should give INTERNAL, some older code will give UNAVAILABLE
170 GPR_ASSERT(status == GRPC_STATUS_INTERNAL ||
171 status == GRPC_STATUS_UNAVAILABLE);
172 GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/foo"));
173 GPR_ASSERT(was_cancelled == 1);
174
175 grpc_slice_unref(details);
176 grpc_metadata_array_destroy(&initial_metadata_recv);
177 grpc_metadata_array_destroy(&trailing_metadata_recv);
178 grpc_metadata_array_destroy(&request_metadata_recv);
179 grpc_call_details_destroy(&call_details);
180
181 grpc_call_unref(c);
182 grpc_call_unref(s);
183
184 cq_verifier_destroy(cqv);
185
186 end_test(&f);
187 config.tear_down_data(&f);
188 }
189
shutdown_finishes_calls(grpc_end2end_test_config config)190 void shutdown_finishes_calls(grpc_end2end_test_config config) {
191 test_early_server_shutdown_finishes_inflight_calls(config);
192 }
193
shutdown_finishes_calls_pre_init(void)194 void shutdown_finishes_calls_pre_init(void) {}
195