test/core/end2end/tests/retry_recv_initial_metadata.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 "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/grpc.h>
  26 #include <grpc/support/alloc.h>
  27 #include <grpc/support/log.h>
  28 #include <grpc/support/string_util.h>
  29 #include <grpc/support/time.h>
  30
  31 #include "src/core/lib/channel/channel_args.h"
  32 #include "src/core/lib/gpr/string.h"
  33 #include "src/core/lib/gpr/useful.h"
  34 #include "src/core/lib/iomgr/exec_ctx.h"
  35 #include "src/core/lib/transport/static_metadata.h"
  36
  37 #include "test/core/end2end/cq_verifier.h"
  38 #include "test/core/end2end/tests/cancel_test_helpers.h"
  39
  40 static void* tag(intptr_t t) { return reinterpret_cast<void*>(t); }
  41
  42 static grpc_end2end_test_fixture begin_test(grpc_end2end_test_config config,
  43                                             const char* test_name,
  44                                             grpc_channel_args* client_args,
  45                                             grpc_channel_args* server_args) {
  46   grpc_end2end_test_fixture f;
  47   gpr_log(GPR_INFO, "Running test: %s/%s", test_name, config.name);
  48   f = config.create_fixture(client_args, server_args);
  49   config.init_server(&f, server_args);
  50   config.init_client(&f, client_args);
  51   return f;
  52 }
  53
  54 static gpr_timespec n_seconds_from_now(int n) {
  55   return grpc_timeout_seconds_to_deadline(n);
  56 }
  57
  58 static gpr_timespec five_seconds_from_now(void) {
  59   return n_seconds_from_now(5);
  60 }
  61
  62 static void drain_cq(grpc_completion_queue* cq) {
  63   grpc_event ev;
  64   do {
  65     ev = grpc_completion_queue_next(cq, five_seconds_from_now(), nullptr);
  66   } while (ev.type != GRPC_QUEUE_SHUTDOWN);
  67 }
  68
  69 static void shutdown_server(grpc_end2end_test_fixture* f) {
  70   if (!f->server) return;
  71   grpc_server_shutdown_and_notify(f->server, f->shutdown_cq, tag(1000));
  72   GPR_ASSERT(grpc_completion_queue_pluck(f->shutdown_cq, tag(1000),
  73                                          grpc_timeout_seconds_to_deadline(5),
  74                                          nullptr)
  75                  .type == GRPC_OP_COMPLETE);
  76   grpc_server_destroy(f->server);
  77   f->server = nullptr;
  78 }
  79
  80 static void shutdown_client(grpc_end2end_test_fixture* f) {
  81   if (!f->client) return;
  82   grpc_channel_destroy(f->client);
  83   f->client = nullptr;
  84 }
  85
  86 static void end_test(grpc_end2end_test_fixture* f) {
  87   shutdown_server(f);
  88   shutdown_client(f);
  89
  90   grpc_completion_queue_shutdown(f->cq);
  91   drain_cq(f->cq);
  92   grpc_completion_queue_destroy(f->cq);
  93   grpc_completion_queue_destroy(f->shutdown_cq);
  94 }
  95
  96 // Tests that receiving initial metadata commits the call.
  97 // - 1 retry allowed for ABORTED status
  98 // - first attempt receives initial metadata before trailing metadata,
  99 //   so no retry is done even though status was ABORTED
 100 static void test_retry_recv_initial_metadata(grpc_end2end_test_config config) {
 101   grpc_call* c;
 102   grpc_call* s;
 103   grpc_op ops[6];
 104   grpc_op* op;
 105   grpc_metadata_array initial_metadata_recv;
 106   grpc_metadata_array trailing_metadata_recv;
 107   grpc_metadata_array request_metadata_recv;
 108   grpc_call_details call_details;
 109   grpc_slice request_payload_slice = grpc_slice_from_static_string("foo");
 110   grpc_slice response_payload_slice = grpc_slice_from_static_string("bar");
 111   grpc_byte_buffer* request_payload =
 112       grpc_raw_byte_buffer_create(&request_payload_slice, 1);
 113   grpc_byte_buffer* response_payload =
 114       grpc_raw_byte_buffer_create(&response_payload_slice, 1);
 115   grpc_byte_buffer* request_payload_recv = nullptr;
 116   grpc_byte_buffer* response_payload_recv = nullptr;
 117   grpc_status_code status;
 118   grpc_call_error error;
 119   grpc_slice details;
 120   int was_cancelled = 2;
 121   char* peer;
 122   grpc_metadata initial_metadata_from_server = {
 123       grpc_slice_from_static_string("key1"),
 124       grpc_slice_from_static_string("val1"),
 125       {{nullptr, nullptr, nullptr, nullptr}}};
 126
 127   grpc_arg args[] = {
 128       grpc_channel_arg_string_create(
 129           const_cast<char*>(GRPC_ARG_SERVICE_CONFIG),
 130           const_cast<char*>(
 131               "{\n"
 132               "  \"methodConfig\": [ {\n"
 133               "    \"name\": [\n"
 134               "      { \"service\": \"service\", \"method\": \"method\" }\n"
 135               "    ],\n"
 136               "    \"retryPolicy\": {\n"
 137               "      \"maxAttempts\": 2,\n"
 138               "      \"initialBackoff\": \"1s\",\n"
 139               "      \"maxBackoff\": \"120s\",\n"
 140               "      \"backoffMultiplier\": 1.6,\n"
 141               "      \"retryableStatusCodes\": [ \"ABORTED\" ]\n"
 142               "    }\n"
 143               "  } ]\n"
 144               "}")),
 145   };
 146   grpc_channel_args client_args = {GPR_ARRAY_SIZE(args), args};
 147   grpc_end2end_test_fixture f =
 148       begin_test(config, "retry_recv_initial_metadata", &client_args, nullptr);
 149
 150   cq_verifier* cqv = cq_verifier_create(f.cq);
 151
 152   gpr_timespec deadline = five_seconds_from_now();
 153   c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
 154                                grpc_slice_from_static_string("/service/method"),
 155                                nullptr, deadline, nullptr);
 156   GPR_ASSERT(c);
 157
 158   peer = grpc_call_get_peer(c);
 159   GPR_ASSERT(peer != nullptr);
 160   gpr_log(GPR_DEBUG, "client_peer_before_call=%s", peer);
 161   gpr_free(peer);
 162
 163   grpc_metadata_array_init(&initial_metadata_recv);
 164   grpc_metadata_array_init(&trailing_metadata_recv);
 165   grpc_metadata_array_init(&request_metadata_recv);
 166   grpc_call_details_init(&call_details);
 167   grpc_slice status_details = grpc_slice_from_static_string("xyz");
 168
 169   memset(ops, 0, sizeof(ops));
 170   op = ops;
 171   op->op = GRPC_OP_SEND_INITIAL_METADATA;
 172   op->data.send_initial_metadata.count = 0;
 173   op++;
 174   op->op = GRPC_OP_SEND_MESSAGE;
 175   op->data.send_message.send_message = request_payload;
 176   op++;
 177   op->op = GRPC_OP_RECV_MESSAGE;
 178   op->data.recv_message.recv_message = &response_payload_recv;
 179   op++;
 180   op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
 181   op++;
 182   op->op = GRPC_OP_RECV_INITIAL_METADATA;
 183   op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
 184   op++;
 185   op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
 186   op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
 187   op->data.recv_status_on_client.status = &status;
 188   op->data.recv_status_on_client.status_details = &details;
 189   op++;
 190   error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(1),
 191                                 nullptr);
 192   GPR_ASSERT(GRPC_CALL_OK == error);
 193
 194   error =
 195       grpc_server_request_call(f.server, &s, &call_details,
 196                                &request_metadata_recv, f.cq, f.cq, tag(101));
 197   GPR_ASSERT(GRPC_CALL_OK == error);
 198   CQ_EXPECT_COMPLETION(cqv, tag(101), true);
 199   cq_verify(cqv);
 200
 201   peer = grpc_call_get_peer(s);
 202   GPR_ASSERT(peer != nullptr);
 203   gpr_log(GPR_DEBUG, "server_peer=%s", peer);
 204   gpr_free(peer);
 205   peer = grpc_call_get_peer(c);
 206   GPR_ASSERT(peer != nullptr);
 207   gpr_log(GPR_DEBUG, "client_peer=%s", peer);
 208   gpr_free(peer);
 209
 210   // Server sends initial metadata in its own batch, before sending
 211   // trailing metadata.
 212   // Ideally, this would not require actually sending any metadata
 213   // entries, but we do so to avoid sporadic failures in the proxy
 214   // tests, where the proxy may wind up combining the batches, depending
 215   // on timing.  Sending a metadata entry ensures that the transport
 216   // won't send a Trailers-Only response, even if the batches are combined.
 217   memset(ops, 0, sizeof(ops));
 218   op = ops;
 219   op->op = GRPC_OP_SEND_INITIAL_METADATA;
 220   op->data.send_initial_metadata.count = 1;
 221   op->data.send_initial_metadata.metadata = &initial_metadata_from_server;
 222   op++;
 223   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(102),
 224                                 nullptr);
 225   GPR_ASSERT(GRPC_CALL_OK == error);
 226
 227   CQ_EXPECT_COMPLETION(cqv, tag(102), true);
 228   cq_verify(cqv);
 229
 230   memset(ops, 0, sizeof(ops));
 231   op = ops;
 232   op->op = GRPC_OP_SEND_STATUS_FROM_SERVER;
 233   op->data.send_status_from_server.trailing_metadata_count = 0;
 234   op->data.send_status_from_server.status = GRPC_STATUS_ABORTED;
 235   op->data.send_status_from_server.status_details = &status_details;
 236   op++;
 237   op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
 238   op->data.recv_close_on_server.cancelled = &was_cancelled;
 239   op++;
 240   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(103),
 241                                 nullptr);
 242   GPR_ASSERT(GRPC_CALL_OK == error);
 243
 244   CQ_EXPECT_COMPLETION(cqv, tag(103), true);
 245   CQ_EXPECT_COMPLETION(cqv, tag(1), true);
 246   cq_verify(cqv);
 247
 248   GPR_ASSERT(status == GRPC_STATUS_ABORTED);
 249   GPR_ASSERT(0 == grpc_slice_str_cmp(details, "xyz"));
 250   GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/service/method"));
 251   GPR_ASSERT(0 == call_details.flags);
 252   GPR_ASSERT(was_cancelled == 0);
 253
 254   grpc_slice_unref(details);
 255   grpc_metadata_array_destroy(&initial_metadata_recv);
 256   grpc_metadata_array_destroy(&trailing_metadata_recv);
 257   grpc_metadata_array_destroy(&request_metadata_recv);
 258   grpc_call_details_destroy(&call_details);
 259   grpc_byte_buffer_destroy(request_payload);
 260   grpc_byte_buffer_destroy(response_payload);
 261   grpc_byte_buffer_destroy(request_payload_recv);
 262   grpc_byte_buffer_destroy(response_payload_recv);
 263
 264   grpc_call_unref(c);
 265   grpc_call_unref(s);
 266
 267   cq_verifier_destroy(cqv);
 268
 269   end_test(&f);
 270   config.tear_down_data(&f);
 271 }
 272
 273 void retry_recv_initial_metadata(grpc_end2end_test_config config) {
 274   GPR_ASSERT(config.feature_mask & FEATURE_MASK_SUPPORTS_CLIENT_CHANNEL);
 275   test_retry_recv_initial_metadata(config);
 276 }
 277
 278 void retry_recv_initial_metadata_pre_init(void) {}