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
|
/*
* 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.
*/
package com.smartdevicelink.managers.screen.menu;
import androidx.test.ext.junit.runners.AndroidJUnit4;
import com.smartdevicelink.managers.BaseSubManager;
import com.smartdevicelink.managers.CompletionListener;
import com.smartdevicelink.protocol.enums.FunctionID;
import com.smartdevicelink.proxy.interfaces.ISdl;
import com.smartdevicelink.proxy.rpc.OnCommand;
import com.smartdevicelink.proxy.rpc.OnHMIStatus;
import com.smartdevicelink.proxy.rpc.enums.HMILevel;
import com.smartdevicelink.proxy.rpc.enums.TriggerSource;
import com.smartdevicelink.proxy.rpc.listeners.OnRPCNotificationListener;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import static junit.framework.TestCase.assertEquals;
import static junit.framework.TestCase.assertFalse;
import static junit.framework.TestCase.assertNotNull;
import static junit.framework.TestCase.assertNull;
import static junit.framework.TestCase.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
@RunWith(AndroidJUnit4.class)
public class VoiceCommandManagerTests {
private VoiceCommand command, command3;
private List<VoiceCommand> commands;
private VoiceCommandManager voiceCommandManager;
private static final int voiceCommandIdMin = 1900000000;
private OnRPCNotificationListener onHMIStatusListener, commandListener;
// SETUP / HELPERS
@Before
public void setUp() throws Exception{
VoiceCommandSelectionListener mockListener = mock(VoiceCommandSelectionListener.class);
command = new VoiceCommand(Arrays.asList("Command one", "Command two"), null);
VoiceCommand command2 = new VoiceCommand(Arrays.asList("Command three", "Command four"), null);
command3 = new VoiceCommand(Arrays.asList("Command five", "Command six"), mockListener);
commands = Arrays.asList(command,command2);
ISdl internalInterface = mock(ISdl.class);
// When internalInterface.addOnRPCNotificationListener(FunctionID.ON_HMI_STATUS, OnRPCNotificationListener) is called
// inside the VoiceCommandManager's constructor, then keep a reference to the OnRPCNotificationListener so we can trigger it later
// to emulate what Core does when it sends OnHMIStatus notification
Answer<Void> onHMIStatusAnswer = new Answer<Void>() {
@Override
public Void answer(InvocationOnMock invocation) {
Object[] args = invocation.getArguments();
onHMIStatusListener = (OnRPCNotificationListener) args[1];
return null;
}
};
doAnswer(onHMIStatusAnswer).when(internalInterface).addOnRPCNotificationListener(eq(FunctionID.ON_HMI_STATUS), any(OnRPCNotificationListener.class));
Answer<Void> onCommandAnswer = new Answer<Void>() {
@Override
public Void answer(InvocationOnMock invocation) {
Object[] args = invocation.getArguments();
commandListener = (OnRPCNotificationListener) args[1];
return null;
}
};
doAnswer(onCommandAnswer).when(internalInterface).addOnRPCNotificationListener(eq(FunctionID.ON_COMMAND), any(OnRPCNotificationListener.class));
voiceCommandManager = new VoiceCommandManager(internalInterface);
// Check some stuff during setup
assertEquals(voiceCommandManager.currentHMILevel, HMILevel.HMI_NONE);
assertEquals(voiceCommandManager.getState(), BaseSubManager.SETTING_UP);
assertEquals(voiceCommandManager.lastVoiceCommandId, voiceCommandIdMin);
assertFalse(voiceCommandManager.hasQueuedUpdate);
assertFalse(voiceCommandManager.waitingOnHMIUpdate);
assertNotNull(voiceCommandManager.commandListener);
assertNotNull(voiceCommandManager.hmiListener);
assertNull(voiceCommandManager.voiceCommands);
assertNull(voiceCommandManager.oldVoiceCommands);
assertNull(voiceCommandManager.inProgressUpdate);
}
@After
public void tearDown() throws Exception {
voiceCommandManager.dispose();
assertEquals(voiceCommandManager.lastVoiceCommandId, voiceCommandIdMin);
assertNull(voiceCommandManager.voiceCommands);
assertNull(voiceCommandManager.oldVoiceCommands);
assertNull(voiceCommandManager.currentHMILevel);
assertNull(voiceCommandManager.inProgressUpdate);
assertFalse(voiceCommandManager.hasQueuedUpdate);
assertFalse(voiceCommandManager.waitingOnHMIUpdate);
// after everything, make sure we are in the correct state
assertEquals(voiceCommandManager.getState(), BaseSubManager.SHUTDOWN);
}
@Test
public void testStartVoiceCommandManager(){
voiceCommandManager.start(new CompletionListener() {
@Override
public void onComplete(boolean success) {
assertTrue(success);
// Make sure the state has changed, as the Screen Manager is dependant on it
assertEquals(voiceCommandManager.getState(), BaseSubManager.READY);
}
});
}
@Test
public void testHMINotReady(){
voiceCommandManager.currentHMILevel = HMILevel.HMI_NONE;
voiceCommandManager.setVoiceCommands(commands);
// updating voice commands before HMI is ready
assertNull(voiceCommandManager.inProgressUpdate);
assertTrue(voiceCommandManager.waitingOnHMIUpdate);
// these are the 2 commands we have waiting
assertEquals(voiceCommandManager.voiceCommands.size(), 2);
assertEquals(voiceCommandManager.currentHMILevel, HMILevel.HMI_NONE);
// The VCM should send the pending voice commands once HMI full occurs
sendFakeCoreOnHMIFullNotifications();
// Listener should be triggered - which sets new HMI level and should proceed to send our pending update
assertEquals(voiceCommandManager.currentHMILevel, HMILevel.HMI_FULL);
// This being false means it received the hmi notification and sent the pending commands
assertFalse(voiceCommandManager.waitingOnHMIUpdate);
}
@Test
public void testUpdatingCommands(){
// we have previously sent 2 VoiceCommand objects. we will now update it and have just one
// make sure the system returns us 2 delete commands
assertEquals(voiceCommandManager.deleteCommandsForVoiceCommands(commands).size(), 2);
// when we only send one command to update, we should only be returned one add command
assertEquals(voiceCommandManager.addCommandsForVoiceCommands(Collections.singletonList(command)).size(), 1);
// Send a new single command, and test that its listener works, as it gets called from the VCM
voiceCommandManager.setVoiceCommands(Collections.singletonList(command3));
// Fake onCommand - we want to make sure that we can pass back onCommand events to our VoiceCommand Objects
OnCommand onCommand = new OnCommand();
onCommand.setCmdID(command3.getCommandId());
onCommand.setTriggerSource(TriggerSource.TS_VR); // these are voice commands
commandListener.onNotified(onCommand); // send off the notification
// verify the mock listener has only been hit once
verify(command3.getVoiceCommandSelectionListener(), times(1)).onVoiceCommandSelected();
}
// Emulate what happens when Core sends OnHMIStatus notification
private void sendFakeCoreOnHMIFullNotifications() {
OnHMIStatus onHMIStatusFakeNotification = new OnHMIStatus();
onHMIStatusFakeNotification.setHmiLevel(HMILevel.HMI_FULL);
onHMIStatusListener.onNotified(onHMIStatusFakeNotification);
}
}
|
