test/core/end2end/tests/workaround_cronet_compression.cc

   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
  39 static void* tag(intptr_t t) { return (void*)t; }
  40
  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
  53 static gpr_timespec n_seconds_from_now(int n) {
  54   return grpc_timeout_seconds_to_deadline(n);
  55 }
  56
  57 static gpr_timespec five_seconds_from_now(void) {
  58   return n_seconds_from_now(5);
  59 }
  60
  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
  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
  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
  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
  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,
 104     char* user_agent_override) {
 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_compression_algorithm(
 140       nullptr, default_client_channel_compression_algorithm);
 141   server_args = grpc_channel_args_set_compression_algorithm(
 142       nullptr, default_server_channel_compression_algorithm);
 143
 144   if (user_agent_override) {
 145     grpc_core::ExecCtx exec_ctx;
 146     grpc_channel_args* client_args_old = client_args;
 147     grpc_arg arg;
 148     arg.key = const_cast<char*>(GRPC_ARG_PRIMARY_USER_AGENT_STRING);
 149     arg.type = GRPC_ARG_STRING;
 150     arg.value.string = user_agent_override;
 151     client_args = grpc_channel_args_copy_and_add(client_args_old, &arg, 1);
 152     grpc_channel_args_destroy(client_args_old);
 153   }
 154
 155   f = begin_test(config, test_name, client_args, server_args);
 156   cqv = cq_verifier_create(f.cq);
 157
 158   gpr_timespec deadline = five_seconds_from_now();
 159   c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
 160                                grpc_slice_from_static_string("/foo"), nullptr,
 161                                deadline, nullptr);
 162   GPR_ASSERT(c);
 163
 164   grpc_metadata_array_init(&initial_metadata_recv);
 165   grpc_metadata_array_init(&trailing_metadata_recv);
 166   grpc_metadata_array_init(&request_metadata_recv);
 167   grpc_call_details_init(&call_details);
 168
 169   memset(ops, 0, sizeof(ops));
 170   op = ops;
 171   op->op = GRPC_OP_SEND_INITIAL_METADATA;
 172   if (client_init_metadata != nullptr) {
 173     op->data.send_initial_metadata.count = 1;
 174     op->data.send_initial_metadata.metadata = client_init_metadata;
 175   } else {
 176     op->data.send_initial_metadata.count = 0;
 177   }
 178   op->flags = 0;
 179   op->reserved = nullptr;
 180   op++;
 181   op->op = GRPC_OP_RECV_INITIAL_METADATA;
 182   op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
 183   op->flags = 0;
 184   op->reserved = nullptr;
 185   op++;
 186   op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
 187   op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
 188   op->data.recv_status_on_client.status = &status;
 189   op->data.recv_status_on_client.status_details = &details;
 190   op->flags = 0;
 191   op->reserved = nullptr;
 192   op++;
 193   error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(1),
 194                                 nullptr);
 195   GPR_ASSERT(GRPC_CALL_OK == error);
 196
 197   error =
 198       grpc_server_request_call(f.server, &s, &call_details,
 199                                &request_metadata_recv, f.cq, f.cq, tag(100));
 200   GPR_ASSERT(GRPC_CALL_OK == error);
 201   CQ_EXPECT_COMPLETION(cqv, tag(100), true);
 202   cq_verify(cqv);
 203
 204   GPR_ASSERT(GPR_BITCOUNT(grpc_call_test_only_get_encodings_accepted_by_peer(
 205                  s)) == GRPC_COMPRESS_ALGORITHMS_COUNT);
 206   GPR_ASSERT(GPR_BITGET(grpc_call_test_only_get_encodings_accepted_by_peer(s),
 207                         GRPC_COMPRESS_NONE) != 0);
 208   GPR_ASSERT(GPR_BITGET(grpc_call_test_only_get_encodings_accepted_by_peer(s),
 209                         GRPC_COMPRESS_DEFLATE) != 0);
 210   GPR_ASSERT(GPR_BITGET(grpc_call_test_only_get_encodings_accepted_by_peer(s),
 211                         GRPC_COMPRESS_GZIP) != 0);
 212
 213   memset(ops, 0, sizeof(ops));
 214   op = ops;
 215   op->op = GRPC_OP_SEND_INITIAL_METADATA;
 216   op->data.send_initial_metadata.count = 0;
 217   if (set_server_level) {
 218     op->data.send_initial_metadata.maybe_compression_level.is_set = true;
 219     op->data.send_initial_metadata.maybe_compression_level.level =
 220         server_compression_level;
 221   }
 222   op->flags = 0;
 223   op->reserved = nullptr;
 224   op++;
 225   op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
 226   op->data.recv_close_on_server.cancelled = &was_cancelled;
 227   op->flags = 0;
 228   op->reserved = nullptr;
 229   op++;
 230   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(101),
 231                                 nullptr);
 232   GPR_ASSERT(GRPC_CALL_OK == error);
 233
 234   for (int i = 0; i < 2; i++) {
 235     request_payload = grpc_raw_byte_buffer_create(&request_payload_slice, 1);
 236     response_payload = grpc_raw_byte_buffer_create(&response_payload_slice, 1);
 237
 238     memset(ops, 0, sizeof(ops));
 239     op = ops;
 240     op->op = GRPC_OP_SEND_MESSAGE;
 241     op->data.send_message.send_message = request_payload;
 242     op->flags = client_send_flags_bitmask;
 243     op->reserved = nullptr;
 244     op++;
 245     op->op = GRPC_OP_RECV_MESSAGE;
 246     op->data.recv_message.recv_message = &response_payload_recv;
 247     op->flags = 0;
 248     op->reserved = nullptr;
 249     op++;
 250     error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(2),
 251                                   nullptr);
 252     GPR_ASSERT(GRPC_CALL_OK == error);
 253
 254     memset(ops, 0, sizeof(ops));
 255     op = ops;
 256     op->op = GRPC_OP_RECV_MESSAGE;
 257     op->data.recv_message.recv_message = &request_payload_recv;
 258     op->flags = 0;
 259     op->reserved = nullptr;
 260     op++;
 261     error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops),
 262                                   tag(102), nullptr);
 263     GPR_ASSERT(GRPC_CALL_OK == error);
 264     CQ_EXPECT_COMPLETION(cqv, tag(102), 1);
 265     cq_verify(cqv);
 266
 267     GPR_ASSERT(request_payload_recv->type == GRPC_BB_RAW);
 268     GPR_ASSERT(byte_buffer_eq_string(request_payload_recv, request_str));
 269     GPR_ASSERT(request_payload_recv->data.raw.compression ==
 270                expected_algorithm_from_client);
 271
 272     memset(ops, 0, sizeof(ops));
 273     op = ops;
 274     op->op = GRPC_OP_SEND_MESSAGE;
 275     op->data.send_message.send_message = response_payload;
 276     op->flags = 0;
 277     op->reserved = nullptr;
 278     op++;
 279     error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops),
 280                                   tag(103), nullptr);
 281     GPR_ASSERT(GRPC_CALL_OK == error);
 282     CQ_EXPECT_COMPLETION(cqv, tag(103), 1);
 283     CQ_EXPECT_COMPLETION(cqv, tag(2), 1);
 284     cq_verify(cqv);
 285
 286     GPR_ASSERT(response_payload_recv->type == GRPC_BB_RAW);
 287     GPR_ASSERT(byte_buffer_eq_string(response_payload_recv, response_str));
 288     if (server_compression_level > GRPC_COMPRESS_LEVEL_NONE) {
 289       const grpc_compression_algorithm algo_for_server_level =
 290           grpc_call_compression_for_level(s, server_compression_level);
 291       GPR_ASSERT(response_payload_recv->data.raw.compression ==
 292                  algo_for_server_level);
 293     } else {
 294       GPR_ASSERT(response_payload_recv->data.raw.compression ==
 295                  expected_algorithm_from_server);
 296     }
 297
 298     grpc_byte_buffer_destroy(request_payload);
 299     grpc_byte_buffer_destroy(response_payload);
 300     grpc_byte_buffer_destroy(request_payload_recv);
 301     grpc_byte_buffer_destroy(response_payload_recv);
 302   }
 303
 304   grpc_slice_unref(request_payload_slice);
 305   grpc_slice_unref(response_payload_slice);
 306
 307   memset(ops, 0, sizeof(ops));
 308   op = ops;
 309   op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
 310   op->flags = 0;
 311   op->reserved = nullptr;
 312   op++;
 313   error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(3),
 314                                 nullptr);
 315   GPR_ASSERT(GRPC_CALL_OK == error);
 316
 317   memset(ops, 0, sizeof(ops));
 318   op = ops;
 319   op->op = GRPC_OP_SEND_STATUS_FROM_SERVER;
 320   op->data.send_status_from_server.trailing_metadata_count = 0;
 321   op->data.send_status_from_server.status = GRPC_STATUS_OK;
 322   grpc_slice status_details = grpc_slice_from_static_string("xyz");
 323   op->data.send_status_from_server.status_details = &status_details;
 324   op->flags = 0;
 325   op->reserved = nullptr;
 326   op++;
 327   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(104),
 328                                 nullptr);
 329   GPR_ASSERT(GRPC_CALL_OK == error);
 330
 331   CQ_EXPECT_COMPLETION(cqv, tag(1), 1);
 332   CQ_EXPECT_COMPLETION(cqv, tag(3), 1);
 333   CQ_EXPECT_COMPLETION(cqv, tag(101), 1);
 334   CQ_EXPECT_COMPLETION(cqv, tag(104), 1);
 335   cq_verify(cqv);
 336
 337   GPR_ASSERT(status == GRPC_STATUS_OK);
 338   GPR_ASSERT(0 == grpc_slice_str_cmp(details, "xyz"));
 339   GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/foo"));
 340   GPR_ASSERT(was_cancelled == 0);
 341
 342   grpc_slice_unref(details);
 343   grpc_metadata_array_destroy(&initial_metadata_recv);
 344   grpc_metadata_array_destroy(&trailing_metadata_recv);
 345   grpc_metadata_array_destroy(&request_metadata_recv);
 346   grpc_call_details_destroy(&call_details);
 347
 348   grpc_call_unref(c);
 349   grpc_call_unref(s);
 350
 351   cq_verifier_destroy(cqv);
 352
 353   {
 354     grpc_core::ExecCtx exec_ctx;
 355     grpc_channel_args_destroy(client_args);
 356     grpc_channel_args_destroy(server_args);
 357   }
 358
 359   end_test(&f);
 360   config.tear_down_data(&f);
 361 }
 362
 363 typedef struct workaround_cronet_compression_config {
 364   char* user_agent_override;
 365   grpc_compression_algorithm expected_algorithm_from_server;
 366 } workaround_cronet_compression_config;
 367
 368 static workaround_cronet_compression_config workaround_configs[] = {
 369     {nullptr, GRPC_COMPRESS_GZIP},
 370     {const_cast<char*>(
 371          "grpc-objc/1.3.0-dev grpc-c/3.0.0-dev (ios; cronet_http; gentle)"),
 372      GRPC_COMPRESS_NONE},
 373     {const_cast<char*>(
 374          "grpc-objc/1.3.0-dev grpc-c/3.0.0-dev (ios; chttp2; gentle)"),
 375      GRPC_COMPRESS_GZIP},
 376     {const_cast<char*>(
 377          "grpc-objc/1.4.0 grpc-c/3.0.0-dev (ios; cronet_http; gentle)"),
 378      GRPC_COMPRESS_GZIP}};
 379 static const size_t workaround_configs_num =
 380     sizeof(workaround_configs) / sizeof(*workaround_configs);
 381
 382 static void test_workaround_cronet_compression(
 383     grpc_end2end_test_config config) {
 384   for (uint32_t i = 0; i < workaround_configs_num; i++) {
 385     request_with_payload_template(
 386         config, "test_invoke_request_with_compressed_payload", 0,
 387         GRPC_COMPRESS_GZIP, GRPC_COMPRESS_GZIP, GRPC_COMPRESS_GZIP,
 388         workaround_configs[i].expected_algorithm_from_server, nullptr, false,
 389         /* ignored */ GRPC_COMPRESS_LEVEL_NONE,
 390         workaround_configs[i].user_agent_override);
 391   }
 392 }
 393
 394 void workaround_cronet_compression(grpc_end2end_test_config config) {
 395   if (config.feature_mask & FEATURE_MASK_SUPPORTS_WORKAROUNDS) {
 396     test_workaround_cronet_compression(config);
 397   }
 398 }
 399
 400 void workaround_cronet_compression_pre_init(void) {}