summaryrefslogtreecommitdiff
path: root/android/sdl_android/src/androidTest/java/com/smartdevicelink/test/rpc/requests/PerformInteractionTests.java
blob: 6b0060e13d8601782476c323b19f5de89cb55a9d (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
package com.smartdevicelink.test.rpc.requests;

import com.smartdevicelink.marshal.JsonRPCMarshaller;
import com.smartdevicelink.protocol.enums.FunctionID;
import com.smartdevicelink.proxy.RPCMessage;
import com.smartdevicelink.proxy.rpc.PerformInteraction;
import com.smartdevicelink.proxy.rpc.TTSChunk;
import com.smartdevicelink.proxy.rpc.VrHelpItem;
import com.smartdevicelink.proxy.rpc.enums.InteractionMode;
import com.smartdevicelink.proxy.rpc.enums.LayoutMode;
import com.smartdevicelink.test.BaseRpcTests;
import com.smartdevicelink.test.JsonUtils;
import com.smartdevicelink.test.TestValues;
import com.smartdevicelink.test.Validator;
import com.smartdevicelink.test.json.rpc.JsonFileReader;

import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;

import java.util.ArrayList;
import java.util.Hashtable;
import java.util.List;

/**
 * This is a unit test class for the SmartDeviceLink library project class : 
 * {@link com.smartdevicelink.proxy.rpc.PerformInteraction}
 */
public class PerformInteractionTests extends BaseRpcTests {
	
	@Override
	protected RPCMessage createMessage() {
		PerformInteraction msg = new PerformInteraction();

		msg.setInitialPrompt(TestValues.GENERAL_TTSCHUNK_LIST);
		msg.setHelpPrompt(TestValues.GENERAL_TTSCHUNK_LIST);
		msg.setTimeoutPrompt(TestValues.GENERAL_TTSCHUNK_LIST);
		msg.setVrHelp(TestValues.GENERAL_VRHELPITEM_LIST);
		msg.setInteractionChoiceSetIDList(TestValues.GENERAL_INTEGER_LIST);
		msg.setInteractionLayout(TestValues.GENERAL_LAYOUTMODE);
		msg.setInitialText(TestValues.GENERAL_STRING);
		msg.setInteractionMode(TestValues.GENERAL_INTERACTIONMODE);
		msg.setTimeout(TestValues.GENERAL_INT);
		msg.setCancelID(TestValues.GENERAL_INTEGER);

		return msg;
	}

	@Override
	protected String getMessageType() {
		return RPCMessage.KEY_REQUEST;
	}

	@Override
	protected String getCommandType() {
		return FunctionID.PERFORM_INTERACTION.toString();
	}

	@Override
	protected JSONObject getExpectedParameters(int sdlVersion) {
		JSONObject result = new JSONObject();

		try {			
			result.put(PerformInteraction.KEY_INITIAL_PROMPT, TestValues.JSON_TTSCHUNKS);
			result.put(PerformInteraction.KEY_HELP_PROMPT, TestValues.JSON_TTSCHUNKS);
			result.put(PerformInteraction.KEY_TIMEOUT_PROMPT, TestValues.JSON_TTSCHUNKS);
			result.put(PerformInteraction.KEY_VR_HELP, TestValues.JSON_VRHELPITEMS);
			result.put(PerformInteraction.KEY_INTERACTION_CHOICE_SET_ID_LIST, JsonUtils.createJsonArray(TestValues.GENERAL_INTEGER_LIST));
			result.put(PerformInteraction.KEY_INTERACTION_LAYOUT, TestValues.GENERAL_LAYOUTMODE);
			result.put(PerformInteraction.KEY_INITIAL_TEXT, TestValues.GENERAL_STRING);
			result.put(PerformInteraction.KEY_INTERACTION_MODE, TestValues.GENERAL_INTERACTIONMODE);
			result.put(PerformInteraction.KEY_TIMEOUT, TestValues.GENERAL_INT);
			result.put(PerformInteraction.KEY_CANCEL_ID, TestValues.GENERAL_INTEGER);
		} catch (JSONException e) {
			fail(TestValues.JSON_FAIL);
		}

		return result;
	}

    /**
	 * Tests the expected values of the RPC message.
	 */
    public void testRpcValues () {    	
    	// Test Values
		List<TTSChunk> testInitialPrompt = ( (PerformInteraction) msg).getInitialPrompt();
		List<TTSChunk> testHelpPrompt    = ( (PerformInteraction) msg).getHelpPrompt();
		List<TTSChunk> testTimeoutPrompt = ( (PerformInteraction) msg).getTimeoutPrompt();
		List<VrHelpItem> testVrHelpItems = ( (PerformInteraction) msg).getVrHelp();
		List<Integer> testChoiceSetIds   = ( (PerformInteraction) msg).getInteractionChoiceSetIDList();
		LayoutMode testLayout    = ( (PerformInteraction) msg).getInteractionLayout();
		String testInitialText   = ( (PerformInteraction) msg).getInitialText();
		InteractionMode testMode = ( (PerformInteraction) msg).getInteractionMode();
		Integer testTimeout      = ( (PerformInteraction) msg).getTimeout();
		Integer testCancelID = ( (PerformInteraction) msg ).getCancelID();
		
		// Valid Tests
		assertTrue(TestValues.TRUE, Validator.validateTtsChunks(TestValues.GENERAL_TTSCHUNK_LIST, testInitialPrompt));
		assertTrue(TestValues.TRUE, Validator.validateTtsChunks(TestValues.GENERAL_TTSCHUNK_LIST, testHelpPrompt));
		assertTrue(TestValues.TRUE, Validator.validateTtsChunks(TestValues.GENERAL_TTSCHUNK_LIST, testTimeoutPrompt));
		assertTrue(TestValues.TRUE, Validator.validateVrHelpItems(TestValues.GENERAL_VRHELPITEM_LIST, testVrHelpItems));
		assertEquals(TestValues.MATCH, TestValues.GENERAL_INTEGER_LIST, testChoiceSetIds);
		assertEquals(TestValues.MATCH, TestValues.GENERAL_LAYOUTMODE, testLayout);
		assertEquals(TestValues.MATCH, TestValues.GENERAL_STRING, testInitialText);
		assertEquals(TestValues.MATCH, TestValues.GENERAL_INTERACTIONMODE, testMode);
		assertEquals(TestValues.MATCH, (Integer) TestValues.GENERAL_INT, testTimeout);
		assertEquals(TestValues.MATCH, TestValues.GENERAL_INTEGER, testCancelID);
	
		// Invald/Null Tests
		PerformInteraction msg = new PerformInteraction();
		assertNotNull(TestValues.NOT_NULL, msg);

		testNullBase(msg);

		assertNull(TestValues.NULL, msg.getInitialPrompt());
		assertNull(TestValues.NULL, msg.getHelpPrompt());
		assertNull(TestValues.NULL, msg.getTimeoutPrompt());
		assertNull(TestValues.NULL, msg.getVrHelp());
		assertNull(TestValues.NULL, msg.getInteractionChoiceSetIDList());
		assertNull(TestValues.NULL, msg.getInteractionLayout());
		assertNull(TestValues.NULL, msg.getInitialText());
		assertNull(TestValues.NULL, msg.getInteractionMode());
		assertNull(TestValues.NULL, msg.getTimeout());
		assertNull(TestValues.NULL, msg.getCancelID());
	}

    /**
     * Tests a valid JSON construction of this RPC message.
     */
    public void testJsonConstructor () {
    	JSONObject commandJson = JsonFileReader.readId(this.mContext, getCommandType(), getMessageType());
    	assertNotNull(TestValues.NOT_NULL, commandJson);
    	
		try {
			Hashtable<String, Object> hash = JsonRPCMarshaller.deserializeJSONObject(commandJson);
			PerformInteraction cmd = new PerformInteraction(hash);
			
			JSONObject body = JsonUtils.readJsonObjectFromJsonObject(commandJson, getMessageType());
			assertNotNull(TestValues.NOT_NULL, body);
			
			// Test everything in the json body.
			assertEquals(TestValues.MATCH, JsonUtils.readStringFromJsonObject(body, RPCMessage.KEY_FUNCTION_NAME), cmd.getFunctionName());
			assertEquals(TestValues.MATCH, JsonUtils.readIntegerFromJsonObject(body, RPCMessage.KEY_CORRELATION_ID), cmd.getCorrelationID());

			JSONObject parameters = JsonUtils.readJsonObjectFromJsonObject(body, RPCMessage.KEY_PARAMETERS);
			assertEquals(TestValues.MATCH, JsonUtils.readStringFromJsonObject(parameters, PerformInteraction.KEY_INITIAL_TEXT), cmd.getInitialText());
			assertEquals(TestValues.MATCH, JsonUtils.readStringFromJsonObject(parameters, PerformInteraction.KEY_INTERACTION_MODE), cmd.getInteractionMode().toString());
			assertEquals(TestValues.MATCH, JsonUtils.readIntegerFromJsonObject(parameters, PerformInteraction.KEY_CANCEL_ID), cmd.getCancelID());

			List<Integer> interactionIDList = JsonUtils.readIntegerListFromJsonObject(parameters, PerformInteraction.KEY_INTERACTION_CHOICE_SET_ID_LIST);
			List<Integer> testIDList = cmd.getInteractionChoiceSetIDList();
			assertEquals(TestValues.MATCH, interactionIDList.size(), testIDList.size());
			assertTrue(TestValues.TRUE, Validator.validateIntegerList(interactionIDList, testIDList));
			
			assertEquals(TestValues.MATCH, JsonUtils.readStringFromJsonObject(parameters, PerformInteraction.KEY_INTERACTION_LAYOUT), cmd.getInteractionLayout().toString());
			
			JSONArray initalPromptArray = JsonUtils.readJsonArrayFromJsonObject(parameters, PerformInteraction.KEY_INITIAL_PROMPT);
			List<TTSChunk> initalPromptList = new ArrayList<TTSChunk>();
			for (int index = 0; index < initalPromptArray.length(); index++) {
	        	TTSChunk chunk = new TTSChunk(JsonRPCMarshaller.deserializeJSONObject( (JSONObject)initalPromptArray.get(index)) );
	        	initalPromptList.add(chunk);
			}
			assertTrue(TestValues.TRUE,  Validator.validateTtsChunks(initalPromptList, cmd.getInitialPrompt()));
			
			JSONArray helpPromptArray = JsonUtils.readJsonArrayFromJsonObject(parameters, PerformInteraction.KEY_HELP_PROMPT);
			List<TTSChunk> helpPromptList = new ArrayList<TTSChunk>();
			for (int index = 0; index < helpPromptArray.length(); index++) {
	        	TTSChunk chunk = new TTSChunk(JsonRPCMarshaller.deserializeJSONObject( (JSONObject)helpPromptArray.get(index)) );
	        	helpPromptList.add(chunk);
			}
			assertTrue(TestValues.TRUE, Validator.validateTtsChunks(helpPromptList, cmd.getHelpPrompt()));
			
			JSONArray timeoutPromptArray = JsonUtils.readJsonArrayFromJsonObject(parameters, PerformInteraction.KEY_TIMEOUT_PROMPT);
			List<TTSChunk> timeoutPromptList = new ArrayList<TTSChunk>();
			for (int index = 0; index < timeoutPromptArray.length(); index++) {
	        	TTSChunk chunk = new TTSChunk(JsonRPCMarshaller.deserializeJSONObject( (JSONObject)timeoutPromptArray.get(index)) );
	        	timeoutPromptList.add(chunk);
			}
			assertTrue(TestValues.TRUE,  Validator.validateTtsChunks(timeoutPromptList, cmd.getTimeoutPrompt()));
			assertEquals(TestValues.MATCH, JsonUtils.readIntegerFromJsonObject(parameters, PerformInteraction.KEY_TIMEOUT), cmd.getTimeout());
			
			JSONArray vrHelpArray = JsonUtils.readJsonArrayFromJsonObject(parameters, PerformInteraction.KEY_VR_HELP);
			List<VrHelpItem> vrHelpList= new ArrayList<VrHelpItem>();
			for (int index = 0; index < vrHelpArray.length(); index++) {
				VrHelpItem vrHelpItem = new VrHelpItem(JsonRPCMarshaller.deserializeJSONObject( (JSONObject)vrHelpArray.get(index)) );
				vrHelpList.add(vrHelpItem);
			}
			assertTrue(TestValues.TRUE,  Validator.validateVrHelpItems(vrHelpList, cmd.getVrHelp()) );
		} catch (JSONException e) {
			fail(TestValues.JSON_FAIL);
		}    	
    }    
}