From 540f839cb5868dac3eb409f509b85995826cf559 Mon Sep 17 00:00:00 2001 From: Bent Bisballe Nyeng Date: Sat, 6 Jun 2020 19:44:36 +0200 Subject: Add unit-test framework. --- test/dgunit.h | 241 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 241 insertions(+) create mode 100644 test/dgunit.h (limited to 'test/dgunit.h') diff --git a/test/dgunit.h b/test/dgunit.h new file mode 100644 index 0000000..6717310 --- /dev/null +++ b/test/dgunit.h @@ -0,0 +1,241 @@ +/* -*- Mode: c++ -*- */ +/*************************************************************************** + * dgunit.h + * + * Sat Jun 16 15:44:06 CEST 2018 + * Copyright 2018 Bent Bisballe Nyeng + * deva@aasimon.org + ****************************************************************************/ + +/* + * This file is part of DrumGizmo. + * + * DrumGizmo 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 3 of the License, or + * (at your option) any later version. + * + * DrumGizmo is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with DrumGizmo; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. + */ +#pragma once + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +class DGUnit +{ +public: + DGUnit() + { + if(DGUnit::suite_list == nullptr) + { + DGUnit::suite_list = this; + return; + } + + auto unit = DGUnit::suite_list; + while(unit->next_unit) + { + } + unit->next_unit = this; + } + + //! Overload to prepare stuff for each of the tests. + virtual void setup() {} + + //! Overload to tear down stuff for each of the tests. + virtual void teardown() {} + + struct test_result + { + std::string func; + std::string file; + std::size_t line; + std::string msg; + int id; + }; + + //! Run test + //! \param test_suite the name of a test suite or null for all. + //! \param test_name the name of a test name inside a test suite. Only valid + //! if test_suite is non-null. nullptr for all tests. + static int runTests(std::ofstream& out) + { + std::size_t test_num{0}; + std::size_t failed{0}; + + std::list failed_tests; + std::list successful_tests; + + for(auto suite = DGUnit::suite_list; suite; suite = suite->next_unit) + { + for(auto test : suite->tests) + { + ++test_num; + try + { + suite->setup(); + test.first(); + suite->teardown(); + } + catch(test_result& result) + { + std::cout << "F"; + fflush(stdout); + result.id = test_num; + result.func = test.second; + failed_tests.push_back(result); + ++failed; + continue; + } + catch(...) + { + break; // Uncaught exception. Do not proceed with this test. + } + std::cout << "."; + fflush(stdout); + test_result result{test.second}; + result.id = test_num; + successful_tests.push_back(result); + } + } + + out << "\n"; + out << "\n"; + out << " \n"; + for(auto test : failed_tests) + { + out << " \n"; + out << " " << sanitize(test.func) << "\n"; + out << " Assertion\n"; + out << " \n"; + out << " " << sanitize(test.file) << "\n"; + out << " " << test.line << "\n"; + out << " \n"; + out << " " << sanitize(test.msg) << "\n"; + out << " \n"; + } + out << " \n"; + out << " \n"; + for(auto test : successful_tests) + { + out << " \n"; + out << " " << sanitize(test.func) << "\n"; + out << " \n"; + + } + out << " \n"; + out << " \n"; + out << " " << (successful_tests.size() + failed_tests.size()) << "\n"; + out << " " << failed_tests.size() << "\n"; + out << " 0\n"; + out << " " << failed_tests.size() << "\n"; + out << " \n"; + out << "\n"; + + return failed == 0 ? 0 : 1; + } + +protected: + template + void registerTest(O* obj, const F& fn, const char* name) + { + tests.emplace_back(std::make_pair(std::bind(fn, obj), name)); + } + #define DGUNIT_TEST(func) \ + registerTest(this, &func, #func) + + void dg_assert(bool value, const char* expr, + const char* file, std::size_t line) + { + if(!value) + { + std::stringstream ss; + ss << "assertion failed\n" + "- Expression: " << expr << "\n"; + throw test_result{"", file, line, ss.str()}; + } + } + //! Convenience macro to pass along filename and linenumber + #define DGUNIT_ASSERT(value) \ + dg_assert(value, #value, __FILE__, __LINE__) + + void assert_equal(double expected, double value, + const char* file, std::size_t line) + { + if(std::fabs(expected - value) > 0.0000001) + { + std::stringstream ss; + ss << "equality assertion failed\n" + "- Expected: " << expected << "\n" + "- Actual : " << value << "\n"; + throw test_result{"", file, line, ss.str()}; + } + } + template + void assert_equal(T expected, T value, + const char* file, std::size_t line) + { + if(expected != value) + { + std::stringstream ss; + ss << "equality assertion failed\n" + "- Expected: " << expected << "\n" + "- Actual : " << value << "\n"; + throw test_result{"", file, line, ss.str()}; + } + } + //! Convenience macro to pass along filename and linenumber + #define DGUNIT_ASSERT_EQUAL(expected, value) \ + assert_equal(expected, value, __FILE__, __LINE__) + +private: + static std::string sanitize(const std::string& input) + { + std::string output; + for(auto c : input) + { + switch(c) + { + case '"': + output += """; + break; + case '&': + output += "&"; + break; + case '<': + output += "<"; + break; + case '>': + output += ">"; + break; + default: + output += c; + break; + } + } + return output; + } + + static DGUnit* suite_list; + DGUnit* next_unit{nullptr}; + std::vector, const char*>> tests; +}; + +#ifdef DGUNIT_MAIN +DGUnit* DGUnit::suite_list{nullptr}; +#endif -- cgit v1.2.3