test/core/end2end/tests/simple_request.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/grpc.h>
  26 #include <grpc/support/alloc.h>
  27 #include <grpc/support/log.h>
  28 #include <grpc/support/time.h>
  29 #include "src/core/lib/debug/stats.h"
  30 #include "src/core/lib/gpr/string.h"
  31 #include "test/core/end2end/cq_verifier.h"
  32
  33 static void* tag(intptr_t t) { return (void*)t; }
  34
  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
  47 static gpr_timespec n_seconds_from_now(int n) {
  48   return grpc_timeout_seconds_to_deadline(n);
  49 }
  50
  51 static gpr_timespec five_seconds_from_now(void) {
  52   return n_seconds_from_now(5);
  53 }
  54
  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
  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
  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
  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 static void simple_request_body(grpc_end2end_test_config config,
  90                                 grpc_end2end_test_fixture f) {
  91   grpc_call* c;
  92   grpc_call* s;
  93   cq_verifier* cqv = cq_verifier_create(f.cq);
  94   grpc_op ops[6];
  95   grpc_op* op;
  96   grpc_metadata_array initial_metadata_recv;
  97   grpc_metadata_array trailing_metadata_recv;
  98   grpc_metadata_array request_metadata_recv;
  99   grpc_call_details call_details;
 100   grpc_status_code status;
 101   const char* error_string;
 102   grpc_call_error error;
 103   grpc_slice details;
 104   int was_cancelled = 2;
 105   char* peer;
 106   grpc_stats_data* before =
 107       static_cast<grpc_stats_data*>(gpr_malloc(sizeof(grpc_stats_data)));
 108   grpc_stats_data* after =
 109       static_cast<grpc_stats_data*>(gpr_malloc(sizeof(grpc_stats_data)));
 110
 111 #if defined(GRPC_COLLECT_STATS) || !defined(NDEBUG)
 112   grpc_stats_collect(before);
 113 #endif /* defined(GRPC_COLLECT_STATS) || !defined(NDEBUG) */
 114
 115   gpr_timespec deadline = five_seconds_from_now();
 116   c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
 117                                grpc_slice_from_static_string("/foo"), nullptr,
 118                                deadline, nullptr);
 119   GPR_ASSERT(c);
 120
 121   peer = grpc_call_get_peer(c);
 122   GPR_ASSERT(peer != nullptr);
 123   gpr_log(GPR_DEBUG, "client_peer_before_call=%s", peer);
 124   gpr_free(peer);
 125
 126   grpc_metadata_array_init(&initial_metadata_recv);
 127   grpc_metadata_array_init(&trailing_metadata_recv);
 128   grpc_metadata_array_init(&request_metadata_recv);
 129   grpc_call_details_init(&call_details);
 130
 131   memset(ops, 0, sizeof(ops));
 132   op = ops;
 133   op->op = GRPC_OP_SEND_INITIAL_METADATA;
 134   op->data.send_initial_metadata.count = 0;
 135   op->flags = 0;
 136   op->reserved = nullptr;
 137   op++;
 138   op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
 139   op->flags = 0;
 140   op->reserved = nullptr;
 141   op++;
 142   op->op = GRPC_OP_RECV_INITIAL_METADATA;
 143   op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
 144   op->flags = 0;
 145   op->reserved = nullptr;
 146   op++;
 147   op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
 148   op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
 149   op->data.recv_status_on_client.status = &status;
 150   op->data.recv_status_on_client.status_details = &details;
 151   op->data.recv_status_on_client.error_string = &error_string;
 152   op->flags = 0;
 153   op->reserved = nullptr;
 154   op++;
 155   error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(1),
 156                                 nullptr);
 157   GPR_ASSERT(GRPC_CALL_OK == error);
 158
 159   error =
 160       grpc_server_request_call(f.server, &s, &call_details,
 161                                &request_metadata_recv, f.cq, f.cq, tag(101));
 162   GPR_ASSERT(GRPC_CALL_OK == error);
 163   CQ_EXPECT_COMPLETION(cqv, tag(101), 1);
 164   cq_verify(cqv);
 165
 166   peer = grpc_call_get_peer(s);
 167   GPR_ASSERT(peer != nullptr);
 168   gpr_log(GPR_DEBUG, "server_peer=%s", peer);
 169   gpr_free(peer);
 170   peer = grpc_call_get_peer(c);
 171   GPR_ASSERT(peer != nullptr);
 172   gpr_log(GPR_DEBUG, "client_peer=%s", peer);
 173   gpr_free(peer);
 174
 175   memset(ops, 0, sizeof(ops));
 176   op = ops;
 177   op->op = GRPC_OP_SEND_INITIAL_METADATA;
 178   op->data.send_initial_metadata.count = 0;
 179   op->flags = 0;
 180   op->reserved = nullptr;
 181   op++;
 182   op->op = GRPC_OP_SEND_STATUS_FROM_SERVER;
 183   op->data.send_status_from_server.trailing_metadata_count = 0;
 184   op->data.send_status_from_server.status = GRPC_STATUS_UNIMPLEMENTED;
 185   grpc_slice status_details = grpc_slice_from_static_string("xyz");
 186   op->data.send_status_from_server.status_details = &status_details;
 187   op->flags = 0;
 188   op->reserved = nullptr;
 189   op++;
 190   op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
 191   op->data.recv_close_on_server.cancelled = &was_cancelled;
 192   op->flags = 0;
 193   op->reserved = nullptr;
 194   op++;
 195   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(102),
 196                                 nullptr);
 197   GPR_ASSERT(GRPC_CALL_OK == error);
 198
 199   CQ_EXPECT_COMPLETION(cqv, tag(102), 1);
 200   CQ_EXPECT_COMPLETION(cqv, tag(1), 1);
 201   cq_verify(cqv);
 202
 203   GPR_ASSERT(status == GRPC_STATUS_UNIMPLEMENTED);
 204   GPR_ASSERT(0 == grpc_slice_str_cmp(details, "xyz"));
 205   // the following sanity check makes sure that the requested error string is
 206   // correctly populated by the core. It looks for certain substrings that are
 207   // not likely to change much. Some parts of the error, like time created,
 208   // obviously are not checked.
 209   GPR_ASSERT(nullptr != strstr(error_string, "xyz"));
 210   GPR_ASSERT(nullptr != strstr(error_string, "description"));
 211   GPR_ASSERT(nullptr != strstr(error_string, "Error received from peer"));
 212   GPR_ASSERT(nullptr != strstr(error_string, "grpc_message"));
 213   GPR_ASSERT(nullptr != strstr(error_string, "grpc_status"));
 214   GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/foo"));
 215   GPR_ASSERT(0 == call_details.flags);
 216   GPR_ASSERT(was_cancelled == 1);
 217
 218   grpc_slice_unref(details);
 219   gpr_free((void*)error_string);
 220   grpc_metadata_array_destroy(&initial_metadata_recv);
 221   grpc_metadata_array_destroy(&trailing_metadata_recv);
 222   grpc_metadata_array_destroy(&request_metadata_recv);
 223   grpc_call_details_destroy(&call_details);
 224
 225   grpc_call_unref(c);
 226   grpc_call_unref(s);
 227
 228   cq_verifier_destroy(cqv);
 229
 230   int expected_calls = 1;
 231   if (config.feature_mask & FEATURE_MASK_SUPPORTS_REQUEST_PROXYING) {
 232     expected_calls *= 2;
 233   }
 234 #if defined(GRPC_COLLECT_STATS) || !defined(NDEBUG)
 235
 236   grpc_stats_collect(after);
 237
 238   char* stats = grpc_stats_data_as_json(after);
 239   gpr_log(GPR_DEBUG, "%s", stats);
 240   gpr_free(stats);
 241
 242   GPR_ASSERT(after->counters[GRPC_STATS_COUNTER_CLIENT_CALLS_CREATED] -
 243                  before->counters[GRPC_STATS_COUNTER_CLIENT_CALLS_CREATED] ==
 244              expected_calls);
 245   GPR_ASSERT(after->counters[GRPC_STATS_COUNTER_SERVER_CALLS_CREATED] -
 246                  before->counters[GRPC_STATS_COUNTER_SERVER_CALLS_CREATED] ==
 247              expected_calls);
 248 #endif /* defined(GRPC_COLLECT_STATS) || !defined(NDEBUG) */
 249   gpr_free(before);
 250   gpr_free(after);
 251 }
 252
 253 static void test_invoke_simple_request(grpc_end2end_test_config config) {
 254   grpc_end2end_test_fixture f;
 255
 256   f = begin_test(config, "test_invoke_simple_request", nullptr, nullptr);
 257   simple_request_body(config, f);
 258   end_test(&f);
 259   config.tear_down_data(&f);
 260 }
 261
 262 static void test_invoke_10_simple_requests(grpc_end2end_test_config config) {
 263   int i;
 264   grpc_end2end_test_fixture f =
 265       begin_test(config, "test_invoke_10_simple_requests", nullptr, nullptr);
 266   for (i = 0; i < 10; i++) {
 267     simple_request_body(config, f);
 268     gpr_log(GPR_INFO, "Running test: Passed simple request %d", i);
 269   }
 270   end_test(&f);
 271   config.tear_down_data(&f);
 272 }
 273
 274 void simple_request(grpc_end2end_test_config config) {
 275   int i;
 276   for (i = 0; i < 10; i++) {
 277     test_invoke_simple_request(config);
 278   }
 279   test_invoke_10_simple_requests(config);
 280 }
 281
 282 void simple_request_pre_init(void) {}