1 /*
2  *
3  * Copyright 2015 gRPC authors.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  *     http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  */
18 
19 #include "test/core/end2end/end2end_tests.h"
20 
21 #include <stdio.h>
22 #include <string.h>
23 
24 #include <grpc/byte_buffer.h>
25 #include <grpc/support/alloc.h>
26 #include <grpc/support/log.h>
27 #include <grpc/support/time.h>
28 
29 #include "src/core/lib/gpr/useful.h"
30 #include "test/core/end2end/cq_verifier.h"
31 #include "test/core/end2end/tests/cancel_test_helpers.h"
32 
tag(intptr_t t)33 static void* tag(intptr_t t) { return (void*)t; }
34 
begin_test(grpc_end2end_test_config config,const char * test_name,cancellation_mode mode,grpc_channel_args * client_args,grpc_channel_args * server_args)35 static grpc_end2end_test_fixture begin_test(grpc_end2end_test_config config,
36                                             const char* test_name,
37                                             cancellation_mode mode,
38                                             grpc_channel_args* client_args,
39                                             grpc_channel_args* server_args) {
40   grpc_end2end_test_fixture f;
41   gpr_log(GPR_INFO, "Running test: %s/%s/%s", test_name, config.name,
42           mode.name);
43   f = config.create_fixture(client_args, server_args);
44   config.init_server(&f, server_args);
45   config.init_client(&f, client_args);
46   return f;
47 }
48 
n_seconds_from_now(int n)49 static gpr_timespec n_seconds_from_now(int n) {
50   return grpc_timeout_seconds_to_deadline(n);
51 }
52 
five_seconds_from_now(void)53 static gpr_timespec five_seconds_from_now(void) {
54   return n_seconds_from_now(5);
55 }
56 
drain_cq(grpc_completion_queue * cq)57 static void drain_cq(grpc_completion_queue* cq) {
58   grpc_event ev;
59   do {
60     ev = grpc_completion_queue_next(cq, five_seconds_from_now(), nullptr);
61   } while (ev.type != GRPC_QUEUE_SHUTDOWN);
62 }
63 
shutdown_server(grpc_end2end_test_fixture * f)64 static void shutdown_server(grpc_end2end_test_fixture* f) {
65   if (!f->server) return;
66   grpc_server_shutdown_and_notify(f->server, f->shutdown_cq, tag(1000));
67   GPR_ASSERT(grpc_completion_queue_pluck(f->shutdown_cq, tag(1000),
68                                          grpc_timeout_seconds_to_deadline(5),
69                                          nullptr)
70                  .type == GRPC_OP_COMPLETE);
71   grpc_server_destroy(f->server);
72   f->server = nullptr;
73 }
74 
shutdown_client(grpc_end2end_test_fixture * f)75 static void shutdown_client(grpc_end2end_test_fixture* f) {
76   if (!f->client) return;
77   grpc_channel_destroy(f->client);
78   f->client = nullptr;
79 }
80 
end_test(grpc_end2end_test_fixture * f)81 static void end_test(grpc_end2end_test_fixture* f) {
82   shutdown_server(f);
83   shutdown_client(f);
84 
85   grpc_completion_queue_shutdown(f->cq);
86   drain_cq(f->cq);
87   grpc_completion_queue_destroy(f->cq);
88   grpc_completion_queue_destroy(f->shutdown_cq);
89 }
90 
91 /* Cancel and do nothing */
test_cancel_in_a_vacuum(grpc_end2end_test_config config,cancellation_mode mode)92 static void test_cancel_in_a_vacuum(grpc_end2end_test_config config,
93                                     cancellation_mode mode) {
94   grpc_call* c;
95   grpc_end2end_test_fixture f =
96       begin_test(config, "test_cancel_in_a_vacuum", mode, nullptr, nullptr);
97   cq_verifier* v_client = cq_verifier_create(f.cq);
98 
99   gpr_timespec deadline = five_seconds_from_now();
100   c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
101                                grpc_slice_from_static_string("/foo"), nullptr,
102                                deadline, nullptr);
103   GPR_ASSERT(c);
104 
105   GPR_ASSERT(GRPC_CALL_OK == mode.initiate_cancel(c, nullptr));
106 
107   grpc_call_unref(c);
108 
109   cq_verifier_destroy(v_client);
110   end_test(&f);
111   config.tear_down_data(&f);
112 }
113 
cancel_in_a_vacuum(grpc_end2end_test_config config)114 void cancel_in_a_vacuum(grpc_end2end_test_config config) {
115   unsigned i;
116 
117   for (i = 0; i < GPR_ARRAY_SIZE(cancellation_modes); i++) {
118     test_cancel_in_a_vacuum(config, cancellation_modes[i]);
119   }
120 }
121 
cancel_in_a_vacuum_pre_init(void)122 void cancel_in_a_vacuum_pre_init(void) {}
123