This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
SDL_test_assert.c
1
2
/*
Simple DirectMedia Layer
3
Copyright (C) 1997-2013 Sam Lantinga <slouken@libsdl.org>
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/
/*
24
Used by the test framework and test cases.
25
26
27
28
29
30
31
32
*/
#include "SDL_config.h"
#include "SDL_test.h"
/* Assert check message format */
33
const char *SDLTest_AssertCheckFormat = "Assert '%s': %s";
34
35
/* Assert summary message format */
36
const char *SDLTest_AssertSummaryFormat = "Assert Summary: Total=%d Passed=%d Failed=%d";
38
39
40
41
42
43
/*! \brief counts the failed asserts */
static Uint32 SDLTest_AssertsFailed = 0;
/*! \brief counts the passed asserts */
static Uint32 SDLTest_AssertsPassed = 0;
44
45
46
/*
* Assert that logs and break execution flow on failures (i.e. for harness errors).
*/
47
void SDLTest_Assert(int assertCondition, const char *assertDescription, ...)
50
51
52
53
54
55
56
57
58
59
char logMessage[SDLTEST_MAX_LOGMESSAGE_LENGTH];
/* Print assert description into a buffer */
SDL_memset(logMessage, 0, SDLTEST_MAX_LOGMESSAGE_LENGTH);
va_start(list, assertDescription);
SDL_vsnprintf(logMessage, SDLTEST_MAX_LOGMESSAGE_LENGTH - 1, assertDescription, list);
va_end(list);
/* Log, then assert and break on failure */
SDL_assert((SDLTest_AssertCheck(assertCondition, logMessage)));
60
61
62
63
64
}
/*
* Assert that logs but does not break execution flow on failures (i.e. for test cases).
*/
65
int SDLTest_AssertCheck(int assertCondition, const char *assertDescription, ...)
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
char logMessage[SDLTEST_MAX_LOGMESSAGE_LENGTH];
/* Print assert description into a buffer */
SDL_memset(logMessage, 0, SDLTEST_MAX_LOGMESSAGE_LENGTH);
va_start(list, assertDescription);
SDL_vsnprintf(logMessage, SDLTEST_MAX_LOGMESSAGE_LENGTH - 1, assertDescription, list);
va_end(list);
/* Log pass or fail message */
if (assertCondition == ASSERT_FAIL)
{
SDLTest_AssertsFailed++;
SDLTest_LogError(SDLTest_AssertCheckFormat, logMessage, "Failed");
}
else
{
SDLTest_AssertsPassed++;
SDLTest_Log(SDLTest_AssertCheckFormat, logMessage, "Passed");
}
return assertCondition;
91
92
93
/*
* Explicitly passing Assert that logs (i.e. for test cases).
*/
94
void SDLTest_AssertPass(const char *assertDescription, ...)
95
96
{
va_list list;
97
98
99
100
101
102
103
104
105
106
107
char logMessage[SDLTEST_MAX_LOGMESSAGE_LENGTH];
/* Print assert description into a buffer */
SDL_memset(logMessage, 0, SDLTEST_MAX_LOGMESSAGE_LENGTH);
va_start(list, assertDescription);
SDL_vsnprintf(logMessage, SDLTEST_MAX_LOGMESSAGE_LENGTH - 1, assertDescription, list);
va_end(list);
/* Log pass message */
SDLTest_AssertsPassed++;
SDLTest_Log(SDLTest_AssertCheckFormat, logMessage, "Pass");
110
111
112
113
114
/*
* Resets the assert summary counters to zero.
*/
void SDLTest_ResetAssertSummary()
{
115
116
SDLTest_AssertsPassed = 0;
SDLTest_AssertsFailed = 0;
117
118
119
}
/*
120
* Logs summary of all assertions (total, pass, fail) since last reset
121
122
123
124
* as INFO (failed==0) or ERROR (failed > 0).
*/
void SDLTest_LogAssertSummary()
{
125
126
127
128
129
130
131
132
133
Uint32 totalAsserts = SDLTest_AssertsPassed + SDLTest_AssertsFailed;
if (SDLTest_AssertsFailed == 0)
{
SDLTest_Log(SDLTest_AssertSummaryFormat, totalAsserts, SDLTest_AssertsPassed, SDLTest_AssertsFailed);
}
else
{
SDLTest_LogError(SDLTest_AssertSummaryFormat, totalAsserts, SDLTest_AssertsPassed, SDLTest_AssertsFailed);
}
135
136
137
138
139
140
/*
* Converts the current assert state into a test result
*/
int SDLTest_AssertSummaryToTestResult()
{
141
142
143
144
145
146
147
148
149
if (SDLTest_AssertsFailed > 0) {
return TEST_RESULT_FAILED;
} else {
if (SDLTest_AssertsPassed > 0) {
return TEST_RESULT_PASSED;
} else {
return TEST_RESULT_NO_ASSERT;
}
}