Home | History | Annotate | Download | only in tests
      1 /*
      2  *
      3  * Copyright 2016 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 #include "src/core/lib/gpr/string.h"
     31 #include "src/core/lib/iomgr/error.h"
     32 #include "test/core/end2end/cq_verifier.h"
     33 
     34 static void* tag(intptr_t t) { return (void*)t; }
     35 
     36 static grpc_end2end_test_fixture begin_test(grpc_end2end_test_config config,
     37                                             const char* test_name,
     38                                             grpc_channel_args* client_args,
     39                                             grpc_channel_args* server_args) {
     40   grpc_end2end_test_fixture f;
     41   gpr_log(GPR_INFO, "Running test: %s/%s", test_name, config.name);
     42   f = config.create_fixture(client_args, server_args);
     43   config.init_server(&f, server_args);
     44   config.init_client(&f, client_args);
     45   return f;
     46 }
     47 
     48 static gpr_timespec n_seconds_from_now(int n) {
     49   return grpc_timeout_seconds_to_deadline(n);
     50 }
     51 
     52 static gpr_timespec five_seconds_from_now(void) {
     53   return n_seconds_from_now(5);
     54 }
     55 
     56 static void drain_cq(grpc_completion_queue* cq) {
     57   grpc_event ev;
     58   do {
     59     ev = grpc_completion_queue_next(cq, five_seconds_from_now(), nullptr);
     60   } while (ev.type != GRPC_QUEUE_SHUTDOWN);
     61 }
     62 
     63 static void shutdown_server(grpc_end2end_test_fixture* f) {
     64   if (!f->server) return;
     65   grpc_server_shutdown_and_notify(f->server, f->shutdown_cq, tag(1000));
     66   GPR_ASSERT(grpc_completion_queue_pluck(f->shutdown_cq, tag(1000),
     67                                          grpc_timeout_seconds_to_deadline(5),
     68                                          nullptr)
     69                  .type == GRPC_OP_COMPLETE);
     70   grpc_server_destroy(f->server);
     71   f->server = nullptr;
     72 }
     73 
     74 static void shutdown_client(grpc_end2end_test_fixture* f) {
     75   if (!f->client) return;
     76   grpc_channel_destroy(f->client);
     77   f->client = nullptr;
     78 }
     79 
     80 static void end_test(grpc_end2end_test_fixture* f) {
     81   shutdown_server(f);
     82   shutdown_client(f);
     83 
     84   grpc_completion_queue_shutdown(f->cq);
     85   drain_cq(f->cq);
     86   grpc_completion_queue_destroy(f->cq);
     87   grpc_completion_queue_destroy(f->shutdown_cq);
     88 }
     89 
     90 static void simple_request_body(grpc_end2end_test_config config,
     91                                 grpc_end2end_test_fixture f) {
     92   grpc_call* c;
     93   grpc_call* s;
     94   cq_verifier* cqv = cq_verifier_create(f.cq);
     95   grpc_op ops[6];
     96   grpc_op* op;
     97   grpc_metadata_array initial_metadata_recv;
     98   grpc_metadata_array trailing_metadata_recv;
     99   grpc_metadata_array request_metadata_recv;
    100   grpc_call_details call_details;
    101   grpc_status_code status;
    102   grpc_call_error error;
    103   grpc_slice details;
    104   int was_cancelled = 2;
    105   char* peer;
    106 
    107   gpr_timespec deadline = five_seconds_from_now();
    108   c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
    109                                grpc_slice_from_static_string("/foo"), nullptr,
    110                                deadline, nullptr);
    111   GPR_ASSERT(c);
    112 
    113   peer = grpc_call_get_peer(c);
    114   GPR_ASSERT(peer != nullptr);
    115   gpr_free(peer);
    116 
    117   grpc_metadata_array_init(&initial_metadata_recv);
    118   grpc_metadata_array_init(&trailing_metadata_recv);
    119   grpc_metadata_array_init(&request_metadata_recv);
    120   grpc_call_details_init(&call_details);
    121 
    122   memset(ops, 0, sizeof(ops));
    123   op = ops;
    124   op->op = GRPC_OP_SEND_INITIAL_METADATA;
    125   op->data.send_initial_metadata.count = 0;
    126   op->flags = 0;
    127   op->reserved = nullptr;
    128   op++;
    129   op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
    130   op->flags = 0;
    131   op->reserved = nullptr;
    132   op++;
    133   op->op = GRPC_OP_RECV_INITIAL_METADATA;
    134   op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
    135   op->flags = 0;
    136   op->reserved = nullptr;
    137   op++;
    138   op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
    139   op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
    140   op->data.recv_status_on_client.status = &status;
    141   op->data.recv_status_on_client.status_details = &details;
    142   op->flags = 0;
    143   op->reserved = nullptr;
    144   op++;
    145   error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(1),
    146                                 nullptr);
    147   GPR_ASSERT(GRPC_CALL_OK == error);
    148 
    149   error =
    150       grpc_server_request_call(f.server, &s, &call_details,
    151                                &request_metadata_recv, f.cq, f.cq, tag(101));
    152   GPR_ASSERT(GRPC_CALL_OK == error);
    153   CQ_EXPECT_COMPLETION(cqv, tag(101), 1);
    154   cq_verify(cqv);
    155 
    156   peer = grpc_call_get_peer(s);
    157   GPR_ASSERT(peer != nullptr);
    158   gpr_free(peer);
    159   peer = grpc_call_get_peer(c);
    160   GPR_ASSERT(peer != nullptr);
    161   gpr_free(peer);
    162 
    163   memset(ops, 0, sizeof(ops));
    164   op = ops;
    165   op->op = GRPC_OP_SEND_INITIAL_METADATA;
    166   op->data.send_initial_metadata.count = 0;
    167   op->flags = 0;
    168   op->reserved = nullptr;
    169   op++;
    170   op->op = GRPC_OP_SEND_STATUS_FROM_SERVER;
    171   op->data.send_status_from_server.trailing_metadata_count = 0;
    172   op->data.send_status_from_server.status = GRPC_STATUS_OK;
    173   op->data.send_status_from_server.status_details = nullptr;
    174   op->flags = 0;
    175   op->reserved = nullptr;
    176   op++;
    177   op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
    178   op->data.recv_close_on_server.cancelled = &was_cancelled;
    179   op->flags = 0;
    180   op->reserved = nullptr;
    181   op++;
    182   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(102),
    183                                 nullptr);
    184   GPR_ASSERT(GRPC_CALL_OK == error);
    185 
    186   CQ_EXPECT_COMPLETION(cqv, tag(102), 1);
    187   CQ_EXPECT_COMPLETION(cqv, tag(1), 1);
    188   cq_verify(cqv);
    189 
    190   GPR_ASSERT(status == GRPC_STATUS_OK);
    191   GPR_ASSERT(GRPC_SLICE_LENGTH(details) == 0);
    192   GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/foo"));
    193   GPR_ASSERT(0 == call_details.flags);
    194   GPR_ASSERT(was_cancelled == 0);
    195 
    196   grpc_slice_unref(details);
    197   grpc_metadata_array_destroy(&initial_metadata_recv);
    198   grpc_metadata_array_destroy(&trailing_metadata_recv);
    199   grpc_metadata_array_destroy(&request_metadata_recv);
    200   grpc_call_details_destroy(&call_details);
    201 
    202   grpc_call_unref(c);
    203   grpc_call_unref(s);
    204 
    205   cq_verifier_destroy(cqv);
    206 }
    207 
    208 static void test_no_error_on_hotpath_one_request(
    209     grpc_end2end_test_config config) {
    210   grpc_end2end_test_fixture f;
    211 
    212   f = begin_test(config, "test_invoke_simple_request_with_no_error_logging",
    213                  nullptr, nullptr);
    214   // First RPC is not considered the hotpath, since there are lots of things to
    215   // set up.
    216   simple_request_body(config, f);
    217   grpc_disable_error_creation();
    218   simple_request_body(config, f);
    219   grpc_enable_error_creation();
    220   end_test(&f);
    221   config.tear_down_data(&f);
    222 }
    223 
    224 static void test_no_error_on_hotpath_10_requests(
    225     grpc_end2end_test_config config) {
    226   int i;
    227   grpc_end2end_test_fixture f = begin_test(
    228       config, "test_no_error_on_hotpath_in_one_request", nullptr, nullptr);
    229   // First RPC is not considered the hotpath, since there are lots of things to
    230   // set up.
    231   simple_request_body(config, f);
    232   grpc_disable_error_creation();
    233   for (i = 0; i < 10; i++) {
    234     simple_request_body(config, f);
    235   }
    236   grpc_enable_error_creation();
    237   end_test(&f);
    238   config.tear_down_data(&f);
    239 }
    240 
    241 void no_error_on_hotpath(grpc_end2end_test_config config) {
    242   test_no_error_on_hotpath_one_request(config);
    243   test_no_error_on_hotpath_10_requests(config);
    244 }
    245 
    246 void no_error_on_hotpath_pre_init(void) {}
    247