aboutsummaryrefslogtreecommitdiff
path: root/src/zencore/testing.cpp
blob: ef8fb0480cbeb528ccd19dc89aacbc600be31d32 (plain) (blame)
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
// Copyright Epic Games, Inc. All Rights Reserved.

#include "zencore/testing.h"
#include "zencore/logging.h"

#if ZEN_WITH_TESTS

#	include <chrono>
#	include <cstdlib>
#	include <cstdio>
#	include <string>
#	include <vector>

#	include <doctest/doctest.h>

namespace zen::testing {

using namespace std::literals;

struct TestListener : public doctest::IReporter
{
	const std::string_view ColorYellow = "\033[0;33m"sv;
	const std::string_view ColorNone   = "\033[0m"sv;

	// constructor has to accept the ContextOptions by ref as a single argument
	TestListener(const doctest::ContextOptions&) {}

	void report_query(const doctest::QueryData& /*in*/) override {}

	void test_run_start() override { RunStart = std::chrono::steady_clock::now(); }

	void test_run_end(const doctest::TestRunStats& in) override
	{
		auto   elapsed		  = std::chrono::steady_clock::now() - RunStart;
		double elapsedSeconds = std::chrono::duration_cast<std::chrono::milliseconds>(elapsed).count() / 1000.0;

		// Write machine-readable summary to file if requested (used by xmake test summary table)
		const char* summaryFile = std::getenv("ZEN_TEST_SUMMARY_FILE");
		if (summaryFile && summaryFile[0] != '\0')
		{
			if (FILE* f = std::fopen(summaryFile, "w"))
			{
				std::fprintf(f,
							 "cases_total=%u\ncases_passed=%u\nassertions_total=%d\nassertions_passed=%d\n"
							 "elapsed_seconds=%.3f\n",
							 in.numTestCasesPassingFilters,
							 in.numTestCasesPassingFilters - in.numTestCasesFailed,
							 in.numAsserts,
							 in.numAsserts - in.numAssertsFailed,
							 elapsedSeconds);
				for (const auto& failure : FailedTests)
				{
					std::fprintf(f, "failed=%s|%s|%u\n", failure.Name.c_str(), failure.File.c_str(), failure.Line);
				}
				std::fclose(f);
			}
		}
	}

	void test_case_start(const doctest::TestCaseData& in) override
	{
		Current = &in;
		ZEN_CONSOLE("{}======== TEST_CASE: {:<50} ========{}", ColorYellow, Current->m_name, ColorNone);
	}

	// called when a test case is reentered because of unfinished subcases
	void test_case_reenter(const doctest::TestCaseData& /*in*/) override
	{
		ZEN_CONSOLE("{}-------------------------------------------------------------------------------{}", ColorYellow, ColorNone);
	}

	void test_case_end(const doctest::CurrentTestCaseStats& in) override
	{
		if (!in.testCaseSuccess && Current)
		{
			FailedTests.push_back({Current->m_name, Current->m_file.c_str(), Current->m_line});
		}
		Current = nullptr;
	}

	void test_case_exception(const doctest::TestCaseException& /*in*/) override {}

	void subcase_start(const doctest::SubcaseSignature& in) override
	{
		ZEN_CONSOLE("{}-------- SUBCASE:   {:<50} --------{}",
					ColorYellow,
					fmt::format("{}/{}", Current->m_name, in.m_name.c_str()),
					ColorNone);
	}

	void subcase_end() override {}

	void log_assert(const doctest::AssertData& /*in*/) override {}

	void log_message(const doctest::MessageData& /*in*/) override {}

	void test_case_skipped(const doctest::TestCaseData& /*in*/) override {}

	const doctest::TestCaseData*		  Current  = nullptr;
	std::chrono::steady_clock::time_point RunStart = {};

	struct FailedTestInfo
	{
		std::string Name;
		std::string File;
		unsigned	Line;
	};
	std::vector<FailedTestInfo> FailedTests;
};

struct TestRunner::Impl
{
	Impl() { REGISTER_LISTENER("ZenTestListener", 1, TestListener); }
	doctest::Context Session;
};

TestRunner::TestRunner()
{
	m_Impl = std::make_unique<Impl>();
}

TestRunner::~TestRunner()
{
}

int
TestRunner::ApplyCommandLine(int argc, char const* const* argv)
{
	m_Impl->Session.applyCommandLine(argc, argv);

	for (int i = 1; i < argc; ++i)
	{
		if (argv[i] == "--debug"sv)
		{
			zen::logging::SetLogLevel(zen::logging::level::Debug);
		}
		else if (argv[i] == "--verbose"sv)
		{
			zen::logging::SetLogLevel(zen::logging::level::Trace);
		}
	}

	return 0;
}

int
TestRunner::Run()
{
	return m_Impl->Session.run();
}

}  // namespace zen::testing

#endif	// ZEN_WITH_TESTS