Merge pull request #96 from hlovdal/setup_and_teardown

Add support for unittest_setup and unittest_teardown functions

Author: ianfixes

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,6 @@
 #include "ArduinoUnitTests.h"
 
+TestSetup *TestSetup::sInstance;
+TestTeardown *TestTeardown::sInstance;
+
 Test* Test::sRoot = 0;

cpp/unittest/ArduinoUnitTests.h

@@ -15,6 +15,26 @@ struct TestData {
   int result;
 };
 
+class TestSetup
+{
+  public:
+  TestSetup() {
+    sInstance = this;
+  }
+  virtual void run() {}
+  static TestSetup *sInstance;
+};
+
+class TestTeardown
+{
+  public:
+  TestTeardown() {
+    sInstance = this;
+  }
+  virtual void run() {}
+  static TestTeardown *sInstance;
+};
+
 class Test
 {
   public:
@@ -152,7 +172,9 @@ class Test
     static int run_and_report(int argc, char *argv[]) {
       // TODO: pick a reporter based on args
       ReporterTAP rep;
+      if (TestSetup::sInstance) TestSetup::sInstance->run();
       Results results = run(&rep);
+      if (TestTeardown::sInstance) TestTeardown::sInstance->run();
       return results.failed + results.skipped;
     }
 
@@ -217,6 +239,24 @@ 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()                          \
+  class unittest_setup_class : public TestSetup { \
+    public:                                       \
+    virtual void run() override;                  \
+  } unittest_setup_instance;                      \
+  void unittest_setup_class::run()
+
+#define unittest_teardown()                             \
+  class unittest_teardown_class : public TestTeardown { \
+    public:                                             \
+    virtual void run() override;                        \
+  } unittest_teardown_instance;                         \
+  void unittest_teardown_class::run()
 
 #define unittest_main()                      \
   int main(int argc, char *argv[]) {         \