| // |
| // |
| // Copyright 2018 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 <limits.h> |
| #include <string.h> |
| |
| #include <algorithm> |
| #include <functional> |
| #include <initializer_list> |
| #include <memory> |
| #include <vector> |
| |
| #include "absl/status/status.h" |
| |
| #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/channel/channel_fwd.h" |
| #include "src/core/lib/channel/channel_stack.h" |
| #include "src/core/lib/channel/channel_stack_builder.h" |
| #include "src/core/lib/channel/context.h" |
| #include "src/core/lib/config/core_configuration.h" |
| #include "src/core/lib/iomgr/closure.h" |
| #include "src/core/lib/iomgr/error.h" |
| #include "src/core/lib/surface/channel_stack_type.h" |
| #include "src/core/lib/transport/transport.h" |
| #include "test/core/end2end/cq_verifier.h" |
| #include "test/core/end2end/end2end_tests.h" |
| #include "test/core/util/test_config.h" |
| |
| enum { TIMEOUT = 200000 }; |
| |
| 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; |
| } |
| |
| // Simple request to test that filters see a consistent view of the |
| // call context. |
| static void test_request(const CoreTestConfiguration& config) { |
| grpc_call* c; |
| grpc_call* s; |
| grpc_slice request_payload_slice = |
| grpc_slice_from_copied_string("hello world"); |
| grpc_byte_buffer* request_payload = |
| grpc_raw_byte_buffer_create(&request_payload_slice, 1); |
| auto f = begin_test(config, "filter_context", nullptr, nullptr); |
| grpc_core::CqVerifier cqv(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* request_payload_recv = nullptr; |
| grpc_call_details call_details; |
| grpc_status_code status; |
| grpc_call_error error; |
| grpc_slice details; |
| int was_cancelled = 2; |
| |
| 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("/foo"), |
| nullptr, deadline, nullptr); |
| 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->data.send_initial_metadata.metadata = nullptr; |
| op->flags = 0; |
| op->reserved = nullptr; |
| op++; |
| op->op = GRPC_OP_SEND_MESSAGE; |
| op->data.send_message.send_message = request_payload; |
| op->flags = 0; |
| op->reserved = nullptr; |
| op++; |
| op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT; |
| op->flags = 0; |
| op->reserved = nullptr; |
| op++; |
| op->op = GRPC_OP_RECV_INITIAL_METADATA; |
| op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv; |
| op->flags = 0; |
| op->reserved = nullptr; |
| 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->flags = 0; |
| op->reserved = nullptr; |
| 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); |
| |
| 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(101), true); |
| cqv.Verify(); |
| |
| memset(ops, 0, sizeof(ops)); |
| op = ops; |
| op->op = GRPC_OP_SEND_INITIAL_METADATA; |
| op->data.send_initial_metadata.count = 0; |
| op->flags = 0; |
| op->reserved = nullptr; |
| 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_UNIMPLEMENTED; |
| grpc_slice status_string = grpc_slice_from_static_string("xyz"); |
| op->data.send_status_from_server.status_details = &status_string; |
| op->flags = 0; |
| op->reserved = nullptr; |
| op++; |
| op->op = GRPC_OP_RECV_CLOSE_ON_SERVER; |
| op->data.recv_close_on_server.cancelled = &was_cancelled; |
| op->flags = 0; |
| op->reserved = nullptr; |
| 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); |
| |
| cqv.Expect(grpc_core::CqVerifier::tag(102), true); |
| cqv.Expect(grpc_core::CqVerifier::tag(1), true); |
| cqv.Verify(); |
| |
| GPR_ASSERT(status == GRPC_STATUS_UNIMPLEMENTED); |
| GPR_ASSERT(0 == grpc_slice_str_cmp(details, "xyz")); |
| |
| 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_unref(s); |
| grpc_call_unref(c); |
| |
| grpc_byte_buffer_destroy(request_payload); |
| grpc_byte_buffer_destroy(request_payload_recv); |
| } |
| |
| //****************************************************************************** |
| // Test context filter |
| // |
| |
| struct call_data { |
| grpc_call_context_element* context; |
| }; |
| |
| static grpc_error_handle init_call_elem(grpc_call_element* elem, |
| const grpc_call_element_args* args) { |
| call_data* calld = static_cast<call_data*>(elem->call_data); |
| calld->context = args->context; |
| gpr_log(GPR_INFO, "init_call_elem(): context=%p", args->context); |
| return absl::OkStatus(); |
| } |
| |
| static void start_transport_stream_op_batch( |
| grpc_call_element* elem, grpc_transport_stream_op_batch* batch) { |
| call_data* calld = static_cast<call_data*>(elem->call_data); |
| // If batch payload context is not null (which will happen in some |
| // cancellation cases), make sure we get the same context here that we |
| // saw in init_call_elem(). |
| gpr_log(GPR_INFO, "start_transport_stream_op_batch(): context=%p", |
| batch->payload->context); |
| if (batch->payload->context != nullptr) { |
| GPR_ASSERT(calld->context == batch->payload->context); |
| } |
| grpc_call_next_op(elem, batch); |
| } |
| |
| static void destroy_call_elem(grpc_call_element* /*elem*/, |
| const grpc_call_final_info* /*final_info*/, |
| grpc_closure* /*ignored*/) {} |
| |
| static grpc_error_handle init_channel_elem( |
| grpc_channel_element* /*elem*/, grpc_channel_element_args* /*args*/) { |
| return absl::OkStatus(); |
| } |
| |
| static void destroy_channel_elem(grpc_channel_element* /*elem*/) {} |
| |
| static const grpc_channel_filter test_filter = { |
| start_transport_stream_op_batch, |
| nullptr, |
| grpc_channel_next_op, |
| sizeof(call_data), |
| init_call_elem, |
| grpc_call_stack_ignore_set_pollset_or_pollset_set, |
| destroy_call_elem, |
| 0, |
| init_channel_elem, |
| grpc_channel_stack_no_post_init, |
| destroy_channel_elem, |
| grpc_channel_next_get_info, |
| "filter_context"}; |
| |
| //****************************************************************************** |
| // Registration |
| // |
| |
| void filter_context(const CoreTestConfiguration& config) { |
| grpc_core::CoreConfiguration::RunWithSpecialConfiguration( |
| [](grpc_core::CoreConfiguration::Builder* builder) { |
| grpc_core::BuildCoreConfiguration(builder); |
| for (auto type : {GRPC_CLIENT_CHANNEL, GRPC_CLIENT_SUBCHANNEL, |
| GRPC_CLIENT_DIRECT_CHANNEL, GRPC_SERVER_CHANNEL}) { |
| builder->channel_init()->RegisterStage( |
| type, INT_MAX, [](grpc_core::ChannelStackBuilder* builder) { |
| // Want to add the filter as close to the end as possible, to |
| // make sure that all of the filters work well together. |
| // However, we can't add it at the very end, because the |
| // connected channel filter must be the last one. So we add it |
| // right before the last one. |
| auto it = builder->mutable_stack()->end(); |
| --it; |
| builder->mutable_stack()->insert(it, &test_filter); |
| return true; |
| }); |
| } |
| }, |
| [config] { test_request(config); }); |
| } |
| |
| void filter_context_pre_init(void) {} |