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 /* 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_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_end2end_test_fixture f =
95       begin_test(config, "test_invoke_request_with_payload", nullptr, nullptr);
96   cq_verifier* cqv = cq_verifier_create(f.cq);
97   grpc_op ops[6];
98   grpc_op* op;
99   grpc_metadata_array initial_metadata_recv;
100   grpc_metadata_array trailing_metadata_recv;
101   grpc_metadata_array request_metadata_recv;
102   grpc_byte_buffer* request_payload_recv = nullptr;
103   grpc_call_details call_details;
104   grpc_status_code status;
105   grpc_call_error error;
106   grpc_slice details;
107   int was_cancelled = 2;
108 
109   gpr_timespec deadline = five_seconds_from_now();
110   c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
111                                grpc_slice_from_static_string("/foo"), nullptr,
112                                deadline, nullptr);
113   GPR_ASSERT(c);
114 
115   grpc_metadata_array_init(&initial_metadata_recv);
116   grpc_metadata_array_init(&trailing_metadata_recv);
117   grpc_metadata_array_init(&request_metadata_recv);
118   grpc_call_details_init(&call_details);
119 
120   memset(ops, 0, sizeof(ops));
121   op = ops;
122   op->op = GRPC_OP_SEND_INITIAL_METADATA;
123   op->data.send_initial_metadata.count = 0;
124   op->flags = 0;
125   op->reserved = nullptr;
126   op++;
127   op->op = GRPC_OP_SEND_MESSAGE;
128   op->data.send_message.send_message = request_payload;
129   op->flags = 0;
130   op->reserved = nullptr;
131   op++;
132   op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
133   op->flags = 0;
134   op->reserved = nullptr;
135   op++;
136   op->op = GRPC_OP_RECV_INITIAL_METADATA;
137   op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
138   op->flags = 0;
139   op->reserved = nullptr;
140   op++;
141   op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
142   op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
143   op->data.recv_status_on_client.status = &status;
144   op->data.recv_status_on_client.status_details = &details;
145   op->flags = 0;
146   op->reserved = nullptr;
147   op++;
148   error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(1),
149                                 nullptr);
150   GPR_ASSERT(GRPC_CALL_OK == error);
151 
152   GPR_ASSERT(GRPC_CALL_OK == grpc_server_request_call(
153                                  f.server, &s, &call_details,
154                                  &request_metadata_recv, f.cq, f.cq, tag(101)));
155   CQ_EXPECT_COMPLETION(cqv, tag(101), 1);
156   cq_verify(cqv);
157 
158   memset(ops, 0, sizeof(ops));
159   op = ops;
160   op->op = GRPC_OP_SEND_INITIAL_METADATA;
161   op->data.send_initial_metadata.count = 0;
162   op->flags = 0;
163   op->reserved = nullptr;
164   op++;
165   op->op = GRPC_OP_RECV_MESSAGE;
166   op->data.recv_message.recv_message = &request_payload_recv;
167   op->flags = 0;
168   op->reserved = nullptr;
169   op++;
170   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(102),
171                                 nullptr);
172   GPR_ASSERT(GRPC_CALL_OK == error);
173 
174   CQ_EXPECT_COMPLETION(cqv, tag(102), 1);
175   cq_verify(cqv);
176 
177   memset(ops, 0, sizeof(ops));
178   op = ops;
179   op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
180   op->data.recv_close_on_server.cancelled = &was_cancelled;
181   op->flags = 0;
182   op->reserved = nullptr;
183   op++;
184   op->op = GRPC_OP_SEND_STATUS_FROM_SERVER;
185   op->data.send_status_from_server.trailing_metadata_count = 0;
186   op->data.send_status_from_server.status = GRPC_STATUS_OK;
187   grpc_slice status_details = grpc_slice_from_static_string("xyz");
188   op->data.send_status_from_server.status_details = &status_details;
189   op->flags = 0;
190   op->reserved = nullptr;
191   op++;
192   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(103),
193                                 nullptr);
194   GPR_ASSERT(GRPC_CALL_OK == error);
195 
196   CQ_EXPECT_COMPLETION(cqv, tag(103), 1);
197   CQ_EXPECT_COMPLETION(cqv, tag(1), 1);
198   cq_verify(cqv);
199 
200   GPR_ASSERT(status == GRPC_STATUS_OK);
201   GPR_ASSERT(0 == grpc_slice_str_cmp(details, "xyz"));
202   GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/foo"));
203   GPR_ASSERT(was_cancelled == 0);
204   GPR_ASSERT(byte_buffer_eq_string(request_payload_recv, "hello world"));
205 
206   grpc_slice_unref(details);
207   grpc_metadata_array_destroy(&initial_metadata_recv);
208   grpc_metadata_array_destroy(&trailing_metadata_recv);
209   grpc_metadata_array_destroy(&request_metadata_recv);
210   grpc_call_details_destroy(&call_details);
211 
212   grpc_call_unref(c);
213   grpc_call_unref(s);
214 
215   cq_verifier_destroy(cqv);
216 
217   grpc_byte_buffer_destroy(request_payload);
218   grpc_byte_buffer_destroy(request_payload_recv);
219 
220   end_test(&f);
221   config.tear_down_data(&f);
222 }
223 
request_with_payload(grpc_end2end_test_config config)224 void request_with_payload(grpc_end2end_test_config config) {
225   test_invoke_request_with_payload(config);
226 }
227 
request_with_payload_pre_init(void)228 void request_with_payload_pre_init(void) {}
229