Add unit-test framework.

6 files changed, 426 insertions, 27 deletions

diff --git a/test/Makefile.am b/test/Makefile.am
index 8cf4ce5..34b750d 100644
--- a/test/Makefile.am
+++ b/test/Makefile.am
@@ -1,13 +1,20 @@
 # Rules for the test code (use `make check` to execute)
-TESTS = proto
+if ENABLE_TESTS
+
+TESTS = logintest
+
+EXTRA_DIST = \
+	dgunit.h \
+	scopedfile.h
 
 check_PROGRAMS = $(TESTS)
 
-proto_CXXFLAGS = -DOUTPUT=\"proto\" $(CPPUNIT_CFLAGS) \
-	-I$(top_srcdir)/src -I$(top_srcdir)/hugin -DDISABLE_HUGIN
-proto_CFLAGS = -DDISABLE_HUGIN
-proto_LDFLAGS = $(CPPUNIT_LIBS)
-proto_SOURCES = \
-	$(top_srcdir)/hugin/hugin.c \
-	test.cc \
-	proto.cc
+logintest_CXXFLAGS = -DOUTPUT=\"logintest\" \
+	$(DEBUG_FLAGS) \
+	-I$(top_srcdir)/src
+logintest_LDFLAGS =
+logintest_SOURCES = \
+	logintest.cc \
+	dgtest.cc
+
+endif
diff --git a/test/dgtest.cc b/test/dgtest.cc
new file mode 100644
index 0000000..21e1543
--- /dev/null
+++ b/test/dgtest.cc
@@ -0,0 +1,37 @@
+/* -*- Mode: c++ -*- */
+/***************************************************************************
+ *            dgtest.cc
+ *
+ *  Sat Jun 16 15:48:36 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.
+ */
+#define DGUNIT_MAIN
+#include "dgunit.h"
+
+#include <fstream>
+
+int main(int argc, char* argv[])
+{
+	std::ofstream xmlfile;
+	xmlfile.open("result_" OUTPUT ".xml");
+	return DGUnit::runTests(xmlfile);
+}
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 <cstddef>
+#include <iostream>
+#include <list>
+#include <vector>
+#include <functional>
+#include <string>
+#include <sstream>
+#include <fstream>
+#include <cmath>
+
+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<test_result> failed_tests;
+		std::list<test_result> 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 << "<?xml version=\"1.0\" encoding='ISO-8859-1' standalone='yes' ?>\n";
+		out << "<TestRun>\n";
+		out << "	<FailedTests>\n";
+		for(auto test : failed_tests)
+		{
+			out << "		<FailedTest id=\"" << test.id << "\">\n";
+			out << "			<Name>" << sanitize(test.func) << "</Name>\n";
+			out << "			<FailureType>Assertion</FailureType>\n";
+			out << "			<Location>\n";
+			out << "				<File>" << sanitize(test.file) << "</File>\n";
+			out << "				<Line>" << test.line << "</Line>\n";
+			out << "			</Location>\n";
+			out << "			<Message>" << sanitize(test.msg) << "</Message>\n";
+			out << "		</FailedTest>\n";
+		}
+		out << "	</FailedTests>\n";
+		out << "	<SuccessfulTests>\n";
+		for(auto test : successful_tests)
+		{
+			out << "		<Test id=\"" << test.id << "\">\n";
+			out << "			<Name>" << sanitize(test.func) << "</Name>\n";
+			out << "		</Test>\n";
+
+		}
+		out << "	</SuccessfulTests>\n";
+		out << "	<Statistics>\n";
+		out << "		<Tests>" << (successful_tests.size() + failed_tests.size()) << "</Tests>\n";
+		out << "		<FailuresTotal>" << failed_tests.size() << "</FailuresTotal>\n";
+		out << "		<Errors>0</Errors>\n";
+		out << "		<Failures>" << failed_tests.size() << "</Failures>\n";
+		out << "	</Statistics>\n";
+		out << "</TestRun>\n";
+
+		return failed == 0 ? 0 : 1;
+	}
+
+protected:
+	template<typename O, typename F>
+	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<typename T>
+	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 += "&quot;";
+				break;
+			case '&':
+				output += "&amp;";
+				break;
+			case '<':
+				output += "&lt;";
+				break;
+			case '>':
+				output += "&gt;";
+				break;
+			default:
+				output += c;
+				break;
+			}
+		}
+		return output;
+	}
+
+	static DGUnit* suite_list;
+	DGUnit* next_unit{nullptr};
+	std::vector<std::pair<std::function<void()>, const char*>> tests;
+};
+
+#ifdef DGUNIT_MAIN
+DGUnit* DGUnit::suite_list{nullptr};
+#endif
diff --git a/test/proto.cc b/test/logintest.cc
index 0cc8da9..f4dc192 100644
--- a/test/proto.cc
+++ b/test/logintest.cc
@@ -1,44 +1,46 @@
 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set et sw=2 ts=2: */
 /***************************************************************************
- *            engine.cc
+ *            logintest.cc
  *
- *  Fri Nov 29 18:09:02 CET 2013
- *  Copyright 2013 Bent Bisballe Nyeng
+ *  Sat Jun  6 19:32:12 CEST 2020
+ *  Copyright 2020 Bent Bisballe Nyeng
  *  deva@aasimon.org
  ****************************************************************************/
 
 /*
- *  This file is part of DrumGizmo.
+ *  This file is part of Munia.
  *
- *  DrumGizmo is free software; you can redistribute it and/or modify
+ *  Munia is free software; you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
  *  the Free Software Foundation; either version 2 of the License, or
  *  (at your option) any later version.
  *
- *  DrumGizmo is distributed in the hope that it will be useful,
+ *  Munia 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 General Public License for more details.
  *
  *  You should have received a copy of the GNU General Public License
- *  along with DrumGizmo; if not, write to the Free Software
+ *  along with Munia; if not, write to the Free Software
  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
  */
-#include <cppunit/extensions/HelperMacros.h>
+#include "dgunit.h"
 
-class test_proto_class : public CppUnit::TestFixture
+class LoginTest
+	: public DGUnit
 {
-  CPPUNIT_TEST_SUITE(test_proto_class);
-	CPPUNIT_TEST(test_proto);
-	CPPUNIT_TEST_SUITE_END();
-
 public:
-	void setUp() {}
-	void tearDown() {}
-  void test_proto() {
+	LoginTest()
+	{
+		DGUNIT_TEST(LoginTest::test);
+	}
+
+	void test()
+	{
+		DGUNIT_ASSERT_EQUAL(42, 42);
 	}
 };
 
 // Registers the fixture into the 'registry'
-CPPUNIT_TEST_SUITE_REGISTRATION(test_proto_class);
-
+static LoginTest test;
diff --git a/test/scopedfile.cc b/test/scopedfile.cc
new file mode 100644
index 0000000..b03a2bc
--- /dev/null
+++ b/test/scopedfile.cc
@@ -0,0 +1,70 @@
+/* -*- Mode: c++ -*- */
+/***************************************************************************
+ *            scopedfile.cc
+ *
+ *  Wed Jun  6 15:15:31 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.
+ */
+#include "scopedfile.h"
+
+#include <cstdlib>
+#include <unistd.h>
+
+#include <cpp11fix.h>
+
+#ifdef _WIN32
+#define WIN32_LEAN_AND_MEAN
+#include <windows.h>
+#endif
+
+struct Pimpl
+{
+	std::string filename;
+	int fd;
+};
+
+ScopedFile::ScopedFile(const std::string& data)
+	: pimpl(std::make_unique<struct Pimpl>())
+{
+#ifndef _WIN32
+	char templ[] = "/tmp/dg-scoped-file-XXXXXX"; // buffer for filename
+	pimpl->fd = mkstemp(templ);
+#else
+	char templ[] = "dg-scoped-file-XXXXXX"; // buffer for filename
+	_mktemp_s(templ);
+	pimpl->fd = open(templ);
+#endif
+	pimpl->filename = templ;
+	auto sz = write(pimpl->fd, data.data(), data.size());
+	(void)sz;
+	close(pimpl->fd);
+}
+
+ScopedFile::~ScopedFile()
+{
+	unlink(pimpl->filename.data());
+}
+
+std::string ScopedFile::filename() const
+{
+	return pimpl->filename;
+}
diff --git a/test/scopedfile.h b/test/scopedfile.h
new file mode 100644
index 0000000..d66eac4
--- /dev/null
+++ b/test/scopedfile.h
@@ -0,0 +1,42 @@
+/* -*- Mode: c++ -*- */
+/***************************************************************************
+ *            scopedfile.h
+ *
+ *  Wed Jun  6 15:15:31 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 <string>
+#include <memory>
+
+class ScopedFile
+{
+public:
+	ScopedFile(const std::string& data);
+	~ScopedFile();
+
+	std::string filename() const;
+
+private:
+	std::unique_ptr<struct Pimpl> pimpl;
+};