test/core/end2end/tests/retry_unref_before_recv.cc - third_party/grpc - Git at Google

 //
 // Copyright 2017 gRPC authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
 //
 //     http://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
 //

 #include <string.h>

 #include <functional>
 #include <memory>

 #include <grpc/byte_buffer.h>
 #include <grpc/grpc.h>
 #include <grpc/impl/propagation_bits.h>
 #include <grpc/slice.h>
 #include <grpc/status.h>
 #include <grpc/support/log.h>
 #include <grpc/support/time.h>

 #include "src/core/lib/channel/channel_args.h"
 #include "src/core/lib/gpr/useful.h"
 #include "test/core/end2end/cq_verifier.h"
 #include "test/core/end2end/end2end_tests.h"
 #include "test/core/util/test_config.h"

 static std::unique_ptr<CoreTestFixture> begin_test(
     const CoreTestConfiguration& config, const char* test_name,
     grpc_channel_args* client_args, grpc_channel_args* server_args) {
   gpr_log(GPR_INFO, "Running test: %s/%s", test_name, config.name);
   auto f = config.create_fixture(grpc_core::ChannelArgs::FromC(client_args),
                                  grpc_core::ChannelArgs::FromC(server_args));
   f->InitServer(grpc_core::ChannelArgs::FromC(server_args));
   f->InitClient(grpc_core::ChannelArgs::FromC(client_args));
   return f;
 }

 // Tests that we can unref a call while recv ops are started but before
 // they complete.  This ensures that we don't drop callbacks or cause a
 // memory leak.
 static void test_retry_unref_before_recv(const CoreTestConfiguration& config) {
   grpc_call* c;
   grpc_call* s;
   grpc_op ops[6];
   grpc_op* op;
   grpc_metadata_array initial_metadata_recv;
   grpc_metadata_array request_metadata_recv;
   grpc_call_details call_details;
   grpc_slice request_payload_slice = grpc_slice_from_static_string("foo");
   grpc_slice response_payload_slice = grpc_slice_from_static_string("bar");
   grpc_byte_buffer* request_payload =
       grpc_raw_byte_buffer_create(&request_payload_slice, 1);
   grpc_byte_buffer* response_payload =
       grpc_raw_byte_buffer_create(&response_payload_slice, 1);
   grpc_byte_buffer* request_payload_recv = nullptr;
   grpc_byte_buffer* response_payload_recv = nullptr;
   grpc_call_error error;
   int was_cancelled = 2;

   grpc_arg args[] = {
       grpc_channel_arg_string_create(
           const_cast<char*>(GRPC_ARG_SERVICE_CONFIG),
           const_cast<char*>(
               "{\n"
               "  \"methodConfig\": [ {\n"
               "    \"name\": [\n"
               "      { \"service\": \"service\", \"method\": \"method\" }\n"
               "    ],\n"
               "    \"retryPolicy\": {\n"
               "      \"maxAttempts\": 3,\n"
               "      \"initialBackoff\": \"1s\",\n"
               "      \"maxBackoff\": \"120s\",\n"
               "      \"backoffMultiplier\": 1.6,\n"
               "      \"retryableStatusCodes\": [ \"ABORTED\" ]\n"
               "    }\n"
               "  } ]\n"
               "}")),
   };
   grpc_channel_args client_args = {GPR_ARRAY_SIZE(args), args};
   auto f = begin_test(config, "retry_unref_before_recv", &client_args, nullptr);

   grpc_core::CqVerifier cqv(f->cq());

   gpr_timespec deadline = grpc_timeout_seconds_to_deadline(5);
   c = grpc_channel_create_call(f->client(), nullptr, GRPC_PROPAGATE_DEFAULTS,
                                f->cq(),
                                grpc_slice_from_static_string("/service/method"),
                                nullptr, deadline, nullptr);
   GPR_ASSERT(c);

   grpc_metadata_array_init(&initial_metadata_recv);
   grpc_metadata_array_init(&request_metadata_recv);
   grpc_call_details_init(&call_details);
   grpc_slice status_details = grpc_slice_from_static_string("xyz");

   // Client starts send ops.
   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 = request_payload;
   op++;
   op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
   op++;
   error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops),
                                 grpc_core::CqVerifier::tag(1), nullptr);
   GPR_ASSERT(GRPC_CALL_OK == error);

   // Client starts recv_initial_metadata and recv_message, but not
   // recv_trailing_metadata.
   memset(ops, 0, sizeof(ops));
   op = ops;
   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, static_cast<size_t>(op - ops),
                                 grpc_core::CqVerifier::tag(2), nullptr);
   GPR_ASSERT(GRPC_CALL_OK == error);

   // Server gets a call and client send ops complete.
   error = grpc_server_request_call(f->server(), &s, &call_details,
                                    &request_metadata_recv, f->cq(), f->cq(),
                                    grpc_core::CqVerifier::tag(101));
   GPR_ASSERT(GRPC_CALL_OK == error);
   cqv.Expect(grpc_core::CqVerifier::tag(1), true);
   cqv.Expect(grpc_core::CqVerifier::tag(101), true);
   cqv.Verify();

   // Client unrefs the call without starting recv_trailing_metadata.
   // This should trigger a cancellation.
   grpc_call_unref(c);

   // Server immediately sends FAILED_PRECONDITION status (not retriable).
   // This forces the retry filter to start a recv_trailing_metadata op
   // internally, since the application hasn't started it yet.
   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_STATUS_FROM_SERVER;
   op->data.send_status_from_server.trailing_metadata_count = 0;
   op->data.send_status_from_server.status = GRPC_STATUS_FAILED_PRECONDITION;
   op->data.send_status_from_server.status_details = &status_details;
   op++;
   op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
   op->data.recv_close_on_server.cancelled = &was_cancelled;
   op++;
   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops),
                                 grpc_core::CqVerifier::tag(102), nullptr);
   GPR_ASSERT(GRPC_CALL_OK == error);

   // Server ops complete and client recv ops complete.
   cqv.Expect(grpc_core::CqVerifier::tag(2), false);  // Failure!
   cqv.Expect(grpc_core::CqVerifier::tag(102), true);
   cqv.Verify();

   GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/service/method"));
   // Note: Not checking the value of was_cancelled here, because it will
   // be flaky, depending on whether the server sent its response before
   // the client sent its cancellation.

   grpc_call_unref(s);
   grpc_metadata_array_destroy(&request_metadata_recv);
   grpc_metadata_array_init(&request_metadata_recv);
   grpc_call_details_destroy(&call_details);
   grpc_call_details_init(&call_details);

   grpc_metadata_array_destroy(&initial_metadata_recv);
   grpc_metadata_array_destroy(&request_metadata_recv);
   grpc_call_details_destroy(&call_details);
   grpc_byte_buffer_destroy(request_payload);
   grpc_byte_buffer_destroy(response_payload);
   grpc_byte_buffer_destroy(request_payload_recv);
   grpc_byte_buffer_destroy(response_payload_recv);
 }

 void retry_unref_before_recv(const CoreTestConfiguration& config) {
   GPR_ASSERT(config.feature_mask & FEATURE_MASK_SUPPORTS_CLIENT_CHANNEL);
   test_retry_unref_before_recv(config);
 }

 void retry_unref_before_recv_pre_init(void) {}
	//
	// Copyright 2017 gRPC authors.
	//
	// Licensed under the Apache License, Version 2.0 (the "License");
	// you may not use this file except in compliance with the License.
	// You may obtain a copy of the License at
	//
	// http://www.apache.org/licenses/LICENSE-2.0
	//
	// Unless required by applicable law or agreed to in writing, software
	// distributed under the License is distributed on an "AS IS" BASIS,
	// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	// See the License for the specific language governing permissions and
	// limitations under the License.
	//

	#include <string.h>

	#include <functional>
	#include <memory>

	#include <grpc/byte_buffer.h>
	#include <grpc/grpc.h>
	#include <grpc/impl/propagation_bits.h>
	#include <grpc/slice.h>
	#include <grpc/status.h>
	#include <grpc/support/log.h>
	#include <grpc/support/time.h>

	#include "src/core/lib/channel/channel_args.h"
	#include "src/core/lib/gpr/useful.h"
	#include "test/core/end2end/cq_verifier.h"
	#include "test/core/end2end/end2end_tests.h"
	#include "test/core/util/test_config.h"

	static std::unique_ptr<CoreTestFixture> begin_test(
	const CoreTestConfiguration& config, const char* test_name,
	grpc_channel_args* client_args, grpc_channel_args* server_args) {
	gpr_log(GPR_INFO, "Running test: %s/%s", test_name, config.name);
	auto f = config.create_fixture(grpc_core::ChannelArgs::FromC(client_args),
	grpc_core::ChannelArgs::FromC(server_args));
	f->InitServer(grpc_core::ChannelArgs::FromC(server_args));
	f->InitClient(grpc_core::ChannelArgs::FromC(client_args));
	return f;
	}

	// Tests that we can unref a call while recv ops are started but before
	// they complete. This ensures that we don't drop callbacks or cause a
	// memory leak.
	static void test_retry_unref_before_recv(const CoreTestConfiguration& config) {
	grpc_call* c;
	grpc_call* s;
	grpc_op ops[6];
	grpc_op* op;
	grpc_metadata_array initial_metadata_recv;
	grpc_metadata_array request_metadata_recv;
	grpc_call_details call_details;
	grpc_slice request_payload_slice = grpc_slice_from_static_string("foo");
	grpc_slice response_payload_slice = grpc_slice_from_static_string("bar");
	grpc_byte_buffer* request_payload =
	grpc_raw_byte_buffer_create(&request_payload_slice, 1);
	grpc_byte_buffer* response_payload =
	grpc_raw_byte_buffer_create(&response_payload_slice, 1);
	grpc_byte_buffer* request_payload_recv = nullptr;
	grpc_byte_buffer* response_payload_recv = nullptr;
	grpc_call_error error;
	int was_cancelled = 2;

	grpc_arg args[] = {
	grpc_channel_arg_string_create(
	const_cast<char*>(GRPC_ARG_SERVICE_CONFIG),
	const_cast<char*>(
	"{\n"
	" \"methodConfig\": [ {\n"
	" \"name\": [\n"
	" { \"service\": \"service\", \"method\": \"method\" }\n"
	" ],\n"
	" \"retryPolicy\": {\n"
	" \"maxAttempts\": 3,\n"
	" \"initialBackoff\": \"1s\",\n"
	" \"maxBackoff\": \"120s\",\n"
	" \"backoffMultiplier\": 1.6,\n"
	" \"retryableStatusCodes\": [ \"ABORTED\" ]\n"
	" }\n"
	" } ]\n"
	"}")),
	};
	grpc_channel_args client_args = {GPR_ARRAY_SIZE(args), args};
	auto f = begin_test(config, "retry_unref_before_recv", &client_args, nullptr);

	grpc_core::CqVerifier cqv(f->cq());

	gpr_timespec deadline = grpc_timeout_seconds_to_deadline(5);
	c = grpc_channel_create_call(f->client(), nullptr, GRPC_PROPAGATE_DEFAULTS,
	f->cq(),
	grpc_slice_from_static_string("/service/method"),
	nullptr, deadline, nullptr);
	GPR_ASSERT(c);

	grpc_metadata_array_init(&initial_metadata_recv);
	grpc_metadata_array_init(&request_metadata_recv);
	grpc_call_details_init(&call_details);
	grpc_slice status_details = grpc_slice_from_static_string("xyz");

	// Client starts send ops.
	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 = request_payload;
	op++;
	op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
	op++;
	error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops),
	grpc_core::CqVerifier::tag(1), nullptr);
	GPR_ASSERT(GRPC_CALL_OK == error);

	// Client starts recv_initial_metadata and recv_message, but not
	// recv_trailing_metadata.
	memset(ops, 0, sizeof(ops));
	op = ops;
	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, static_cast<size_t>(op - ops),
	grpc_core::CqVerifier::tag(2), nullptr);
	GPR_ASSERT(GRPC_CALL_OK == error);

	// Server gets a call and client send ops complete.
	error = grpc_server_request_call(f->server(), &s, &call_details,
	&request_metadata_recv, f->cq(), f->cq(),
	grpc_core::CqVerifier::tag(101));
	GPR_ASSERT(GRPC_CALL_OK == error);
	cqv.Expect(grpc_core::CqVerifier::tag(1), true);
	cqv.Expect(grpc_core::CqVerifier::tag(101), true);
	cqv.Verify();

	// Client unrefs the call without starting recv_trailing_metadata.
	// This should trigger a cancellation.
	grpc_call_unref(c);

	// Server immediately sends FAILED_PRECONDITION status (not retriable).
	// This forces the retry filter to start a recv_trailing_metadata op
	// internally, since the application hasn't started it yet.
	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_STATUS_FROM_SERVER;
	op->data.send_status_from_server.trailing_metadata_count = 0;
	op->data.send_status_from_server.status = GRPC_STATUS_FAILED_PRECONDITION;
	op->data.send_status_from_server.status_details = &status_details;
	op++;
	op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
	op->data.recv_close_on_server.cancelled = &was_cancelled;
	op++;
	error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops),
	grpc_core::CqVerifier::tag(102), nullptr);
	GPR_ASSERT(GRPC_CALL_OK == error);

	// Server ops complete and client recv ops complete.
	cqv.Expect(grpc_core::CqVerifier::tag(2), false); // Failure!
	cqv.Expect(grpc_core::CqVerifier::tag(102), true);
	cqv.Verify();

	GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/service/method"));
	// Note: Not checking the value of was_cancelled here, because it will
	// be flaky, depending on whether the server sent its response before
	// the client sent its cancellation.

	grpc_call_unref(s);
	grpc_metadata_array_destroy(&request_metadata_recv);
	grpc_metadata_array_init(&request_metadata_recv);
	grpc_call_details_destroy(&call_details);
	grpc_call_details_init(&call_details);

	grpc_metadata_array_destroy(&initial_metadata_recv);
	grpc_metadata_array_destroy(&request_metadata_recv);
	grpc_call_details_destroy(&call_details);
	grpc_byte_buffer_destroy(request_payload);
	grpc_byte_buffer_destroy(response_payload);
	grpc_byte_buffer_destroy(request_payload_recv);
	grpc_byte_buffer_destroy(response_payload_recv);
	}

	void retry_unref_before_recv(const CoreTestConfiguration& config) {
	GPR_ASSERT(config.feature_mask & FEATURE_MASK_SUPPORTS_CLIENT_CHANNEL);
	test_retry_unref_before_recv(config);
	}

	void retry_unref_before_recv_pre_init(void) {}