| /* |
| * |
| * 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 "test/core/end2end/end2end_tests.h" |
| |
| #include <stdio.h> |
| #include <string.h> |
| |
| #include <grpc/byte_buffer.h> |
| #include <grpc/grpc.h> |
| #include <grpc/support/alloc.h> |
| #include <grpc/support/log.h> |
| #include <grpc/support/string_util.h> |
| #include <grpc/support/time.h> |
| |
| #include "src/core/lib/surface/channel.h" |
| #include "src/core/lib/surface/server.h" |
| |
| #include "src/core/lib/channel/channel_args.h" |
| #include "src/core/lib/gpr/string.h" |
| #include "src/core/lib/gpr/useful.h" |
| #include "src/core/lib/iomgr/exec_ctx.h" |
| #include "src/core/lib/transport/static_metadata.h" |
| |
| #include "test/core/end2end/cq_verifier.h" |
| #include "test/core/end2end/tests/cancel_test_helpers.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, "Running test: %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_from_now(int n) { |
| return grpc_timeout_seconds_to_deadline(n); |
| } |
| |
| static gpr_timespec five_seconds_from_now(void) { |
| return n_seconds_from_now(5); |
| } |
| |
| static void drain_cq(grpc_completion_queue* cq) { |
| grpc_event ev; |
| do { |
| ev = grpc_completion_queue_next(cq, five_seconds_from_now(), nullptr); |
| } 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->shutdown_cq, tag(1000)); |
| GPR_ASSERT(grpc_completion_queue_pluck(f->shutdown_cq, tag(1000), |
| grpc_timeout_seconds_to_deadline(5), |
| nullptr) |
| .type == GRPC_OP_COMPLETE); |
| grpc_server_destroy(f->server); |
| f->server = nullptr; |
| } |
| |
| static void shutdown_client(grpc_end2end_test_fixture* f) { |
| if (!f->client) return; |
| grpc_channel_destroy(f->client); |
| f->client = nullptr; |
| } |
| |
| 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); |
| grpc_completion_queue_destroy(f->shutdown_cq); |
| } |
| |
| // Tests retrying a streaming RPC. This is the same as |
| // the basic retry test, except that the client sends two messages on the |
| // call before the initial attempt fails. |
| // FIXME: We should also test the case where the retry is committed after |
| // replaying 1 of 2 previously-completed send_message ops. However, |
| // there's no way to trigger that from an end2end test, because the |
| // replayed ops happen under the hood -- they are not surfaced to the |
| // C-core API, and therefore we have no way to inject the commit at the |
| // right point. |
| static void test_retry_streaming(grpc_end2end_test_config config) { |
| grpc_call* c; |
| grpc_call* s; |
| 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_call_details call_details; |
| grpc_slice request_payload_slice = grpc_slice_from_static_string("foo"); |
| grpc_slice request2_payload_slice = grpc_slice_from_static_string("bar"); |
| grpc_slice request3_payload_slice = grpc_slice_from_static_string("baz"); |
| grpc_slice response_payload_slice = grpc_slice_from_static_string("quux"); |
| grpc_byte_buffer* request_payload = |
| grpc_raw_byte_buffer_create(&request_payload_slice, 1); |
| grpc_byte_buffer* request2_payload = |
| grpc_raw_byte_buffer_create(&request2_payload_slice, 1); |
| grpc_byte_buffer* request3_payload = |
| grpc_raw_byte_buffer_create(&request3_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* request2_payload_recv = nullptr; |
| grpc_byte_buffer* request3_payload_recv = nullptr; |
| grpc_byte_buffer* response_payload_recv = nullptr; |
| grpc_status_code status; |
| grpc_call_error error; |
| grpc_slice details; |
| int was_cancelled = 2; |
| char* peer; |
| |
| grpc_arg args[] = { |
| grpc_channel_arg_integer_create( |
| const_cast<char*>(GRPC_ARG_MAX_CHANNEL_TRACE_EVENT_MEMORY_PER_NODE), |
| 1024 * 8), |
| grpc_channel_arg_integer_create( |
| const_cast<char*>(GRPC_ARG_ENABLE_CHANNELZ), true), |
| 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}; |
| grpc_end2end_test_fixture f = |
| begin_test(config, "retry_streaming", &client_args, nullptr); |
| |
| cq_verifier* cqv = cq_verifier_create(f.cq); |
| |
| gpr_timespec deadline = five_seconds_from_now(); |
| c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq, |
| grpc_slice_from_static_string("/service/method"), |
| nullptr, deadline, nullptr); |
| grpc_core::channelz::ChannelNode* channelz_channel = |
| grpc_channel_get_channelz_node(f.client); |
| |
| GPR_ASSERT(c); |
| |
| peer = grpc_call_get_peer(c); |
| GPR_ASSERT(peer != nullptr); |
| gpr_log(GPR_DEBUG, "client_peer_before_call=%s", peer); |
| gpr_free(peer); |
| |
| 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); |
| grpc_slice status_details = grpc_slice_from_static_string("xyz"); |
| |
| // Client starts a batch for receiving initial metadata, a message, |
| // and 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++; |
| 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, static_cast<size_t>(op - ops), tag(1), |
| nullptr); |
| GPR_ASSERT(GRPC_CALL_OK == error); |
| |
| // Client sends initial metadata and a message. |
| 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++; |
| error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(2), |
| nullptr); |
| GPR_ASSERT(GRPC_CALL_OK == error); |
| CQ_EXPECT_COMPLETION(cqv, tag(2), true); |
| cq_verify(cqv); |
| |
| // Server gets a call with received initial metadata. |
| error = |
| grpc_server_request_call(f.server, &s, &call_details, |
| &request_metadata_recv, f.cq, f.cq, tag(101)); |
| GPR_ASSERT(GRPC_CALL_OK == error); |
| CQ_EXPECT_COMPLETION(cqv, tag(101), true); |
| cq_verify(cqv); |
| |
| peer = grpc_call_get_peer(s); |
| GPR_ASSERT(peer != nullptr); |
| gpr_log(GPR_DEBUG, "server_peer=%s", peer); |
| gpr_free(peer); |
| peer = grpc_call_get_peer(c); |
| GPR_ASSERT(peer != nullptr); |
| gpr_log(GPR_DEBUG, "client_peer=%s", peer); |
| gpr_free(peer); |
| |
| // Server receives a message. |
| memset(ops, 0, sizeof(ops)); |
| op = ops; |
| op->op = GRPC_OP_RECV_MESSAGE; |
| op->data.recv_message.recv_message = &request_payload_recv; |
| op++; |
| error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(102), |
| nullptr); |
| GPR_ASSERT(GRPC_CALL_OK == error); |
| CQ_EXPECT_COMPLETION(cqv, tag(102), true); |
| cq_verify(cqv); |
| |
| // Client sends a second message. |
| memset(ops, 0, sizeof(ops)); |
| op = ops; |
| op->op = GRPC_OP_SEND_MESSAGE; |
| op->data.send_message.send_message = request2_payload; |
| op++; |
| error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(3), |
| nullptr); |
| GPR_ASSERT(GRPC_CALL_OK == error); |
| CQ_EXPECT_COMPLETION(cqv, tag(3), true); |
| cq_verify(cqv); |
| |
| // Server receives the second message. |
| memset(ops, 0, sizeof(ops)); |
| op = ops; |
| op->op = GRPC_OP_RECV_MESSAGE; |
| op->data.recv_message.recv_message = &request2_payload_recv; |
| op++; |
| error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(103), |
| nullptr); |
| GPR_ASSERT(GRPC_CALL_OK == error); |
| CQ_EXPECT_COMPLETION(cqv, tag(103), true); |
| cq_verify(cqv); |
| |
| // Server sends both initial and trailing metadata. |
| memset(ops, 0, sizeof(ops)); |
| op = ops; |
| op->op = GRPC_OP_RECV_CLOSE_ON_SERVER; |
| op->data.recv_close_on_server.cancelled = &was_cancelled; |
| op++; |
| 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_ABORTED; |
| op->data.send_status_from_server.status_details = &status_details; |
| op++; |
| error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(104), |
| nullptr); |
| GPR_ASSERT(GRPC_CALL_OK == error); |
| CQ_EXPECT_COMPLETION(cqv, tag(104), true); |
| cq_verify(cqv); |
| |
| // Clean up from first attempt. |
| 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); |
| GPR_ASSERT(byte_buffer_eq_slice(request_payload_recv, request_payload_slice)); |
| grpc_byte_buffer_destroy(request_payload_recv); |
| request_payload_recv = nullptr; |
| GPR_ASSERT( |
| byte_buffer_eq_slice(request2_payload_recv, request2_payload_slice)); |
| grpc_byte_buffer_destroy(request2_payload_recv); |
| request2_payload_recv = nullptr; |
| |
| // Server gets a second call (the retry). |
| error = |
| grpc_server_request_call(f.server, &s, &call_details, |
| &request_metadata_recv, f.cq, f.cq, tag(201)); |
| GPR_ASSERT(GRPC_CALL_OK == error); |
| CQ_EXPECT_COMPLETION(cqv, tag(201), true); |
| cq_verify(cqv); |
| |
| peer = grpc_call_get_peer(s); |
| GPR_ASSERT(peer != nullptr); |
| gpr_log(GPR_DEBUG, "server_peer=%s", peer); |
| gpr_free(peer); |
| peer = grpc_call_get_peer(c); |
| GPR_ASSERT(peer != nullptr); |
| gpr_log(GPR_DEBUG, "client_peer=%s", peer); |
| gpr_free(peer); |
| |
| // Server receives a message. |
| memset(ops, 0, sizeof(ops)); |
| op = ops; |
| op->op = GRPC_OP_RECV_MESSAGE; |
| op->data.recv_message.recv_message = &request_payload_recv; |
| op++; |
| error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(202), |
| nullptr); |
| GPR_ASSERT(GRPC_CALL_OK == error); |
| CQ_EXPECT_COMPLETION(cqv, tag(202), true); |
| cq_verify(cqv); |
| |
| // Server receives a second message. |
| memset(ops, 0, sizeof(ops)); |
| op = ops; |
| op->op = GRPC_OP_RECV_MESSAGE; |
| op->data.recv_message.recv_message = &request2_payload_recv; |
| op++; |
| error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(203), |
| nullptr); |
| GPR_ASSERT(GRPC_CALL_OK == error); |
| CQ_EXPECT_COMPLETION(cqv, tag(203), true); |
| cq_verify(cqv); |
| |
| // Client sends a third message and a close. |
| memset(ops, 0, sizeof(ops)); |
| op = ops; |
| op->op = GRPC_OP_SEND_MESSAGE; |
| op->data.send_message.send_message = request3_payload; |
| op++; |
| op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT; |
| op++; |
| error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(4), |
| nullptr); |
| GPR_ASSERT(GRPC_CALL_OK == error); |
| CQ_EXPECT_COMPLETION(cqv, tag(4), true); |
| cq_verify(cqv); |
| |
| // Server receives a third message. |
| memset(ops, 0, sizeof(ops)); |
| op = ops; |
| op->op = GRPC_OP_RECV_MESSAGE; |
| op->data.recv_message.recv_message = &request3_payload_recv; |
| op++; |
| error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(204), |
| nullptr); |
| GPR_ASSERT(GRPC_CALL_OK == error); |
| CQ_EXPECT_COMPLETION(cqv, tag(204), true); |
| cq_verify(cqv); |
| |
| // Server receives a close and sends initial metadata, a message, and |
| // trailing metadata. |
| memset(ops, 0, sizeof(ops)); |
| op = ops; |
| op->op = GRPC_OP_RECV_CLOSE_ON_SERVER; |
| op->data.recv_close_on_server.cancelled = &was_cancelled; |
| op++; |
| 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++; |
| op->op = GRPC_OP_SEND_STATUS_FROM_SERVER; |
| op->data.send_status_from_server.trailing_metadata_count = 0; |
| // Returning a retriable code, but because we are also sending a |
| // message, the client will commit instead of retrying again. |
| op->data.send_status_from_server.status = GRPC_STATUS_ABORTED; |
| op->data.send_status_from_server.status_details = &status_details; |
| op++; |
| error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(205), |
| nullptr); |
| GPR_ASSERT(GRPC_CALL_OK == error); |
| CQ_EXPECT_COMPLETION(cqv, tag(205), true); |
| CQ_EXPECT_COMPLETION(cqv, tag(1), true); |
| cq_verify(cqv); |
| |
| GPR_ASSERT(status == GRPC_STATUS_ABORTED); |
| GPR_ASSERT(0 == grpc_slice_str_cmp(details, "xyz")); |
| GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/service/method")); |
| GPR_ASSERT(0 == call_details.flags); |
| GPR_ASSERT(was_cancelled == 0); |
| |
| GPR_ASSERT(channelz_channel != nullptr); |
| std::string json = channelz_channel->RenderJsonString(); |
| gpr_log(GPR_INFO, "%s", json.c_str()); |
| GPR_ASSERT(json.find("\"trace\"") != json.npos); |
| GPR_ASSERT(json.find("\"description\":\"Channel created\"") != json.npos); |
| GPR_ASSERT(json.find("\"severity\":\"CT_INFO\"") != json.npos); |
| GPR_ASSERT(json.find("Resolution event") != json.npos); |
| GPR_ASSERT(json.find("Created new LB policy") != json.npos); |
| GPR_ASSERT(json.find("Service config changed") != json.npos); |
| GPR_ASSERT(json.find("Address list became non-empty") != json.npos); |
| GPR_ASSERT(json.find("Channel state change to CONNECTING") != json.npos); |
| |
| 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_byte_buffer_destroy(request_payload); |
| grpc_byte_buffer_destroy(request2_payload); |
| grpc_byte_buffer_destroy(request3_payload); |
| grpc_byte_buffer_destroy(response_payload); |
| GPR_ASSERT(byte_buffer_eq_slice(request_payload_recv, request_payload_slice)); |
| grpc_byte_buffer_destroy(request_payload_recv); |
| GPR_ASSERT( |
| byte_buffer_eq_slice(request2_payload_recv, request2_payload_slice)); |
| grpc_byte_buffer_destroy(request2_payload_recv); |
| GPR_ASSERT( |
| byte_buffer_eq_slice(request3_payload_recv, request3_payload_slice)); |
| grpc_byte_buffer_destroy(request3_payload_recv); |
| grpc_byte_buffer_destroy(response_payload_recv); |
| |
| grpc_call_unref(c); |
| grpc_call_unref(s); |
| |
| cq_verifier_destroy(cqv); |
| |
| end_test(&f); |
| config.tear_down_data(&f); |
| } |
| |
| void retry_streaming(grpc_end2end_test_config config) { |
| GPR_ASSERT(config.feature_mask & FEATURE_MASK_SUPPORTS_CLIENT_CHANNEL); |
| |
| test_retry_streaming(config); |
| } |
| |
| void retry_streaming_pre_init(void) {} |