summaryrefslogtreecommitdiffstats
path: root/tools/unit-test/slang-unit-test.h
blob: 8f0f0a445c794006170f7c3b11771a308a97fe4c (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
#pragma once

#include "core/slang-render-api-util.h"
#include "slang.h"

enum class TestResult
{
    // NOTE! Must keep in order such that combine is meaningful. That is larger values are higher
    // precident - and a series of tests that has lots of passes and a fail, is still a fail
    // overall.
    Ignored,
    Pass,
    ExpectedFail,
    Fail,
};

enum class TestMessageType
{
    Info,        ///< General info (may not be shown depending on verbosity setting)
    TestFailure, ///< Describes how a test failure took place
    RunError,    ///< Describes an error that caused a test not to actually correctly run
};

class ITestReporter
{
public:
    virtual SLANG_NO_THROW void SLANG_MCALL startTest(const char* testName) = 0;
    virtual SLANG_NO_THROW void SLANG_MCALL addResult(TestResult result) = 0;
    virtual SLANG_NO_THROW void SLANG_MCALL
    addResultWithLocation(TestResult result, const char* testText, const char* file, int line) = 0;
    virtual SLANG_NO_THROW void SLANG_MCALL
    addResultWithLocation(bool testSucceeded, const char* testText, const char* file, int line) = 0;
    virtual SLANG_NO_THROW void SLANG_MCALL addExecutionTime(double time) = 0;
    virtual SLANG_NO_THROW void SLANG_MCALL message(TestMessageType type, const char* message) = 0;
    virtual SLANG_NO_THROW void SLANG_MCALL endTest() = 0;
};

ITestReporter* getTestReporter();

struct UnitTestContext
{
    slang::IGlobalSession* slangGlobalSession;
    const char* workDirectory;
    const char* executableDirectory;
    Slang::RenderApiFlags enabledApis;
};

typedef void (*UnitTestFunc)(UnitTestContext*);

class IUnitTestModule
{
public:
    virtual SLANG_NO_THROW SlangInt SLANG_MCALL getTestCount() = 0;
    virtual SLANG_NO_THROW const char* SLANG_MCALL getTestName(SlangInt index) = 0;
    virtual SLANG_NO_THROW UnitTestFunc SLANG_MCALL getTestFunc(SlangInt index) = 0;
    virtual SLANG_NO_THROW void SLANG_MCALL setTestReporter(ITestReporter* reporter) = 0;
    virtual SLANG_NO_THROW void SLANG_MCALL destroy() = 0;
};

class UnitTestRegisterHelper
{
public:
    UnitTestRegisterHelper(const char* name, UnitTestFunc testFunc);
};

class AbortTestException
{
};

typedef IUnitTestModule* (*UnitTestGetModuleFunc)();

#define SLANG_UNIT_TEST(name)                                    \
    void _##name##_impl(UnitTestContext* unitTestContext);       \
    void name(UnitTestContext* unitTestContext)                  \
    {                                                            \
        try                                                      \
        {                                                        \
            _##name##_impl(unitTestContext);                     \
        }                                                        \
        catch (AbortTestException&)                              \
        {                                                        \
        }                                                        \
    }                                                            \
    UnitTestRegisterHelper _##name##RegisterHelper(#name, name); \
    void _##name##_impl(UnitTestContext* unitTestContext)

#define SLANG_CHECK(x) getTestReporter()->addResultWithLocation((x), #x, __FILE__, __LINE__);
#define SLANG_CHECK_ABORT(x)                                                                   \
    {                                                                                          \
        bool _slang_check_result = (x);                                                        \
        getTestReporter()->addResultWithLocation(_slang_check_result, #x, __FILE__, __LINE__); \
        if (!_slang_check_result)                                                              \
            throw AbortTestException();                                                        \
    }
#define SLANG_IGNORE_TEST                              \
    getTestReporter()->addResult(TestResult::Ignored); \
    throw AbortTestException();
#define SLANG_CHECK_MSG(condition, message) \
    getTestReporter()                       \
        ->addResultWithLocation((condition), #condition " " message, __FILE__, __LINE__)