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
30 /* this is a private API but exposed here for testing*/
31 extern void grpc_network_status_shutdown_all_endpoints();
32
tag(intptr_t t)33 static void* tag(intptr_t t) { return (void*)t; }
34
begin_test(grpc_end2end_test_config config,const char * test_name,grpc_channel_args * client_args,grpc_channel_args * server_args)35 static grpc_end2end_test_fixture begin_test(grpc_end2end_test_config config,
36 const char* test_name,
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", test_name, config.name);
41 f = config.create_fixture(client_args, server_args);
42 config.init_server(&f, server_args);
43 config.init_client(&f, client_args);
44 return f;
45 }
46
n_seconds_from_now(int n)47 static gpr_timespec n_seconds_from_now(int n) {
48 return grpc_timeout_seconds_to_deadline(n);
49 }
50
five_seconds_from_now(void)51 static gpr_timespec five_seconds_from_now(void) {
52 return n_seconds_from_now(500);
53 }
54
drain_cq(grpc_completion_queue * cq)55 static void drain_cq(grpc_completion_queue* cq) {
56 grpc_event ev;
57 do {
58 ev = grpc_completion_queue_next(cq, five_seconds_from_now(), nullptr);
59 } while (ev.type != GRPC_QUEUE_SHUTDOWN);
60 }
61
shutdown_server(grpc_end2end_test_fixture * f)62 static void shutdown_server(grpc_end2end_test_fixture* f) {
63 if (!f->server) return;
64 grpc_server_shutdown_and_notify(f->server, f->shutdown_cq, tag(1000));
65 GPR_ASSERT(grpc_completion_queue_pluck(f->shutdown_cq, tag(1000),
66 grpc_timeout_seconds_to_deadline(5),
67 nullptr)
68 .type == GRPC_OP_COMPLETE);
69 grpc_server_destroy(f->server);
70 f->server = nullptr;
71 }
72
shutdown_client(grpc_end2end_test_fixture * f)73 static void shutdown_client(grpc_end2end_test_fixture* f) {
74 if (!f->client) return;
75 grpc_channel_destroy(f->client);
76 f->client = nullptr;
77 }
78
end_test(grpc_end2end_test_fixture * f)79 static void end_test(grpc_end2end_test_fixture* f) {
80 shutdown_server(f);
81 shutdown_client(f);
82
83 grpc_completion_queue_shutdown(f->cq);
84 drain_cq(f->cq);
85 grpc_completion_queue_destroy(f->cq);
86 grpc_completion_queue_destroy(f->shutdown_cq);
87 }
88
89 /* Client sends a request with payload, server reads then returns status. */
test_invoke_network_status_change(grpc_end2end_test_config config)90 static void test_invoke_network_status_change(grpc_end2end_test_config config) {
91 grpc_call* c;
92 grpc_call* s;
93 grpc_slice request_payload_slice =
94 grpc_slice_from_copied_string("hello world");
95 grpc_byte_buffer* request_payload =
96 grpc_raw_byte_buffer_create(&request_payload_slice, 1);
97 grpc_end2end_test_fixture f =
98 begin_test(config, "test_invoke_request_with_payload", nullptr, nullptr);
99 cq_verifier* cqv = cq_verifier_create(f.cq);
100 grpc_op ops[6];
101 grpc_op* op;
102 grpc_metadata_array initial_metadata_recv;
103 grpc_metadata_array trailing_metadata_recv;
104 grpc_metadata_array request_metadata_recv;
105 grpc_byte_buffer* request_payload_recv = nullptr;
106 grpc_call_details call_details;
107 grpc_status_code status;
108 grpc_call_error error;
109 grpc_slice details;
110 int was_cancelled = 2;
111
112 gpr_timespec deadline = five_seconds_from_now();
113 c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
114 grpc_slice_from_static_string("/foo"), nullptr,
115 deadline, nullptr);
116 GPR_ASSERT(c);
117
118 grpc_metadata_array_init(&initial_metadata_recv);
119 grpc_metadata_array_init(&trailing_metadata_recv);
120 grpc_metadata_array_init(&request_metadata_recv);
121 grpc_call_details_init(&call_details);
122
123 memset(ops, 0, sizeof(ops));
124 op = ops;
125 op->op = GRPC_OP_SEND_INITIAL_METADATA;
126 op->data.send_initial_metadata.count = 0;
127 op->flags = 0;
128 op->reserved = nullptr;
129 op++;
130 op->op = GRPC_OP_SEND_MESSAGE;
131 op->data.send_message.send_message = request_payload;
132 op->flags = 0;
133 op->reserved = nullptr;
134 op++;
135 op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
136 op->flags = 0;
137 op->reserved = nullptr;
138 op++;
139 op->op = GRPC_OP_RECV_INITIAL_METADATA;
140 op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
141 op->flags = 0;
142 op->reserved = nullptr;
143 op++;
144 op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
145 op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
146 op->data.recv_status_on_client.status = &status;
147 op->data.recv_status_on_client.status_details = &details;
148 op->flags = 0;
149 op->reserved = nullptr;
150 op++;
151 error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(1),
152 nullptr);
153 GPR_ASSERT(GRPC_CALL_OK == error);
154
155 GPR_ASSERT(GRPC_CALL_OK == grpc_server_request_call(
156 f.server, &s, &call_details,
157 &request_metadata_recv, f.cq, f.cq, tag(101)));
158 CQ_EXPECT_COMPLETION(cqv, tag(101), 1);
159 cq_verify(cqv);
160
161 op = ops;
162 op->op = GRPC_OP_SEND_INITIAL_METADATA;
163 op->data.send_initial_metadata.count = 0;
164 op->flags = 0;
165 op->reserved = nullptr;
166 op++;
167 op->op = GRPC_OP_RECV_MESSAGE;
168 op->data.recv_message.recv_message = &request_payload_recv;
169 op->flags = 0;
170 op->reserved = nullptr;
171 op++;
172 error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(102),
173 nullptr);
174 GPR_ASSERT(GRPC_CALL_OK == error);
175
176 CQ_EXPECT_COMPLETION(cqv, tag(102), 1);
177 cq_verify(cqv);
178
179 // Simulate the network loss event
180 grpc_network_status_shutdown_all_endpoints();
181
182 op = ops;
183 op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
184 op->data.recv_close_on_server.cancelled = &was_cancelled;
185 op->flags = 0;
186 op->reserved = nullptr;
187 op++;
188 op->op = GRPC_OP_SEND_STATUS_FROM_SERVER;
189 op->data.send_status_from_server.trailing_metadata_count = 0;
190 op->data.send_status_from_server.status = GRPC_STATUS_OK;
191 grpc_slice status_details = grpc_slice_from_static_string("xyz");
192 op->data.send_status_from_server.status_details = &status_details;
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(103),
197 nullptr);
198 GPR_ASSERT(GRPC_CALL_OK == error);
199
200 CQ_EXPECT_COMPLETION(cqv, tag(103), 1);
201 CQ_EXPECT_COMPLETION(cqv, tag(1), 1);
202 cq_verify(cqv);
203
204 // TODO(makdharma) Update this when the shutdown_all_endpoints is implemented.
205 // Expected behavior of a RPC when network is lost.
206 // GPR_ASSERT(status == GRPC_STATUS_UNAVAILABLE);
207 GPR_ASSERT(status == GRPC_STATUS_OK);
208
209 GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/foo"));
210
211 grpc_slice_unref(details);
212 grpc_metadata_array_destroy(&initial_metadata_recv);
213 grpc_metadata_array_destroy(&trailing_metadata_recv);
214 grpc_metadata_array_destroy(&request_metadata_recv);
215 grpc_call_details_destroy(&call_details);
216
217 grpc_call_unref(c);
218 grpc_call_unref(s);
219
220 cq_verifier_destroy(cqv);
221
222 grpc_byte_buffer_destroy(request_payload);
223 grpc_byte_buffer_destroy(request_payload_recv);
224
225 end_test(&f);
226 config.tear_down_data(&f);
227 }
228
network_status_change(grpc_end2end_test_config config)229 void network_status_change(grpc_end2end_test_config config) {
230 if (config.feature_mask &
231 FEATURE_MASK_DOES_NOT_SUPPORT_NETWORK_STATUS_CHANGE) {
232 return;
233 }
234 test_invoke_network_status_change(config);
235 }
236
network_status_change_pre_init(void)237 void network_status_change_pre_init(void) {}
238