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