xref: /aosp_15_r20/external/grpc-grpc/src/objective-c/tests/CronetTests/CronetUnitTests.mm (revision cc02d7e222339f7a4f6ba5f422e6413f4bd931f2)
1/*
2 *
3 * Copyright 2016 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#import <XCTest/XCTest.h>
20#import <netinet/in.h>
21#import <sys/socket.h>
22
23#import "../ConfigureCronet.h"
24
25#import <Cronet/Cronet.h>
26#import <grpc/grpc.h>
27#import <grpc/grpc_cronet.h>
28#import "test/core/end2end/cq_verifier.h"
29#import "test/core/util/port.h"
30
31#import <grpc/support/alloc.h>
32#import <grpc/support/log.h>
33
34#import "src/core/lib/channel/channel_args.h"
35#import "src/core/lib/gpr/string.h"
36#import "src/core/lib/gpr/tmpfile.h"
37#import "src/core/lib/gprpp/env.h"
38#import "src/core/lib/gprpp/host_port.h"
39#import "test/core/end2end/data/ssl_test_data.h"
40#import "test/core/util/test_config.h"
41
42#if COCOAPODS
43#import <openssl_grpc/ssl.h>
44#else
45#import <openssl/ssl.h>
46#endif
47
48static void drain_cq(grpc_completion_queue *cq) {
49  grpc_event ev;
50  do {
51    ev = grpc_completion_queue_next(cq, grpc_timeout_seconds_to_deadline(5), NULL);
52  } while (ev.type != GRPC_QUEUE_SHUTDOWN);
53}
54
55@interface CronetUnitTests : XCTestCase
56
57@end
58
59@implementation CronetUnitTests
60
61+ (void)setUp {
62  [super setUp];
63
64  char *argv[] = {(char *)"CoreCronetEnd2EndTests"};
65  int argc = 1;
66  grpc_test_init(&argc, argv);
67
68  grpc_init();
69  configureCronet(/*enable_netlog=*/false);
70  init_ssl();
71}
72
73+ (void)tearDown {
74  grpc_shutdown();
75  cleanup_ssl();
76
77  [super tearDown];
78}
79
80void init_ssl(void) {
81  SSL_load_error_strings();
82  OpenSSL_add_ssl_algorithms();
83}
84
85void cleanup_ssl(void) { EVP_cleanup(); }
86
87int alpn_cb(SSL *ssl, const unsigned char **out, unsigned char *outlen, const unsigned char *in,
88            unsigned int inlen, void *arg) {
89  // Always select "h2" as the ALPN protocol to be used
90  *out = (const unsigned char *)"h2";
91  *outlen = 2;
92  return SSL_TLSEXT_ERR_OK;
93}
94
95void init_ctx(SSL_CTX *ctx) {
96  // Install server certificate
97  BIO *pem = BIO_new_mem_buf((void *)test_server1_cert, (int)strlen(test_server1_cert));
98  X509 *cert = PEM_read_bio_X509_AUX(pem, NULL, NULL, (char *)"");
99  SSL_CTX_use_certificate(ctx, cert);
100  X509_free(cert);
101  BIO_free(pem);
102
103  // Install server private key
104  pem = BIO_new_mem_buf((void *)test_server1_key, (int)strlen(test_server1_key));
105  EVP_PKEY *key = PEM_read_bio_PrivateKey(pem, NULL, NULL, (char *)"");
106  SSL_CTX_use_PrivateKey(ctx, key);
107  EVP_PKEY_free(key);
108  BIO_free(pem);
109
110  // Select cipher suite
111  SSL_CTX_set_cipher_list(ctx, "ECDHE-RSA-AES128-GCM-SHA256");
112
113  // Select ALPN protocol
114  SSL_CTX_set_alpn_select_cb(ctx, alpn_cb, NULL);
115}
116
117unsigned int parse_h2_length(const char *field) {
118  return ((unsigned int)(unsigned char)(field[0])) * 65536 +
119         ((unsigned int)(unsigned char)(field[1])) * 256 +
120         ((unsigned int)(unsigned char)(field[2]));
121}
122
123- (void)testInternalError {
124  grpc_call *c;
125  grpc_slice request_payload_slice = grpc_slice_from_copied_string("hello world");
126  grpc_byte_buffer *request_payload = grpc_raw_byte_buffer_create(&request_payload_slice, 1);
127  gpr_timespec deadline = grpc_timeout_seconds_to_deadline(5);
128  grpc_metadata meta_c[2] = {{grpc_slice_from_static_string("key1"),
129                              grpc_slice_from_static_string("val1"),
130                              0,
131                              {{NULL, NULL, NULL, NULL}}},
132                             {grpc_slice_from_static_string("key2"),
133                              grpc_slice_from_static_string("val2"),
134                              0,
135                              {{NULL, NULL, NULL, NULL}}}};
136
137  int port = grpc_pick_unused_port_or_die();
138  std::string addr = grpc_core::JoinHostPort("127.0.0.1", port);
139  grpc_completion_queue *cq = grpc_completion_queue_create_for_next(NULL);
140  stream_engine *cronetEngine = [Cronet getGlobalEngine];
141  grpc_channel *client = grpc_cronet_secure_channel_create(cronetEngine, addr.c_str(), NULL, NULL);
142
143  grpc_core::CqVerifier cqv(cq);
144  grpc_op ops[6];
145  grpc_op *op;
146  grpc_metadata_array initial_metadata_recv;
147  grpc_metadata_array trailing_metadata_recv;
148  grpc_metadata_array request_metadata_recv;
149  grpc_byte_buffer *response_payload_recv = NULL;
150  grpc_call_details call_details;
151  grpc_status_code status;
152  grpc_call_error error;
153  grpc_slice details;
154
155  c = grpc_channel_create_call(client, NULL, GRPC_PROPAGATE_DEFAULTS, cq,
156                               grpc_slice_from_static_string("/foo"), NULL, deadline, NULL);
157  GPR_ASSERT(c);
158
159  grpc_metadata_array_init(&initial_metadata_recv);
160  grpc_metadata_array_init(&trailing_metadata_recv);
161  grpc_metadata_array_init(&request_metadata_recv);
162  grpc_call_details_init(&call_details);
163
164  int sl = socket(AF_INET, SOCK_STREAM, 0);
165  GPR_ASSERT(sl >= 0);
166
167  // Make an TCP endpoint to accept the connection
168  struct sockaddr_in s_addr;
169  memset(&s_addr, 0, sizeof(s_addr));
170  s_addr.sin_family = AF_INET;
171  s_addr.sin_addr.s_addr = htonl(INADDR_ANY);
172  s_addr.sin_port = htons(port);
173  GPR_ASSERT(0 == bind(sl, (struct sockaddr *)&s_addr, sizeof(s_addr)));
174  GPR_ASSERT(0 == listen(sl, 5));
175
176  memset(ops, 0, sizeof(ops));
177  op = ops;
178  op->op = GRPC_OP_SEND_INITIAL_METADATA;
179  op->data.send_initial_metadata.count = 2;
180  op->data.send_initial_metadata.metadata = meta_c;
181  op->flags = 0;
182  op->reserved = NULL;
183  op++;
184  op->op = GRPC_OP_SEND_MESSAGE;
185  op->data.send_message.send_message = request_payload;
186  op->flags = 0;
187  op->reserved = NULL;
188  op++;
189  op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
190  op->flags = 0;
191  op->reserved = NULL;
192  op++;
193  op->op = GRPC_OP_RECV_INITIAL_METADATA;
194  op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
195  op->flags = 0;
196  op->reserved = NULL;
197  op++;
198  op->op = GRPC_OP_RECV_MESSAGE;
199  op->data.recv_message.recv_message = &response_payload_recv;
200  op->flags = 0;
201  op->reserved = NULL;
202  op++;
203  op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
204  op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
205  op->data.recv_status_on_client.status = &status;
206  op->data.recv_status_on_client.status_details = &details;
207  op->flags = 0;
208  op->reserved = NULL;
209  op++;
210  error = grpc_call_start_batch(c, ops, (size_t)(op - ops), (void *)1, NULL);
211  GPR_ASSERT(GRPC_CALL_OK == error);
212
213  dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
214    int s = accept(sl, NULL, NULL);
215    GPR_ASSERT(s >= 0);
216
217    // Close the connection after 1 second to trigger Cronet's on_failed()
218    sleep(1);
219    close(s);
220    close(sl);
221  });
222
223  cqv.Expect((void *)1, true);
224  cqv.Verify();
225
226  GPR_ASSERT(status == GRPC_STATUS_UNAVAILABLE);
227
228  grpc_slice_unref(details);
229  grpc_metadata_array_destroy(&initial_metadata_recv);
230  grpc_metadata_array_destroy(&trailing_metadata_recv);
231  grpc_metadata_array_destroy(&request_metadata_recv);
232  grpc_call_details_destroy(&call_details);
233
234  grpc_call_unref(c);
235
236  grpc_byte_buffer_destroy(request_payload);
237  grpc_byte_buffer_destroy(response_payload_recv);
238
239  grpc_channel_destroy(client);
240  grpc_completion_queue_shutdown(cq);
241  drain_cq(cq);
242  grpc_completion_queue_destroy(cq);
243}
244
245- (void)packetCoalescing:(BOOL)useCoalescing {
246  grpc_arg arg;
247  arg.key = (char *)GRPC_ARG_USE_CRONET_PACKET_COALESCING;
248  arg.type = GRPC_ARG_INTEGER;
249  arg.value.integer = useCoalescing ? 1 : 0;
250  grpc_channel_args *args = grpc_channel_args_copy_and_add(NULL, &arg, 1);
251
252  grpc_call *c;
253  grpc_slice request_payload_slice = grpc_slice_from_copied_string("hello world");
254  grpc_byte_buffer *request_payload = grpc_raw_byte_buffer_create(&request_payload_slice, 1);
255  gpr_timespec deadline = grpc_timeout_seconds_to_deadline(5);
256  grpc_metadata meta_c[2] = {{grpc_slice_from_static_string("key1"),
257                              grpc_slice_from_static_string("val1"),
258                              0,
259                              {{NULL, NULL, NULL, NULL}}},
260                             {grpc_slice_from_static_string("key2"),
261                              grpc_slice_from_static_string("val2"),
262                              0,
263                              {{NULL, NULL, NULL, NULL}}}};
264
265  int port = grpc_pick_unused_port_or_die();
266  std::string addr = grpc_core::JoinHostPort("127.0.0.1", port);
267  grpc_completion_queue *cq = grpc_completion_queue_create_for_next(NULL);
268  stream_engine *cronetEngine = [Cronet getGlobalEngine];
269  grpc_channel *client = grpc_cronet_secure_channel_create(cronetEngine, addr.c_str(), args, NULL);
270
271  grpc_core::CqVerifier cqv(cq);
272  grpc_op ops[6];
273  grpc_op *op;
274  grpc_metadata_array initial_metadata_recv;
275  grpc_metadata_array trailing_metadata_recv;
276  grpc_metadata_array request_metadata_recv;
277  grpc_byte_buffer *response_payload_recv = NULL;
278  grpc_call_details call_details;
279  grpc_status_code status;
280  grpc_call_error error;
281  grpc_slice details;
282
283  c = grpc_channel_create_call(client, NULL, GRPC_PROPAGATE_DEFAULTS, cq,
284                               grpc_slice_from_static_string("/foo"), NULL, deadline, NULL);
285  GPR_ASSERT(c);
286
287  grpc_metadata_array_init(&initial_metadata_recv);
288  grpc_metadata_array_init(&trailing_metadata_recv);
289  grpc_metadata_array_init(&request_metadata_recv);
290  grpc_call_details_init(&call_details);
291
292  __weak XCTestExpectation *expectation = [self expectationWithDescription:@"Coalescing"];
293
294  int sl = socket(AF_INET, SOCK_STREAM, 0);
295  GPR_ASSERT(sl >= 0);
296  struct sockaddr_in s_addr;
297  memset(&s_addr, 0, sizeof(s_addr));
298  s_addr.sin_family = AF_INET;
299  s_addr.sin_addr.s_addr = htonl(INADDR_ANY);
300  s_addr.sin_port = htons(port);
301  GPR_ASSERT(0 == bind(sl, (struct sockaddr *)&s_addr, sizeof(s_addr)));
302  GPR_ASSERT(0 == listen(sl, 5));
303
304  dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
305    int s = accept(sl, NULL, NULL);
306    GPR_ASSERT(s >= 0);
307    struct timeval tv;
308    tv.tv_sec = 2;
309    tv.tv_usec = 0;
310    setsockopt(s, SOL_SOCKET, SO_RCVTIMEO, &tv, sizeof(tv));
311
312    // Make an TLS endpoint to receive Cronet's transmission
313    SSL_CTX *ctx = SSL_CTX_new(TLSv1_2_server_method());
314    init_ctx(ctx);
315    SSL *ssl = SSL_new(ctx);
316    SSL_set_fd(ssl, s);
317    SSL_accept(ssl);
318
319    const char magic[] = "PRI * HTTP/2.0\r\n\r\nSM\r\n\r\n";
320
321    char buf[4096];
322    long len;
323    BOOL coalesced = NO;
324    while ((len = SSL_read(ssl, buf, sizeof(buf))) > 0) {
325      gpr_log(GPR_DEBUG, "Read len: %ld", len);
326
327      // Analyze the HTTP/2 frames in the same TLS PDU to identify if
328      // coalescing is successful
329      unsigned int p = 0;
330      while (p < len) {
331        if (len - p >= 24 && 0 == memcmp(&buf[p], magic, 24)) {
332          p += 24;
333          continue;
334        }
335
336        if (buf[p + 3] == 0 &&                   // Type is DATA
337            parse_h2_length(&buf[p]) == 0x10 &&  // Length is correct
338            (buf[p + 4] & 1) != 0 &&             // EOS bit is set
339            0 == memcmp("hello world", &buf[p + 14],
340                        11)) {  // Message is correct
341          coalesced = YES;
342          break;
343        }
344        p += (parse_h2_length(&buf[p]) + 9);
345      }
346      if (coalesced) {
347        break;
348      }
349    }
350
351    XCTAssert(coalesced == useCoalescing);
352    SSL_free(ssl);
353    SSL_CTX_free(ctx);
354    close(s);
355    close(sl);
356    [expectation fulfill];
357  });
358
359  memset(ops, 0, sizeof(ops));
360  op = ops;
361  op->op = GRPC_OP_SEND_INITIAL_METADATA;
362  op->data.send_initial_metadata.count = 2;
363  op->data.send_initial_metadata.metadata = meta_c;
364  op->flags = 0;
365  op->reserved = NULL;
366  op++;
367  op->op = GRPC_OP_SEND_MESSAGE;
368  op->data.send_message.send_message = request_payload;
369  op->flags = 0;
370  op->reserved = NULL;
371  op++;
372  op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
373  op->flags = 0;
374  op->reserved = NULL;
375  op++;
376  op->op = GRPC_OP_RECV_INITIAL_METADATA;
377  op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
378  op->flags = 0;
379  op->reserved = NULL;
380  op++;
381  op->op = GRPC_OP_RECV_MESSAGE;
382  op->data.recv_message.recv_message = &response_payload_recv;
383  op->flags = 0;
384  op->reserved = NULL;
385  op++;
386  op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
387  op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
388  op->data.recv_status_on_client.status = &status;
389  op->data.recv_status_on_client.status_details = &details;
390  op->flags = 0;
391  op->reserved = NULL;
392  op++;
393  error = grpc_call_start_batch(c, ops, (size_t)(op - ops), (void *)1, NULL);
394  GPR_ASSERT(GRPC_CALL_OK == error);
395
396  cqv.Expect((void *)1, true);
397  cqv.Verify();
398
399  grpc_slice_unref(details);
400  grpc_metadata_array_destroy(&initial_metadata_recv);
401  grpc_metadata_array_destroy(&trailing_metadata_recv);
402  grpc_metadata_array_destroy(&request_metadata_recv);
403  grpc_call_details_destroy(&call_details);
404
405  grpc_call_unref(c);
406
407  grpc_byte_buffer_destroy(request_payload);
408  grpc_byte_buffer_destroy(response_payload_recv);
409
410  grpc_channel_destroy(client);
411  grpc_completion_queue_shutdown(cq);
412  drain_cq(cq);
413  grpc_completion_queue_destroy(cq);
414
415  [self waitForExpectationsWithTimeout:4 handler:nil];
416}
417
418- (void)testPacketCoalescing {
419  [self packetCoalescing:YES];
420  [self packetCoalescing:NO];
421}
422
423@end
424