summaryrefslogtreecommitdiff
path: root/SmartDeviceLinkTests/DevAPISpecs/SDLLifecycleProtocolHandlerSpec.m
blob: 681ec9cc50fef7fe0058cdf7ff96f71b3268ee3b (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
//
//  SDLLifecycleProtocolHandler.m
//  SmartDeviceLinkTests
//
//  Created by Joel Fischer on 6/25/20.
//  Copyright © 2020 smartdevicelink. All rights reserved.
//

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

#import "SDLConfiguration.h"
#import "SDLFunctionID.h"
#import "SDLLifecycleConfiguration.h"
#import "SDLLifecycleProtocolHandler.h"
#import "SDLNotificationConstants.h"
#import "SDLNotificationDispatcher.h"
#import "SDLProtocol.h"
#import "SDLProtocolDelegate.h"
#import "SDLProtocolHeader.h"
#import "SDLProtocolMessage.h"
#import "SDLRPCPayload.h"
#import "SDLShow.h"
#import "SDLTimer.h"

@interface SDLLifecycleProtocolHandler ()

@property (weak, nonatomic) SDLNotificationDispatcher *notificationDispatcher;
@property (strong, nonatomic) SDLTimer *rpcStartServiceTimeoutTimer;
@property (copy, nonatomic) NSString *appId;

@end

QuickSpecBegin(SDLLifecycleProtocolHandlerSpec)

describe(@"SDLLifecycleProtocolHandler tests", ^{
    __block SDLLifecycleProtocolHandler *testHandler = nil;
    __block id mockProtocol = nil;
    __block id mockNotificationDispatcher = nil;
    __block id mockTimer = nil;

    beforeEach(^{
        mockProtocol = OCMClassMock([SDLProtocol class]);
        mockNotificationDispatcher = OCMClassMock([SDLNotificationDispatcher class]);
        mockTimer = OCMClassMock([SDLTimer class]);

        SDLLifecycleConfiguration *testLifecycleConfig = [SDLLifecycleConfiguration defaultConfigurationWithAppName:@"test" fullAppId:@"appid"];
        SDLConfiguration *testConfig = [[SDLConfiguration alloc] initWithLifecycle:testLifecycleConfig lockScreen:nil logging:nil fileManager:nil encryption:nil];

        testHandler = [[SDLLifecycleProtocolHandler alloc] initWithProtocol:mockProtocol notificationDispatcher:mockNotificationDispatcher configuration:testConfig];
        testHandler.rpcStartServiceTimeoutTimer = mockTimer;
    });

    describe(@"when started", ^{
        beforeEach(^{
            OCMExpect([(SDLProtocol *)mockProtocol start]);
            [testHandler start];
        });

        it(@"should start the protocol", ^{
            OCMVerifyAll(mockProtocol);
        });
    });

    describe(@"when stopped", ^{
        beforeEach(^{
            OCMExpect([(SDLProtocol *)mockProtocol stopWithCompletionHandler:[OCMArg any]]);
            [testHandler stopWithCompletionHandler:^{}];
        });

        it(@"should stop the protocol", ^{
            OCMVerifyAll(mockProtocol);
        });
    });

    describe(@"when the protocol notifies us", ^{
        context(@"of the transport opening", ^{
            beforeEach(^{
                OCMExpect([mockNotificationDispatcher postNotificationName:[OCMArg isEqual:SDLTransportDidConnect] infoObject:[OCMArg isNil]]);
                OCMExpect([mockProtocol startServiceWithType:0 payload:[OCMArg any]]).ignoringNonObjectArgs();
                OCMExpect([(SDLTimer *)mockTimer start]);
                [testHandler protocolDidOpen:mockProtocol];
            });

            it(@"should set everything up", ^{
                OCMVerifyAll(mockNotificationDispatcher);
                OCMVerifyAll(mockProtocol);
                OCMVerifyAll(mockTimer);
            });
        });

        context(@"of the transport closing", ^{
            beforeEach(^{
                OCMExpect([mockNotificationDispatcher postNotificationName:[OCMArg isEqual:SDLTransportDidDisconnect] infoObject:[OCMArg isNil]]);
                [testHandler protocolDidClose:mockProtocol];
            });

            it(@"should send a notification", ^{
                OCMVerifyAll(mockNotificationDispatcher);
            });
        });

        context(@"of the transport erroring", ^{
            beforeEach(^{
                OCMExpect([mockNotificationDispatcher postNotificationName:[OCMArg isEqual:SDLTransportConnectError] infoObject:[OCMArg isNotNil]]);
                [testHandler protocol:mockProtocol transportDidError:[NSError errorWithDomain:@"test" code:1 userInfo:nil]];
            });

            it(@"should send a notification", ^{
                OCMVerifyAll(mockNotificationDispatcher);
            });
        });

        context(@"of an RPC Start Service ACK", ^{
            beforeEach(^{
                SDLProtocolHeader *header = [SDLProtocolHeader headerForVersion:4];
                header.serviceType = SDLServiceTypeRPC;
                header.frameData = SDLFrameInfoStartServiceACK;
                SDLProtocolMessage *message = [SDLProtocolMessage messageWithHeader:header andPayload:nil];

                OCMExpect([mockNotificationDispatcher postNotificationName:[OCMArg isEqual:SDLRPCServiceDidConnect] infoObject:[OCMArg isNil]]);
                OCMExpect([(SDLTimer *)mockTimer cancel]);

                [testHandler protocol:mockProtocol didReceiveStartServiceACK:message];
            });

            it(@"should stop the timer and send a notification", ^{
                OCMVerifyAll(mockNotificationDispatcher);
                OCMVerifyAll(mockTimer);
            });
        });

        context(@"of an RPC Start Service NAK", ^{
            beforeEach(^{
                SDLProtocolHeader *header = [SDLProtocolHeader headerForVersion:4];
                header.serviceType = SDLServiceTypeRPC;
                header.frameData = SDLFrameInfoStartServiceNACK;
                SDLProtocolMessage *message = [SDLProtocolMessage messageWithHeader:header andPayload:nil];

                OCMExpect([mockNotificationDispatcher postNotificationName:[OCMArg isEqual:SDLRPCServiceConnectionDidError] infoObject:[OCMArg isNil]]);
                OCMExpect([(SDLTimer *)mockTimer cancel]);

                [testHandler protocol:mockProtocol didReceiveStartServiceNAK:message];
            });

            it(@"should stop the timer and send a notification", ^{
                OCMVerifyAll(mockNotificationDispatcher);
                OCMVerifyAll(mockTimer);
            });
        });

        context(@"no response from the module to the RPC Start Service", ^{
            beforeEach(^{
                testHandler.rpcStartServiceTimeoutTimer = nil;
            });

            it(@"should send a transport disconnected notification when the timer elapses", ^{
                OCMExpect([mockProtocol stopWithCompletionHandler:[OCMArg any]]);

                [testHandler protocolDidOpen:mockProtocol];

                OCMVerifyAllWithDelay(mockProtocol, 11.0);
            });
        });

        context(@"of an RPC End Service ACK", ^{
            beforeEach(^{
                SDLProtocolHeader *header = [SDLProtocolHeader headerForVersion:4];
                header.serviceType = SDLServiceTypeRPC;
                header.frameData = SDLFrameInfoEndServiceACK;
                SDLProtocolMessage *message = [SDLProtocolMessage messageWithHeader:header andPayload:nil];

                OCMExpect([mockNotificationDispatcher postNotificationName:[OCMArg isEqual:SDLRPCServiceDidDisconnect] infoObject:[OCMArg isNil]]);
                OCMExpect([(SDLTimer *)mockTimer cancel]);

                [testHandler protocol:mockProtocol didReceiveEndServiceACK:message];
            });

            it(@"should stop the timer and send a notification", ^{
                OCMVerifyAll(mockNotificationDispatcher);
                OCMVerifyAll(mockTimer);
            });
        });

        context(@"of an RPC End Service NAK", ^{
            beforeEach(^{
                SDLProtocolHeader *header = [SDLProtocolHeader headerForVersion:4];
                header.serviceType = SDLServiceTypeRPC;
                header.frameData = SDLFrameInfoEndServiceNACK;
                SDLProtocolMessage *message = [SDLProtocolMessage messageWithHeader:header andPayload:nil];

                OCMExpect([mockNotificationDispatcher postNotificationName:[OCMArg isEqual:SDLRPCServiceConnectionDidError] infoObject:[OCMArg any]]);

                [testHandler protocol:mockProtocol didReceiveEndServiceNAK:message];
            });

            it(@"should send a RPC service connection error notification", ^{
                OCMVerifyAll(mockNotificationDispatcher);
            });
        });

        context(@"of a protocol message", ^{
            beforeEach(^{
                SDLShow *showRPC = [[SDLShow alloc] initWithMainField1:@"Test1" mainField2:@"Test2" alignment:SDLTextAlignmentLeft];

                SDLProtocolHeader *header = [SDLProtocolHeader headerForVersion:4];
                header.serviceType = SDLServiceTypeRPC;
                header.frameData = SDLFrameInfoSingleFrame;

                NSDictionary *dict = [showRPC serializeAsDictionary:4];
                NSData *data = [NSJSONSerialization dataWithJSONObject:dict options:kNilOptions error:nil];
                SDLRPCPayload *messagePayload = [[SDLRPCPayload alloc] init];
                messagePayload.jsonData = data;
                messagePayload.rpcType = SDLRPCMessageTypeRequest;
                messagePayload.correlationID = 1;
                messagePayload.functionID = [[SDLFunctionID sharedInstance] functionIdForName:SDLRPCFunctionNameShow].unsignedIntValue;

                SDLProtocolMessage *testMessage = [SDLProtocolMessage messageWithHeader:header andPayload:messagePayload.data];

                OCMExpect([mockNotificationDispatcher postRPCRequestNotification:[OCMArg isEqual:SDLDidReceiveShowRequest] request:[OCMArg isNotNil]]);

                [testHandler protocol:mockProtocol didReceiveMessage:testMessage];
            });

            it(@"should send the notification", ^{
                OCMVerifyAll(mockNotificationDispatcher);
            });
        });
    });
});

QuickSpecEnd