Add support for unittest_setup and unittest_teardown functions

Author: hlovdal

SampleProjects/TestSomething/test/setup_and_treardown.cpp

@@ -0,0 +1,57 @@
+#include <ArduinoUnitTests.h>
+#include <Arduino.h>
+
+class LcdInterface {
+  public:
+  virtual void print(const char *) = 0;
+};
+
+class MockLcd : public LcdInterface {
+  public:
+  void print(const char *) {}
+};
+
+LcdInterface *Lcd_p;
+
+class Calculator {
+  public:
+  int add(int a, int b) {
+    int result = a + b;
+    char buf[40];
+    sprintf(buf, "%d + %d = %d", a, b, result);
+    Lcd_p->print(buf);
+    return result;
+  }
+};
+
+unittest_setup()
+{
+  Lcd_p = new MockLcd();
+}
+
+unittest_teardown()
+{
+  delete Lcd_p;
+}
+
+// This is a typical test where using setup (and teardown) would be useful
+// to set up the "external" lcd dependency that the calculator uses indirectly
+// but it is not something that is related to the functionality that is tested.
+
+// When you want to test that the calculator actually prints the calculations,
+// then that should be done in the arrange part of the actual test (by setting
+// up an mock lcd class that keeps a list of all messages printed).
+
+unittest(add)
+{
+  // Arrange
+  Calculator c;
+
+  // Act
+  int result = c.add(11, 22);
+
+  // Assert
+  assertEqual(33, result);
+}
+
+unittest_main()

cpp/unittest/ArduinoUnitTests.cpp

@@ -1,3 +1,5 @@
 #include "ArduinoUnitTests.h"
 
+Test* Test::sSetup = 0;
+Test* Test::sTeardown = 0;
 Test* Test::sRoot = 0;

cpp/unittest/ArduinoUnitTests.h

@@ -81,6 +81,8 @@ class Test
     const char* mName;
 
     // linked list structure for active tests
+    static Test* sSetup;
+    static Test* sTeardown;
     static Test* sRoot;
     Test* mNext;
 
@@ -119,7 +121,13 @@ class Test
     Test(const char* _name) : mName(_name) {
       mResult = RESULT_NONE;
       mReporter = 0;
-      append();
+      if (_name == "s e t u p") {
+        sSetup = this;
+      } else if (_name == "t e a r d o w n") {
+        sTeardown = this;
+      } else {
+        append();
+      }
     }
 
     inline void fail() { mResult = RESULT_FAIL; }
@@ -152,7 +160,9 @@ class Test
     static int run_and_report(int argc, char *argv[]) {
       // TODO: pick a reporter based on args
       ReporterTAP rep;
+      if (sSetup) sSetup->task();
       Results results = run(&rep);
+      if (sTeardown) sTeardown->task();
       return results.failed + results.skipped;
     }
 
@@ -217,6 +227,31 @@ class Test
   } test_##name##_instance;        \
   void test_##name ::task()
 
+/**
+ * The unittest_setup and unittest_teardown functions are intended to be used
+ * to set up "external" dependencies that needs to present but are not directly
+ * related to the functionality that you are testing, for instance a LCD.
+ */
+#define unittest_setup()                          \
+  struct xtest_unittest_setup : Test              \
+  {                                               \
+    xtest_unittest_setup() : Test("s e t u p"){}; \
+    void task();                                  \
+  } xtest_unittest_setup_instance;                \
+  void xtest_unittest_setup::task()
+
+#define unittest_teardown() \
+  struct xtest_unittest_teardown : Test                    \
+  {                                                        \
+    xtest_unittest_teardown() : Test("t e a r d o w n"){}; \
+    void task();                                           \
+  } xtest_unittest_teardown_instance;                      \
+  void xtest_unittest_teardown::task()
+
+// To avoid potentionally breaking existing code by re-using the Test class for
+// setup and teardown, add a "x" prefix in front of names so that it will be
+// different from code generated by the unittest macro. Also using _name
+// arguments to Test that cannot be used in the unittest macro.
 
 #define unittest_main()                      \
   int main(int argc, char *argv[]) {         \