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 #include "test/core/end2end/cq_verifier.h"
29 
tag(intptr_t t)30 static void* tag(intptr_t t) { return (void*)t; }
31 
begin_test(grpc_end2end_test_config config,const char * test_name,grpc_channel_args * client_args,grpc_channel_args * server_args)32 static grpc_end2end_test_fixture begin_test(grpc_end2end_test_config config,
33                                             const char* test_name,
34                                             grpc_channel_args* client_args,
35                                             grpc_channel_args* server_args) {
36   grpc_end2end_test_fixture f;
37   gpr_log(GPR_INFO, "Running test: %s/%s", test_name, config.name);
38   f = config.create_fixture(client_args, server_args);
39   config.init_server(&f, server_args);
40   config.init_client(&f, client_args);
41   return f;
42 }
43 
n_seconds_from_now(int n)44 static gpr_timespec n_seconds_from_now(int n) {
45   return grpc_timeout_seconds_to_deadline(n);
46 }
47 
five_seconds_from_now(void)48 static gpr_timespec five_seconds_from_now(void) {
49   return n_seconds_from_now(5);
50 }
51 
drain_cq(grpc_completion_queue * cq)52 static void drain_cq(grpc_completion_queue* cq) {
53   grpc_event ev;
54   do {
55     ev = grpc_completion_queue_next(cq, five_seconds_from_now(), nullptr);
56   } while (ev.type != GRPC_QUEUE_SHUTDOWN);
57 }
58 
shutdown_server(grpc_end2end_test_fixture * f)59 static void shutdown_server(grpc_end2end_test_fixture* f) {
60   if (!f->server) return;
61   grpc_server_shutdown_and_notify(f->server, f->shutdown_cq, tag(1000));
62   GPR_ASSERT(grpc_completion_queue_pluck(f->shutdown_cq, tag(1000),
63                                          grpc_timeout_seconds_to_deadline(5),
64                                          nullptr)
65                  .type == GRPC_OP_COMPLETE);
66   grpc_server_destroy(f->server);
67   f->server = nullptr;
68 }
69 
shutdown_client(grpc_end2end_test_fixture * f)70 static void shutdown_client(grpc_end2end_test_fixture* f) {
71   if (!f->client) return;
72   grpc_channel_destroy(f->client);
73   f->client = nullptr;
74 }
75 
end_test(grpc_end2end_test_fixture * f)76 static void end_test(grpc_end2end_test_fixture* f) {
77   shutdown_server(f);
78   shutdown_client(f);
79 
80   grpc_completion_queue_shutdown(f->cq);
81   drain_cq(f->cq);
82   grpc_completion_queue_destroy(f->cq);
83   grpc_completion_queue_destroy(f->shutdown_cq);
84 }
85 
86 // Request with a large amount of metadata.
test_request_with_large_metadata(grpc_end2end_test_config config)87 static void test_request_with_large_metadata(grpc_end2end_test_config config) {
88   grpc_call* c;
89   grpc_call* s;
90   grpc_slice request_payload_slice =
91       grpc_slice_from_copied_string("hello world");
92   grpc_byte_buffer* request_payload =
93       grpc_raw_byte_buffer_create(&request_payload_slice, 1);
94   grpc_metadata meta;
95   const size_t large_size = 64 * 1024;
96   grpc_arg arg;
97   arg.type = GRPC_ARG_INTEGER;
98   arg.key = const_cast<char*>(GRPC_ARG_MAX_METADATA_SIZE);
99   arg.value.integer = static_cast<int>(large_size) + 1024;
100   grpc_channel_args args = {1, &arg};
101   grpc_end2end_test_fixture f =
102       begin_test(config, "test_request_with_large_metadata", &args, &args);
103   cq_verifier* cqv = cq_verifier_create(f.cq);
104   grpc_op ops[6];
105   grpc_op* op;
106   grpc_metadata_array initial_metadata_recv;
107   grpc_metadata_array trailing_metadata_recv;
108   grpc_metadata_array request_metadata_recv;
109   grpc_byte_buffer* request_payload_recv = nullptr;
110   grpc_call_details call_details;
111   grpc_status_code status;
112   grpc_call_error error;
113   grpc_slice details;
114   int was_cancelled = 2;
115 
116   gpr_timespec deadline = five_seconds_from_now();
117   c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
118                                grpc_slice_from_static_string("/foo"), nullptr,
119                                deadline, nullptr);
120   GPR_ASSERT(c);
121 
122   meta.key = grpc_slice_from_static_string("key");
123   meta.value = grpc_slice_malloc(large_size);
124   memset(GRPC_SLICE_START_PTR(meta.value), 'a', large_size);
125 
126   grpc_metadata_array_init(&initial_metadata_recv);
127   grpc_metadata_array_init(&trailing_metadata_recv);
128   grpc_metadata_array_init(&request_metadata_recv);
129   grpc_call_details_init(&call_details);
130 
131   memset(ops, 0, sizeof(ops));
132   // Client: send request.
133   op = ops;
134   op->op = GRPC_OP_SEND_INITIAL_METADATA;
135   op->data.send_initial_metadata.count = 1;
136   op->data.send_initial_metadata.metadata = &meta;
137   op->flags = 0;
138   op->reserved = nullptr;
139   op++;
140   op->op = GRPC_OP_SEND_MESSAGE;
141   op->data.send_message.send_message = request_payload;
142   op->flags = 0;
143   op->reserved = nullptr;
144   op++;
145   op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
146   op->flags = 0;
147   op->reserved = nullptr;
148   op++;
149   op->op = GRPC_OP_RECV_INITIAL_METADATA;
150   op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
151   op->flags = 0;
152   op->reserved = nullptr;
153   op++;
154   op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
155   op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
156   op->data.recv_status_on_client.status = &status;
157   op->data.recv_status_on_client.status_details = &details;
158   op->flags = 0;
159   op->reserved = nullptr;
160   op++;
161   error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(1),
162                                 nullptr);
163   GPR_ASSERT(GRPC_CALL_OK == error);
164 
165   error =
166       grpc_server_request_call(f.server, &s, &call_details,
167                                &request_metadata_recv, f.cq, f.cq, tag(101));
168   GPR_ASSERT(GRPC_CALL_OK == error);
169 
170   CQ_EXPECT_COMPLETION(cqv, tag(101), 1);
171   cq_verify(cqv);
172 
173   memset(ops, 0, sizeof(ops));
174   // Server: send initial metadata and receive request.
175   op = ops;
176   op->op = GRPC_OP_SEND_INITIAL_METADATA;
177   op->data.send_initial_metadata.count = 0;
178   op->flags = 0;
179   op->reserved = nullptr;
180   op++;
181   op->op = GRPC_OP_RECV_MESSAGE;
182   op->data.recv_message.recv_message = &request_payload_recv;
183   op->flags = 0;
184   op->reserved = nullptr;
185   op++;
186   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(102),
187                                 nullptr);
188   GPR_ASSERT(GRPC_CALL_OK == error);
189 
190   CQ_EXPECT_COMPLETION(cqv, tag(102), 1);
191   cq_verify(cqv);
192 
193   memset(ops, 0, sizeof(ops));
194   // Server: receive close and send status.  This should trigger
195   // completion of request on client.
196   op = ops;
197   op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
198   op->data.recv_close_on_server.cancelled = &was_cancelled;
199   op->flags = 0;
200   op->reserved = nullptr;
201   op++;
202   op->op = GRPC_OP_SEND_STATUS_FROM_SERVER;
203   op->data.send_status_from_server.trailing_metadata_count = 0;
204   op->data.send_status_from_server.status = GRPC_STATUS_OK;
205   grpc_slice status_details = grpc_slice_from_static_string("xyz");
206   op->data.send_status_from_server.status_details = &status_details;
207   op->flags = 0;
208   op->reserved = nullptr;
209   op++;
210   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(103),
211                                 nullptr);
212   GPR_ASSERT(GRPC_CALL_OK == error);
213 
214   CQ_EXPECT_COMPLETION(cqv, tag(103), 1);
215   CQ_EXPECT_COMPLETION(cqv, tag(1), 1);
216   cq_verify(cqv);
217 
218   GPR_ASSERT(status == GRPC_STATUS_OK);
219   GPR_ASSERT(0 == grpc_slice_str_cmp(details, "xyz"));
220   GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/foo"));
221   GPR_ASSERT(was_cancelled == 0);
222   GPR_ASSERT(byte_buffer_eq_string(request_payload_recv, "hello world"));
223   GPR_ASSERT(contains_metadata_slices(&request_metadata_recv,
224                                       grpc_slice_from_static_string("key"),
225                                       meta.value));
226 
227   grpc_slice_unref(details);
228   grpc_metadata_array_destroy(&initial_metadata_recv);
229   grpc_metadata_array_destroy(&trailing_metadata_recv);
230   grpc_metadata_array_destroy(&request_metadata_recv);
231   grpc_call_details_destroy(&call_details);
232 
233   grpc_call_unref(c);
234   grpc_call_unref(s);
235 
236   cq_verifier_destroy(cqv);
237 
238   grpc_byte_buffer_destroy(request_payload);
239   grpc_byte_buffer_destroy(request_payload_recv);
240 
241   grpc_slice_unref(meta.value);
242 
243   end_test(&f);
244   config.tear_down_data(&f);
245 }
246 
large_metadata(grpc_end2end_test_config config)247 void large_metadata(grpc_end2end_test_config config) {
248   test_request_with_large_metadata(config);
249 }
250 
large_metadata_pre_init(void)251 void large_metadata_pre_init(void) {}
252