summaryrefslogtreecommitdiff
path: root/android/sdl_android/src/androidTest/java/com/smartdevicelink/test/rpc/requests/PutFileTests.java
blob: b70c837944c49602d9135ad67660f2a0282b463c (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
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.PutFile;
import com.smartdevicelink.proxy.rpc.enums.FileType;
import com.smartdevicelink.test.BaseRpcTests;
import com.smartdevicelink.test.JsonUtils;
import com.smartdevicelink.test.TestValues;
import com.smartdevicelink.test.json.rpc.JsonFileReader;

import org.json.JSONException;
import org.json.JSONObject;
import org.junit.Test;

import java.util.Hashtable;
import java.util.zip.CRC32;

import static junit.framework.TestCase.assertEquals;
import static junit.framework.TestCase.assertNotNull;
import static junit.framework.TestCase.assertNull;
import static junit.framework.TestCase.fail;
import static androidx.test.platform.app.InstrumentationRegistry.getInstrumentation;

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

		msg.setFileType(TestValues.GENERAL_FILETYPE);
		msg.setPersistentFile(TestValues.GENERAL_BOOLEAN);
		msg.setSystemFile(TestValues.GENERAL_BOOLEAN);
		msg.setOffset(TestValues.GENERAL_LONG);
		msg.setLength(TestValues.GENERAL_LONG);
		msg.setCRC(TestValues.GENERAL_BYTE_ARRAY);
		msg.setCRC(TestValues.GENERAL_LONG);

		return msg;
	}

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

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

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

		try {
			result.put(PutFile.KEY_FILE_TYPE, TestValues.GENERAL_FILETYPE);
			result.put(PutFile.KEY_PERSISTENT_FILE, TestValues.GENERAL_BOOLEAN);
			result.put(PutFile.KEY_SYSTEM_FILE, TestValues.GENERAL_BOOLEAN);
			result.put(PutFile.KEY_OFFSET, TestValues.GENERAL_LONG);
			result.put(PutFile.KEY_LENGTH, TestValues.GENERAL_LONG);
			result.put(PutFile.KEY_CRC, TestValues.GENERAL_LONG);
		} catch (JSONException e) {
			fail(TestValues.JSON_FAIL);
		}

		return result;
	}
	
	/**
	 * Tests the expected values of the RPC message.
	 */
	@Test
    public void testRpcValues () {    	
    	// Test Values
		FileType testFileType = ( (PutFile) msg ).getFileType();
		boolean  testPersistentFile = ( (PutFile) msg ).getPersistentFile();
		boolean  testSystemFile = ( (PutFile) msg ).getSystemFile();
		Long     testOffset = ( (PutFile) msg ).getOffset();
		Long     testLength = ( (PutFile) msg ).getLength();
		Long     testCRC = ( (PutFile) msg ).getCRC();

		// Valid Tests
		assertEquals(TestValues.MATCH, TestValues.GENERAL_FILETYPE, testFileType);
		assertEquals(TestValues.MATCH, TestValues.GENERAL_BOOLEAN, testPersistentFile);
		assertEquals(TestValues.MATCH, TestValues.GENERAL_BOOLEAN, testSystemFile);
		assertEquals(TestValues.MATCH, TestValues.GENERAL_LONG, testOffset);
		assertEquals(TestValues.MATCH, TestValues.GENERAL_LONG, testLength);
		assertEquals(TestValues.MATCH, TestValues.GENERAL_LONG, testCRC);

		// Invalid/Null Tests
		PutFile msg = new PutFile();
		assertNotNull("Null object creation failed.", msg);
		testNullBase(msg);

		assertNull(TestValues.NULL, msg.getFileType());
		assertNull(TestValues.NULL, msg.getPersistentFile());
		assertNull(TestValues.NULL, msg.getSystemFile());
		assertNull(TestValues.NULL, msg.getOffset());
		assertNull(TestValues.NULL, msg.getLength());
		assertNull(TestValues.NULL, msg.getCRC());
	}

	/**
	 * Tests the expected values of the CRC checksum.
	 */
	@Test
	public void testByteArrayCheckSum () {
		// Test Values
		PutFile msgCRC = new PutFile();
		msgCRC.setCRC(TestValues.GENERAL_BYTE_ARRAY);
		Long testCRCByteArray = msgCRC.getCRC();

		CRC32 crc = new CRC32();
		crc.update(TestValues.GENERAL_BYTE_ARRAY);
		Long crcValue = crc.getValue();

		assertEquals(TestValues.MATCH, crcValue, testCRCByteArray);
	}



    /**
     * Tests a valid JSON construction of this RPC message.
     */
    @Test
    public void testJsonConstructor () {
    	JSONObject commandJson = JsonFileReader.readId(getInstrumentation().getTargetContext(), getCommandType(), getMessageType());
    	assertNotNull(TestValues.NOT_NULL, commandJson);
    	
		try {
			Hashtable<String, Object> hash = JsonRPCMarshaller.deserializeJSONObject(commandJson);
			PutFile cmd = new PutFile(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.readBooleanFromJsonObject(parameters, PutFile.KEY_PERSISTENT_FILE), cmd.getPersistentFile());
			assertEquals(TestValues.MATCH, JsonUtils.readBooleanFromJsonObject(parameters, PutFile.KEY_SYSTEM_FILE), cmd.getSystemFile());
			assertEquals(TestValues.MATCH, JsonUtils.readStringFromJsonObject(parameters, PutFile.KEY_FILE_TYPE), cmd.getFileType().toString());
			assertEquals(TestValues.MATCH, JsonUtils.readStringFromJsonObject(parameters, PutFile.KEY_SDL_FILE_NAME), cmd.getSdlFileName());
			assertEquals(TestValues.MATCH, (Long) JsonUtils.readIntegerFromJsonObject(parameters, PutFile.KEY_OFFSET).longValue(), cmd.getOffset());
			assertEquals(TestValues.MATCH, (Long) JsonUtils.readIntegerFromJsonObject(parameters, PutFile.KEY_LENGTH).longValue(), cmd.getLength());
			assertEquals(TestValues.MATCH, (Long) JsonUtils.readIntegerFromJsonObject(parameters, PutFile.KEY_CRC).longValue(), cmd.getCRC());
		} catch (JSONException e) {
			fail(TestValues.JSON_FAIL);
		}    	
    }
}