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