Updated and documented trace/enums test classes.

6 files changed, 205 insertions, 195 deletions

diff --git a/sdl_android_tests/src/com/smartdevicelink/test/trace/DetailLevelTests.java b/sdl_android_tests/src/com/smartdevicelink/test/trace/DetailLevelTests.java
deleted file mode 100644
index 334245be4..000000000
--- a/sdl_android_tests/src/com/smartdevicelink/test/trace/DetailLevelTests.java
+++ /dev/null
@@ -1,61 +0,0 @@
-package com.smartdevicelink.test.trace;
-
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.List;
-
-import junit.framework.TestCase;
-
-import com.smartdevicelink.trace.enums.DetailLevel;
-
-public class DetailLevelTests extends TestCase {
-
-	private final String MSG = "Value did not match expected value.";
-	
-	public void testValidEnums () {
-		
-		String test = "OFF";
-		DetailLevel enumOff = DetailLevel.valueForString(test);		
-		test = "TERSE";
-		DetailLevel enumTerse = DetailLevel.valueForString(test);
-		test = "VERBOSE";
-		DetailLevel enumVerbose = DetailLevel.valueForString(test);
-		
-		assertNotNull(MSG, enumOff);
-		assertNotNull(MSG, enumTerse);
-		assertNotNull(MSG, enumVerbose);
-	}
-
-	public void testInvalidEnum () {		
-		String test = "invalid";
-		try {
-			DetailLevel temp = DetailLevel.valueForString(test);
-			assertNull(MSG, temp);
-		} catch (IllegalArgumentException e) {
-			fail("Invalid enum throws IllegalArgumentException.");
-		}
-	}
-	
-	public void testNullEnum () {
-		String test = null;
-		try {
-			DetailLevel temp = DetailLevel.valueForString(test);
-			assertNull(MSG, temp);
-		} catch (NullPointerException e) {
-			fail("Invalid enum throws NullPointerException.");
-		}
-	}
-	
-	public void testListEnum () {
-		List<DetailLevel> enumValueList = Arrays.asList(DetailLevel.values());
-		List<DetailLevel> enumTestList  = new ArrayList<DetailLevel>();
-		
-		enumTestList.add(DetailLevel.OFF);
-		enumTestList.add(DetailLevel.TERSE);
-		enumTestList.add(DetailLevel.VERBOSE);
-		
-		assertTrue("Enum value list does not match enum class list.",
-				enumValueList.containsAll(enumTestList) &&
-				enumTestList.containsAll(enumValueList));		
-	}
-}
\ No newline at end of file
diff --git a/sdl_android_tests/src/com/smartdevicelink/test/trace/InterfaceActivityDirectionTests.java b/sdl_android_tests/src/com/smartdevicelink/test/trace/InterfaceActivityDirectionTests.java
deleted file mode 100644
index 33a249769..000000000
--- a/sdl_android_tests/src/com/smartdevicelink/test/trace/InterfaceActivityDirectionTests.java
+++ /dev/null
@@ -1,61 +0,0 @@
-package com.smartdevicelink.test.trace;
-
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.List;
-
-import junit.framework.TestCase;
-
-import com.smartdevicelink.trace.enums.InterfaceActivityDirection;
-
-public class InterfaceActivityDirectionTests extends TestCase {
-
-	private final String MSG = "Value did not match expected value.";
-	
-	public void testValidEnums () {
-		
-		String test = "Transmit";
-		InterfaceActivityDirection enumTransmit = InterfaceActivityDirection.valueForString(test);		
-		test = "Receive";
-		InterfaceActivityDirection enumReceive = InterfaceActivityDirection.valueForString(test);
-		test = "None";
-		InterfaceActivityDirection enumNone = InterfaceActivityDirection.valueForString(test);
-		
-		assertNotNull(MSG, enumTransmit);
-		assertNotNull(MSG, enumReceive);
-		assertNotNull(MSG, enumNone);
-	}
-
-	public void testInvalidEnum () {		
-		String test = "invalid";
-		try {
-			InterfaceActivityDirection temp = InterfaceActivityDirection.valueForString(test);
-			assertNull(MSG, temp);
-		} catch (IllegalArgumentException e) {
-			fail("Invalid enum throws IllegalArgumentException.");
-		}
-	}
-	
-	public void testNullEnum () {
-		String test = null;
-		try {
-			InterfaceActivityDirection temp = InterfaceActivityDirection.valueForString(test);
-			assertNull(MSG, temp);
-		} catch (NullPointerException e) {
-			fail("Invalid enum throws NullPointerException.");
-		}
-	}
-	
-	public void testListEnum () {
-		List<InterfaceActivityDirection> enumValueList = Arrays.asList(InterfaceActivityDirection.values());
-		List<InterfaceActivityDirection> enumTestList  = new ArrayList<InterfaceActivityDirection>();
-		
-		enumTestList.add(InterfaceActivityDirection.Transmit);
-		enumTestList.add(InterfaceActivityDirection.Receive);
-		enumTestList.add(InterfaceActivityDirection.None);
-		
-		assertTrue("Enum value list does not match enum class list.",
-				enumValueList.containsAll(enumTestList) &&
-				enumTestList.containsAll(enumValueList));		
-	}
-}
\ No newline at end of file
diff --git a/sdl_android_tests/src/com/smartdevicelink/test/trace/ModTests.java b/sdl_android_tests/src/com/smartdevicelink/test/trace/ModTests.java
deleted file mode 100644
index c66ad4993..000000000
--- a/sdl_android_tests/src/com/smartdevicelink/test/trace/ModTests.java
+++ /dev/null
@@ -1,73 +0,0 @@
-package com.smartdevicelink.test.trace;
-
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.List;
-
-import junit.framework.TestCase;
-
-import com.smartdevicelink.trace.enums.Mod;
-
-public class ModTests extends TestCase {
-	
-	private final String MSG = "Value did not match expected value.";
-	
-	public void testValidEnums () {
-		
-		String test = "proto";
-		Mod enumProto = Mod.valueForString(test);		
-		test = "proxy";
-		Mod enumProxy = Mod.valueForString(test);
-		test = "tran";
-		Mod enumTran = Mod.valueForString(test);
-		test = "app";
-		Mod enumApp = Mod.valueForString(test);
-		test = "rpc";
-		Mod enumRpc = Mod.valueForString(test);
-		test = "mar";
-		Mod enumMar = Mod.valueForString(test);
-		
-		assertNotNull(MSG, enumProto);
-		assertNotNull(MSG, enumProxy);
-		assertNotNull(MSG, enumTran);
-		assertNotNull(MSG, enumApp);
-		assertNotNull(MSG, enumRpc);
-		assertNotNull(MSG, enumMar);
-	}
-
-	public void testInvalidEnum () {		
-		String test = "invalid";
-		try {
-			Mod temp = Mod.valueForString(test);
-			assertNull(MSG, temp);
-		} catch (IllegalArgumentException e) {
-			fail("Invalid enum throws IllegalArgumentException.");
-		}
-	}
-	
-	public void testNullEnum () {
-		String test = null;
-		try {
-			Mod temp = Mod.valueForString(test);
-			assertNull(MSG, temp);
-		} catch (NullPointerException e) {
-			fail("Invalid enum throws NullPointerException.");
-		}
-	}
-	
-	public void testListEnum () {
-		List<Mod> enumValueList = Arrays.asList(Mod.values());
-		List<Mod> enumTestList  = new ArrayList<Mod>();
-		
-		enumTestList.add(Mod.tran);
-		enumTestList.add(Mod.proto);
-		enumTestList.add(Mod.mar);
-		enumTestList.add(Mod.rpc);
-		enumTestList.add(Mod.app);
-		enumTestList.add(Mod.proxy);
-		
-		assertTrue("Enum value list does not match enum class list.",
-				enumValueList.containsAll(enumTestList) &&
-				enumTestList.containsAll(enumValueList));		
-	}
-}
\ No newline at end of file
diff --git a/sdl_android_tests/src/com/smartdevicelink/test/trace/enums/DetailLevelTests.java b/sdl_android_tests/src/com/smartdevicelink/test/trace/enums/DetailLevelTests.java
new file mode 100644
index 000000000..615f0af4c
--- /dev/null
+++ b/sdl_android_tests/src/com/smartdevicelink/test/trace/enums/DetailLevelTests.java
@@ -0,0 +1,63 @@
+package com.smartdevicelink.test.trace.enums;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
+import junit.framework.TestCase;
+
+import com.smartdevicelink.test.Test;
+import com.smartdevicelink.trace.enums.DetailLevel;
+
+/**
+ * This is a unit test class for the SmartDeviceLink library project class : 
+ * {@link com.smartdevicelink.trace.enums.DetailLevel}
+ */
+public class DetailLevelTests extends TestCase {
+	
+	/**
+	 * This is a unit test for the following enum : 
+	 * {@link com.smartdevicelink.trace.enums.DetailLevel}
+	 */
+	public void testDetailLevelEnum () {
+		
+		// Test Values
+		String testOff     = "OFF";
+		String testTerse   = "TERSE";
+		String testInvalid = "INVALID";
+		String testVerbose = "VERBOSE";
+		
+		try {
+			// Comparison Values
+			DetailLevel expectedOffEnum        = DetailLevel.OFF;
+			DetailLevel expectedTerseEnum      = DetailLevel.TERSE;
+			DetailLevel expectedVerboseEnum    = DetailLevel.VERBOSE;
+			List<DetailLevel> expectedEnumList = new ArrayList<DetailLevel>();
+			expectedEnumList.add(DetailLevel.OFF);
+			expectedEnumList.add(DetailLevel.TERSE);
+			expectedEnumList.add(DetailLevel.VERBOSE);
+			
+			DetailLevel actualNullEnum       = DetailLevel.valueForString(null);
+			DetailLevel actualOffEnum        = DetailLevel.valueForString(testOff);
+			DetailLevel actualTerseEnum      = DetailLevel.valueForString(testTerse);
+			DetailLevel actualInvalidEnum    = DetailLevel.valueForString(testInvalid);
+			DetailLevel actualVerboseEnum    = DetailLevel.valueForString(testVerbose);
+			List<DetailLevel> actualEnumList = Arrays.asList(DetailLevel.values());
+			
+			// Valid Tests
+			assertEquals(Test.MATCH, expectedOffEnum, actualOffEnum);
+			assertEquals(Test.MATCH, expectedTerseEnum, actualTerseEnum);
+			assertEquals(Test.MATCH, expectedVerboseEnum, actualVerboseEnum);
+			assertTrue(Test.ARRAY, expectedEnumList.containsAll(actualEnumList) && actualEnumList.containsAll(expectedEnumList));
+			
+			// Invalid/Null Tests
+			assertNull(Test.NULL, actualInvalidEnum);
+			assertNull(Test.NULL, actualNullEnum);
+			
+		}catch (NullPointerException e) {
+			fail("Could not retrieve value for null string, should return null.");
+		} catch (IllegalArgumentException e) {
+			fail("Could not retrieve value for invalid string, should return null.");
+		}
+	}
+}
\ No newline at end of file
diff --git a/sdl_android_tests/src/com/smartdevicelink/test/trace/enums/InterfaceActivityDirectionTests.java b/sdl_android_tests/src/com/smartdevicelink/test/trace/enums/InterfaceActivityDirectionTests.java
new file mode 100644
index 000000000..4086788e6
--- /dev/null
+++ b/sdl_android_tests/src/com/smartdevicelink/test/trace/enums/InterfaceActivityDirectionTests.java
@@ -0,0 +1,63 @@
+package com.smartdevicelink.test.trace.enums;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
+import junit.framework.TestCase;
+
+import com.smartdevicelink.test.Test;
+import com.smartdevicelink.trace.enums.InterfaceActivityDirection;
+
+/**
+ * This is a unit test class for the SmartDeviceLink library project class : 
+ * {@link com.smartdevicelink.trace.enums.InterfaceActivityDirection}
+ */
+public class InterfaceActivityDirectionTests extends TestCase {
+	
+	/**
+	 * This is a unit test for the following enum : 
+	 * {@link com.smartdevicelink.trace.enums.InterfaceActivityDirection}
+	 */
+	public void testInterfaceActivityDirectionEnum () {
+		
+		// Test Values
+		String testNone     = "None";
+		String testInvalid  = "Invalid";
+		String testReceive  = "Receive";
+		String testTransmit	= "Transmit";
+		
+		try {
+			// Comparison Values
+			InterfaceActivityDirection expectedNoneEnum       = InterfaceActivityDirection.None;
+			InterfaceActivityDirection expectedReceiveEnum    = InterfaceActivityDirection.Receive;
+			InterfaceActivityDirection expectedTransmitEnum   = InterfaceActivityDirection.Transmit;
+			List<InterfaceActivityDirection> expectedEnumList = new ArrayList<InterfaceActivityDirection>();
+			expectedEnumList.add(InterfaceActivityDirection.None);
+			expectedEnumList.add(InterfaceActivityDirection.Receive);
+			expectedEnumList.add(InterfaceActivityDirection.Transmit);
+			
+			InterfaceActivityDirection actualNullEnum       = InterfaceActivityDirection.valueForString(null);
+			InterfaceActivityDirection actualNoneEnum       = InterfaceActivityDirection.valueForString(testNone);
+			InterfaceActivityDirection actualInvalidEnum    = InterfaceActivityDirection.valueForString(testInvalid);
+			InterfaceActivityDirection actualReceiveEnum    = InterfaceActivityDirection.valueForString(testReceive);
+			InterfaceActivityDirection actualTransmitEnum   = InterfaceActivityDirection.valueForString(testTransmit);
+			List<InterfaceActivityDirection> actualEnumList = Arrays.asList(InterfaceActivityDirection.values());
+			
+			// Valid Tests
+			assertEquals(Test.MATCH, expectedNoneEnum, actualNoneEnum);
+			assertEquals(Test.MATCH, expectedReceiveEnum, actualReceiveEnum);
+			assertEquals(Test.MATCH, expectedTransmitEnum, actualTransmitEnum);
+			assertTrue(Test.ARRAY, expectedEnumList.containsAll(actualEnumList) && actualEnumList.containsAll(expectedEnumList));
+						
+			// Invalid/Null 
+			assertNull(Test.NULL, actualInvalidEnum);
+			assertNull(Test.NULL, actualNullEnum);
+			
+		} catch (NullPointerException e) {
+			fail("Could not retrieve value for null string, should return null.");
+		} catch (IllegalArgumentException e) {
+			fail("Could not retrieve value for invalid string, should return null.");
+		}	
+	}
+}
\ No newline at end of file
diff --git a/sdl_android_tests/src/com/smartdevicelink/test/trace/enums/ModTests.java b/sdl_android_tests/src/com/smartdevicelink/test/trace/enums/ModTests.java
new file mode 100644
index 000000000..917960506
--- /dev/null
+++ b/sdl_android_tests/src/com/smartdevicelink/test/trace/enums/ModTests.java
@@ -0,0 +1,79 @@
+package com.smartdevicelink.test.trace.enums;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
+import junit.framework.TestCase;
+
+import com.smartdevicelink.test.Test;
+import com.smartdevicelink.trace.enums.Mod;
+
+/**
+ * This is a unit test class for the SmartDeviceLink library project class : 
+ * {@link com.smartdevicelink.trace.enums.Mod}
+ */
+public class ModTests extends TestCase {
+	
+	/**
+	 * This is a unit test for the following enum : 
+	 * {@link com.smartdevicelink.trace.enums.Mod}
+	 */
+	public void testModEnum () {
+		
+		// TestValues
+		String testApp     = "app";
+		String testRpc     = "rpc";
+		String testMar     = "mar";
+		String testTran    = "tran";
+		String testProto   = "proto";
+		String testProxy   = "proxy";
+		String testInvalid = "invalid";
+		
+		try {
+			// Comparison Values
+			Mod expectedAppEnum   = Mod.app;
+			Mod expectedRpcEnum   = Mod.rpc;
+			Mod expectedMarEnum   = Mod.mar;
+			Mod expectedTranEnum  = Mod.tran;
+			Mod expectedProtoEnum = Mod.proto;
+			Mod expectedProxyEnum = Mod.proxy;
+			List<Mod> expectedEnumList = new ArrayList<Mod>();
+			expectedEnumList.add(Mod.app);
+			expectedEnumList.add(Mod.rpc);
+			expectedEnumList.add(Mod.mar);
+			expectedEnumList.add(Mod.tran);
+			expectedEnumList.add(Mod.proto);
+			expectedEnumList.add(Mod.proxy);
+			
+			Mod actualNullEnum       = Mod.valueForString(null);
+			Mod actualAppEnum        = Mod.valueForString(testApp);
+			Mod actualRpcEnum        = Mod.valueForString(testRpc);
+			Mod actualMarEnum        = Mod.valueForString(testMar);
+			Mod actualTranEnum       = Mod.valueForString(testTran);
+			Mod actualProtoEnum      = Mod.valueForString(testProto);
+			Mod actualProxyEnum      = Mod.valueForString(testProxy);
+			Mod actualInvalidEnum    = Mod.valueForString(testInvalid);
+			List<Mod> actualEnumList = Arrays.asList(Mod.values());
+			
+			// Valid Tests
+			assertEquals(Test.MATCH, expectedAppEnum, actualAppEnum);
+			assertEquals(Test.MATCH, expectedRpcEnum, actualRpcEnum);
+			assertEquals(Test.MATCH, expectedMarEnum, actualMarEnum);
+			assertEquals(Test.MATCH, expectedTranEnum, actualTranEnum);
+			assertEquals(Test.MATCH, expectedProtoEnum, actualProtoEnum);
+			assertEquals(Test.MATCH, expectedProxyEnum, actualProxyEnum);
+			assertTrue(Test.ARRAY, expectedEnumList.containsAll(actualEnumList) && actualEnumList.containsAll(expectedEnumList));
+			
+			// Invalid/Null Tests
+			assertNull(Test.NULL, actualInvalidEnum);
+			assertNull(Test.NULL, actualNullEnum);
+			
+		} catch (NullPointerException e) {
+			fail("Could not retrieve value for null string, should return null.");
+		} catch (IllegalArgumentException e) {
+			fail("Could not retrieve value for invalid string, should return null.");
+		}
+		
+	}
+}
\ No newline at end of file