summaryrefslogtreecommitdiff
path: root/SmartDeviceLinkTests/TransportSpecs/SDLTCPTransportSpec.m
blob: e9a25f8340af219e1b934785ad454681d5c41a25 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
//
//  SDLTCPTransportSpec.m
//  SmartDeviceLinkTests
//
//  Created by Sho Amano on 2018/04/24.
//  Copyright © 2018 Xevo Inc. All rights reserved.
//

#import <Foundation/Foundation.h>
#import <Quick/Quick.h>
#import <Nimble/Nimble.h>
#import <OCMock/OCMock.h>

#import "SDLTCPTransport.h"
#import "SDLError.h"
#import "TestTCPServer.h"

#import <stdio.h>

@interface SDLTCPTransport ()
// verify some internal properties
@property (nullable, nonatomic, strong) NSThread *ioThread;
@property (nullable, nonatomic, strong) NSInputStream *inputStream;
@property (nullable, nonatomic, strong) NSOutputStream *outputStream;
@end

QuickSpecBegin(SDLTCPTransportSpec)

describe(@"SDLTCPTransport", ^ {
    __block SDLTCPTransport *transport = nil;
    __block id transportDelegateMock = nil;
    __block TestTCPServer *server = nil;
    __block id serverDelegateMock = nil;

    beforeEach(^{
        transport = [[SDLTCPTransport alloc] init];
        transport.hostName = @"localhost";
        transport.portNumber = @"12345";
        transportDelegateMock = OCMProtocolMock(@protocol(SDLTransportDelegate));
        transport.delegate = transportDelegateMock;

        server = [[TestTCPServer alloc] init];
        serverDelegateMock = OCMProtocolMock(@protocol(TestTCPServerDelegate));
        server.delegate = serverDelegateMock;
    });

    afterEach(^{
        transport.delegate = nil;
        server.delegate = nil;

        [transport disconnect];
        transport = nil;
        transportDelegateMock = nil;

        [server teardown];
        server = nil;
        serverDelegateMock = nil;
    });

    it(@"Should be able to connect to specified TCP server and disconnect from it", ^ {
        BOOL ret = [server setup:@"localhost" port:@"12345"];
        expect(ret);

        OCMExpect([serverDelegateMock onClientConnected]);
        OCMExpect([transportDelegateMock onTransportConnected]);

        [transport connect];

        OCMVerifyAllWithDelay(serverDelegateMock, 0.5);
        OCMVerifyAllWithDelay(transportDelegateMock, 0.5);

        expect(transport.ioThread != nil);
        expect(transport.inputStream != nil);
        expect(transport.outputStream != nil);

        [transport disconnect];

        expect(transport.ioThread == nil);
        expect(transport.inputStream == nil);
        expect(transport.outputStream == nil);
    });

    it(@"Should invoke onError delegate when connection is refused", ^ {
        // Start the server without SO_REUSEADDR then close it. Then the port will not be owned by anybody for a while.
        server.enableSOReuseAddr = NO;
        BOOL ret = [server setup:@"localhost" port:@"12346"];
        expect(ret);
        [server teardown];
        server = nil;

        OCMExpect([transportDelegateMock onError:[OCMArg checkWithBlock:^BOOL(NSError *error) {
            if (error.domain == SDLErrorDomainTransport && error.code == SDLTransportErrorConnectionRefused) {
                return YES;
            } else {
                return NO;
            }
        }]]);

        transport.portNumber = @"12346";
        [transport connect];

        OCMVerifyAllWithDelay(transportDelegateMock, 0.5);

        [transport disconnect];

        expect(transport.ioThread == nil);
        expect(transport.inputStream == nil);
        expect(transport.outputStream == nil);
    });

    it(@"Should invoke onError delegate when connection is timed out", ^ {
        OCMExpect([transportDelegateMock onError:[OCMArg checkWithBlock:^BOOL(NSError *error) {
            if (error.domain == SDLErrorDomainTransport && error.code == SDLTransportErrorConnectionTimedOut) {
                return YES;
            } else {
                return NO;
            }
        }]]);

        transport.hostName = @"127.0.0.2";
        [transport connect];

        // timeout value should be longer than 'ConnectionTimeoutSecs' in SDLTCPTransport
        OCMVerifyAllWithDelay(transportDelegateMock, 60.0);

        [transport disconnect];

        expect(transport.ioThread == nil);
        expect(transport.inputStream == nil);
        expect(transport.outputStream == nil);
    });

    it(@"Should invoke onError delegate when input parameter is invalid", ^ {
        OCMExpect([transportDelegateMock onError:[OCMArg checkWithBlock:^BOOL(NSError *error) {
            if (error.domain == SDLErrorDomainTransport && error.code == SDLTransportErrorUnknown) {
                return YES;
            } else {
                return NO;
            }
        }]]);

        transport.portNumber = @"abcde";
        [transport connect];

        OCMVerifyAllWithDelay(transportDelegateMock, 0.5);

        [transport disconnect];

        expect(transport.ioThread == nil);
        expect(transport.inputStream == nil);
        expect(transport.outputStream == nil);
    });

    it(@"Should send out data when send is called", ^ {
        BOOL ret = [server setup:@"localhost" port:@"12345"];
        expect(ret);

        char buf[256];
        snprintf(buf, sizeof(buf), "This is dummy message.");
        NSData *testData = [NSData dataWithBytes:buf length:strlen(buf)];
        NSMutableData *receivedData = [[NSMutableData alloc] init];

        OCMExpect([serverDelegateMock onClientConnected]);
        OCMStub([serverDelegateMock onClientDataReceived:OCMOCK_ANY]).andDo(^(NSInvocation *invocation) {
            __unsafe_unretained NSData *data;
            [invocation getArgument:&data atIndex:2];   // first argument is index 2
            [receivedData appendData:data];
            NSLog(@"mock server received %lu bytes", data.length);
        });

        OCMExpect([transportDelegateMock onTransportConnected]);

        [transport connect];
        [transport sendData:testData];

        OCMVerifyAllWithDelay(serverDelegateMock, 0.5);
        OCMVerifyAllWithDelay(transportDelegateMock, 0.5);

        [NSThread sleepForTimeInterval:0.5];
        expect([receivedData isEqualToData:testData]);

        [transport disconnect];
    });

    it(@"Should send out data even if send is called some time after", ^ {
        BOOL ret = [server setup:@"localhost" port:@"12345"];
        expect(ret);

        char buf1[256], buf2[256];
        snprintf(buf1, sizeof(buf1), "This is another dummy message.");
        snprintf(buf2, sizeof(buf2), "followed by 12345678901234567890123456");
        NSData *testData1 = [NSData dataWithBytes:buf1 length:strlen(buf1)];
        NSData *testData2 = [NSData dataWithBytes:buf2 length:strlen(buf2)];
        NSMutableData *expectedData = [NSMutableData dataWithData:testData1];
        [expectedData appendData:testData2];

        __block NSMutableData *receivedData = [[NSMutableData alloc] init];

        OCMExpect([serverDelegateMock onClientConnected]);
        OCMStub([serverDelegateMock onClientDataReceived:OCMOCK_ANY]).andDo(^(NSInvocation *invocation) {
            __unsafe_unretained NSData *data;
            [invocation getArgument:&data atIndex:2];   // first argument is index 2
            [receivedData appendData:data];
            NSLog(@"mock server received %lu bytes", data.length);
        });

        OCMExpect([transportDelegateMock onTransportConnected]);

        [transport connect];

        // check that transport still sends out data long after NSStreamEventHasSpaceAvailable event
        [NSThread sleepForTimeInterval:1.0];
        [transport sendData:testData1];
        [transport sendData:testData2];

        OCMVerifyAllWithDelay(serverDelegateMock, 0.5);
        OCMVerifyAllWithDelay(transportDelegateMock, 0.5);

        [NSThread sleepForTimeInterval:0.5];
        expect([receivedData isEqualToData:expectedData]);

        // don't receive further delegate events
        server.delegate = nil;

        [transport disconnect];
    });

    it(@"Should invoke onDataReceived delegate when received some data", ^ {
        BOOL ret = [server setup:@"localhost" port:@"12345"];
        expect(ret);

        char buf1[256], buf2[256];
        snprintf(buf1, sizeof(buf1), "This is test data.");
        snprintf(buf2, sizeof(buf2), "This is another chunk of data.");
        NSData *testData1 = [NSData dataWithBytes:buf1 length:strlen(buf1)];
        NSData *testData2 = [NSData dataWithBytes:buf2 length:strlen(buf2)];
        NSMutableData *expectedData = [NSMutableData dataWithData:testData1];
        [expectedData appendData:testData2];

        OCMExpect([transportDelegateMock onTransportConnected]);

        NSMutableData *receivedData = [[NSMutableData alloc] init];
        OCMStub([transportDelegateMock onDataReceived:OCMOCK_ANY]).andDo(^(NSInvocation *invocation) {
            __unsafe_unretained NSData *data;
            [invocation getArgument:&data atIndex:2];   // first argument is index 2
            [receivedData appendData:data];
            NSLog(@"client received %lu bytes", data.length);
        });

        OCMExpect([serverDelegateMock onClientConnected]);

        [transport connect];

        // wait until connected
        OCMVerifyAllWithDelay(serverDelegateMock, 0.5);
        [server send:testData1];
        [server send:testData2];

        OCMVerifyAllWithDelay(transportDelegateMock, 0.5);

        [NSThread sleepForTimeInterval:0.5];
        expect([receivedData isEqualToData:expectedData]);

        [transport disconnect];
    });

    it(@"Should generate disconnected event after peer closed connection", ^ {
        BOOL ret = [server setup:@"localhost" port:@"12345"];
        expect(ret);

        OCMExpect([serverDelegateMock onClientConnected]);
        OCMExpect([transportDelegateMock onTransportConnected]);

        [transport connect];

        OCMVerifyAllWithDelay(serverDelegateMock, 0.5);
        OCMVerifyAllWithDelay(transportDelegateMock, 0.5);

        OCMExpect([transportDelegateMock onTransportDisconnected]);

        // Close the writing connection. This will notify the client that peer closed the connection.
        ret = [server shutdownClient];
        expect(ret);

        OCMVerifyAllWithDelay(transportDelegateMock, 0.5);

        [transport disconnect];
    });
});

QuickSpecEnd