1 /*
2  *
3  * Copyright 2017 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 /* Client sends a request with payload, server reads then returns status. */
test_invoke_request_with_payload(grpc_end2end_test_config config)87 static void test_invoke_request_with_payload(grpc_end2end_test_config config) {
88   grpc_call* c;
89   grpc_call* s;
90   grpc_slice request_payload_slice1 =
91       grpc_slice_from_copied_string("hello world");
92   grpc_byte_buffer* request_payload1 =
93       grpc_raw_byte_buffer_create(&request_payload_slice1, 1);
94   grpc_slice request_payload_slice2 = grpc_slice_from_copied_string("abc123");
95   grpc_byte_buffer* request_payload2 =
96       grpc_raw_byte_buffer_create(&request_payload_slice2, 1);
97   grpc_end2end_test_fixture f =
98       begin_test(config, "test_invoke_request_with_payload", nullptr, nullptr);
99   cq_verifier* cqv = cq_verifier_create(f.cq);
100   grpc_op ops[6];
101   grpc_op* op;
102   grpc_metadata_array initial_metadata_recv;
103   grpc_metadata_array trailing_metadata_recv;
104   grpc_metadata_array request_metadata_recv;
105   grpc_byte_buffer* request_payload_recv1 = nullptr;
106   grpc_byte_buffer* request_payload_recv2 = nullptr;
107   grpc_call_details call_details;
108   grpc_status_code status;
109   grpc_call_error error;
110   grpc_slice details = grpc_empty_slice();
111   int was_cancelled = 2;
112 
113   gpr_timespec deadline = five_seconds_from_now();
114   c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
115                                grpc_slice_from_static_string("/foo"), nullptr,
116                                deadline, nullptr);
117   GPR_ASSERT(c);
118 
119   grpc_metadata_array_init(&initial_metadata_recv);
120   grpc_metadata_array_init(&trailing_metadata_recv);
121   grpc_metadata_array_init(&request_metadata_recv);
122   grpc_call_details_init(&call_details);
123 
124   memset(ops, 0, sizeof(ops));
125   op = ops;
126   op->op = GRPC_OP_SEND_INITIAL_METADATA;
127   op->data.send_initial_metadata.count = 0;
128   op++;
129   error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(1),
130                                 nullptr);
131   GPR_ASSERT(GRPC_CALL_OK == error);
132 
133   memset(ops, 0, sizeof(ops));
134   op = ops;
135   op->op = GRPC_OP_RECV_INITIAL_METADATA;
136   op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
137   op->flags = 0;
138   op->reserved = nullptr;
139   op++;
140   error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(2),
141                                 nullptr);
142   GPR_ASSERT(GRPC_CALL_OK == error);
143 
144   GPR_ASSERT(GRPC_CALL_OK == grpc_server_request_call(
145                                  f.server, &s, &call_details,
146                                  &request_metadata_recv, f.cq, f.cq, tag(101)));
147   CQ_EXPECT_COMPLETION(cqv, tag(1), true); /* send message is buffered */
148   CQ_EXPECT_COMPLETION(cqv, tag(101), true);
149   cq_verify(cqv);
150 
151   memset(ops, 0, sizeof(ops));
152   op = ops;
153   op->op = GRPC_OP_SEND_MESSAGE;
154   op->data.send_message.send_message = request_payload1;
155   op->flags = GRPC_WRITE_BUFFER_HINT;
156   op++;
157   error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(3),
158                                 nullptr);
159   GPR_ASSERT(GRPC_CALL_OK == error);
160 
161   memset(ops, 0, sizeof(ops));
162   op = ops;
163   op->op = GRPC_OP_SEND_INITIAL_METADATA;
164   op->data.send_initial_metadata.count = 0;
165   op++;
166   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(102),
167                                 nullptr);
168   GPR_ASSERT(GRPC_CALL_OK == error);
169 
170   /* recv message should not succeed yet - it's buffered at the client still */
171   memset(ops, 0, sizeof(ops));
172   op = ops;
173   op->op = GRPC_OP_RECV_MESSAGE;
174   op->data.recv_message.recv_message = &request_payload_recv1;
175   op++;
176   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(103),
177                                 nullptr);
178   GPR_ASSERT(GRPC_CALL_OK == error);
179 
180   CQ_EXPECT_COMPLETION(cqv, tag(2), true);
181   CQ_EXPECT_COMPLETION(cqv, tag(3), true);
182   CQ_EXPECT_COMPLETION(cqv, tag(102), true);
183   cq_verify(cqv);
184 
185   /* send another message, this time not buffered */
186   memset(ops, 0, sizeof(ops));
187   op = ops;
188   op->op = GRPC_OP_SEND_MESSAGE;
189   op->data.send_message.send_message = request_payload2;
190   op->flags = 0;
191   op++;
192   error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(4),
193                                 nullptr);
194   GPR_ASSERT(GRPC_CALL_OK == error);
195 
196   /* now the first send should match up with the first recv */
197   CQ_EXPECT_COMPLETION(cqv, tag(103), true);
198   CQ_EXPECT_COMPLETION(cqv, tag(4), true);
199   cq_verify(cqv);
200 
201   /* and the next recv should be ready immediately also */
202   memset(ops, 0, sizeof(ops));
203   op = ops;
204   op->op = GRPC_OP_RECV_MESSAGE;
205   op->data.recv_message.recv_message = &request_payload_recv2;
206   op++;
207   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(104),
208                                 nullptr);
209   GPR_ASSERT(GRPC_CALL_OK == error);
210 
211   CQ_EXPECT_COMPLETION(cqv, tag(104), true);
212   cq_verify(cqv);
213 
214   memset(ops, 0, sizeof(ops));
215   op = ops;
216   op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
217   op->flags = 0;
218   op->reserved = nullptr;
219   op++;
220   op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
221   op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
222   op->data.recv_status_on_client.status = &status;
223   op->data.recv_status_on_client.status_details = &details;
224   op->flags = 0;
225   op->reserved = nullptr;
226   op++;
227   error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(4),
228                                 nullptr);
229 
230   memset(ops, 0, sizeof(ops));
231   op = ops;
232   op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
233   op->data.recv_close_on_server.cancelled = &was_cancelled;
234   op->flags = 0;
235   op->reserved = nullptr;
236   op++;
237   op->op = GRPC_OP_SEND_STATUS_FROM_SERVER;
238   op->data.send_status_from_server.trailing_metadata_count = 0;
239   op->data.send_status_from_server.status = GRPC_STATUS_OK;
240   grpc_slice status_details = grpc_slice_from_static_string("xyz");
241   op->data.send_status_from_server.status_details = &status_details;
242   op->flags = 0;
243   op->reserved = nullptr;
244   op++;
245   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(105),
246                                 nullptr);
247   GPR_ASSERT(GRPC_CALL_OK == error);
248 
249   CQ_EXPECT_COMPLETION(cqv, tag(105), 1);
250   CQ_EXPECT_COMPLETION(cqv, tag(4), 1);
251   cq_verify(cqv);
252 
253   GPR_ASSERT(status == GRPC_STATUS_OK);
254   GPR_ASSERT(0 == grpc_slice_str_cmp(details, "xyz"));
255   GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/foo"));
256   GPR_ASSERT(was_cancelled == 0);
257   GPR_ASSERT(byte_buffer_eq_string(request_payload_recv1, "hello world"));
258   GPR_ASSERT(byte_buffer_eq_string(request_payload_recv2, "abc123"));
259 
260   grpc_slice_unref(details);
261   grpc_metadata_array_destroy(&initial_metadata_recv);
262   grpc_metadata_array_destroy(&trailing_metadata_recv);
263   grpc_metadata_array_destroy(&request_metadata_recv);
264   grpc_call_details_destroy(&call_details);
265 
266   grpc_call_unref(c);
267   grpc_call_unref(s);
268 
269   cq_verifier_destroy(cqv);
270 
271   grpc_byte_buffer_destroy(request_payload1);
272   grpc_byte_buffer_destroy(request_payload_recv1);
273   grpc_byte_buffer_destroy(request_payload2);
274   grpc_byte_buffer_destroy(request_payload_recv2);
275 
276   end_test(&f);
277   config.tear_down_data(&f);
278 }
279 
write_buffering(grpc_end2end_test_config config)280 void write_buffering(grpc_end2end_test_config config) {
281   test_invoke_request_with_payload(config);
282 }
283 
write_buffering_pre_init(void)284 void write_buffering_pre_init(void) {}
285