aboutsummaryrefslogtreecommitdiff
path: root/src/unittest/test.h
blob: 8219e30fc0f2eb64c464d560abed1f4816116bf4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/*
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 (...) {                 \
		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 t_CONTENT_STONE;
extern content_t t_CONTENT_GRASS;
extern content_t t_CONTENT_TORCH;
extern content_t t_CONTENT_WATER;
extern content_t t_CONTENT_LAVA;
extern content_t t_CONTENT_BRICK;

void run_tests();

#endif