Merge pull request firmata#59 from soundanalogous/update-unit-tests

updated unit tests to use ArduinoUnit version 2.0

Author: soundanalogous

test/readme.md

@@ -1,3 +1,7 @@
 #Testing Firmata
 
-TO DO: overview of firmata testing process.
+The Firmata test suite includes unit tests (see the unit directory). Integration
+tests may also be added at some point in the future.
+
+If you make changes to Firmata.cpp, run the tests in /test/unit/ to ensure
+that your changes have not produced any unexpected errors.

test/unit/firmata_test/firmata_test.ino

@@ -1,28 +1,26 @@
+/*
+ * To run this test suite, you must first install the ArduinoUnit library
+ * to your Arduino/libraries/ directory.
+ * You can get ArduinoUnit here: https://github.com/mmurdoch/arduinounit
+ * Download version 2.0 or greater.
+ */
+
 #include <ArduinoUnit.h>
 #include <Firmata.h>
 
-TestSuite suite;
-
 void setup()
 {
   Serial.begin(9600);
 }
 
 void loop()
 {
-  suite.run();
-}
-
-void assertStringsEqual(Test& __test__, const char* expected, const String& actual)
-{
-  size_t expectedLength = strlen(expected);
-  assertEquals(expectedLength, actual.length());
-  for (size_t i = 0; i < expectedLength; i++)
-  {
-    assertEquals(expected[i], actual[i]);
-  }
+  Test::run();
 }
 
+// Note: this test required adding a method (Firmata.unsetFirmwareVersion()) to 
+// Firmata.cpp solely for the purpose of running this test. The method has been 
+// removed from Firmata.cpp, but keeping the test here as a recored 
 // test(setFirmwareVersionDoesNotLeakMemory)
 // {
 //   Firmata.setFirmwareVersion(1, 0);
@@ -48,7 +46,7 @@ test(beginPrintsVersion)
     FIRMATA_MINOR_VERSION,
     0
   };
-  assertStringsEqual(__test__, expected, stream.bytesWritten());
+  assertEqual(expected, stream.bytesWritten());
 }
 
 void processMessage(const byte* message, size_t length)
@@ -84,7 +82,7 @@ test(processWriteDigital_0)
   byte message[] = { DIGITAL_MESSAGE, 0, 0 };
   processMessage(message, 3);
 
-  assertEquals(0, _digitalPortValue);
+  assertEqual(0, _digitalPortValue);
 }
 
 test(processWriteDigital_127)
@@ -95,7 +93,7 @@ test(processWriteDigital_127)
   byte message[] = { DIGITAL_MESSAGE, 127, 0 };
   processMessage(message, 3);
 
-  assertEquals(127, _digitalPortValue);
+  assertEqual(127, _digitalPortValue);
 }
 
 test(processWriteDigital_128)
@@ -106,7 +104,7 @@ test(processWriteDigital_128)
   byte message[] = { DIGITAL_MESSAGE, 0, 1 };
   processMessage(message, 3);
 
-  assertEquals(128, _digitalPortValue);
+  assertEqual(128, _digitalPortValue);
 }
 
 test(processWriteLargestDigitalValue)
@@ -118,7 +116,7 @@ test(processWriteLargestDigitalValue)
   processMessage(message, 3);
 
   // Maximum of 14 bits can be set (B0011111111111111)
-  assertEquals(0x3FFF, _digitalPortValue);
+  assertEqual(0x3FFF, _digitalPortValue);
 }
 
 test(defaultDigitalWritePortIsZero)
@@ -129,7 +127,7 @@ test(defaultDigitalWritePortIsZero)
   byte message[] = { DIGITAL_MESSAGE, 0, 0 };
   processMessage(message, 3);
 
-  assertEquals(0, _digitalPort);
+  assertEqual(0, _digitalPort);
 }
 
 test(specifiedDigitalWritePort)
@@ -140,6 +138,5 @@ test(specifiedDigitalWritePort)
   byte message[] = { DIGITAL_MESSAGE + 1, 0, 0 };
   processMessage(message, 3);
 
-  assertEquals(1, _digitalPort);
+  assertEqual(1, _digitalPort);
 }
-

test/unit/readme.md

@@ -1,4 +1,8 @@
 #Firmata Unit Tests
 
-TO DO: instructions on running unit tests and creating new tests for new
-features.
+Unit tests are written using the [ArduinoUnit](https://github.com/mmurdoch/arduinounit) library (version 2.0).
+
+Follow the instructions in the [ArduinoUnit readme](https://github.com/mmurdoch/arduinounit/blob/master/readme.md) to install the library.
+
+Compile and upload the test sketch as you would any other sketch. Then open the 
+Serial Monitor to view the test results.