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/compression.h>
26 #include <grpc/support/alloc.h>
27 #include <grpc/support/log.h>
28 #include <grpc/support/time.h>
29 #include "src/core/lib/channel/channel_args.h"
30 #include "src/core/lib/compression/compression_args.h"
31 #include "src/core/lib/surface/call.h"
32 #include "test/core/end2end/cq_verifier.h"
33
tag(intptr_t t)34 static void* tag(intptr_t t) { return (void*)t; }
35
begin_test(grpc_end2end_test_config config,const char * test_name,grpc_channel_args * client_args,grpc_channel_args * server_args)36 static grpc_end2end_test_fixture begin_test(grpc_end2end_test_config config,
37 const char* test_name,
38 grpc_channel_args* client_args,
39 grpc_channel_args* server_args) {
40 grpc_end2end_test_fixture f;
41 gpr_log(GPR_INFO, "Running test: %s/%s", test_name, config.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 /* Creates and returns a grpc_slice containing random alphanumeric characters.
91 */
generate_random_slice()92 static grpc_slice generate_random_slice() {
93 size_t i;
94 static const char chars[] = "abcdefghijklmnopqrstuvwxyz1234567890";
95 char* output;
96 const size_t output_size = 1024 * 1024;
97 output = static_cast<char*>(gpr_malloc(output_size));
98 for (i = 0; i < output_size - 1; ++i) {
99 output[i] = chars[rand() % static_cast<int>(sizeof(chars) - 1)];
100 }
101 output[output_size - 1] = '\0';
102 grpc_slice out = grpc_slice_from_copied_string(output);
103 gpr_free(output);
104 return out;
105 }
106
request_response_with_payload(grpc_end2end_test_config,grpc_end2end_test_fixture f)107 static void request_response_with_payload(grpc_end2end_test_config /*config*/,
108 grpc_end2end_test_fixture f) {
109 /* Create large request and response bodies. These are big enough to require
110 * multiple round trips to deliver to the peer, and their exact contents of
111 * will be verified on completion. */
112 grpc_slice request_payload_slice = generate_random_slice();
113 grpc_slice response_payload_slice = generate_random_slice();
114
115 grpc_call* c;
116 grpc_call* s;
117 grpc_byte_buffer* request_payload =
118 grpc_raw_byte_buffer_create(&request_payload_slice, 1);
119 grpc_byte_buffer* response_payload =
120 grpc_raw_byte_buffer_create(&response_payload_slice, 1);
121 cq_verifier* cqv = cq_verifier_create(f.cq);
122 grpc_op ops[6];
123 grpc_op* op;
124 grpc_metadata_array initial_metadata_recv;
125 grpc_metadata_array trailing_metadata_recv;
126 grpc_metadata_array request_metadata_recv;
127 grpc_byte_buffer* request_payload_recv = nullptr;
128 grpc_byte_buffer* response_payload_recv = nullptr;
129 grpc_call_details call_details;
130 grpc_status_code status;
131 grpc_call_error error;
132 grpc_slice details;
133 int was_cancelled = 2;
134
135 gpr_timespec deadline = n_seconds_from_now(60);
136 c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
137 grpc_slice_from_static_string("/foo"), nullptr,
138 deadline, nullptr);
139 GPR_ASSERT(c);
140
141 grpc_metadata_array_init(&initial_metadata_recv);
142 grpc_metadata_array_init(&trailing_metadata_recv);
143 grpc_metadata_array_init(&request_metadata_recv);
144 grpc_call_details_init(&call_details);
145
146 memset(ops, 0, sizeof(ops));
147 op = ops;
148 op->op = GRPC_OP_SEND_INITIAL_METADATA;
149 op->data.send_initial_metadata.count = 0;
150 op->flags = 0;
151 op->reserved = nullptr;
152 op++;
153 op->op = GRPC_OP_SEND_MESSAGE;
154 op->data.send_message.send_message = request_payload;
155 op->flags = 0;
156 op->reserved = nullptr;
157 op++;
158 op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
159 op->flags = 0;
160 op->reserved = nullptr;
161 op++;
162 op->op = GRPC_OP_RECV_INITIAL_METADATA;
163 op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
164 op->flags = 0;
165 op->reserved = nullptr;
166 op++;
167 op->op = GRPC_OP_RECV_MESSAGE;
168 op->data.recv_message.recv_message = &response_payload_recv;
169 op->flags = 0;
170 op->reserved = nullptr;
171 op++;
172 op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
173 op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
174 op->data.recv_status_on_client.status = &status;
175 op->data.recv_status_on_client.status_details = &details;
176 op->flags = 0;
177 op->reserved = nullptr;
178 op++;
179 error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(1),
180 nullptr);
181 GPR_ASSERT(GRPC_CALL_OK == error);
182
183 error =
184 grpc_server_request_call(f.server, &s, &call_details,
185 &request_metadata_recv, f.cq, f.cq, tag(101));
186 GPR_ASSERT(GRPC_CALL_OK == error);
187 CQ_EXPECT_COMPLETION(cqv, tag(101), 1);
188 cq_verify(cqv);
189
190 memset(ops, 0, sizeof(ops));
191 op = ops;
192 op->op = GRPC_OP_SEND_INITIAL_METADATA;
193 op->data.send_initial_metadata.count = 0;
194 op->flags = 0;
195 op->reserved = nullptr;
196 op++;
197 op->op = GRPC_OP_RECV_MESSAGE;
198 op->data.recv_message.recv_message = &request_payload_recv;
199 op->flags = 0;
200 op->reserved = nullptr;
201 op++;
202 error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(102),
203 nullptr);
204 GPR_ASSERT(GRPC_CALL_OK == error);
205
206 CQ_EXPECT_COMPLETION(cqv, tag(102), 1);
207 cq_verify(cqv);
208
209 memset(ops, 0, sizeof(ops));
210 op = ops;
211 op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
212 op->data.recv_close_on_server.cancelled = &was_cancelled;
213 op->flags = 0;
214 op->reserved = nullptr;
215 op++;
216 op->op = GRPC_OP_SEND_MESSAGE;
217 op->data.send_message.send_message = response_payload;
218 op->flags = 0;
219 op->reserved = nullptr;
220 op++;
221 op->op = GRPC_OP_SEND_STATUS_FROM_SERVER;
222 op->data.send_status_from_server.trailing_metadata_count = 0;
223 op->data.send_status_from_server.status = GRPC_STATUS_OK;
224 grpc_slice status_details = grpc_slice_from_static_string("xyz");
225 op->data.send_status_from_server.status_details = &status_details;
226 op->flags = 0;
227 op->reserved = nullptr;
228 op++;
229 error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(103),
230 nullptr);
231 GPR_ASSERT(GRPC_CALL_OK == error);
232
233 CQ_EXPECT_COMPLETION(cqv, tag(103), 1);
234 CQ_EXPECT_COMPLETION(cqv, tag(1), 1);
235 cq_verify(cqv);
236
237 GPR_ASSERT(status == GRPC_STATUS_OK);
238 GPR_ASSERT(0 == grpc_slice_str_cmp(details, "xyz"));
239 GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/foo"));
240 GPR_ASSERT(was_cancelled == 0);
241 GPR_ASSERT(byte_buffer_eq_slice(request_payload_recv, request_payload_slice));
242 GPR_ASSERT(
243 byte_buffer_eq_slice(response_payload_recv, response_payload_slice));
244
245 grpc_slice_unref(details);
246 grpc_metadata_array_destroy(&initial_metadata_recv);
247 grpc_metadata_array_destroy(&trailing_metadata_recv);
248 grpc_metadata_array_destroy(&request_metadata_recv);
249 grpc_call_details_destroy(&call_details);
250
251 grpc_call_unref(c);
252 grpc_call_unref(s);
253
254 cq_verifier_destroy(cqv);
255
256 grpc_byte_buffer_destroy(request_payload);
257 grpc_byte_buffer_destroy(response_payload);
258 grpc_byte_buffer_destroy(request_payload_recv);
259 grpc_byte_buffer_destroy(response_payload_recv);
260 }
261
262 /* Client sends a request with payload, server reads then returns a response
263 payload and status. */
test_invoke_request_response_with_payload(grpc_end2end_test_config config)264 static void test_invoke_request_response_with_payload(
265 grpc_end2end_test_config config) {
266 grpc_channel_args* client_args =
267 grpc_channel_args_set_channel_default_compression_algorithm(
268 nullptr, GRPC_COMPRESS_STREAM_GZIP);
269 grpc_channel_args* server_args =
270 grpc_channel_args_set_channel_default_compression_algorithm(
271 nullptr, GRPC_COMPRESS_STREAM_GZIP);
272 grpc_end2end_test_fixture f =
273 begin_test(config, "test_invoke_request_response_with_payload",
274 client_args, server_args);
275 request_response_with_payload(config, f);
276 end_test(&f);
277 config.tear_down_data(&f);
278 {
279 grpc_core::ExecCtx exec_ctx;
280 grpc_channel_args_destroy(client_args);
281 grpc_channel_args_destroy(server_args);
282 }
283 }
284
test_invoke_10_request_response_with_payload(grpc_end2end_test_config config)285 static void test_invoke_10_request_response_with_payload(
286 grpc_end2end_test_config config) {
287 int i;
288 grpc_end2end_test_fixture f = begin_test(
289 config, "test_invoke_10_request_response_with_payload", nullptr, nullptr);
290 for (i = 0; i < 10; i++) {
291 request_response_with_payload(config, f);
292 }
293 end_test(&f);
294 config.tear_down_data(&f);
295 }
296
stream_compression_payload(grpc_end2end_test_config config)297 void stream_compression_payload(grpc_end2end_test_config config) {
298 test_invoke_request_response_with_payload(config);
299 test_invoke_10_request_response_with_payload(config);
300 }
301
stream_compression_payload_pre_init(void)302 void stream_compression_payload_pre_init(void) {}
303