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