test/core/end2end/tests/ping_pong_streaming.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 <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 "test/core/end2end/cq_verifier.h"
  28 #include "test/core/end2end/end2end_tests.h"
  29
  30 static void* tag(intptr_t t) { return reinterpret_cast<void*>(t); }
  31
  32 static grpc_end2end_test_fixture begin_test(grpc_end2end_test_config config,
  33                                             const char* test_name,
  34                                             grpc_channel_args* client_args,
  35                                             grpc_channel_args* server_args) {
  36   grpc_end2end_test_fixture f;
  37   gpr_log(GPR_INFO, "Running test: %s/%s", test_name, config.name);
  38   f = config.create_fixture(client_args, server_args);
  39   config.init_server(&f, server_args);
  40   config.init_client(&f, client_args);
  41   return f;
  42 }
  43
  44 static gpr_timespec n_seconds_from_now(int n) {
  45   return grpc_timeout_seconds_to_deadline(n);
  46 }
  47
  48 static gpr_timespec five_seconds_from_now(void) {
  49   return n_seconds_from_now(5);
  50 }
  51
  52 static void drain_cq(grpc_completion_queue* cq) {
  53   grpc_event ev;
  54   do {
  55     ev = grpc_completion_queue_next(cq, five_seconds_from_now(), nullptr);
  56   } while (ev.type != GRPC_QUEUE_SHUTDOWN);
  57 }
  58
  59 static void shutdown_server(grpc_end2end_test_fixture* f) {
  60   if (!f->server) return;
  61   grpc_server_shutdown_and_notify(f->server, f->shutdown_cq, tag(1000));
  62   GPR_ASSERT(grpc_completion_queue_pluck(f->shutdown_cq, tag(1000),
  63                                          grpc_timeout_seconds_to_deadline(5),
  64                                          nullptr)
  65                  .type == GRPC_OP_COMPLETE);
  66   grpc_server_destroy(f->server);
  67   f->server = nullptr;
  68 }
  69
  70 static void shutdown_client(grpc_end2end_test_fixture* f) {
  71   if (!f->client) return;
  72   grpc_channel_destroy(f->client);
  73   f->client = nullptr;
  74 }
  75
  76 static void end_test(grpc_end2end_test_fixture* f) {
  77   shutdown_server(f);
  78   shutdown_client(f);
  79
  80   grpc_completion_queue_shutdown(f->cq);
  81   drain_cq(f->cq);
  82   grpc_completion_queue_destroy(f->cq);
  83   grpc_completion_queue_destroy(f->shutdown_cq);
  84 }
  85
  86 /* Client pings and server pongs. Repeat messages rounds before finishing. */
  87 static void test_pingpong_streaming(grpc_end2end_test_config config,
  88                                     int messages) {
  89   grpc_end2end_test_fixture f =
  90       begin_test(config, "test_pingpong_streaming", nullptr, nullptr);
  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   grpc_call_error error;
 102   grpc_slice details;
 103   int was_cancelled = 2;
 104   grpc_byte_buffer* request_payload;
 105   grpc_byte_buffer* request_payload_recv;
 106   grpc_byte_buffer* response_payload;
 107   grpc_byte_buffer* response_payload_recv;
 108   int i;
 109   grpc_slice request_payload_slice =
 110       grpc_slice_from_copied_string("hello world");
 111   grpc_slice response_payload_slice =
 112       grpc_slice_from_copied_string("hello you");
 113
 114   gpr_timespec deadline = five_seconds_from_now();
 115   c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
 116                                grpc_slice_from_static_string("/foo"), nullptr,
 117                                deadline, nullptr);
 118   GPR_ASSERT(c);
 119
 120   grpc_metadata_array_init(&initial_metadata_recv);
 121   grpc_metadata_array_init(&trailing_metadata_recv);
 122   grpc_metadata_array_init(&request_metadata_recv);
 123   grpc_call_details_init(&call_details);
 124
 125   memset(ops, 0, sizeof(ops));
 126   op = ops;
 127   op->op = GRPC_OP_SEND_INITIAL_METADATA;
 128   op->data.send_initial_metadata.count = 0;
 129   op->flags = 0;
 130   op->reserved = nullptr;
 131   op++;
 132   op->op = GRPC_OP_RECV_INITIAL_METADATA;
 133   op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
 134   op->flags = 0;
 135   op->reserved = nullptr;
 136   op++;
 137   op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
 138   op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
 139   op->data.recv_status_on_client.status = &status;
 140   op->data.recv_status_on_client.status_details = &details;
 141   op->flags = 0;
 142   op->reserved = nullptr;
 143   op++;
 144   error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(1),
 145                                 nullptr);
 146   GPR_ASSERT(GRPC_CALL_OK == error);
 147
 148   error =
 149       grpc_server_request_call(f.server, &s, &call_details,
 150                                &request_metadata_recv, f.cq, f.cq, tag(100));
 151   GPR_ASSERT(GRPC_CALL_OK == error);
 152   CQ_EXPECT_COMPLETION(cqv, tag(100), 1);
 153   cq_verify(cqv);
 154
 155   memset(ops, 0, sizeof(ops));
 156   op = ops;
 157   op->op = GRPC_OP_SEND_INITIAL_METADATA;
 158   op->data.send_initial_metadata.count = 0;
 159   op->flags = 0;
 160   op->reserved = nullptr;
 161   op++;
 162   op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
 163   op->data.recv_close_on_server.cancelled = &was_cancelled;
 164   op->flags = 0;
 165   op->reserved = nullptr;
 166   op++;
 167   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(101),
 168                                 nullptr);
 169   GPR_ASSERT(GRPC_CALL_OK == error);
 170
 171   for (i = 0; i < messages; i++) {
 172     request_payload = grpc_raw_byte_buffer_create(&request_payload_slice, 1);
 173     response_payload = grpc_raw_byte_buffer_create(&response_payload_slice, 1);
 174
 175     memset(ops, 0, sizeof(ops));
 176     op = ops;
 177     op->op = GRPC_OP_SEND_MESSAGE;
 178     op->data.send_message.send_message = request_payload;
 179     op->flags = 0;
 180     op->reserved = nullptr;
 181     op++;
 182     op->op = GRPC_OP_RECV_MESSAGE;
 183     op->data.recv_message.recv_message = &response_payload_recv;
 184     op->flags = 0;
 185     op->reserved = nullptr;
 186     op++;
 187     error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(2),
 188                                   nullptr);
 189     GPR_ASSERT(GRPC_CALL_OK == error);
 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     error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops),
 199                                   tag(102), nullptr);
 200     GPR_ASSERT(GRPC_CALL_OK == error);
 201     CQ_EXPECT_COMPLETION(cqv, tag(102), 1);
 202     cq_verify(cqv);
 203
 204     memset(ops, 0, sizeof(ops));
 205     op = ops;
 206     op->op = GRPC_OP_SEND_MESSAGE;
 207     op->data.send_message.send_message = response_payload;
 208     op->flags = 0;
 209     op->reserved = nullptr;
 210     op++;
 211     error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops),
 212                                   tag(103), nullptr);
 213     GPR_ASSERT(GRPC_CALL_OK == error);
 214     CQ_EXPECT_COMPLETION(cqv, tag(103), 1);
 215     CQ_EXPECT_COMPLETION(cqv, tag(2), 1);
 216     cq_verify(cqv);
 217
 218     grpc_byte_buffer_destroy(request_payload);
 219     grpc_byte_buffer_destroy(response_payload);
 220     grpc_byte_buffer_destroy(request_payload_recv);
 221     grpc_byte_buffer_destroy(response_payload_recv);
 222   }
 223
 224   grpc_slice_unref(request_payload_slice);
 225   grpc_slice_unref(response_payload_slice);
 226
 227   memset(ops, 0, sizeof(ops));
 228   op = ops;
 229   op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
 230   op->flags = 0;
 231   op->reserved = nullptr;
 232   op++;
 233   error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(3),
 234                                 nullptr);
 235   GPR_ASSERT(GRPC_CALL_OK == error);
 236
 237   memset(ops, 0, sizeof(ops));
 238   op = ops;
 239   op->op = GRPC_OP_SEND_STATUS_FROM_SERVER;
 240   op->data.send_status_from_server.trailing_metadata_count = 0;
 241   op->data.send_status_from_server.status = GRPC_STATUS_UNIMPLEMENTED;
 242   grpc_slice status_details = grpc_slice_from_static_string("xyz");
 243   op->data.send_status_from_server.status_details = &status_details;
 244   op->flags = 0;
 245   op->reserved = nullptr;
 246   op++;
 247   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(104),
 248                                 nullptr);
 249   GPR_ASSERT(GRPC_CALL_OK == error);
 250
 251   CQ_EXPECT_COMPLETION(cqv, tag(1), 1);
 252   CQ_EXPECT_COMPLETION(cqv, tag(3), 1);
 253   CQ_EXPECT_COMPLETION(cqv, tag(101), 1);
 254   CQ_EXPECT_COMPLETION(cqv, tag(104), 1);
 255   cq_verify(cqv);
 256
 257   grpc_call_unref(c);
 258   grpc_call_unref(s);
 259
 260   cq_verifier_destroy(cqv);
 261
 262   grpc_metadata_array_destroy(&initial_metadata_recv);
 263   grpc_metadata_array_destroy(&trailing_metadata_recv);
 264   grpc_metadata_array_destroy(&request_metadata_recv);
 265   grpc_call_details_destroy(&call_details);
 266   grpc_slice_unref(details);
 267
 268   end_test(&f);
 269   config.tear_down_data(&f);
 270 }
 271
 272 void ping_pong_streaming(grpc_end2end_test_config config) {
 273   int i;
 274
 275   for (i = 1; i < 10; i++) {
 276     test_pingpong_streaming(config, i);
 277   }
 278 }
 279
 280 void ping_pong_streaming_pre_init(void) {}