test/core/end2end/tests/keepalive_timeout.c - platform/external/grpc-grpc - Gitiles

 /*
  *
  * Copyright 2017, Google Inc.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
  * copyright notice, this list of conditions and the following disclaimer
  * in the documentation and/or other materials provided with the
  * distribution.
  *     * Neither the name of Google Inc. nor the names of its
  * contributors may be used to endorse or promote products derived from
  * this software without specific prior written permission.
  *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
  */

 #include "test/core/end2end/end2end_tests.h"

 #include <stdio.h>
 #include <string.h>

 #include <grpc/byte_buffer.h>
 #include <grpc/support/alloc.h>
 #include <grpc/support/log.h>
 #include <grpc/support/time.h>
 #include <grpc/support/useful.h>
 #include "src/core/ext/transport/chttp2/transport/frame_ping.h"
 #include "src/core/lib/channel/channel_args.h"
 #include "src/core/lib/iomgr/exec_ctx.h"
 #include "src/core/lib/support/env.h"
 #include "test/core/end2end/cq_verifier.h"

 static void *tag(intptr_t t) { return (void *)t; }

 static grpc_end2end_test_fixture begin_test(grpc_end2end_test_config config,
                                             const char *test_name,
                                             grpc_channel_args *client_args,
                                             grpc_channel_args *server_args) {
   grpc_end2end_test_fixture f;
   gpr_log(GPR_INFO, "%s/%s", test_name, config.name);
   f = config.create_fixture(client_args, server_args);
   config.init_server(&f, server_args);
   config.init_client(&f, client_args);
   return f;
 }

 static gpr_timespec n_seconds_time(int n) {
   return grpc_timeout_seconds_to_deadline(n);
 }

 static gpr_timespec five_seconds_time(void) { return n_seconds_time(5); }

 static void drain_cq(grpc_completion_queue *cq) {
   grpc_event ev;
   do {
     ev = grpc_completion_queue_next(cq, five_seconds_time(), NULL);
   } while (ev.type != GRPC_QUEUE_SHUTDOWN);
 }

 static void shutdown_server(grpc_end2end_test_fixture *f) {
   if (!f->server) return;
   grpc_server_shutdown_and_notify(f->server, f->cq, tag(1000));
   GPR_ASSERT(
       grpc_completion_queue_pluck(f->cq, tag(1000), five_seconds_time(), NULL)
           .type == GRPC_OP_COMPLETE);
   grpc_server_destroy(f->server);
   f->server = NULL;
 }

 static void shutdown_client(grpc_end2end_test_fixture *f) {
   if (!f->client) return;
   grpc_channel_destroy(f->client);
   f->client = NULL;
 }

 static void end_test(grpc_end2end_test_fixture *f) {
   shutdown_server(f);
   shutdown_client(f);

   grpc_completion_queue_shutdown(f->cq);
   drain_cq(f->cq);
   grpc_completion_queue_destroy(f->cq);
 }

 /* Client sends a request, server replies with a payload, then waits for the
    keepalive watchdog timeouts before returning status. */
 static void test_keepalive_timeout(grpc_end2end_test_config config) {
   grpc_call *c;
   grpc_call *s;
   grpc_slice response_payload_slice =
       grpc_slice_from_copied_string("hello world");
   grpc_byte_buffer *response_payload =
       grpc_raw_byte_buffer_create(&response_payload_slice, 1);
   gpr_timespec deadline = five_seconds_time();

   grpc_arg keepalive_args[] = {{.type = GRPC_ARG_INTEGER,
                                 .key = GRPC_ARG_CLIENT_KEEPALIVE_TIME_S,
                                 .value.integer = 2},
                                {.type = GRPC_ARG_INTEGER,
                                 .key = GRPC_ARG_CLIENT_KEEPALIVE_TIMEOUT_S,
                                 .value.integer = 0},
                                {.type = GRPC_ARG_INTEGER,
                                 .key = GRPC_ARG_HTTP2_BDP_PROBE,
                                 .value.integer = 1}};

   grpc_channel_args *client_args = NULL;
   client_args = grpc_channel_args_copy_and_add(client_args, keepalive_args, 2);

   grpc_end2end_test_fixture f =
       begin_test(config, "keepalive_timeout", client_args, NULL);
   cq_verifier *cqv = cq_verifier_create(f.cq);
   grpc_op ops[6];
   grpc_op *op;
   grpc_metadata_array initial_metadata_recv;
   grpc_metadata_array trailing_metadata_recv;
   grpc_metadata_array request_metadata_recv;
   grpc_byte_buffer *response_payload_recv = NULL;
   grpc_call_details call_details;
   grpc_status_code status;
   grpc_call_error error;
   grpc_slice details;

   /* Disable ping ack to trigger the keepalive timeout */
   grpc_set_disable_ping_ack(true);

   c = grpc_channel_create_call(
       f.client, NULL, GRPC_PROPAGATE_DEFAULTS, f.cq,
       grpc_slice_from_static_string("/foo"),
       get_host_override_slice("foo.test.google.fr:1234", config), deadline,
       NULL);
   GPR_ASSERT(c);

   grpc_metadata_array_init(&initial_metadata_recv);
   grpc_metadata_array_init(&trailing_metadata_recv);
   grpc_metadata_array_init(&request_metadata_recv);
   grpc_call_details_init(&call_details);

   memset(ops, 0, sizeof(ops));
   op = ops;
   op->op = GRPC_OP_SEND_INITIAL_METADATA;
   op->data.send_initial_metadata.count = 0;
   op++;
   op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
   op++;
   op->op = GRPC_OP_RECV_INITIAL_METADATA;
   op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
   op++;
   op->op = GRPC_OP_RECV_MESSAGE;
   op->data.recv_message.recv_message = &response_payload_recv;
   op++;
   error = grpc_call_start_batch(c, ops, (size_t)(op - ops), tag(1), NULL);
   GPR_ASSERT(GRPC_CALL_OK == error);

   GPR_ASSERT(GRPC_CALL_OK == grpc_server_request_call(
                                  f.server, &s, &call_details,
                                  &request_metadata_recv, f.cq, f.cq, tag(101)));
   CQ_EXPECT_COMPLETION(cqv, tag(101), 1);
   cq_verify(cqv);

   memset(ops, 0, sizeof(ops));
   op = ops;
   op->op = GRPC_OP_SEND_INITIAL_METADATA;
   op->data.send_initial_metadata.count = 0;
   op++;
   op->op = GRPC_OP_SEND_MESSAGE;
   op->data.send_message.send_message = response_payload;
   op++;
   error = grpc_call_start_batch(s, ops, (size_t)(op - ops), tag(102), NULL);
   GPR_ASSERT(GRPC_CALL_OK == error);

   CQ_EXPECT_COMPLETION(cqv, tag(102), 1);
   cq_verify(cqv);

   CQ_EXPECT_COMPLETION(cqv, tag(1), 1);
   cq_verify(cqv);

   memset(ops, 0, sizeof(ops));
   op = ops;
   op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
   op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
   op->data.recv_status_on_client.status = &status;
   op->data.recv_status_on_client.status_details = &details;
   op++;
   error = grpc_call_start_batch(c, ops, (size_t)(op - ops), tag(3), NULL);
   GPR_ASSERT(GRPC_CALL_OK == error);

   CQ_EXPECT_COMPLETION(cqv, tag(3), 1);
   cq_verify(cqv);

   char *details_str = grpc_slice_to_c_string(details);
   char *method_str = grpc_slice_to_c_string(call_details.method);
   GPR_ASSERT(status == GRPC_STATUS_UNAVAILABLE);
   GPR_ASSERT(0 == grpc_slice_str_cmp(details, "keepalive watchdog timeout"));
   GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/foo"));
   validate_host_override_string("foo.test.google.fr:1234", call_details.host,
                                 config);

   gpr_free(details_str);
   gpr_free(method_str);

   grpc_slice_unref(details);
   grpc_metadata_array_destroy(&initial_metadata_recv);
   grpc_metadata_array_destroy(&trailing_metadata_recv);
   grpc_metadata_array_destroy(&request_metadata_recv);
   grpc_call_details_destroy(&call_details);

   grpc_call_destroy(c);
   grpc_call_destroy(s);

   cq_verifier_destroy(cqv);

   grpc_byte_buffer_destroy(response_payload);
   grpc_byte_buffer_destroy(response_payload_recv);

   if (client_args != NULL) {
     grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT;
     grpc_channel_args_destroy(&exec_ctx, client_args);
     grpc_exec_ctx_finish(&exec_ctx);
   }

   end_test(&f);
   config.tear_down_data(&f);
 }

 void keepalive_timeout(grpc_end2end_test_config config) {
   test_keepalive_timeout(config);
 }

 void keepalive_timeout_pre_init(void) {}
	/*
	*
	* Copyright 2017, Google Inc.
	* All rights reserved.
	*
	* Redistribution and use in source and binary forms, with or without
	* modification, are permitted provided that the following conditions are
	* met:
	*
	* * Redistributions of source code must retain the above copyright
	* notice, this list of conditions and the following disclaimer.
	* * Redistributions in binary form must reproduce the above
	* copyright notice, this list of conditions and the following disclaimer
	* in the documentation and/or other materials provided with the
	* distribution.
	* * Neither the name of Google Inc. nor the names of its
	* contributors may be used to endorse or promote products derived from
	* this software without specific prior written permission.
	*
	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	*
	*/

	#include "test/core/end2end/end2end_tests.h"

	#include <stdio.h>
	#include <string.h>

	#include <grpc/byte_buffer.h>
	#include <grpc/support/alloc.h>
	#include <grpc/support/log.h>
	#include <grpc/support/time.h>
	#include <grpc/support/useful.h>
	#include "src/core/ext/transport/chttp2/transport/frame_ping.h"
	#include "src/core/lib/channel/channel_args.h"
	#include "src/core/lib/iomgr/exec_ctx.h"
	#include "src/core/lib/support/env.h"
	#include "test/core/end2end/cq_verifier.h"

	static void tag(intptr_t t) { return (void )t; }

	static grpc_end2end_test_fixture begin_test(grpc_end2end_test_config config,
	const char *test_name,
	grpc_channel_args *client_args,
	grpc_channel_args *server_args) {
	grpc_end2end_test_fixture f;
	gpr_log(GPR_INFO, "%s/%s", test_name, config.name);
	f = config.create_fixture(client_args, server_args);
	config.init_server(&f, server_args);
	config.init_client(&f, client_args);
	return f;
	}

	static gpr_timespec n_seconds_time(int n) {
	return grpc_timeout_seconds_to_deadline(n);
	}

	static gpr_timespec five_seconds_time(void) { return n_seconds_time(5); }

	static void drain_cq(grpc_completion_queue *cq) {
	grpc_event ev;
	do {
	ev = grpc_completion_queue_next(cq, five_seconds_time(), NULL);
	} while (ev.type != GRPC_QUEUE_SHUTDOWN);
	}

	static void shutdown_server(grpc_end2end_test_fixture *f) {
	if (!f->server) return;
	grpc_server_shutdown_and_notify(f->server, f->cq, tag(1000));
	GPR_ASSERT(
	grpc_completion_queue_pluck(f->cq, tag(1000), five_seconds_time(), NULL)
	.type == GRPC_OP_COMPLETE);
	grpc_server_destroy(f->server);
	f->server = NULL;
	}

	static void shutdown_client(grpc_end2end_test_fixture *f) {
	if (!f->client) return;
	grpc_channel_destroy(f->client);
	f->client = NULL;
	}

	static void end_test(grpc_end2end_test_fixture *f) {
	shutdown_server(f);
	shutdown_client(f);

	grpc_completion_queue_shutdown(f->cq);
	drain_cq(f->cq);
	grpc_completion_queue_destroy(f->cq);
	}

	/* Client sends a request, server replies with a payload, then waits for the
	keepalive watchdog timeouts before returning status. */
	static void test_keepalive_timeout(grpc_end2end_test_config config) {
	grpc_call *c;
	grpc_call *s;
	grpc_slice response_payload_slice =
	grpc_slice_from_copied_string("hello world");
	grpc_byte_buffer *response_payload =
	grpc_raw_byte_buffer_create(&response_payload_slice, 1);
	gpr_timespec deadline = five_seconds_time();

	grpc_arg keepalive_args[] = {{.type = GRPC_ARG_INTEGER,
	.key = GRPC_ARG_CLIENT_KEEPALIVE_TIME_S,
	.value.integer = 2},
	{.type = GRPC_ARG_INTEGER,
	.key = GRPC_ARG_CLIENT_KEEPALIVE_TIMEOUT_S,
	.value.integer = 0},
	{.type = GRPC_ARG_INTEGER,
	.key = GRPC_ARG_HTTP2_BDP_PROBE,
	.value.integer = 1}};

	grpc_channel_args *client_args = NULL;
	client_args = grpc_channel_args_copy_and_add(client_args, keepalive_args, 2);

	grpc_end2end_test_fixture f =
	begin_test(config, "keepalive_timeout", client_args, NULL);
	cq_verifier *cqv = cq_verifier_create(f.cq);
	grpc_op ops[6];
	grpc_op *op;
	grpc_metadata_array initial_metadata_recv;
	grpc_metadata_array trailing_metadata_recv;
	grpc_metadata_array request_metadata_recv;
	grpc_byte_buffer *response_payload_recv = NULL;
	grpc_call_details call_details;
	grpc_status_code status;
	grpc_call_error error;
	grpc_slice details;

	/* Disable ping ack to trigger the keepalive timeout */
	grpc_set_disable_ping_ack(true);

	c = grpc_channel_create_call(
	f.client, NULL, GRPC_PROPAGATE_DEFAULTS, f.cq,
	grpc_slice_from_static_string("/foo"),
	get_host_override_slice("foo.test.google.fr:1234", config), deadline,
	NULL);
	GPR_ASSERT(c);

	grpc_metadata_array_init(&initial_metadata_recv);
	grpc_metadata_array_init(&trailing_metadata_recv);
	grpc_metadata_array_init(&request_metadata_recv);
	grpc_call_details_init(&call_details);

	memset(ops, 0, sizeof(ops));
	op = ops;
	op->op = GRPC_OP_SEND_INITIAL_METADATA;
	op->data.send_initial_metadata.count = 0;
	op++;
	op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
	op++;
	op->op = GRPC_OP_RECV_INITIAL_METADATA;
	op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
	op++;
	op->op = GRPC_OP_RECV_MESSAGE;
	op->data.recv_message.recv_message = &response_payload_recv;
	op++;
	error = grpc_call_start_batch(c, ops, (size_t)(op - ops), tag(1), NULL);
	GPR_ASSERT(GRPC_CALL_OK == error);

	GPR_ASSERT(GRPC_CALL_OK == grpc_server_request_call(
	f.server, &s, &call_details,
	&request_metadata_recv, f.cq, f.cq, tag(101)));
	CQ_EXPECT_COMPLETION(cqv, tag(101), 1);
	cq_verify(cqv);

	memset(ops, 0, sizeof(ops));
	op = ops;
	op->op = GRPC_OP_SEND_INITIAL_METADATA;
	op->data.send_initial_metadata.count = 0;
	op++;
	op->op = GRPC_OP_SEND_MESSAGE;
	op->data.send_message.send_message = response_payload;
	op++;
	error = grpc_call_start_batch(s, ops, (size_t)(op - ops), tag(102), NULL);
	GPR_ASSERT(GRPC_CALL_OK == error);

	CQ_EXPECT_COMPLETION(cqv, tag(102), 1);
	cq_verify(cqv);

	CQ_EXPECT_COMPLETION(cqv, tag(1), 1);
	cq_verify(cqv);

	memset(ops, 0, sizeof(ops));
	op = ops;
	op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
	op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
	op->data.recv_status_on_client.status = &status;
	op->data.recv_status_on_client.status_details = &details;
	op++;
	error = grpc_call_start_batch(c, ops, (size_t)(op - ops), tag(3), NULL);
	GPR_ASSERT(GRPC_CALL_OK == error);

	CQ_EXPECT_COMPLETION(cqv, tag(3), 1);
	cq_verify(cqv);

	char *details_str = grpc_slice_to_c_string(details);
	char *method_str = grpc_slice_to_c_string(call_details.method);
	GPR_ASSERT(status == GRPC_STATUS_UNAVAILABLE);
	GPR_ASSERT(0 == grpc_slice_str_cmp(details, "keepalive watchdog timeout"));
	GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/foo"));
	validate_host_override_string("foo.test.google.fr:1234", call_details.host,
	config);

	gpr_free(details_str);
	gpr_free(method_str);

	grpc_slice_unref(details);
	grpc_metadata_array_destroy(&initial_metadata_recv);
	grpc_metadata_array_destroy(&trailing_metadata_recv);
	grpc_metadata_array_destroy(&request_metadata_recv);
	grpc_call_details_destroy(&call_details);

	grpc_call_destroy(c);
	grpc_call_destroy(s);

	cq_verifier_destroy(cqv);

	grpc_byte_buffer_destroy(response_payload);
	grpc_byte_buffer_destroy(response_payload_recv);

	if (client_args != NULL) {
	grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT;
	grpc_channel_args_destroy(&exec_ctx, client_args);
	grpc_exec_ctx_finish(&exec_ctx);
	}

	end_test(&f);
	config.tear_down_data(&f);
	}

	void keepalive_timeout(grpc_end2end_test_config config) {
	test_keepalive_timeout(config);
	}

	void keepalive_timeout_pre_init(void) {}