summaryrefslogtreecommitdiff
path: root/SmartDeviceLinkTests/DevAPISpecs/SDLVoiceCommandUpdateOperationSpec.m
blob: 2eb5f9eb376c4c712df2a79e60494bba04b21afb (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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
#import <Quick/Quick.h>
#import <Nimble/Nimble.h>

#import "SDLAddCommand.h"
#import "SDLAddCommandResponse.h"
#import "SDLDeleteCommand.h"
#import "SDLDeleteCommandResponse.h"
#import "SDLError.h"
#import "SDLFileManager.h"
#import "SDLHMILevel.h"
#import "SDLVoiceCommand.h"
#import "SDLVoiceCommandManager.h"
#import "SDLVoiceCommandUpdateOperation.h"
#import "TestConnectionManager.h"

@interface SDLVoiceCommand()

@property (assign, nonatomic) UInt32 commandId;

@end

@interface SDLVoiceCommandUpdateOperation()

@property (strong, nonatomic) NSMutableArray<SDLVoiceCommand *> *currentVoiceCommands;

@end

QuickSpecBegin(SDLVoiceCommandUpdateOperationSpec)

__block SDLDeleteCommandResponse *successDelete = nil;
__block SDLDeleteCommandResponse *failDelete = nil;
__block SDLAddCommandResponse *successAdd = nil;
__block SDLAddCommandResponse *failAdd = nil;

__block SDLVoiceCommand *newVoiceCommand1 = [[SDLVoiceCommand alloc] initWithVoiceCommands:@[@"NewVC1"] handler:^{}];
__block SDLVoiceCommand *newVoiceCommand2 = [[SDLVoiceCommand alloc] initWithVoiceCommands:@[@"NewVC2"] handler:^{}];
__block SDLVoiceCommand *oldVoiceCommand1Dupe = [[SDLVoiceCommand alloc] initWithVoiceCommands:@[@"OldVC1"] handler:^{}];
__block SDLVoiceCommand *oldVoiceCommand1 = [[SDLVoiceCommand alloc] initWithVoiceCommands:@[@"OldVC1"] handler:^{}];
__block SDLVoiceCommand *oldVoiceCommand2 = [[SDLVoiceCommand alloc] initWithVoiceCommands:@[@"OldVC2"] handler:^{}];


describe(@"a voice command operation", ^{
    __block TestConnectionManager *testConnectionManager = nil;
    __block SDLVoiceCommandUpdateOperation *testOp = nil;

    __block NSError *callbackError = nil;
    __block NSArray<SDLVoiceCommand *> *callbackCurrentVoiceCommands = nil;

    beforeEach(^{
        successDelete = [[SDLDeleteCommandResponse alloc] init];
        successDelete.success = @YES;
        successDelete.resultCode = SDLResultSuccess;

        failDelete = [[SDLDeleteCommandResponse alloc] init];
        failDelete.success = @NO;
        failDelete.resultCode = SDLResultDisallowed;

        successAdd = [[SDLAddCommandResponse alloc] init];
        successAdd.success = @YES;
        successAdd.resultCode = SDLResultSuccess;

        failAdd = [[SDLAddCommandResponse alloc] init];
        failAdd.success = @NO;
        failAdd.resultCode = SDLResultDisallowed;

        newVoiceCommand1.commandId = 1;
        newVoiceCommand2.commandId = 2;
        oldVoiceCommand1.commandId = 3;
        oldVoiceCommand2.commandId = 4;

        testConnectionManager = [[TestConnectionManager alloc] init];
        testOp = nil;

        callbackError = nil;
        callbackCurrentVoiceCommands = nil;
    });

    // should have a priority of 'normal'
    it(@"should have a priority of 'normal'", ^{
        testOp = [[SDLVoiceCommandUpdateOperation alloc] initWithConnectionManager:testConnectionManager pendingVoiceCommands:@[] oldVoiceCommands:@[] updateCompletionHandler:^(NSArray<SDLVoiceCommand *> * _Nonnull newCurrentVoiceCommands, NSError * _Nullable error) {
        }];

        expect(@(testOp.queuePriority)).to(equal(@(NSOperationQueuePriorityNormal)));
    });

    // initializing the operation
    describe(@"initializing the operation", ^{
        testOp = [[SDLVoiceCommandUpdateOperation alloc] initWithConnectionManager:testConnectionManager pendingVoiceCommands:@[newVoiceCommand1, newVoiceCommand2] oldVoiceCommands:@[oldVoiceCommand1, oldVoiceCommand2] updateCompletionHandler:^(NSArray<SDLVoiceCommand *> * _Nonnull newCurrentVoiceCommands, NSError * _Nullable error) {}];

        expect(testOp.oldVoiceCommands).to(equal(@[oldVoiceCommand1, oldVoiceCommand2]));
    });

    // when updating oldVoiceCommands
    describe(@"when updating oldVoiceCommands", ^{
        beforeEach(^{
            testOp = [[SDLVoiceCommandUpdateOperation alloc] init];
            testOp.oldVoiceCommands = @[newVoiceCommand1, newVoiceCommand2];
        });

        // should update both oldVoiceCommands and currentVoiceCommands
        it(@"should update both oldVoiceCommands and currentVoiceCommands", ^{
            expect(testOp.oldVoiceCommands).to(equal(@[newVoiceCommand1, newVoiceCommand2]));
            expect(testOp.currentVoiceCommands).to(equal(testOp.oldVoiceCommands));
        });
    });

    // starting the operation
    describe(@"starting the operation", ^{

        // if it starts cancelled
        context(@"if it starts cancelled", ^{
            beforeEach(^{
                testOp = [[SDLVoiceCommandUpdateOperation alloc] initWithConnectionManager:testConnectionManager pendingVoiceCommands:@[newVoiceCommand1, newVoiceCommand2] oldVoiceCommands:@[oldVoiceCommand1, oldVoiceCommand2] updateCompletionHandler:^(NSArray<SDLVoiceCommand *> * _Nonnull newCurrentVoiceCommands, NSError * _Nullable error) {
                    callbackCurrentVoiceCommands = newCurrentVoiceCommands;
                    callbackError = error;
                }];
                [testOp cancel];
                [testOp start];
            });

            it(@"should return immediately with an error", ^{
                expect(callbackError).toEventuallyNot(beNil());
            });
        });

        // if it has voice commands to delete
        context(@"if it has voice commands to delete", ^{
            beforeEach(^{
                testOp = [[SDLVoiceCommandUpdateOperation alloc] initWithConnectionManager:testConnectionManager pendingVoiceCommands:@[] oldVoiceCommands:@[oldVoiceCommand1, oldVoiceCommand2] updateCompletionHandler:^(NSArray<SDLVoiceCommand *> * _Nonnull newCurrentVoiceCommands, NSError * _Nullable error) {
                    callbackCurrentVoiceCommands = newCurrentVoiceCommands;
                    callbackError = error;
                }];
                [testOp start];
            });

            // and the delete succeeds
            context(@"and the delete succeeds", ^{
                beforeEach(^{
                    SDLDeleteCommandResponse *deleteOld1 = [[SDLDeleteCommandResponse alloc] init];
                    deleteOld1.success = @YES;
                    deleteOld1.resultCode = SDLResultSuccess;

                    SDLDeleteCommandResponse *deleteOld2 = [[SDLDeleteCommandResponse alloc] init];
                    deleteOld2.success = @YES;
                    deleteOld2.resultCode = SDLResultSuccess;

                    [testConnectionManager respondToRequestWithResponse:deleteOld1 requestNumber:0 error:nil];
                    [testConnectionManager respondToRequestWithResponse:deleteOld2 requestNumber:1 error:nil];
                    [testConnectionManager respondToLastMultipleRequestsWithSuccess:YES];
                });

                it(@"should update the current voice commands", ^{
                    expect(callbackCurrentVoiceCommands).to(haveCount(0));
                    expect(callbackError).to(beNil());
                    expect(testConnectionManager.receivedRequests).to(haveCount(2));
                });
            });

            // and the delete fails
            context(@"and the delete fails", ^{
                beforeEach(^{
                    [testConnectionManager respondToRequestWithResponse:failDelete requestNumber:0 error:[NSError sdl_lifecycle_failedWithBadResult:SDLResultDisallowed info:nil]];
                    [testConnectionManager respondToRequestWithResponse:failDelete requestNumber:1 error:[NSError sdl_lifecycle_failedWithBadResult:SDLResultDisallowed info:nil]];
                    [testConnectionManager respondToLastMultipleRequestsWithSuccess:NO];
                });

                it(@"should update the current voice commands and attempt to send the adds", ^{
                    expect(callbackCurrentVoiceCommands).to(haveCount(2));
                    expect(callbackError).toNot(beNil());
                    expect(testConnectionManager.receivedRequests).to(haveCount(2));
                });
            });

            // and the delete partially fails
            context(@"and the delete partially fails", ^{
                beforeEach(^{
                    [testConnectionManager respondToRequestWithResponse:failDelete requestNumber:0 error:[NSError sdl_lifecycle_failedWithBadResult:SDLResultDisallowed info:nil]];
                    [testConnectionManager respondToRequestWithResponse:successDelete requestNumber:1 error:nil];
                    [testConnectionManager respondToLastMultipleRequestsWithSuccess:NO];
                });

                it(@"should update the current voice commands and attempt to send the adds", ^{
                    expect(callbackCurrentVoiceCommands).to(haveCount(1));
                    expect(callbackError).toNot(beNil());
                    expect(testConnectionManager.receivedRequests).to(haveCount(2));
                });
            });
        });

        // if it has pending voice commands identical to old voice commands
        context(@"if it has pending voice commands identical to old voice commands", ^{
            beforeEach(^{
                testOp = [[SDLVoiceCommandUpdateOperation alloc] initWithConnectionManager:testConnectionManager pendingVoiceCommands:@[oldVoiceCommand1, oldVoiceCommand2] oldVoiceCommands:@[oldVoiceCommand1, oldVoiceCommand2] updateCompletionHandler:^(NSArray<SDLVoiceCommand *> * _Nonnull newCurrentVoiceCommands, NSError * _Nullable error) {
                    callbackCurrentVoiceCommands = newCurrentVoiceCommands;
                    callbackError = error;
                }];
                [testOp start];
            });

            it(@"should not delete or upload the voiceCommands", ^{
                expect(testConnectionManager.receivedRequests).to(haveCount(0));
                expect(callbackCurrentVoiceCommands).to(haveCount(2));
                expect(callbackError).to(beNil());
            });
        });

        // going from voice commands [AB] to [A]
        context(@"going from voice commands [AB] to [A]", ^{
            beforeEach(^{
                testOp = [[SDLVoiceCommandUpdateOperation alloc] initWithConnectionManager:testConnectionManager pendingVoiceCommands:@[newVoiceCommand1] oldVoiceCommands:@[newVoiceCommand1, newVoiceCommand2] updateCompletionHandler:^(NSArray<SDLVoiceCommand *> * _Nonnull newCurrentVoiceCommands, NSError * _Nullable error) {
                    callbackCurrentVoiceCommands = newCurrentVoiceCommands;
                    callbackError = error;
                }];
                [testOp start];
            });

            // and the delete succeeds
            describe(@"and the delete succeeds", ^{
                beforeEach(^{
                    SDLDeleteCommandResponse *deleteOld1 = [[SDLDeleteCommandResponse alloc] init];
                    deleteOld1.success = @YES;
                    deleteOld1.resultCode = SDLResultSuccess;

                    [testConnectionManager respondToRequestWithResponse:deleteOld1 requestNumber:0 error:nil];
                    [testConnectionManager respondToLastMultipleRequestsWithSuccess:YES];
                });

                it(@"Should only delete voiceCommands thats not in common", ^{
                    expect(callbackCurrentVoiceCommands).to(haveCount(1));
                    expect(callbackError).to(beNil());
                    expect(testConnectionManager.receivedRequests).to(haveCount(1));
                });
            });
        });


        // going from voice commands [A] to [AB]
        context(@"going from voice commands [A] to [AB]", ^{
            beforeEach(^{
                testOp = [[SDLVoiceCommandUpdateOperation alloc] initWithConnectionManager:testConnectionManager pendingVoiceCommands:@[newVoiceCommand1, oldVoiceCommand1Dupe] oldVoiceCommands:@[oldVoiceCommand1] updateCompletionHandler:^(NSArray<SDLVoiceCommand *> * _Nonnull newCurrentVoiceCommands, NSError * _Nullable error) {
                    callbackCurrentVoiceCommands = newCurrentVoiceCommands;
                    callbackError = error;
                }];
                [testOp start];
            });

            // and the add succeeds
            describe(@"and the add succeeds", ^{
                beforeEach(^{
                    SDLAddCommandResponse *addNew1 = [[SDLAddCommandResponse alloc] init];
                    addNew1.success = @YES;
                    addNew1.resultCode = SDLResultSuccess;

                    [testConnectionManager respondToRequestWithResponse:addNew1 requestNumber:0 error:nil];
                    [testConnectionManager respondToLastMultipleRequestsWithSuccess:YES];
                });

                it(@"should only upload the voiceCommand thats not in common and update the handler for voiceCommand in common", ^{
                    expect(callbackCurrentVoiceCommands).to(haveCount(2));
                    expect(callbackError).to(beNil());
                    expect(testConnectionManager.receivedRequests).to(haveCount(1));
                    expect(testOp.currentVoiceCommands.firstObject.handler == oldVoiceCommand1Dupe.handler).to(beTrue());
                });
            });
        });

        // going from voice commands [AB] to [CD]
        context(@"going from voice commands [AB] to [CD]", ^{
            beforeEach(^{
                testOp = [[SDLVoiceCommandUpdateOperation alloc] initWithConnectionManager:testConnectionManager pendingVoiceCommands:@[newVoiceCommand1, newVoiceCommand2] oldVoiceCommands:@[oldVoiceCommand1, oldVoiceCommand2] updateCompletionHandler:^(NSArray<SDLVoiceCommand *> * _Nonnull newCurrentVoiceCommands, NSError * _Nullable error) {
                    callbackCurrentVoiceCommands = newCurrentVoiceCommands;
                    callbackError = error;
                }];
                [testOp start];
            });

            // the delete and add commands succeeds
            describe(@"the delete and add commands succeeds", ^{
                beforeEach(^{
                    SDLDeleteCommandResponse *deleteOld1 = [[SDLDeleteCommandResponse alloc] init];
                    deleteOld1.success = @YES;
                    deleteOld1.resultCode = SDLResultSuccess;

                    SDLDeleteCommandResponse *deleteOld2 = [[SDLDeleteCommandResponse alloc] init];
                    deleteOld2.success = @YES;
                    deleteOld2.resultCode = SDLResultSuccess;

                    [testConnectionManager respondToRequestWithResponse:deleteOld1 requestNumber:0 error:nil];
                    [testConnectionManager respondToRequestWithResponse:deleteOld2 requestNumber:1 error:nil];
                    [testConnectionManager respondToLastMultipleRequestsWithSuccess:YES];

                    SDLAddCommandResponse *addNew1 = [[SDLAddCommandResponse alloc] init];
                    addNew1.success = @YES;
                    addNew1.resultCode = SDLResultSuccess;

                    SDLAddCommandResponse *addNew2 = [[SDLAddCommandResponse alloc] init];
                    addNew2.success = @YES;
                    addNew2.resultCode = SDLResultSuccess;

                    [testConnectionManager respondToRequestWithResponse:addNew1 requestNumber:2 error:nil];
                    [testConnectionManager respondToRequestWithResponse:addNew2 requestNumber:3 error:nil];
                    [testConnectionManager respondToLastMultipleRequestsWithSuccess:YES];
                });

                it(@"should delete and upload the voiceCommands", ^{
                    expect(callbackCurrentVoiceCommands).to(haveCount(2));
                    expect(callbackError).to(beNil());
                    expect(testConnectionManager.receivedRequests).to(haveCount(4));
                });
            });
        });

        context(@"if it doesn't have any voice commands to delete", ^{
            beforeEach(^{
                testOp = [[SDLVoiceCommandUpdateOperation alloc] initWithConnectionManager:testConnectionManager pendingVoiceCommands:@[newVoiceCommand1, newVoiceCommand2] oldVoiceCommands:@[] updateCompletionHandler:^(NSArray<SDLVoiceCommand *> * _Nonnull newCurrentVoiceCommands, NSError * _Nullable error) {
                    callbackCurrentVoiceCommands = newCurrentVoiceCommands;
                    callbackError = error;
                }];
                [testOp start];
            });

            context(@"adding voice commands", ^{
                context(@"and the add succeeds", ^{
                    beforeEach(^{
                        SDLAddCommandResponse *addNew1 = [[SDLAddCommandResponse alloc] init];
                        addNew1.success = @YES;
                        addNew1.resultCode = SDLResultSuccess;

                        SDLAddCommandResponse *addNew2 = [[SDLAddCommandResponse alloc] init];
                        addNew2.success = @YES;
                        addNew2.resultCode = SDLResultSuccess;

                        [testConnectionManager respondToRequestWithResponse:addNew1 requestNumber:0 error:nil];
                        [testConnectionManager respondToRequestWithResponse:addNew2 requestNumber:1 error:nil];
                        [testConnectionManager respondToLastMultipleRequestsWithSuccess:YES];
                    });

                    it(@"should update the current voice commands", ^{
                        expect(callbackCurrentVoiceCommands).to(haveCount(2));
                        expect(callbackError).to(beNil());
                        expect(testConnectionManager.receivedRequests).to(haveCount(2));
                    });
                });

                context(@"and the add fails", ^{
                    beforeEach(^{
                        SDLAddCommandResponse *addNew1 = [[SDLAddCommandResponse alloc] init];
                        addNew1.success = @NO;
                        addNew1.resultCode = SDLResultDisallowed;

                        SDLAddCommandResponse *addNew2 = [[SDLAddCommandResponse alloc] init];
                        addNew2.success = @NO;
                        addNew2.resultCode = SDLResultDisallowed;

                        [testConnectionManager respondToRequestWithResponse:addNew1 requestNumber:0 error:[NSError sdl_lifecycle_failedWithBadResult:SDLResultDisallowed info:nil]];
                        [testConnectionManager respondToRequestWithResponse:addNew2 requestNumber:1 error:[NSError sdl_lifecycle_failedWithBadResult:SDLResultDisallowed info:nil]];
                        [testConnectionManager respondToLastMultipleRequestsWithSuccess:NO];
                    });

                    it(@"should update the current voice commands", ^{
                        expect(callbackCurrentVoiceCommands).to(haveCount(0));
                        expect(callbackError).toNot(beNil());
                        expect(testConnectionManager.receivedRequests).to(haveCount(2));
                    });
                });

                context(@"and the add partially fails", ^{
                    beforeEach(^{
                        SDLAddCommandResponse *addNew1 = [[SDLAddCommandResponse alloc] init];
                        addNew1.success = @NO;
                        addNew1.resultCode = SDLResultDisallowed;

                        SDLAddCommandResponse *addNew2 = [[SDLAddCommandResponse alloc] init];
                        addNew2.success = @YES;
                        addNew2.resultCode = SDLResultSuccess;

                        [testConnectionManager respondToRequestWithResponse:addNew1 requestNumber:0 error:[NSError sdl_lifecycle_failedWithBadResult:SDLResultDisallowed info:nil]];
                        [testConnectionManager respondToRequestWithResponse:addNew2 requestNumber:1 error:nil];
                        [testConnectionManager respondToLastMultipleRequestsWithSuccess:NO];
                    });

                    it(@"should update the current voice commands", ^{
                        expect(callbackCurrentVoiceCommands).to(haveCount(1));
                        expect(callbackError).toNot(beNil());
                        expect(testConnectionManager.receivedRequests).to(haveCount(2));
                    });
                });
            });
        });
    });
});

QuickSpecEnd