diff options
| author | 3gg <3gg@shellblade.net> | 2024-05-04 16:51:29 -0700 |
|---|---|---|
| committer | 3gg <3gg@shellblade.net> | 2024-05-04 16:51:29 -0700 |
| commit | 8222bfe56d4dabe8d92fc4b25ea1b0163b16f3e1 (patch) | |
| tree | 763389e42276035ac134d94eb1dc32293b88d807 /src/contrib/SDL-2.30.2/include/SDL_test_harness.h | |
Initial commit.
Diffstat (limited to 'src/contrib/SDL-2.30.2/include/SDL_test_harness.h')
| -rw-r--r-- | src/contrib/SDL-2.30.2/include/SDL_test_harness.h | 134 |
1 files changed, 134 insertions, 0 deletions
diff --git a/src/contrib/SDL-2.30.2/include/SDL_test_harness.h b/src/contrib/SDL-2.30.2/include/SDL_test_harness.h new file mode 100644 index 0000000..bd9e4f8 --- /dev/null +++ b/src/contrib/SDL-2.30.2/include/SDL_test_harness.h | |||
| @@ -0,0 +1,134 @@ | |||
| 1 | /* | ||
| 2 | Simple DirectMedia Layer | ||
| 3 | Copyright (C) 1997-2024 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 | * \file SDL_test_harness.h | ||
| 24 | * | ||
| 25 | * Include file for SDL test framework. | ||
| 26 | * | ||
| 27 | * This code is a part of the SDL2_test library, not the main SDL library. | ||
| 28 | */ | ||
| 29 | |||
| 30 | /* | ||
| 31 | Defines types for test case definitions and the test execution harness API. | ||
| 32 | |||
| 33 | Based on original GSOC code by Markus Kauppila <markus.kauppila@gmail.com> | ||
| 34 | */ | ||
| 35 | |||
| 36 | #ifndef SDL_test_h_arness_h | ||
| 37 | #define SDL_test_h_arness_h | ||
| 38 | |||
| 39 | #include "begin_code.h" | ||
| 40 | /* Set up for C function definitions, even when using C++ */ | ||
| 41 | #ifdef __cplusplus | ||
| 42 | extern "C" { | ||
| 43 | #endif | ||
| 44 | |||
| 45 | |||
| 46 | /* ! Definitions for test case structures */ | ||
| 47 | #define TEST_ENABLED 1 | ||
| 48 | #define TEST_DISABLED 0 | ||
| 49 | |||
| 50 | /* ! Definition of all the possible test return values of the test case method */ | ||
| 51 | #define TEST_ABORTED -1 | ||
| 52 | #define TEST_STARTED 0 | ||
| 53 | #define TEST_COMPLETED 1 | ||
| 54 | #define TEST_SKIPPED 2 | ||
| 55 | |||
| 56 | /* ! Definition of all the possible test results for the harness */ | ||
| 57 | #define TEST_RESULT_PASSED 0 | ||
| 58 | #define TEST_RESULT_FAILED 1 | ||
| 59 | #define TEST_RESULT_NO_ASSERT 2 | ||
| 60 | #define TEST_RESULT_SKIPPED 3 | ||
| 61 | #define TEST_RESULT_SETUP_FAILURE 4 | ||
| 62 | |||
| 63 | /* !< Function pointer to a test case setup function (run before every test) */ | ||
| 64 | typedef void (*SDLTest_TestCaseSetUpFp)(void *arg); | ||
| 65 | |||
| 66 | /* !< Function pointer to a test case function */ | ||
| 67 | typedef int (*SDLTest_TestCaseFp)(void *arg); | ||
| 68 | |||
| 69 | /* !< Function pointer to a test case teardown function (run after every test) */ | ||
| 70 | typedef void (*SDLTest_TestCaseTearDownFp)(void *arg); | ||
| 71 | |||
| 72 | /** | ||
| 73 | * Holds information about a single test case. | ||
| 74 | */ | ||
| 75 | typedef struct SDLTest_TestCaseReference { | ||
| 76 | /* !< Func2Stress */ | ||
| 77 | SDLTest_TestCaseFp testCase; | ||
| 78 | /* !< Short name (or function name) "Func2Stress" */ | ||
| 79 | const char *name; | ||
| 80 | /* !< Long name or full description "This test pushes func2() to the limit." */ | ||
| 81 | const char *description; | ||
| 82 | /* !< Set to TEST_ENABLED or TEST_DISABLED (test won't be run) */ | ||
| 83 | int enabled; | ||
| 84 | } SDLTest_TestCaseReference; | ||
| 85 | |||
| 86 | /** | ||
| 87 | * Holds information about a test suite (multiple test cases). | ||
| 88 | */ | ||
| 89 | typedef struct SDLTest_TestSuiteReference { | ||
| 90 | /* !< "PlatformSuite" */ | ||
| 91 | const char *name; | ||
| 92 | /* !< The function that is run before each test. NULL skips. */ | ||
| 93 | SDLTest_TestCaseSetUpFp testSetUp; | ||
| 94 | /* !< The test cases that are run as part of the suite. Last item should be NULL. */ | ||
| 95 | const SDLTest_TestCaseReference **testCases; | ||
| 96 | /* !< The function that is run after each test. NULL skips. */ | ||
| 97 | SDLTest_TestCaseTearDownFp testTearDown; | ||
| 98 | } SDLTest_TestSuiteReference; | ||
| 99 | |||
| 100 | |||
| 101 | /** | ||
| 102 | * \brief Generates a random run seed string for the harness. The generated seed will contain alphanumeric characters (0-9A-Z). | ||
| 103 | * | ||
| 104 | * Note: The returned string needs to be deallocated by the caller. | ||
| 105 | * | ||
| 106 | * \param length The length of the seed string to generate | ||
| 107 | * | ||
| 108 | * \returns the generated seed string | ||
| 109 | */ | ||
| 110 | char *SDLTest_GenerateRunSeed(const int length); | ||
| 111 | |||
| 112 | /** | ||
| 113 | * \brief Execute a test suite using the given run seed and execution key. | ||
| 114 | * | ||
| 115 | * \param testSuites Suites containing the test case. | ||
| 116 | * \param userRunSeed Custom run seed provided by user, or NULL to autogenerate one. | ||
| 117 | * \param userExecKey Custom execution key provided by user, or 0 to autogenerate one. | ||
| 118 | * \param filter Filter specification. NULL disables. Case sensitive. | ||
| 119 | * \param testIterations Number of iterations to run each test case. | ||
| 120 | * | ||
| 121 | * \returns the test run result: 0 when all tests passed, 1 if any tests failed. | ||
| 122 | */ | ||
| 123 | int SDLTest_RunSuites(SDLTest_TestSuiteReference *testSuites[], const char *userRunSeed, Uint64 userExecKey, const char *filter, int testIterations); | ||
| 124 | |||
| 125 | |||
| 126 | /* Ends C function definitions when using C++ */ | ||
| 127 | #ifdef __cplusplus | ||
| 128 | } | ||
| 129 | #endif | ||
| 130 | #include "close_code.h" | ||
| 131 | |||
| 132 | #endif /* SDL_test_h_arness_h */ | ||
| 133 | |||
| 134 | /* vi: set ts=4 sw=4 expandtab: */ | ||
