test/core/end2end/tests/cancel_after_round_trip.cc

   1 /*
   2  *
   3  * Copyright 2017 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 <stdio.h>
  20 #include <string.h>
  21
  22 #include <grpc/byte_buffer.h>
  23 #include <grpc/support/alloc.h>
  24 #include <grpc/support/log.h>
  25 #include <grpc/support/time.h>
  26
  27 #include "src/core/lib/channel/channel_args.h"
  28 #include "src/core/lib/iomgr/exec_ctx.h"
  29 #include "src/core/lib/slice/slice_internal.h"
  30 #include "src/core/lib/transport/metadata.h"
  31 #include "test/core/end2end/cq_verifier.h"
  32 #include "test/core/end2end/end2end_tests.h"
  33 #include "test/core/end2end/tests/cancel_test_helpers.h"
  34
  35 static void* tag(intptr_t t) { return reinterpret_cast<void*>(t); }
  36
  37 static grpc_end2end_test_fixture begin_test(grpc_end2end_test_config config,
  38                                             const char* test_name,
  39                                             cancellation_mode mode,
  40                                             bool use_service_config,
  41                                             grpc_channel_args* client_args,
  42                                             grpc_channel_args* server_args) {
  43   grpc_end2end_test_fixture f;
  44   gpr_log(GPR_INFO, "Running test: %s/%s/%s/%s", test_name, config.name,
  45           mode.name, use_service_config ? "service_config" : "client_api");
  46   f = config.create_fixture(client_args, server_args);
  47   config.init_server(&f, server_args);
  48   config.init_client(&f, client_args);
  49   return f;
  50 }
  51
  52 static gpr_timespec n_seconds_from_now(int n) {
  53   return grpc_timeout_seconds_to_deadline(n);
  54 }
  55
  56 static gpr_timespec five_seconds_from_now(void) {
  57   return n_seconds_from_now(5);
  58 }
  59
  60 static void drain_cq(grpc_completion_queue* cq) {
  61   grpc_event ev;
  62   do {
  63     ev = grpc_completion_queue_next(cq, five_seconds_from_now(), nullptr);
  64   } while (ev.type != GRPC_QUEUE_SHUTDOWN);
  65 }
  66
  67 static void shutdown_server(grpc_end2end_test_fixture* f) {
  68   if (!f->server) return;
  69   grpc_server_shutdown_and_notify(f->server, f->shutdown_cq, tag(1000));
  70   GPR_ASSERT(grpc_completion_queue_pluck(f->shutdown_cq, tag(1000),
  71                                          grpc_timeout_seconds_to_deadline(5),
  72                                          nullptr)
  73                  .type == GRPC_OP_COMPLETE);
  74   grpc_server_destroy(f->server);
  75   f->server = nullptr;
  76 }
  77
  78 static void shutdown_client(grpc_end2end_test_fixture* f) {
  79   if (!f->client) return;
  80   grpc_channel_destroy(f->client);
  81   f->client = nullptr;
  82 }
  83
  84 static void end_test(grpc_end2end_test_fixture* f) {
  85   shutdown_server(f);
  86   shutdown_client(f);
  87
  88   grpc_completion_queue_shutdown(f->cq);
  89   drain_cq(f->cq);
  90   grpc_completion_queue_destroy(f->cq);
  91   grpc_completion_queue_destroy(f->shutdown_cq);
  92 }
  93
  94 /* Cancel after accept, no payload */
  95 static void test_cancel_after_round_trip(grpc_end2end_test_config config,
  96                                          cancellation_mode mode,
  97                                          bool use_service_config) {
  98   grpc_op ops[6];
  99   grpc_op* op;
 100   grpc_call* c;
 101   grpc_call* s;
 102   grpc_metadata_array initial_metadata_recv;
 103   grpc_metadata_array trailing_metadata_recv;
 104   grpc_metadata_array request_metadata_recv;
 105   grpc_call_details call_details;
 106   grpc_status_code status;
 107   grpc_call_error error;
 108   grpc_slice details;
 109   grpc_byte_buffer* request_payload_recv = nullptr;
 110   grpc_byte_buffer* response_payload_recv = nullptr;
 111   grpc_slice request_payload_slice =
 112       grpc_slice_from_copied_string("hello world");
 113   grpc_slice response_payload_slice =
 114       grpc_slice_from_copied_string("hello you");
 115   grpc_byte_buffer* request_payload =
 116       grpc_raw_byte_buffer_create(&request_payload_slice, 1);
 117   grpc_byte_buffer* response_payload1 =
 118       grpc_raw_byte_buffer_create(&response_payload_slice, 1);
 119   grpc_byte_buffer* response_payload2 =
 120       grpc_raw_byte_buffer_create(&response_payload_slice, 1);
 121   int was_cancelled = 2;
 122
 123   grpc_channel_args* args = nullptr;
 124   if (use_service_config) {
 125     grpc_arg arg;
 126     arg.type = GRPC_ARG_STRING;
 127     arg.key = const_cast<char*>(GRPC_ARG_SERVICE_CONFIG);
 128     arg.value.string = const_cast<char*>(
 129         "{\n"
 130         "  \"methodConfig\": [ {\n"
 131         "    \"name\": [\n"
 132         "      { \"service\": \"service\", \"method\": \"method\" }\n"
 133         "    ],\n"
 134         "    \"timeout\": \"5s\"\n"
 135         "  } ]\n"
 136         "}");
 137     args = grpc_channel_args_copy_and_add(args, &arg, 1);
 138   }
 139
 140   grpc_end2end_test_fixture f =
 141       begin_test(config, "cancel_after_round_trip", mode, use_service_config,
 142                  args, nullptr);
 143   cq_verifier* cqv = cq_verifier_create(f.cq);
 144
 145   gpr_timespec deadline = use_service_config
 146                               ? gpr_inf_future(GPR_CLOCK_MONOTONIC)
 147                               : five_seconds_from_now();
 148   c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
 149                                grpc_slice_from_static_string("/service/method"),
 150                                nullptr, deadline, nullptr);
 151   GPR_ASSERT(c);
 152
 153   grpc_metadata_array_init(&initial_metadata_recv);
 154   grpc_metadata_array_init(&trailing_metadata_recv);
 155   grpc_metadata_array_init(&request_metadata_recv);
 156   grpc_call_details_init(&call_details);
 157
 158   memset(ops, 0, sizeof(ops));
 159   op = ops;
 160   op->op = GRPC_OP_SEND_INITIAL_METADATA;
 161   op->data.send_initial_metadata.count = 0;
 162   op->flags = 0;
 163   op->reserved = nullptr;
 164   op++;
 165   op->op = GRPC_OP_SEND_MESSAGE;
 166   op->data.send_message.send_message = request_payload;
 167   op->flags = 0;
 168   op->reserved = nullptr;
 169   op++;
 170   op->op = GRPC_OP_RECV_INITIAL_METADATA;
 171   op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
 172   op->flags = 0;
 173   op->reserved = nullptr;
 174   op++;
 175   op->op = GRPC_OP_RECV_MESSAGE;
 176   op->data.recv_message.recv_message = &response_payload_recv;
 177   op->flags = 0;
 178   op->reserved = nullptr;
 179   op++;
 180   error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(1),
 181                                 nullptr);
 182   GPR_ASSERT(GRPC_CALL_OK == error);
 183
 184   error =
 185       grpc_server_request_call(f.server, &s, &call_details,
 186                                &request_metadata_recv, f.cq, f.cq, tag(101));
 187   GPR_ASSERT(GRPC_CALL_OK == error);
 188   CQ_EXPECT_COMPLETION(cqv, tag(101), 1);
 189   cq_verify(cqv);
 190
 191   memset(ops, 0, sizeof(ops));
 192   op = ops;
 193   op->op = GRPC_OP_RECV_MESSAGE;
 194   op->data.recv_message.recv_message = &request_payload_recv;
 195   op->flags = 0;
 196   op->reserved = nullptr;
 197   op++;
 198   op->op = GRPC_OP_SEND_INITIAL_METADATA;
 199   op->data.send_initial_metadata.count = 0;
 200   op->flags = 0;
 201   op->reserved = nullptr;
 202   op++;
 203   op->op = GRPC_OP_SEND_MESSAGE;
 204   op->data.send_message.send_message = response_payload1;
 205   op->flags = 0;
 206   op->reserved = nullptr;
 207   op++;
 208   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(102),
 209                                 nullptr);
 210   GPR_ASSERT(GRPC_CALL_OK == error);
 211
 212   CQ_EXPECT_COMPLETION(cqv, tag(102), 1);
 213   CQ_EXPECT_COMPLETION(cqv, tag(1), 1);
 214   cq_verify(cqv);
 215
 216   grpc_byte_buffer_destroy(request_payload_recv);
 217   grpc_byte_buffer_destroy(response_payload_recv);
 218   request_payload_recv = nullptr;
 219   response_payload_recv = nullptr;
 220
 221   memset(ops, 0, sizeof(ops));
 222   op = ops;
 223   op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
 224   op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
 225   op->data.recv_status_on_client.status = &status;
 226   op->data.recv_status_on_client.status_details = &details;
 227   op->flags = 0;
 228   op->reserved = nullptr;
 229   op++;
 230   op->op = GRPC_OP_RECV_MESSAGE;
 231   op->data.recv_message.recv_message = &response_payload_recv;
 232   op->flags = 0;
 233   op->reserved = nullptr;
 234   op++;
 235   error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(2),
 236                                 nullptr);
 237   GPR_ASSERT(GRPC_CALL_OK == error);
 238
 239   GPR_ASSERT(GRPC_CALL_OK == mode.initiate_cancel(c, nullptr));
 240
 241   memset(ops, 0, sizeof(ops));
 242   op = ops;
 243   op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
 244   op->data.recv_close_on_server.cancelled = &was_cancelled;
 245   op->flags = 0;
 246   op->reserved = nullptr;
 247   op++;
 248   op->op = GRPC_OP_SEND_MESSAGE;
 249   op->data.send_message.send_message = response_payload2;
 250   op->flags = 0;
 251   op->reserved = nullptr;
 252   op++;
 253   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(103),
 254                                 nullptr);
 255   GPR_ASSERT(GRPC_CALL_OK == error);
 256
 257   CQ_EXPECT_COMPLETION(cqv, tag(2), 1);
 258   CQ_EXPECT_COMPLETION(cqv, tag(103), 1);
 259   cq_verify(cqv);
 260
 261   GPR_ASSERT(status == mode.expect_status || status == GRPC_STATUS_INTERNAL);
 262   GPR_ASSERT(was_cancelled == 1);
 263
 264   grpc_metadata_array_destroy(&initial_metadata_recv);
 265   grpc_metadata_array_destroy(&trailing_metadata_recv);
 266   grpc_metadata_array_destroy(&request_metadata_recv);
 267   grpc_call_details_destroy(&call_details);
 268
 269   grpc_byte_buffer_destroy(request_payload);
 270   grpc_byte_buffer_destroy(response_payload1);
 271   grpc_byte_buffer_destroy(response_payload2);
 272   grpc_byte_buffer_destroy(request_payload_recv);
 273   grpc_byte_buffer_destroy(response_payload_recv);
 274   grpc_slice_unref(details);
 275
 276   grpc_call_unref(c);
 277   grpc_call_unref(s);
 278
 279   if (args != nullptr) {
 280     grpc_core::ExecCtx exec_ctx;
 281     grpc_channel_args_destroy(args);
 282   }
 283
 284   cq_verifier_destroy(cqv);
 285   end_test(&f);
 286   config.tear_down_data(&f);
 287 }
 288
 289 void cancel_after_round_trip(grpc_end2end_test_config config) {
 290   unsigned i;
 291
 292   for (i = 0; i < GPR_ARRAY_SIZE(cancellation_modes); i++) {
 293     test_cancel_after_round_trip(config, cancellation_modes[i],
 294                                  false /* use_service_config */);
 295     if (config.feature_mask & FEATURE_MASK_SUPPORTS_CLIENT_CHANNEL &&
 296         cancellation_modes[i].expect_status == GRPC_STATUS_DEADLINE_EXCEEDED) {
 297       test_cancel_after_round_trip(config, cancellation_modes[i],
 298                                    true /* use_service_config */);
 299     }
 300   }
 301 }
 302
 303 void cancel_after_round_trip_pre_init(void) {}