src/test/SDL_test_assert.c
author Andreas Schiffler <aschiffler@ferzkopp.net>
Sat, 01 Dec 2012 14:48:30 -0800
changeset 6718 918ba414168b
parent 6717 2acd95060548
child 6721 53b71f45a53a
permissions -rw-r--r--
Update assert API in test lib; add to and harness; add test lib to VS2010 and VS2012 solution; fix VS2012 solution; fix compiler warning
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
/*! \brief counts the failed asserts */
aschiffler@6718
    33
static Uint32 SDLTest_AssertsFailed = 0;
aschiffler@6717
    34
aschiffler@6717
    35
/*! \brief counts the passed asserts */
aschiffler@6718
    36
static Uint32 SDLTest_AssertsPassed = 0;
aschiffler@6717
    37
aschiffler@6717
    38
/* Assert check message format */
aschiffler@6717
    39
const char *SDLTest_AssertCheckFmt = "Assert %s: %s";
aschiffler@6717
    40
aschiffler@6717
    41
/* Assert summary message format */
aschiffler@6717
    42
const char *SDLTest_AssertSummaryFmt = "Assert Summary: Total=%d Passed=%d Failed=%d";
aschiffler@6717
    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@6717
    47
void SDLTest_Assert(int assertCondition, char *assertDescription)
aschiffler@6717
    48
{
aschiffler@6718
    49
	SDL_assert((SDLTest_AssertCheck(assertCondition, assertDescription)));
aschiffler@6717
    50
}
aschiffler@6717
    51
aschiffler@6717
    52
/*
aschiffler@6717
    53
 * Assert that logs but does not break execution flow on failures (i.e. for test cases).
aschiffler@6717
    54
 */
aschiffler@6718
    55
int SDLTest_AssertCheck(int assertCondition, char *assertDescription)
aschiffler@6717
    56
{
aschiffler@6717
    57
	char *fmt = (char *)SDLTest_AssertCheckFmt;
aschiffler@6718
    58
	if (assertCondition == ASSERT_FAIL)
aschiffler@6717
    59
	{
aschiffler@6718
    60
		SDLTest_AssertsFailed++;
aschiffler@6718
    61
		SDLTest_LogError(fmt, "Failed", assertDescription);
aschiffler@6717
    62
	} 
aschiffler@6717
    63
	else 
aschiffler@6717
    64
	{
aschiffler@6718
    65
		SDLTest_AssertsPassed++;
aschiffler@6718
    66
		SDLTest_Log(fmt, "Passed", assertDescription);
aschiffler@6717
    67
	}
aschiffler@6718
    68
aschiffler@6718
    69
	return assertCondition;
aschiffler@6717
    70
}
aschiffler@6717
    71
aschiffler@6717
    72
/*
aschiffler@6717
    73
 * Resets the assert summary counters to zero.
aschiffler@6717
    74
 */
aschiffler@6717
    75
void SDLTest_ResetAssertSummary()
aschiffler@6717
    76
{
aschiffler@6718
    77
	SDLTest_AssertsPassed = 0;
aschiffler@6718
    78
	SDLTest_AssertsFailed = 0;
aschiffler@6717
    79
}
aschiffler@6717
    80
aschiffler@6717
    81
/*
aschiffler@6717
    82
 * Logs summary of all assertions (total, pass, fail) since last reset 
aschiffler@6717
    83
 * as INFO (failed==0) or ERROR (failed > 0).
aschiffler@6717
    84
 */
aschiffler@6717
    85
void SDLTest_LogAssertSummary()
aschiffler@6717
    86
{
aschiffler@6717
    87
	char *fmt = (char *)SDLTest_AssertSummaryFmt;
aschiffler@6718
    88
	Uint32 totalAsserts = SDLTest_AssertsPassed + SDLTest_AssertsFailed;
aschiffler@6718
    89
	if (SDLTest_AssertsFailed == 0)
aschiffler@6717
    90
	{
aschiffler@6718
    91
		SDLTest_Log(fmt, totalAsserts, SDLTest_AssertsPassed, SDLTest_AssertsFailed);
aschiffler@6717
    92
	} 
aschiffler@6717
    93
	else 
aschiffler@6717
    94
	{
aschiffler@6718
    95
		SDLTest_LogError(fmt, totalAsserts, SDLTest_AssertsPassed, SDLTest_AssertsFailed);
aschiffler@6717
    96
	}
aschiffler@6717
    97
}