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
|
/*
* Copyright (c) 2019 Livio, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following
* disclaimer in the documentation and/or other materials provided with the
* distribution.
*
* Neither the name of the Livio Inc. nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* Created by brettywhite on 6/12/19 1:52 PM
*
*/
package com.smartdevicelink.managers.screen.choiceset;
import com.smartdevicelink.AndroidTestCase2;
import com.smartdevicelink.protocol.enums.FunctionID;
import com.smartdevicelink.proxy.RPCResponse;
import com.smartdevicelink.proxy.interfaces.ISdl;
import com.smartdevicelink.proxy.rpc.CancelInteraction;
import com.smartdevicelink.proxy.rpc.KeyboardProperties;
import com.smartdevicelink.proxy.rpc.PerformInteraction;
import com.smartdevicelink.proxy.rpc.SdlMsgVersion;
import com.smartdevicelink.proxy.rpc.enums.InteractionMode;
import com.smartdevicelink.proxy.rpc.enums.KeyboardLayout;
import com.smartdevicelink.proxy.rpc.enums.KeypressMode;
import com.smartdevicelink.proxy.rpc.enums.Language;
import com.smartdevicelink.proxy.rpc.enums.LayoutMode;
import com.smartdevicelink.test.Test;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;
import java.util.Collections;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
public class PresentChoiceSetOperationTests extends AndroidTestCase2 {
private PresentChoiceSetOperation presentChoiceSetOperation;
private ChoiceSet choiceSet;
private ISdl internalInterface;
private KeyboardListener keyboardListener;
private ChoiceSetSelectionListener choiceSetSelectionListener;
private ExecutorService executor;
@Override
public void setUp() throws Exception{
super.setUp();
internalInterface = mock(ISdl.class);
keyboardListener = mock(KeyboardListener.class);
choiceSetSelectionListener = mock(ChoiceSetSelectionListener.class);
ChoiceCell cell1 = new ChoiceCell("Cell1");
cell1.setChoiceId(0);
choiceSet = new ChoiceSet("Test", Collections.singletonList(cell1), choiceSetSelectionListener);
executor = Executors.newCachedThreadPool();
}
@Override
public void tearDown() throws Exception {
super.tearDown();
}
private KeyboardProperties getKeyBoardProperties(){
KeyboardProperties properties = new KeyboardProperties();
properties.setLanguage(Language.EN_US);
properties.setKeyboardLayout(KeyboardLayout.QWERTZ);
properties.setKeypressMode(KeypressMode.RESEND_CURRENT_ENTRY);
return properties;
}
public void testGetLayoutMode(){
// First we will check knowing our keyboard listener is NOT NULL
presentChoiceSetOperation = new PresentChoiceSetOperation(internalInterface, choiceSet, InteractionMode.MANUAL_ONLY, getKeyBoardProperties(), keyboardListener, choiceSetSelectionListener, Test.GENERAL_INTEGER);
assertEquals(presentChoiceSetOperation.getLayoutMode(), LayoutMode.LIST_WITH_SEARCH);
presentChoiceSetOperation.keyboardListener = null;
assertEquals(presentChoiceSetOperation.getLayoutMode(), LayoutMode.LIST_ONLY);
}
public void testGetPerformInteraction(){
presentChoiceSetOperation = new PresentChoiceSetOperation(internalInterface, choiceSet, InteractionMode.MANUAL_ONLY, getKeyBoardProperties(), keyboardListener, choiceSetSelectionListener, Test.GENERAL_INTEGER);
PerformInteraction pi = presentChoiceSetOperation.getPerformInteraction();
assertEquals(pi.getInitialText(), "Test");
assertNull(pi.getHelpPrompt());
assertNull(pi.getTimeoutPrompt());
assertNull(pi.getVrHelp());
assertEquals(pi.getTimeout(), Integer.valueOf(10000));
assertEquals(pi.getCancelID(), Test.GENERAL_INTEGER);
assertEquals(presentChoiceSetOperation.getLayoutMode(), LayoutMode.LIST_WITH_SEARCH);
}
public void testSetSelectedCellWithId(){
presentChoiceSetOperation = new PresentChoiceSetOperation(internalInterface, choiceSet, InteractionMode.MANUAL_ONLY, getKeyBoardProperties(), keyboardListener, choiceSetSelectionListener, Test.GENERAL_INTEGER);
assertNull(presentChoiceSetOperation.selectedCellRow);
presentChoiceSetOperation.setSelectedCellWithId(0);
assertEquals(presentChoiceSetOperation.selectedCellRow, Integer.valueOf(0));
}
public void testCancelingChoiceSetSuccessfullyIfThreadIsRunning(){
when(internalInterface.getSdlMsgVersion()).thenReturn(new SdlMsgVersion(6, 0));
presentChoiceSetOperation = new PresentChoiceSetOperation(internalInterface, choiceSet, InteractionMode.MANUAL_ONLY, null, null, choiceSetSelectionListener, Test.GENERAL_INTEGER);
executor.execute(presentChoiceSetOperation);
try {
executor.awaitTermination(1, TimeUnit.SECONDS);
} catch (InterruptedException e) {}
assertTrue(presentChoiceSetOperation.isExecuting());
assertFalse(presentChoiceSetOperation.isFinished());
assertFalse(presentChoiceSetOperation.isCancelled());
choiceSet.cancel();
Answer<Void> cancelInteractionAnswer = new Answer<Void>() {
@Override
public Void answer(InvocationOnMock invocation) {
Object[] args = invocation.getArguments();
CancelInteraction cancelInteraction = (CancelInteraction) args[0];
assertEquals(cancelInteraction.getCancelID(), Test.GENERAL_INTEGER);
assertEquals(cancelInteraction.getInteractionFunctionID().intValue(), FunctionID.PERFORM_INTERACTION.getId());
RPCResponse response = new RPCResponse(FunctionID.CANCEL_INTERACTION.toString());
response.setSuccess(true);
cancelInteraction.getOnRPCResponseListener().onResponse(0, response);
return null;
}
};
doAnswer(cancelInteractionAnswer).when(internalInterface).sendRPC(any(CancelInteraction.class));
verify(internalInterface, times(1)).sendRPC(any(CancelInteraction.class));
verify(internalInterface, times(1)).sendRPC(any(PerformInteraction.class));
assertTrue(presentChoiceSetOperation.isExecuting());
assertFalse(presentChoiceSetOperation.isFinished());
assertFalse(presentChoiceSetOperation.isCancelled());
}
public void testCancelingChoiceSetUnsuccessfullyIfThreadIsRunning(){
when(internalInterface.getSdlMsgVersion()).thenReturn(new SdlMsgVersion(6, 0));
presentChoiceSetOperation = new PresentChoiceSetOperation(internalInterface, choiceSet, InteractionMode.MANUAL_ONLY, null, null, choiceSetSelectionListener, Test.GENERAL_INTEGER);
executor.execute(presentChoiceSetOperation);
try {
executor.awaitTermination(1, TimeUnit.SECONDS);
} catch (InterruptedException e) {}
assertTrue(presentChoiceSetOperation.isExecuting());
assertFalse(presentChoiceSetOperation.isFinished());
assertFalse(presentChoiceSetOperation.isCancelled());
choiceSet.cancel();
Answer<Void> cancelInteractionAnswer = new Answer<Void>() {
@Override
public Void answer(InvocationOnMock invocation) {
Object[] args = invocation.getArguments();
CancelInteraction cancelInteraction = (CancelInteraction) args[0];
assertEquals(cancelInteraction.getCancelID(), Test.GENERAL_INTEGER);
assertEquals(cancelInteraction.getInteractionFunctionID().intValue(), FunctionID.PERFORM_INTERACTION.getId());
RPCResponse response = new RPCResponse(FunctionID.CANCEL_INTERACTION.toString());
response.setSuccess(false);
cancelInteraction.getOnRPCResponseListener().onResponse(0, response);
return null;
}
};
doAnswer(cancelInteractionAnswer).when(internalInterface).sendRPC(any(CancelInteraction.class));
verify(internalInterface, times(1)).sendRPC(any(CancelInteraction.class));
verify(internalInterface, times(1)).sendRPC(any(PerformInteraction.class));
assertTrue(presentChoiceSetOperation.isExecuting());
assertFalse(presentChoiceSetOperation.isFinished());
assertFalse(presentChoiceSetOperation.isCancelled());
}
public void testCancelingChoiceSetIfThreadHasFinished(){
when(internalInterface.getSdlMsgVersion()).thenReturn(new SdlMsgVersion(6, 0));
presentChoiceSetOperation = new PresentChoiceSetOperation(internalInterface, choiceSet, InteractionMode.MANUAL_ONLY, null, null, choiceSetSelectionListener, Test.GENERAL_INTEGER);
presentChoiceSetOperation.finishOperation();
assertFalse(presentChoiceSetOperation.isExecuting());
assertTrue(presentChoiceSetOperation.isFinished());
assertFalse(presentChoiceSetOperation.isCancelled());
choiceSet.cancel();
verify(internalInterface, never()).sendRPC(any(CancelInteraction.class));
assertFalse(presentChoiceSetOperation.isExecuting());
assertTrue(presentChoiceSetOperation.isFinished());
assertFalse(presentChoiceSetOperation.isCancelled());
}
public void testCancelingChoiceSetIfThreadHasNotYetRun(){
when(internalInterface.getSdlMsgVersion()).thenReturn(new SdlMsgVersion(6, 0));
presentChoiceSetOperation = new PresentChoiceSetOperation(internalInterface, choiceSet, InteractionMode.MANUAL_ONLY, null, null, choiceSetSelectionListener, Test.GENERAL_INTEGER);
assertFalse(presentChoiceSetOperation.isExecuting());
assertFalse(presentChoiceSetOperation.isFinished());
assertFalse(presentChoiceSetOperation.isCancelled());
choiceSet.cancel();
// Once the operation has started
executor.execute(presentChoiceSetOperation);
try {
executor.awaitTermination(1, TimeUnit.SECONDS);
} catch (InterruptedException e) {}
assertFalse(presentChoiceSetOperation.isExecuting());
assertTrue(presentChoiceSetOperation.isFinished());
assertFalse(presentChoiceSetOperation.isCancelled());
// Make sure neither a `CancelInteraction` or `PerformInteraction` RPC is ever sent
verify(internalInterface, never()).sendRPC(any(CancelInteraction.class));
verify(internalInterface, never()).sendRPC(any(PerformInteraction.class));
}
public void testCancelingChoiceSetIfHeadUnitDoesNotSupportFeature(){
// Cancel Interaction is only supported on RPC specs v.6.0.0+
when(internalInterface.getSdlMsgVersion()).thenReturn(new SdlMsgVersion(5, 3));
presentChoiceSetOperation = new PresentChoiceSetOperation(internalInterface, choiceSet, InteractionMode.MANUAL_ONLY, null, null, choiceSetSelectionListener, Test.GENERAL_INTEGER);
executor.execute(presentChoiceSetOperation);
try {
executor.awaitTermination(1, TimeUnit.SECONDS);
} catch (InterruptedException e) {}
assertTrue(presentChoiceSetOperation.isExecuting());
assertFalse(presentChoiceSetOperation.isFinished());
assertFalse(presentChoiceSetOperation.isCancelled());
choiceSet.cancel();
verify(internalInterface, never()).sendRPC(any(CancelInteraction.class));
verify(internalInterface, times(1)).sendRPC(any(PerformInteraction.class));
}
public void testCancelingChoiceSetIfHeadUnitDoesNotSupportFeatureButThreadIsNotRunning(){
// Cancel Interaction is only supported on RPC specs v.6.0.0+
when(internalInterface.getSdlMsgVersion()).thenReturn(new SdlMsgVersion(5, 3));
presentChoiceSetOperation = new PresentChoiceSetOperation(internalInterface, choiceSet, InteractionMode.MANUAL_ONLY, null, null, choiceSetSelectionListener, Test.GENERAL_INTEGER);
assertFalse(presentChoiceSetOperation.isExecuting());
assertFalse(presentChoiceSetOperation.isFinished());
assertFalse(presentChoiceSetOperation.isCancelled());
choiceSet.cancel();
verify(internalInterface, never()).sendRPC(any(CancelInteraction.class));
// Once the operation has started
executor.execute(presentChoiceSetOperation);
try {
executor.awaitTermination(1, TimeUnit.SECONDS);
} catch (InterruptedException e) {}
assertFalse(presentChoiceSetOperation.isExecuting());
assertTrue(presentChoiceSetOperation.isFinished());
assertFalse(presentChoiceSetOperation.isCancelled());
// Make sure neither a `CancelInteraction` or `PerformInteraction` RPC is ever sent
verify(internalInterface, never()).sendRPC(any(CancelInteraction.class));
verify(internalInterface, never()).sendRPC(any(PerformInteraction.class));
}
}
|
