Tests: Modularize unit testing

Split unit tests into separate files under src/unittest/ Give better unittest diagnostics Clean up some code
2025-07-02 16:38:41 +00:00 · 2015-04-26 01:24:19 -04:00 · 2015-04-26 01:24:19 -04:00 · 7220ca906d
commit 7220ca906d
parent 45a77c8bf1
25 changed files with 3402 additions and 2502 deletions
--- a/src/unittest/test.h
+++ b/src/unittest/test.h
@ -0,0 +1,133 @@
+/*
+Minetest
+Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
+
+This program 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.
+
+This program 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 this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+*/
+
+#ifndef TEST_HEADER
+#define TEST_HEADER
+
+#include <exception>
+#include <vector>
+
+#include "irrlichttypes_extrabloated.h"
+#include "porting.h"
+#include "filesys.h"
+#include "mapnode.h"
+
+class TestFailedException : public std::exception {
+};
+
+// Runs a unit test and reports results
+#define TEST(fxn, ...) do {         \
+	u32 t1 = porting::getTime(PRECISION_MILLI); \
+	try {                           \
+		fxn(__VA_ARGS__);           \
+		dstream << "[PASS] ";       \
+	} catch (TestFailedException) { \
+		dstream << "[FAIL] ";       \
+		num_tests_failed++;         \
+	}                               \
+	num_tests_run++;                \
+	u32 tdiff = porting::getTime(PRECISION_MILLI) - t1;     \
+	dstream << #fxn << " - " << tdiff << "ms" << std::endl; \
+} while (0)
+
+// Asserts the specified condition is true, or fails the current unit test
+#define UASSERT(x) do {                                       \
+	if (!(x)) {                                               \
+		dstream << "Test assertion failed: " #x << std::endl  \
+			<< "    at " << fs::GetFilenameFromPath(__FILE__) \
+			<< ":" << __LINE__ << std::endl;                  \
+		throw TestFailedException();                          \
+	}                                                         \
+} while (0)
+
+// Asserts the specified condition is true, or fails the current unit test
+// and prints the format specifier fmt
+#define UTEST(x, fmt, ...) do {                                        \
+	if (!(x)) {                                                        \
+		char utest_buf[1024];                                          \
+		snprintf(utest_buf, sizeof(utest_buf), fmt, __VA_ARGS__);      \
+		dstream << "Test assertion failed: " << utest_buf << std::endl \
+			<< "    at " << fs::GetFilenameFromPath(__FILE__)          \
+			<< ":" << __LINE__ << std::endl;                           \
+		throw TestFailedException();                                   \
+	}                                                                  \
+} while (0)
+
+// Asserts the comparison specified by CMP is true, or fails the current unit test
+#define UASSERTCMP(T, CMP, actual, expected) do {                             \
+	T a = (actual);                                                           \
+	T e = (expected);                                                         \
+	if (!(a CMP e)) {                                                         \
+		dstream << "Test assertion failed: " << #actual << " " << #CMP << " " \
+			<< #expected << std::endl                                         \
+			<< "    at " << fs::GetFilenameFromPath(__FILE__) << ":"          \
+			<< __LINE__ << std::endl                                          \
+			<< "    actual:   " << a << std::endl << "    expected: "         \
+			<< e << std::endl;                                                \
+		throw TestFailedException();                                          \
+	}                                                                         \
+} while (0)
+
+#define UASSERTEQ(T, actual, expected) UASSERTCMP(T, ==, actual, expected)
+
+// UASSERTs that the specified exception occurs
+#define EXCEPTION_CHECK(EType, code) do { \
+	bool exception_thrown = false;        \
+	try {                                 \
+		code;                             \
+	} catch (EType &e) {                  \
+		exception_thrown = true;          \
+	}                                     \
+	UASSERT(exception_thrown);            \
+} while (0)
+
+class IGameDef;
+
+class TestBase {
+public:
+	bool testModule(IGameDef *gamedef);
+	virtual void runTests(IGameDef *gamedef) = 0;
+	virtual const char *getName() = 0;
+
+	u32 num_tests_failed;
+	u32 num_tests_run;
+};
+
+class TestManager {
+public:
+	static std::vector<TestBase *> &getTestModules()
+	{
+		static std::vector<TestBase *> m_modules_to_test;
+		return m_modules_to_test;
+	}
+
+	static void registerTestModule(TestBase *module)
+	{
+		getTestModules().push_back(module);
+	}
+};
+
+// A few item and node definitions for those tests that need them
+extern content_t CONTENT_STONE;
+extern content_t CONTENT_GRASS;
+extern content_t CONTENT_TORCH;
+
+void run_tests();
+
+#endif