3 * Copyright 2017 gRPC authors.
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include "test/core/end2end/end2end_tests.h"
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"
30 static void* tag(intptr_t t) { return reinterpret_cast<void*>(t); }
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);
44 static gpr_timespec n_seconds_from_now(int n) {
45 return grpc_timeout_seconds_to_deadline(n);
48 static gpr_timespec five_seconds_from_now(void) {
49 return n_seconds_from_now(5);
52 static void drain_cq(grpc_completion_queue* cq) {
55 ev = grpc_completion_queue_next(cq, five_seconds_from_now(), nullptr);
56 } while (ev.type != GRPC_QUEUE_SHUTDOWN);
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),
65 .type == GRPC_OP_COMPLETE);
66 grpc_server_destroy(f->server);
70 static void shutdown_client(grpc_end2end_test_fixture* f) {
71 if (!f->client) return;
72 grpc_channel_destroy(f->client);
76 static void end_test(grpc_end2end_test_fixture* f) {
80 grpc_completion_queue_shutdown(f->cq);
82 grpc_completion_queue_destroy(f->cq);
83 grpc_completion_queue_destroy(f->shutdown_cq);
86 /* Client sends a request with payload, server reads then returns status. */
87 static void test_invoke_request_with_payload(grpc_end2end_test_config config) {
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);
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_recv1 = nullptr;
103 grpc_byte_buffer* request_payload_recv2 = nullptr;
104 grpc_call_details call_details;
105 grpc_status_code status;
106 grpc_call_error error;
107 grpc_slice details = grpc_empty_slice();
108 int was_cancelled = 2;
110 gpr_timespec deadline = five_seconds_from_now();
111 c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
112 grpc_slice_from_static_string("/foo"), nullptr,
116 grpc_metadata_array_init(&initial_metadata_recv);
117 grpc_metadata_array_init(&trailing_metadata_recv);
118 grpc_metadata_array_init(&request_metadata_recv);
119 grpc_call_details_init(&call_details);
121 memset(ops, 0, sizeof(ops));
123 op->op = GRPC_OP_SEND_INITIAL_METADATA;
124 op->data.send_initial_metadata.count = 0;
126 error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(1),
128 GPR_ASSERT(GRPC_CALL_OK == error);
130 memset(ops, 0, sizeof(ops));
132 op->op = GRPC_OP_RECV_INITIAL_METADATA;
133 op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
135 op->reserved = nullptr;
137 error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(2),
139 GPR_ASSERT(GRPC_CALL_OK == error);
141 GPR_ASSERT(GRPC_CALL_OK == grpc_server_request_call(
142 f.server, &s, &call_details,
143 &request_metadata_recv, f.cq, f.cq, tag(101)));
144 CQ_EXPECT_COMPLETION(cqv, tag(1), true); /* send message is buffered */
145 CQ_EXPECT_COMPLETION(cqv, tag(101), true);
148 memset(ops, 0, sizeof(ops));
150 op->op = GRPC_OP_SEND_MESSAGE;
151 op->data.send_message.send_message = request_payload;
152 op->flags = GRPC_WRITE_BUFFER_HINT;
154 error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(3),
156 GPR_ASSERT(GRPC_CALL_OK == error);
158 memset(ops, 0, sizeof(ops));
160 op->op = GRPC_OP_SEND_INITIAL_METADATA;
161 op->data.send_initial_metadata.count = 0;
163 error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(102),
165 GPR_ASSERT(GRPC_CALL_OK == error);
167 /* recv message should not succeed yet - it's buffered at the client still */
168 memset(ops, 0, sizeof(ops));
170 op->op = GRPC_OP_RECV_MESSAGE;
171 op->data.recv_message.recv_message = &request_payload_recv1;
173 error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(103),
175 GPR_ASSERT(GRPC_CALL_OK == error);
177 CQ_EXPECT_COMPLETION(cqv, tag(2), true);
178 CQ_EXPECT_COMPLETION(cqv, tag(3), true);
179 CQ_EXPECT_COMPLETION(cqv, tag(102), true);
182 /* send end of stream: should release the buffering */
183 memset(ops, 0, sizeof(ops));
185 op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
187 error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(4),
189 GPR_ASSERT(GRPC_CALL_OK == error);
191 /* now the first send should match up with the first recv */
192 CQ_EXPECT_COMPLETION(cqv, tag(103), true);
193 CQ_EXPECT_COMPLETION(cqv, tag(4), true);
196 /* and the next recv should be ready immediately also (and empty) */
197 memset(ops, 0, sizeof(ops));
199 op->op = GRPC_OP_RECV_MESSAGE;
200 op->data.recv_message.recv_message = &request_payload_recv2;
202 error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(104),
204 GPR_ASSERT(GRPC_CALL_OK == error);
206 CQ_EXPECT_COMPLETION(cqv, tag(104), true);
209 memset(ops, 0, sizeof(ops));
211 op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
212 op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
213 op->data.recv_status_on_client.status = &status;
214 op->data.recv_status_on_client.status_details = &details;
216 op->reserved = nullptr;
218 error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(4),
221 memset(ops, 0, sizeof(ops));
223 op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
224 op->data.recv_close_on_server.cancelled = &was_cancelled;
226 op->reserved = nullptr;
228 op->op = GRPC_OP_SEND_STATUS_FROM_SERVER;
229 op->data.send_status_from_server.trailing_metadata_count = 0;
230 op->data.send_status_from_server.status = GRPC_STATUS_OK;
231 grpc_slice status_details = grpc_slice_from_static_string("xyz");
232 op->data.send_status_from_server.status_details = &status_details;
234 op->reserved = nullptr;
236 error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(105),
238 GPR_ASSERT(GRPC_CALL_OK == error);
240 CQ_EXPECT_COMPLETION(cqv, tag(105), 1);
241 CQ_EXPECT_COMPLETION(cqv, tag(4), 1);
244 GPR_ASSERT(status == GRPC_STATUS_OK);
245 GPR_ASSERT(0 == grpc_slice_str_cmp(details, "xyz"));
246 GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/foo"));
247 GPR_ASSERT(was_cancelled == 0);
248 GPR_ASSERT(byte_buffer_eq_string(request_payload_recv1, "hello world"));
249 GPR_ASSERT(request_payload_recv2 == nullptr);
251 grpc_slice_unref(details);
252 grpc_metadata_array_destroy(&initial_metadata_recv);
253 grpc_metadata_array_destroy(&trailing_metadata_recv);
254 grpc_metadata_array_destroy(&request_metadata_recv);
255 grpc_call_details_destroy(&call_details);
260 cq_verifier_destroy(cqv);
262 grpc_byte_buffer_destroy(request_payload);
263 grpc_byte_buffer_destroy(request_payload_recv1);
266 config.tear_down_data(&f);
269 void write_buffering_at_end(grpc_end2end_test_config config) {
270 test_invoke_request_with_payload(config);
273 void write_buffering_at_end_pre_init(void) {}