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/response with metadata and payload.*/
test_request_response_with_metadata_and_payload(grpc_end2end_test_config config)87 static void test_request_response_with_metadata_and_payload(
88     grpc_end2end_test_config config) {
89   grpc_call* c;
90   grpc_call* s;
91   grpc_slice request_payload_slice =
92       grpc_slice_from_copied_string("hello world");
93   grpc_slice response_payload_slice =
94       grpc_slice_from_copied_string("hello you");
95   grpc_byte_buffer* request_payload =
96       grpc_raw_byte_buffer_create(&request_payload_slice, 1);
97   grpc_byte_buffer* response_payload =
98       grpc_raw_byte_buffer_create(&response_payload_slice, 1);
99   grpc_metadata meta_c[2] = {{grpc_slice_from_static_string("key1"),
100                               grpc_slice_from_static_string("val1"),
101                               0,
102                               {{nullptr, nullptr, nullptr, nullptr}}},
103                              {grpc_slice_from_static_string("key2"),
104                               grpc_slice_from_static_string("val2"),
105                               0,
106                               {{nullptr, nullptr, nullptr, nullptr}}}};
107   grpc_metadata meta_s[2] = {{grpc_slice_from_static_string("key3"),
108                               grpc_slice_from_static_string("val3"),
109                               0,
110                               {{nullptr, nullptr, nullptr, nullptr}}},
111                              {grpc_slice_from_static_string("key4"),
112                               grpc_slice_from_static_string("val4"),
113                               0,
114                               {{nullptr, nullptr, nullptr, nullptr}}}};
115   grpc_metadata meta_t[2] = {{grpc_slice_from_static_string("key5"),
116                               grpc_slice_from_static_string("val5"),
117                               0,
118                               {{nullptr, nullptr, nullptr, nullptr}}},
119                              {grpc_slice_from_static_string("key6"),
120                               grpc_slice_from_static_string("val6"),
121                               0,
122                               {{nullptr, nullptr, nullptr, nullptr}}}};
123   grpc_end2end_test_fixture f =
124       begin_test(config, "test_request_response_with_metadata_and_payload",
125                  nullptr, nullptr);
126   cq_verifier* cqv = cq_verifier_create(f.cq);
127   grpc_op ops[6];
128   grpc_op* op;
129   grpc_metadata_array initial_metadata_recv;
130   grpc_metadata_array trailing_metadata_recv;
131   grpc_metadata_array request_metadata_recv;
132   grpc_byte_buffer* request_payload_recv = nullptr;
133   grpc_byte_buffer* response_payload_recv = nullptr;
134   grpc_call_details call_details;
135   grpc_status_code status;
136   grpc_call_error error;
137   grpc_slice details;
138   int was_cancelled = 2;
139 
140   gpr_timespec deadline = five_seconds_from_now();
141   c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
142                                grpc_slice_from_static_string("/foo"), nullptr,
143                                deadline, nullptr);
144   GPR_ASSERT(c);
145 
146   grpc_metadata_array_init(&initial_metadata_recv);
147   grpc_metadata_array_init(&trailing_metadata_recv);
148   grpc_metadata_array_init(&request_metadata_recv);
149   grpc_call_details_init(&call_details);
150 
151   memset(ops, 0, sizeof(ops));
152   op = ops;
153   op->op = GRPC_OP_SEND_INITIAL_METADATA;
154   op->data.send_initial_metadata.count = 2;
155   op->data.send_initial_metadata.metadata = meta_c;
156   op->flags = 0;
157   op->reserved = nullptr;
158   op++;
159   op->op = GRPC_OP_SEND_MESSAGE;
160   op->data.send_message.send_message = request_payload;
161   op->flags = 0;
162   op->reserved = nullptr;
163   op++;
164   op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
165   op->flags = 0;
166   op->reserved = nullptr;
167   op++;
168   op->op = GRPC_OP_RECV_INITIAL_METADATA;
169   op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
170   op->flags = 0;
171   op->reserved = nullptr;
172   op++;
173   op->op = GRPC_OP_RECV_MESSAGE;
174   op->data.recv_message.recv_message = &response_payload_recv;
175   op->flags = 0;
176   op->reserved = nullptr;
177   op++;
178   op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
179   op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
180   op->data.recv_status_on_client.status = &status;
181   op->data.recv_status_on_client.status_details = &details;
182   op->flags = 0;
183   op->reserved = nullptr;
184   op++;
185   error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(1),
186                                 nullptr);
187   GPR_ASSERT(GRPC_CALL_OK == error);
188 
189   error =
190       grpc_server_request_call(f.server, &s, &call_details,
191                                &request_metadata_recv, f.cq, f.cq, tag(101));
192   GPR_ASSERT(GRPC_CALL_OK == error);
193   CQ_EXPECT_COMPLETION(cqv, tag(101), 1);
194   cq_verify(cqv);
195 
196   memset(ops, 0, sizeof(ops));
197   op = ops;
198   op->op = GRPC_OP_SEND_INITIAL_METADATA;
199   op->data.send_initial_metadata.count = 2;
200   op->data.send_initial_metadata.metadata = meta_s;
201   op->flags = 0;
202   op->reserved = nullptr;
203   op++;
204   op->op = GRPC_OP_RECV_MESSAGE;
205   op->data.recv_message.recv_message = &request_payload_recv;
206   op->flags = 0;
207   op->reserved = nullptr;
208   op++;
209   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(102),
210                                 nullptr);
211   GPR_ASSERT(GRPC_CALL_OK == error);
212 
213   CQ_EXPECT_COMPLETION(cqv, tag(102), 1);
214   cq_verify(cqv);
215 
216   memset(ops, 0, sizeof(ops));
217   op = ops;
218   op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
219   op->data.recv_close_on_server.cancelled = &was_cancelled;
220   op->flags = 0;
221   op->reserved = nullptr;
222   op++;
223   op->op = GRPC_OP_SEND_MESSAGE;
224   op->data.send_message.send_message = response_payload;
225   op->flags = 0;
226   op->reserved = nullptr;
227   op++;
228   op->op = GRPC_OP_SEND_STATUS_FROM_SERVER;
229   op->data.send_status_from_server.trailing_metadata_count = 2;
230   op->data.send_status_from_server.trailing_metadata = meta_t;
231   op->data.send_status_from_server.status = GRPC_STATUS_OK;
232   grpc_slice status_details = grpc_slice_from_static_string("xyz");
233   op->data.send_status_from_server.status_details = &status_details;
234   op->flags = 0;
235   op->reserved = nullptr;
236   op++;
237   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(103),
238                                 nullptr);
239   GPR_ASSERT(GRPC_CALL_OK == error);
240 
241   CQ_EXPECT_COMPLETION(cqv, tag(103), 1);
242   CQ_EXPECT_COMPLETION(cqv, tag(1), 1);
243   cq_verify(cqv);
244 
245   GPR_ASSERT(status == GRPC_STATUS_OK);
246   GPR_ASSERT(0 == grpc_slice_str_cmp(details, "xyz"));
247   GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/foo"));
248   GPR_ASSERT(byte_buffer_eq_string(request_payload_recv, "hello world"));
249   GPR_ASSERT(byte_buffer_eq_string(response_payload_recv, "hello you"));
250   GPR_ASSERT(contains_metadata(&request_metadata_recv, "key1", "val1"));
251   GPR_ASSERT(contains_metadata(&request_metadata_recv, "key2", "val2"));
252   GPR_ASSERT(contains_metadata(&initial_metadata_recv, "key3", "val3"));
253   GPR_ASSERT(contains_metadata(&initial_metadata_recv, "key4", "val4"));
254   GPR_ASSERT(contains_metadata(&trailing_metadata_recv, "key5", "val5"));
255   GPR_ASSERT(contains_metadata(&trailing_metadata_recv, "key6", "val6"));
256 
257   grpc_slice_unref(details);
258   grpc_metadata_array_destroy(&initial_metadata_recv);
259   grpc_metadata_array_destroy(&trailing_metadata_recv);
260   grpc_metadata_array_destroy(&request_metadata_recv);
261   grpc_call_details_destroy(&call_details);
262 
263   grpc_call_unref(c);
264   grpc_call_unref(s);
265 
266   cq_verifier_destroy(cqv);
267 
268   grpc_byte_buffer_destroy(request_payload);
269   grpc_byte_buffer_destroy(response_payload);
270   grpc_byte_buffer_destroy(request_payload_recv);
271   grpc_byte_buffer_destroy(response_payload_recv);
272 
273   end_test(&f);
274   config.tear_down_data(&f);
275 }
276 
trailing_metadata(grpc_end2end_test_config config)277 void trailing_metadata(grpc_end2end_test_config config) {
278   test_request_response_with_metadata_and_payload(config);
279 }
280 
trailing_metadata_pre_init(void)281 void trailing_metadata_pre_init(void) {}
282