summaryrefslogtreecommitdiff
path: root/SmartDeviceLinkTests/DevAPISpecs/SDLLifecycleConfigurationSpec.m
blob: da30cb2ebf9359cfcb9bfb217121c46d55d2bbd4 (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
//
//  SDLLifecycleConfigurationSpec.m
//  SmartDeviceLinkTests
//
//  Copyright © 2018 smartdevicelink. All rights reserved.
//

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

#import "SDLAppHMIType.h"
#import "SDLLanguage.h"
#import "SDLLifecycleConfiguration.h"
#import "SDLLifecycleConfigurationUpdate.h"
#import "SDLSpeechCapabilities.h"
#import "SDLTTSChunk.h"
#import "SDLVersion.h"


@interface SDLLifecycleConfiguration()

+ (NSString *)sdl_shortAppIdFromFullAppId:(NSString *)fullAppId;

@end


QuickSpecBegin(SDLLifecycleConfigurationSpec)

describe(@"A lifecycle configuration", ^{
    __block SDLLifecycleConfiguration *testConfig = nil;
    __block NSString *testAppName = @"An App Name";
    __block NSString *testFullAppId = @"123e4567-e89b-12d3-a456-426614174000";
    __block NSString *expectedGeneratedAppId = @"123e4567e8";
    __block SDLVersion *baseVersion = nil;

    beforeEach(^{
        testConfig = nil;
        baseVersion = [SDLVersion versionWithMajor:1 minor:0 patch:0];
    });

    context(@"created with a default configuration", ^{
        context(@"should be successfully initialized", ^{
            it(@"defaultConfigurationWithAppName:fullAppId:", ^{
                testConfig = [SDLLifecycleConfiguration defaultConfigurationWithAppName:testAppName fullAppId:testFullAppId];

                expect(testConfig.appId).to(match(expectedGeneratedAppId));
                expect(testConfig.fullAppId).to(match(testFullAppId));
            });

            afterEach(^{
                expect(testConfig.appName).to(match(testAppName));
                expect(testConfig.tcpDebugMode).to(beFalse());
                expect(testConfig.tcpDebugIPAddress).to(match(@"192.168.0.1"));
                expect(@(testConfig.tcpDebugPort)).to(equal(@12345));
                expect(testConfig.appType).to(match(SDLAppHMITypeDefault));
                expect(testConfig.additionalAppTypes).to(beNil());
                expect(testConfig.isMedia).to(beFalse());
                expect(testConfig.language).to(match(SDLLanguageEnUs));
                expect(testConfig.languagesSupported.firstObject).to(match(SDLLanguageEnUs));
                expect(testConfig.shortAppName).to(beNil());
                expect(testConfig.ttsName).to(beNil());
                expect(testConfig.voiceRecognitionCommandNames).to(beNil());
                expect(testConfig.resumeHash).to(beNil());
                expect(testConfig.minimumProtocolVersion).to(equal(baseVersion));
                expect(testConfig.minimumRPCVersion).to(equal(baseVersion));
            });
        });

        context(@"If customized", ^{
            __block NSString *testShortAppName = nil;
            __block SDLTTSChunk *testTTSChunk = nil;
            __block NSArray<SDLTTSChunk *> *testTTSName = nil;
            __block NSArray<NSString *> *testSynonyms = nil;
            __block NSString *testResumeHashString = nil;
            __block NSString *testAppId = nil;

            beforeEach(^{
                testShortAppName = @"Short Name";
                testTTSChunk = [[SDLTTSChunk alloc] initWithText:@"test tts name" type:SDLSpeechCapabilitiesText];
                testTTSName = @[testTTSChunk];
                testSynonyms = @[@"Test 1", @"Test 2", @"Test 3", @"Test 4"];
                testResumeHashString = @"testing";
                testAppId = @"pppppppppppppppppppppppppppppppppppppppppp";

                testConfig = [SDLLifecycleConfiguration defaultConfigurationWithAppName:testAppName fullAppId:testFullAppId];
            });

            it(@"it should get and set correctly", ^{
                testConfig.appType = SDLAppHMITypeMedia;
                testConfig.additionalAppTypes = @[SDLAppHMITypeProjection];
                testConfig.language = SDLLanguageArSa;
                testConfig.languagesSupported = @[SDLLanguageArSa, SDLLanguageEnAu, SDLLanguageEnUs];
                testConfig.shortAppName = testShortAppName;
                testConfig.ttsName = testTTSName;
                testConfig.voiceRecognitionCommandNames = testSynonyms;
                testConfig.resumeHash = testResumeHashString;
                testConfig.minimumProtocolVersion = [SDLVersion versionWithString:@"1.0.0"];
                testConfig.minimumRPCVersion = [SDLVersion versionWithString:@"2.0.0"];
                testConfig.appId = testAppId;
            });

            afterEach(^{
                expect(testConfig.appName).to(match(testAppName));
                expect(testConfig.shortAppName).to(match(testShortAppName));
                expect(testConfig.fullAppId).to(match(testFullAppId));
                expect(testConfig.appId).to(match(testAppId));
                expect(testConfig.tcpDebugMode).to(beFalse());
                expect(testConfig.tcpDebugIPAddress).to(match(@"192.168.0.1"));
                expect(@(testConfig.tcpDebugPort)).to(equal(@12345));
                expect(testConfig.appType).to(match(SDLAppHMITypeMedia));
                expect(testConfig.additionalAppTypes.firstObject).to(match(SDLAppHMITypeProjection));
                expect(testConfig.isMedia).to(beTrue());
                expect(testConfig.language).to(match(SDLLanguageArSa));
                expect(testConfig.languagesSupported).to(haveCount(@3));
                expect(testConfig.ttsName).to(contain(testTTSChunk));
                expect(testConfig.ttsName).to(haveCount(@1));
                expect(testConfig.voiceRecognitionCommandNames).to(haveCount(@(testSynonyms.count)));
                expect(testConfig.resumeHash).to(match(testResumeHashString));
                expect(testConfig.minimumProtocolVersion.stringVersion).to(equal(@"1.0.0"));
                expect(testConfig.minimumRPCVersion.stringVersion).to(equal(@"2.0.0"));
            });
        });
    });
    
    context(@"created with a debug configuration", ^{
        __block NSString *testIPAddress = nil;
        __block UInt16 testPort = 0;
        
        beforeEach(^{
            testIPAddress = @"1.1.1.1";
            testPort = 42;
        });

        context(@"should be successfully initialized", ^{
            it(@"debugConfigurationWithAppName:fullAppId:ipAddress:port:", ^{
                testConfig = [SDLLifecycleConfiguration debugConfigurationWithAppName:testAppName fullAppId:testFullAppId ipAddress:testIPAddress port:testPort];

                expect(testConfig.appId).to(match(expectedGeneratedAppId));
                expect(testConfig.fullAppId).to(match(testFullAppId));
            });

            afterEach(^{
                expect(testConfig.appName).to(match(testAppName));
                expect(testConfig.tcpDebugMode).to(beTrue());
                expect(testConfig.tcpDebugIPAddress).to(match(testIPAddress));
                expect(@(testConfig.tcpDebugPort)).to(equal(@(testPort)));
                expect(testConfig.appType).to(match(SDLAppHMITypeDefault));
                expect(testConfig.additionalAppTypes).to(beNil());
                expect(testConfig.language).to(match(SDLLanguageEnUs));
                expect(testConfig.languagesSupported.firstObject).to(match(SDLLanguageEnUs));
                expect(testConfig.shortAppName).to(beNil());
                expect(testConfig.ttsName).to(beNil());
                expect(testConfig.voiceRecognitionCommandNames).to(beNil());
                expect(testConfig.resumeHash).to(beNil());
                expect(testConfig.minimumProtocolVersion).to(equal(baseVersion));
                expect(testConfig.minimumRPCVersion).to(equal(baseVersion));
            });
        });

        context(@"If customized", ^{
            __block NSString *testShortAppName = nil;
            __block SDLTTSChunk *testTTSChunk = nil;
            __block NSArray<SDLTTSChunk *> *testTTSName = nil;
            __block NSArray<NSString *> *testSynonyms = nil;
            __block NSString *testResumeHashString = nil;
            __block SDLVersion *testVersion = nil;
            __block NSString *testAppId = nil;

            beforeEach(^{
                testConfig = [SDLLifecycleConfiguration debugConfigurationWithAppName:testAppName fullAppId:testFullAppId ipAddress:testIPAddress port:testPort];
            });

            it(@"it should get and set correctly", ^{
                testShortAppName = @"Test Short Name";
                testTTSChunk = [[SDLTTSChunk alloc] initWithText:@"test tts name" type:SDLSpeechCapabilitiesText];
                testTTSName = @[testTTSChunk];
                testSynonyms = @[@"Test 1", @"Test 2", @"Test 3", @"Test 4"];
                testResumeHashString = @"testing";
                testVersion = [SDLVersion versionWithMajor:1 minor:0 patch:0];
                testAppId = @"p&4rrqwervw-jolmk";

                testConfig.appType = SDLAppHMITypeInformation;
                testConfig.additionalAppTypes = @[SDLAppHMITypeProjection];
                testConfig.language = SDLLanguageArSa;
                testConfig.languagesSupported = @[SDLLanguageArSa, SDLLanguageEnAu, SDLLanguageEnUs];
                testConfig.shortAppName = testShortAppName;
                testConfig.ttsName = testTTSName;
                testConfig.voiceRecognitionCommandNames = testSynonyms;
                testConfig.resumeHash = testResumeHashString;
                testConfig.minimumRPCVersion = testVersion;
                testConfig.minimumProtocolVersion = testVersion;
                testConfig.appId = testAppId;
            });

            afterEach(^{
                expect(testConfig.appName).to(match(testAppName));
                expect(testConfig.shortAppName).to(match(testShortAppName));
                expect(testConfig.fullAppId).to(match(testFullAppId));
                expect(testConfig.appId).to(match(testAppId));
                expect(testConfig.tcpDebugMode).to(beTrue());
                expect(testConfig.tcpDebugIPAddress).to(match(@"1.1.1.1"));
                expect(@(testConfig.tcpDebugPort)).to(equal(@42));
                expect(testConfig.appType).to(match(SDLAppHMITypeInformation));
                expect(testConfig.additionalAppTypes.firstObject).to(match(SDLAppHMITypeProjection));
                expect(testConfig.isMedia).to(beFalse());
                expect(testConfig.language).to(match(SDLLanguageArSa));
                expect(testConfig.languagesSupported).to(haveCount(@3));
                expect(testConfig.ttsName).to(contain(testTTSChunk));
                expect(testConfig.ttsName).to(haveCount(@1));
                expect(testConfig.voiceRecognitionCommandNames).to(haveCount(@(testSynonyms.count)));
                expect(testConfig.resumeHash).to(match(testResumeHashString));
                expect(testConfig.minimumRPCVersion).to(equal(testVersion));
                expect(testConfig.minimumProtocolVersion).to(equal(testVersion));
            });
        });
    });
});

describe(@"When generating the `appId` from the `fullAppId`", ^{
    it(@"should return an empty string if the full app id is empty", ^{
        NSString *testFullAppId = @"";
        NSString *appId = [SDLLifecycleConfiguration sdl_shortAppIdFromFullAppId:testFullAppId];
        expect(appId).to(beEmpty());
    });

    it(@"should return an empty string if the full app id only has dashes", ^{
        NSString *testFullAppId = @"--";
        NSString *appId = [SDLLifecycleConfiguration sdl_shortAppIdFromFullAppId:testFullAppId];
        expect(appId).to(beEmpty());
    });

    it(@"should return a string truncated to the first non-dash 10 characters", ^{
        NSString *testFullAppId = @"34-uipe--k-rtqwedeftg-1";
        NSString *appId = [SDLLifecycleConfiguration sdl_shortAppIdFromFullAppId:testFullAppId];
        expect(appId).to(match(@"34uipekrtq"));
    });

    it(@"should return the full app id if the full app id is less than 10 characters", ^{
        NSString *testFullAppId = @"ab";
        NSString *appId = [SDLLifecycleConfiguration sdl_shortAppIdFromFullAppId:testFullAppId];
        expect(appId).to(equal(testFullAppId));
    });
});

QuickSpecEnd