include/SDL_test_harness.h
author Philipp Wiesemann <philipp.wiesemann@arcor.de>
Sat, 06 Dec 2014 00:17:52 +0100
changeset 9267 6fe4583d7e1f
parent 8149 681eb46b8ac4
child 9619 b94b6d0bff0f
permissions -rw-r--r--
Fixed warnings about possible loss of data in conversion.
aschiffler@6717
     1
/*
aschiffler@6717
     2
  Simple DirectMedia Layer
slouken@8149
     3
  Copyright (C) 1997-2014 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
 *  \file SDL_test_harness.h
slouken@7191
    24
 *
aschiffler@6717
    25
 *  Include file for SDL test framework.
aschiffler@6717
    26
 *
aschiffler@6717
    27
 *  This code is a part of the SDL2_test library, not the main SDL library.
aschiffler@6717
    28
 */
aschiffler@6717
    29
aschiffler@6717
    30
/*
aschiffler@6717
    31
  Defines types for test case definitions and the test execution harness API.
slouken@7191
    32
aschiffler@6717
    33
  Based on original GSOC code by Markus Kauppila <markus.kauppila@gmail.com>
aschiffler@6717
    34
*/
aschiffler@6717
    35
aschiffler@6717
    36
#ifndef _SDL_test_harness_h
aschiffler@6717
    37
#define _SDL_test_harness_h
aschiffler@6717
    38
aschiffler@6717
    39
#include "begin_code.h"
aschiffler@6717
    40
/* Set up for C function definitions, even when using C++ */
aschiffler@6717
    41
#ifdef __cplusplus
aschiffler@6717
    42
extern "C" {
aschiffler@6717
    43
#endif
aschiffler@6717
    44
aschiffler@6717
    45
gabomdq@7678
    46
/* ! Definitions for test case structures */
aschiffler@6717
    47
#define TEST_ENABLED  1
aschiffler@6717
    48
#define TEST_DISABLED 0
aschiffler@6717
    49
gabomdq@7678
    50
/* ! Definition of all the possible test return values of the test case method */
slouken@7191
    51
#define TEST_ABORTED        -1
slouken@7191
    52
#define TEST_STARTED         0
slouken@7191
    53
#define TEST_COMPLETED       1
slouken@7191
    54
#define TEST_SKIPPED         2
aschiffler@6717
    55
gabomdq@7678
    56
/* ! Definition of all the possible test results for the harness */
slouken@7191
    57
#define TEST_RESULT_PASSED              0
slouken@7191
    58
#define TEST_RESULT_FAILED              1
slouken@7191
    59
#define TEST_RESULT_NO_ASSERT           2
slouken@7191
    60
#define TEST_RESULT_SKIPPED             3
slouken@7191
    61
#define TEST_RESULT_SETUP_FAILURE       4
aschiffler@6717
    62
gabomdq@7678
    63
/* !< Function pointer to a test case setup function (run before every test) */
aschiffler@6717
    64
typedef void (*SDLTest_TestCaseSetUpFp)(void *arg);
aschiffler@6717
    65
gabomdq@7678
    66
/* !< Function pointer to a test case function */
aschiffler@7189
    67
typedef int (*SDLTest_TestCaseFp)(void *arg);
aschiffler@6717
    68
gabomdq@7678
    69
/* !< Function pointer to a test case teardown function (run after every test) */
aschiffler@6717
    70
typedef void  (*SDLTest_TestCaseTearDownFp)(void *arg);
aschiffler@6717
    71
aschiffler@6717
    72
/**
aschiffler@6717
    73
 * Holds information about a single test case.
aschiffler@6717
    74
 */
aschiffler@6717
    75
typedef struct SDLTest_TestCaseReference {
gabomdq@7678
    76
    /* !< Func2Stress */
slouken@7191
    77
    SDLTest_TestCaseFp testCase;
gabomdq@7678
    78
    /* !< Short name (or function name) "Func2Stress" */
slouken@7191
    79
    char *name;
gabomdq@7678
    80
    /* !< Long name or full description "This test pushes func2() to the limit." */
slouken@7191
    81
    char *description;
gabomdq@7678
    82
    /* !< Set to TEST_ENABLED or TEST_DISABLED (test won't be run) */
slouken@7191
    83
    int enabled;
aschiffler@6717
    84
} SDLTest_TestCaseReference;
aschiffler@6717
    85
aschiffler@6717
    86
/**
aschiffler@6717
    87
 * Holds information about a test suite (multiple test cases).
aschiffler@6717
    88
 */
aschiffler@6721
    89
typedef struct SDLTest_TestSuiteReference {
gabomdq@7678
    90
    /* !< "PlatformSuite" */
slouken@7191
    91
    char *name;
gabomdq@7678
    92
    /* !< The function that is run before each test. NULL skips. */
slouken@7191
    93
    SDLTest_TestCaseSetUpFp testSetUp;
gabomdq@7678
    94
    /* !< The test cases that are run as part of the suite. Last item should be NULL. */
slouken@7191
    95
    const SDLTest_TestCaseReference **testCases;
gabomdq@7678
    96
    /* !< The function that is run after each test. NULL skips. */
slouken@7191
    97
    SDLTest_TestCaseTearDownFp testTearDown;
aschiffler@6721
    98
} SDLTest_TestSuiteReference;
aschiffler@6717
    99
aschiffler@6756
   100
aschiffler@6756
   101
/**
aschiffler@6756
   102
 * \brief Execute a test suite using the given run seed and execution key.
aschiffler@6756
   103
 *
aschiffler@6756
   104
 * \param testSuites Suites containing the test case.
aschiffler@6756
   105
 * \param userRunSeed Custom run seed provided by user, or NULL to autogenerate one.
aschiffler@6756
   106
 * \param userExecKey Custom execution key provided by user, or 0 to autogenerate one.
aschiffler@6763
   107
 * \param filter Filter specification. NULL disables. Case sensitive.
aschiffler@6756
   108
 * \param testIterations Number of iterations to run each test case.
aschiffler@6756
   109
 *
aschiffler@6756
   110
 * \returns Test run result; 0 when all tests passed, 1 if any tests failed.
aschiffler@6756
   111
 */
slouken@6768
   112
int SDLTest_RunSuites(SDLTest_TestSuiteReference *testSuites[], const char *userRunSeed, Uint64 userExecKey, const char *filter, int testIterations);
slouken@7191
   113
aschiffler@6756
   114
aschiffler@6717
   115
/* Ends C function definitions when using C++ */
aschiffler@6717
   116
#ifdef __cplusplus
aschiffler@6717
   117
}
aschiffler@6717
   118
#endif
aschiffler@6717
   119
#include "close_code.h"
aschiffler@6717
   120
aschiffler@6717
   121
#endif /* _SDL_test_harness_h */
aschiffler@6717
   122
aschiffler@6717
   123
/* vi: set ts=4 sw=4 expandtab: */