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/byte_buffer_reader.h>
26 #include <grpc/compression.h>
27 #include <grpc/support/alloc.h>
28 #include <grpc/support/log.h>
29 #include <grpc/support/string_util.h>
30 #include <grpc/support/time.h>
31
32 #include "src/core/lib/channel/channel_args.h"
33 #include "src/core/lib/compression/compression_args.h"
34 #include "src/core/lib/surface/call.h"
35 #include "src/core/lib/surface/call_test_only.h"
36 #include "src/core/lib/transport/static_metadata.h"
37 #include "test/core/end2end/cq_verifier.h"
38
tag(intptr_t t)39 static void* tag(intptr_t t) { return (void*)t; }
40
begin_test(grpc_end2end_test_config config,const char * test_name,grpc_channel_args * client_args,grpc_channel_args * server_args)41 static grpc_end2end_test_fixture begin_test(grpc_end2end_test_config config,
42 const char* test_name,
43 grpc_channel_args* client_args,
44 grpc_channel_args* server_args) {
45 grpc_end2end_test_fixture f;
46 gpr_log(GPR_INFO, "Running test: %s/%s", test_name, config.name);
47 f = config.create_fixture(client_args, server_args);
48 config.init_server(&f, server_args);
49 config.init_client(&f, client_args);
50 return f;
51 }
52
n_seconds_from_now(int n)53 static gpr_timespec n_seconds_from_now(int n) {
54 return grpc_timeout_seconds_to_deadline(n);
55 }
56
five_seconds_from_now(void)57 static gpr_timespec five_seconds_from_now(void) {
58 return n_seconds_from_now(5);
59 }
60
drain_cq(grpc_completion_queue * cq)61 static void drain_cq(grpc_completion_queue* cq) {
62 grpc_event ev;
63 do {
64 ev = grpc_completion_queue_next(cq, five_seconds_from_now(), nullptr);
65 } while (ev.type != GRPC_QUEUE_SHUTDOWN);
66 }
67
shutdown_server(grpc_end2end_test_fixture * f)68 static void shutdown_server(grpc_end2end_test_fixture* f) {
69 if (!f->server) return;
70 grpc_server_shutdown_and_notify(f->server, f->shutdown_cq, tag(1000));
71 GPR_ASSERT(grpc_completion_queue_pluck(f->shutdown_cq, tag(1000),
72 grpc_timeout_seconds_to_deadline(5),
73 nullptr)
74 .type == GRPC_OP_COMPLETE);
75 grpc_server_destroy(f->server);
76 f->server = nullptr;
77 }
78
shutdown_client(grpc_end2end_test_fixture * f)79 static void shutdown_client(grpc_end2end_test_fixture* f) {
80 if (!f->client) return;
81 grpc_channel_destroy(f->client);
82 f->client = nullptr;
83 }
84
end_test(grpc_end2end_test_fixture * f)85 static void end_test(grpc_end2end_test_fixture* f) {
86 shutdown_server(f);
87 shutdown_client(f);
88
89 grpc_completion_queue_shutdown(f->cq);
90 drain_cq(f->cq);
91 grpc_completion_queue_destroy(f->cq);
92 grpc_completion_queue_destroy(f->shutdown_cq);
93 }
94
request_with_payload_template(grpc_end2end_test_config config,const char * test_name,uint32_t client_send_flags_bitmask,grpc_compression_algorithm default_client_channel_compression_algorithm,grpc_compression_algorithm default_server_channel_compression_algorithm,grpc_compression_algorithm expected_algorithm_from_client,grpc_compression_algorithm expected_algorithm_from_server,grpc_metadata * client_init_metadata,bool set_server_level,grpc_compression_level server_compression_level,char * user_agent_override,bool decompress_in_core)95 static void request_with_payload_template(
96 grpc_end2end_test_config config, const char* test_name,
97 uint32_t client_send_flags_bitmask,
98 grpc_compression_algorithm default_client_channel_compression_algorithm,
99 grpc_compression_algorithm default_server_channel_compression_algorithm,
100 grpc_compression_algorithm expected_algorithm_from_client,
101 grpc_compression_algorithm expected_algorithm_from_server,
102 grpc_metadata* client_init_metadata, bool set_server_level,
103 grpc_compression_level server_compression_level, char* user_agent_override,
104 bool decompress_in_core) {
105 grpc_call* c;
106 grpc_call* s;
107 grpc_slice request_payload_slice;
108 grpc_byte_buffer* request_payload;
109 grpc_channel_args* client_args;
110 grpc_channel_args* server_args;
111 grpc_end2end_test_fixture f;
112 grpc_op ops[6];
113 grpc_op* op;
114 grpc_metadata_array initial_metadata_recv;
115 grpc_metadata_array trailing_metadata_recv;
116 grpc_metadata_array request_metadata_recv;
117 grpc_byte_buffer* request_payload_recv = nullptr;
118 grpc_byte_buffer* response_payload;
119 grpc_byte_buffer* response_payload_recv;
120 grpc_call_details call_details;
121 grpc_status_code status;
122 grpc_call_error error;
123 grpc_slice details;
124 int was_cancelled = 2;
125 cq_verifier* cqv;
126 char request_str[1024];
127 char response_str[1024];
128
129 memset(request_str, 'x', 1023);
130 request_str[1023] = '\0';
131
132 memset(response_str, 'y', 1023);
133 response_str[1023] = '\0';
134
135 request_payload_slice = grpc_slice_from_copied_string(request_str);
136 grpc_slice response_payload_slice =
137 grpc_slice_from_copied_string(response_str);
138
139 client_args = grpc_channel_args_set_channel_default_compression_algorithm(
140 nullptr, default_client_channel_compression_algorithm);
141 server_args = grpc_channel_args_set_channel_default_compression_algorithm(
142 nullptr, default_server_channel_compression_algorithm);
143 if (!decompress_in_core) {
144 grpc_arg disable_decompression_in_core_arg =
145 grpc_channel_arg_integer_create(
146 const_cast<char*>(GRPC_ARG_ENABLE_PER_MESSAGE_DECOMPRESSION), 0);
147 grpc_channel_args* old_client_args = client_args;
148 grpc_channel_args* old_server_args = server_args;
149 client_args = grpc_channel_args_copy_and_add(
150 client_args, &disable_decompression_in_core_arg, 1);
151 server_args = grpc_channel_args_copy_and_add(
152 server_args, &disable_decompression_in_core_arg, 1);
153 grpc_channel_args_destroy(old_client_args);
154 grpc_channel_args_destroy(old_server_args);
155 }
156
157 if (user_agent_override) {
158 grpc_channel_args* client_args_old = client_args;
159 grpc_arg arg;
160 arg.key = const_cast<char*>(GRPC_ARG_PRIMARY_USER_AGENT_STRING);
161 arg.type = GRPC_ARG_STRING;
162 arg.value.string = user_agent_override;
163 client_args = grpc_channel_args_copy_and_add(client_args_old, &arg, 1);
164 grpc_channel_args_destroy(client_args_old);
165 }
166
167 f = begin_test(config, test_name, client_args, server_args);
168 cqv = cq_verifier_create(f.cq);
169
170 gpr_timespec deadline = five_seconds_from_now();
171 c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
172 grpc_slice_from_static_string("/foo"), nullptr,
173 deadline, nullptr);
174 GPR_ASSERT(c);
175
176 grpc_metadata_array_init(&initial_metadata_recv);
177 grpc_metadata_array_init(&trailing_metadata_recv);
178 grpc_metadata_array_init(&request_metadata_recv);
179 grpc_call_details_init(&call_details);
180
181 memset(ops, 0, sizeof(ops));
182 op = ops;
183 op->op = GRPC_OP_SEND_INITIAL_METADATA;
184 if (client_init_metadata != nullptr) {
185 op->data.send_initial_metadata.count = 1;
186 op->data.send_initial_metadata.metadata = client_init_metadata;
187 } else {
188 op->data.send_initial_metadata.count = 0;
189 }
190 op->flags = 0;
191 op->reserved = nullptr;
192 op++;
193 op->op = GRPC_OP_RECV_INITIAL_METADATA;
194 op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
195 op->flags = 0;
196 op->reserved = nullptr;
197 op++;
198 op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
199 op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
200 op->data.recv_status_on_client.status = &status;
201 op->data.recv_status_on_client.status_details = &details;
202 op->flags = 0;
203 op->reserved = nullptr;
204 op++;
205 error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(1),
206 nullptr);
207 GPR_ASSERT(GRPC_CALL_OK == error);
208
209 error =
210 grpc_server_request_call(f.server, &s, &call_details,
211 &request_metadata_recv, f.cq, f.cq, tag(100));
212 GPR_ASSERT(GRPC_CALL_OK == error);
213 CQ_EXPECT_COMPLETION(cqv, tag(100), true);
214 cq_verify(cqv);
215
216 GPR_ASSERT(GPR_BITCOUNT(grpc_call_test_only_get_encodings_accepted_by_peer(
217 s)) == GRPC_COMPRESS_ALGORITHMS_COUNT);
218 GPR_ASSERT(GPR_BITGET(grpc_call_test_only_get_encodings_accepted_by_peer(s),
219 GRPC_COMPRESS_NONE) != 0);
220 GPR_ASSERT(GPR_BITGET(grpc_call_test_only_get_encodings_accepted_by_peer(s),
221 GRPC_COMPRESS_DEFLATE) != 0);
222 GPR_ASSERT(GPR_BITGET(grpc_call_test_only_get_encodings_accepted_by_peer(s),
223 GRPC_COMPRESS_GZIP) != 0);
224
225 memset(ops, 0, sizeof(ops));
226 op = ops;
227 op->op = GRPC_OP_SEND_INITIAL_METADATA;
228 op->data.send_initial_metadata.count = 0;
229 if (set_server_level) {
230 op->data.send_initial_metadata.maybe_compression_level.is_set = true;
231 op->data.send_initial_metadata.maybe_compression_level.level =
232 server_compression_level;
233 }
234 op->flags = 0;
235 op->reserved = nullptr;
236 op++;
237 op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
238 op->data.recv_close_on_server.cancelled = &was_cancelled;
239 op->flags = 0;
240 op->reserved = nullptr;
241 op++;
242 error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(101),
243 nullptr);
244 GPR_ASSERT(GRPC_CALL_OK == error);
245
246 for (int i = 0; i < 2; i++) {
247 request_payload = grpc_raw_byte_buffer_create(&request_payload_slice, 1);
248 response_payload = grpc_raw_byte_buffer_create(&response_payload_slice, 1);
249
250 memset(ops, 0, sizeof(ops));
251 op = ops;
252 op->op = GRPC_OP_SEND_MESSAGE;
253 op->data.send_message.send_message = request_payload;
254 op->flags = client_send_flags_bitmask;
255 op->reserved = nullptr;
256 op++;
257 op->op = GRPC_OP_RECV_MESSAGE;
258 op->data.recv_message.recv_message = &response_payload_recv;
259 op->flags = 0;
260 op->reserved = nullptr;
261 op++;
262 error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(2),
263 nullptr);
264 GPR_ASSERT(GRPC_CALL_OK == error);
265
266 memset(ops, 0, sizeof(ops));
267 op = ops;
268 op->op = GRPC_OP_RECV_MESSAGE;
269 op->data.recv_message.recv_message = &request_payload_recv;
270 op->flags = 0;
271 op->reserved = nullptr;
272 op++;
273 error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops),
274 tag(102), nullptr);
275 GPR_ASSERT(GRPC_CALL_OK == error);
276 CQ_EXPECT_COMPLETION(cqv, tag(102), 1);
277 cq_verify(cqv);
278
279 GPR_ASSERT(request_payload_recv->type == GRPC_BB_RAW);
280 GPR_ASSERT(byte_buffer_eq_string(request_payload_recv, request_str));
281 GPR_ASSERT(request_payload_recv->data.raw.compression ==
282 (decompress_in_core ? GRPC_COMPRESS_NONE
283 : expected_algorithm_from_client));
284
285 memset(ops, 0, sizeof(ops));
286 op = ops;
287 op->op = GRPC_OP_SEND_MESSAGE;
288 op->data.send_message.send_message = response_payload;
289 op->flags = 0;
290 op->reserved = nullptr;
291 op++;
292 error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops),
293 tag(103), nullptr);
294 GPR_ASSERT(GRPC_CALL_OK == error);
295 CQ_EXPECT_COMPLETION(cqv, tag(103), 1);
296 CQ_EXPECT_COMPLETION(cqv, tag(2), 1);
297 cq_verify(cqv);
298
299 GPR_ASSERT(response_payload_recv->type == GRPC_BB_RAW);
300 GPR_ASSERT(byte_buffer_eq_string(response_payload_recv, response_str));
301 if (server_compression_level > GRPC_COMPRESS_LEVEL_NONE) {
302 const grpc_compression_algorithm algo_for_server_level =
303 grpc_call_compression_for_level(s, server_compression_level);
304 GPR_ASSERT(
305 response_payload_recv->data.raw.compression ==
306 (decompress_in_core ? GRPC_COMPRESS_NONE : algo_for_server_level));
307 } else {
308 GPR_ASSERT(response_payload_recv->data.raw.compression ==
309 (decompress_in_core ? GRPC_COMPRESS_NONE
310 : expected_algorithm_from_server));
311 }
312
313 grpc_byte_buffer_destroy(request_payload);
314 grpc_byte_buffer_destroy(response_payload);
315 grpc_byte_buffer_destroy(request_payload_recv);
316 grpc_byte_buffer_destroy(response_payload_recv);
317 }
318
319 grpc_slice_unref(request_payload_slice);
320 grpc_slice_unref(response_payload_slice);
321
322 memset(ops, 0, sizeof(ops));
323 op = ops;
324 op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
325 op->flags = 0;
326 op->reserved = nullptr;
327 op++;
328 error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(3),
329 nullptr);
330 GPR_ASSERT(GRPC_CALL_OK == error);
331
332 memset(ops, 0, sizeof(ops));
333 op = ops;
334 op->op = GRPC_OP_SEND_STATUS_FROM_SERVER;
335 op->data.send_status_from_server.trailing_metadata_count = 0;
336 op->data.send_status_from_server.status = GRPC_STATUS_OK;
337 grpc_slice status_details = grpc_slice_from_static_string("xyz");
338 op->data.send_status_from_server.status_details = &status_details;
339 op->flags = 0;
340 op->reserved = nullptr;
341 op++;
342 error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(104),
343 nullptr);
344 GPR_ASSERT(GRPC_CALL_OK == error);
345
346 CQ_EXPECT_COMPLETION(cqv, tag(1), 1);
347 CQ_EXPECT_COMPLETION(cqv, tag(3), 1);
348 CQ_EXPECT_COMPLETION(cqv, tag(101), 1);
349 CQ_EXPECT_COMPLETION(cqv, tag(104), 1);
350 cq_verify(cqv);
351
352 GPR_ASSERT(status == GRPC_STATUS_OK);
353 GPR_ASSERT(0 == grpc_slice_str_cmp(details, "xyz"));
354 GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/foo"));
355 GPR_ASSERT(was_cancelled == 0);
356
357 grpc_slice_unref(details);
358 grpc_metadata_array_destroy(&initial_metadata_recv);
359 grpc_metadata_array_destroy(&trailing_metadata_recv);
360 grpc_metadata_array_destroy(&request_metadata_recv);
361 grpc_call_details_destroy(&call_details);
362
363 grpc_call_unref(c);
364 grpc_call_unref(s);
365
366 cq_verifier_destroy(cqv);
367 grpc_channel_args_destroy(client_args);
368 grpc_channel_args_destroy(server_args);
369 end_test(&f);
370 config.tear_down_data(&f);
371 }
372
373 typedef struct workaround_cronet_compression_config {
374 char* user_agent_override;
375 grpc_compression_algorithm expected_algorithm_from_server;
376 } workaround_cronet_compression_config;
377
378 static workaround_cronet_compression_config workaround_configs[] = {
379 {nullptr, GRPC_COMPRESS_GZIP},
380 {const_cast<char*>(
381 "grpc-objc/1.3.0-dev grpc-c/3.0.0-dev (ios; cronet_http; gentle)"),
382 GRPC_COMPRESS_NONE},
383 {const_cast<char*>(
384 "grpc-objc/1.3.0-dev grpc-c/3.0.0-dev (ios; chttp2; gentle)"),
385 GRPC_COMPRESS_GZIP},
386 {const_cast<char*>(
387 "grpc-objc/1.4.0 grpc-c/3.0.0-dev (ios; cronet_http; gentle)"),
388 GRPC_COMPRESS_GZIP}};
389 static const size_t workaround_configs_num =
390 sizeof(workaround_configs) / sizeof(*workaround_configs);
391
test_workaround_cronet_compression(grpc_end2end_test_config config)392 static void test_workaround_cronet_compression(
393 grpc_end2end_test_config config) {
394 for (uint32_t i = 0; i < workaround_configs_num; i++) {
395 request_with_payload_template(
396 config, "test_invoke_request_with_compressed_payload", 0,
397 GRPC_COMPRESS_GZIP, GRPC_COMPRESS_GZIP, GRPC_COMPRESS_GZIP,
398 workaround_configs[i].expected_algorithm_from_server, nullptr, false,
399 /* ignored */ GRPC_COMPRESS_LEVEL_NONE,
400 workaround_configs[i].user_agent_override, true);
401 request_with_payload_template(
402 config,
403 "test_invoke_request_with_compressed_payload_with_compression_disabled",
404 0, GRPC_COMPRESS_GZIP, GRPC_COMPRESS_GZIP, GRPC_COMPRESS_GZIP,
405 workaround_configs[i].expected_algorithm_from_server, nullptr, false,
406 /* ignored */ GRPC_COMPRESS_LEVEL_NONE,
407 workaround_configs[i].user_agent_override, false);
408 }
409 }
410
workaround_cronet_compression(grpc_end2end_test_config config)411 void workaround_cronet_compression(grpc_end2end_test_config config) {
412 if (config.feature_mask & FEATURE_MASK_SUPPORTS_WORKAROUNDS) {
413 test_workaround_cronet_compression(config);
414 }
415 }
416
workaround_cronet_compression_pre_init(void)417 void workaround_cronet_compression_pre_init(void) {}
418