From e2f15b3b9778c8c8af0484cf820ae93d99c99522 Mon Sep 17 00:00:00 2001
From: DrZiplok <DrZiplok@f9c3cf11-9bcb-44bc-f272-b75c42450872>
Date: Sun, 23 Jan 2011 20:26:11 +0000
Subject: [PATCH] Move the Test unit test framework out into its own header, so
 that it can be used by other libraries.

Add some documentation explaining how it is used.

git-svn-id: https://arducopter.googlecode.com/svn/trunk@1537 f9c3cf11-9bcb-44bc-f272-b75c42450872
---
 libraries/AP_Common/AP_Test.h | 83 +++++++++++++++++++++++++++++++++++
 1 file changed, 83 insertions(+)
 create mode 100644 libraries/AP_Common/AP_Test.h

diff --git a/libraries/AP_Common/AP_Test.h b/libraries/AP_Common/AP_Test.h
new file mode 100644
index 0000000000..39937b8546
--- /dev/null
+++ b/libraries/AP_Common/AP_Test.h
@@ -0,0 +1,83 @@
+// -*- tab-width: 4; Mode: C++; c-basic-offset: 4; indent-tabs-mode: nil -*-
+//
+// This is free software; you can redistribute it and/or modify it under
+// the terms of the GNU Lesser General Public License as published by the
+// Free Software Foundation; either version 2.1 of the License, or (at
+// your option) any later version.
+//
+
+/// @file   AP_Test.h
+/// @brief  A simple unit test framework.
+///
+/// AP_Test provides the usual test start, condition validation and reporting
+/// functions in a compact form.
+///
+/// Each test must be contained within a block; either a standalone function or
+/// a block within a function.  The TEST macro is used to start a test; it creates
+/// the local object which will track the results of the test and saves the name
+/// for later reporting.  Only one test may be performed within each block.
+///
+/// Within the test, use the REQUIRE macro to describe a condition that must be
+/// met for the test to fail.  If the condition within the macro is not met,
+/// the condition will be output as a diagnostic and the test will be considered
+/// to have failed.
+///
+/// The test ends at the end of the block, and the result of the test will be
+/// output as a diagnostic.
+///
+/// Optionally at the end of the test suite, the Test::report method may be used
+/// to summarize the results of all of the tests that were performed.
+///
+
+class Test
+{
+public:
+    Test(const char *name);
+    ~Test();
+    void        require(bool expr, const char *source);
+    static void report();
+
+private:
+    const char  *_name;
+    bool        _fail;
+    static int  _passed;
+    static int  _failed;
+};
+
+Test::Test(const char *name) :
+        _name(name),
+        _fail(false)
+{
+}
+
+Test::~Test()
+{
+    Serial.printf("%s: %s\n", _fail ? "FAILED" : "passed", _name);
+    if (_fail) {
+        _failed++;
+    } else {
+        _passed++;
+    }
+}
+
+void
+Test::require(bool expr, const char *source)
+{
+    if (!expr) {
+        _fail = true;
+        Serial.printf("%s: fail: %s\n", _name, source);
+    }
+}
+
+void
+Test::report()
+{
+    Serial.printf("\n%d passed  %d failed\n", _passed, _failed);
+}
+
+int Test::_passed = 0;
+int Test::_failed = 0;
+
+#define TEST(name)      Test _test(#name)
+#define REQUIRE(expr)   _test.require(expr, #expr)
+