| /* |
| * |
| * Copyright 2015, 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 <stdbool.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/lib/channel/channel_stack_builder.h" |
| #include "src/core/lib/surface/channel_init.h" |
| #include "test/core/end2end/cq_verifier.h" |
| |
| enum { TIMEOUT = 200000 }; |
| |
| static bool g_enable_filter = false; |
| |
| 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), GRPC_TIMEOUT_SECONDS_TO_DEADLINE(5), 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); |
| } |
| |
| /* Simple request via a server filter that always closes the stream.*/ |
| static void test_request(grpc_end2end_test_config config) { |
| grpc_call *c; |
| grpc_call *s; |
| gpr_slice request_payload_slice = gpr_slice_from_copied_string("hello world"); |
| grpc_byte_buffer *request_payload = |
| grpc_raw_byte_buffer_create(&request_payload_slice, 1); |
| gpr_timespec deadline = five_seconds_time(); |
| grpc_end2end_test_fixture f = |
| begin_test(config, "filter_causes_close", NULL, 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 *request_payload_recv = NULL; |
| grpc_call_details call_details; |
| grpc_status_code status; |
| grpc_call_error error; |
| char *details = NULL; |
| size_t details_capacity = 0; |
| |
| c = grpc_channel_create_call(f.client, NULL, GRPC_PROPAGATE_DEFAULTS, f.cq, |
| "/foo", "foo.test.google.fr", 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->data.send_initial_metadata.metadata = NULL; |
| op->flags = 0; |
| op->reserved = NULL; |
| op++; |
| op->op = GRPC_OP_SEND_MESSAGE; |
| op->data.send_message = request_payload; |
| op->flags = 0; |
| op->reserved = NULL; |
| op++; |
| op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT; |
| op->flags = 0; |
| op->reserved = NULL; |
| op++; |
| op->op = GRPC_OP_RECV_INITIAL_METADATA; |
| op->data.recv_initial_metadata = &initial_metadata_recv; |
| op->flags = 0; |
| op->reserved = NULL; |
| 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->data.recv_status_on_client.status_details_capacity = &details_capacity; |
| op->flags = 0; |
| op->reserved = NULL; |
| op++; |
| error = grpc_call_start_batch(c, ops, (size_t)(op - ops), tag(1), NULL); |
| GPR_ASSERT(GRPC_CALL_OK == error); |
| |
| 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(1), 1); |
| cq_verify(cqv); |
| |
| GPR_ASSERT(status == GRPC_STATUS_PERMISSION_DENIED); |
| GPR_ASSERT(0 == strcmp(details, "Random failure that's not preventable.")); |
| |
| gpr_free(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); |
| |
| cq_verifier_destroy(cqv); |
| |
| grpc_byte_buffer_destroy(request_payload); |
| grpc_byte_buffer_destroy(request_payload_recv); |
| |
| end_test(&f); |
| config.tear_down_data(&f); |
| } |
| |
| /******************************************************************************* |
| * Test filter - always closes incoming requests |
| */ |
| |
| typedef struct { grpc_closure *recv_im_ready; } call_data; |
| |
| typedef struct { uint8_t unused; } channel_data; |
| |
| static void recv_im_ready(grpc_exec_ctx *exec_ctx, void *arg, bool success) { |
| grpc_call_element *elem = arg; |
| call_data *calld = elem->call_data; |
| if (success) { |
| // close the stream with an error. |
| gpr_slice message = |
| gpr_slice_from_copied_string("Random failure that's not preventable."); |
| grpc_transport_stream_op op; |
| memset(&op, 0, sizeof(op)); |
| grpc_transport_stream_op_add_close(&op, GRPC_STATUS_PERMISSION_DENIED, |
| &message); |
| grpc_call_next_op(exec_ctx, elem, &op); |
| } |
| calld->recv_im_ready->cb(exec_ctx, calld->recv_im_ready->cb_arg, false); |
| } |
| |
| static void start_transport_stream_op(grpc_exec_ctx *exec_ctx, |
| grpc_call_element *elem, |
| grpc_transport_stream_op *op) { |
| call_data *calld = elem->call_data; |
| if (op->recv_initial_metadata != NULL) { |
| calld->recv_im_ready = op->recv_initial_metadata_ready; |
| op->recv_initial_metadata_ready = grpc_closure_create(recv_im_ready, elem); |
| } |
| grpc_call_next_op(exec_ctx, elem, op); |
| } |
| |
| static void init_call_elem(grpc_exec_ctx *exec_ctx, grpc_call_element *elem, |
| grpc_call_element_args *args) {} |
| |
| static void destroy_call_elem(grpc_exec_ctx *exec_ctx, grpc_call_element *elem, |
| const grpc_call_stats *stats, |
| void *and_free_memory) {} |
| |
| static void init_channel_elem(grpc_exec_ctx *exec_ctx, |
| grpc_channel_element *elem, |
| grpc_channel_element_args *args) {} |
| |
| static void destroy_channel_elem(grpc_exec_ctx *exec_ctx, |
| grpc_channel_element *elem) {} |
| |
| static const grpc_channel_filter test_filter = { |
| start_transport_stream_op, |
| grpc_channel_next_op, |
| sizeof(call_data), |
| init_call_elem, |
| grpc_call_stack_ignore_set_pollset_or_pollset_set, |
| destroy_call_elem, |
| sizeof(channel_data), |
| init_channel_elem, |
| destroy_channel_elem, |
| grpc_call_next_get_peer, |
| "filter_causes_close"}; |
| |
| /******************************************************************************* |
| * Registration |
| */ |
| |
| static bool maybe_add_filter(grpc_channel_stack_builder *builder, void *arg) { |
| if (g_enable_filter) { |
| return grpc_channel_stack_builder_prepend_filter(builder, &test_filter, |
| NULL, NULL); |
| } else { |
| return true; |
| } |
| } |
| |
| static void init_plugin(void) { |
| grpc_channel_init_register_stage(GRPC_SERVER_CHANNEL, 0, maybe_add_filter, |
| NULL); |
| } |
| |
| static void destroy_plugin(void) {} |
| |
| void filter_causes_close(grpc_end2end_test_config config) { |
| g_enable_filter = true; |
| test_request(config); |
| g_enable_filter = false; |
| } |
| |
| void filter_causes_close_pre_init(void) { |
| grpc_register_plugin(init_plugin, destroy_plugin); |
| } |