include/SDL_test_harness.h
author Andreas Schiffler <aschiffler@ferzkopp.net>
Sat, 18 May 2013 09:35:09 -0700
changeset 7189 414be1d64060
parent 6885 700f1b25f77f
child 7191 75360622e65f
permissions -rw-r--r--
Update test harness to handle test return codes; fix comment format in harness; update Main test suite to handle globally disabled features
aschiffler@6717
     1
/*
aschiffler@6717
     2
  Simple DirectMedia Layer
slouken@6885
     3
  Copyright (C) 1997-2013 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
aschiffler@6717
    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.
aschiffler@6717
    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
/* *INDENT-OFF* */
aschiffler@6717
    43
extern "C" {
aschiffler@6717
    44
/* *INDENT-ON* */
aschiffler@6717
    45
#endif
aschiffler@6717
    46
aschiffler@6717
    47
aschiffler@6717
    48
//! Definitions for test case structures
aschiffler@6717
    49
#define TEST_ENABLED  1
aschiffler@6717
    50
#define TEST_DISABLED 0
aschiffler@6717
    51
aschiffler@6717
    52
//! Definition of all the possible test return values of the test case method
aschiffler@6717
    53
#define TEST_ABORTED		-1
aschiffler@7189
    54
#define TEST_STARTED		 0
aschiffler@7189
    55
#define TEST_COMPLETED		 1
aschiffler@7189
    56
#define TEST_SKIPPED		 2
aschiffler@6717
    57
aschiffler@6717
    58
//! Definition of all the possible test results for the harness
aschiffler@6721
    59
#define TEST_RESULT_PASSED				0
aschiffler@6721
    60
#define TEST_RESULT_FAILED				1
aschiffler@6717
    61
#define TEST_RESULT_NO_ASSERT			2
aschiffler@6721
    62
#define TEST_RESULT_SKIPPED				3
aschiffler@6721
    63
#define TEST_RESULT_SETUP_FAILURE		4
aschiffler@6717
    64
aschiffler@6717
    65
//!< Function pointer to a test case setup function (run before every test)
aschiffler@6717
    66
typedef void (*SDLTest_TestCaseSetUpFp)(void *arg);
aschiffler@6717
    67
aschiffler@6717
    68
//!< Function pointer to a test case function
aschiffler@7189
    69
typedef int (*SDLTest_TestCaseFp)(void *arg);
aschiffler@6717
    70
aschiffler@6717
    71
//!< Function pointer to a test case teardown function (run after every test)
aschiffler@6717
    72
typedef void  (*SDLTest_TestCaseTearDownFp)(void *arg);
aschiffler@6717
    73
aschiffler@6717
    74
/**
aschiffler@6717
    75
 * Holds information about a single test case.
aschiffler@6717
    76
 */
aschiffler@6717
    77
typedef struct SDLTest_TestCaseReference {
aschiffler@6717
    78
	/*!< Func2Stress */
aschiffler@6717
    79
	SDLTest_TestCaseFp testCase;
aschiffler@6717
    80
	/*!< Short name (or function name) "Func2Stress" */
aschiffler@6717
    81
	char *name;
aschiffler@6717
    82
	/*!< Long name or full description "This test pushes func2() to the limit." */
aschiffler@6717
    83
	char *description;
aschiffler@6717
    84
	/*!< Set to TEST_ENABLED or TEST_DISABLED (test won't be run) */
aschiffler@6717
    85
	int enabled;
aschiffler@6717
    86
} SDLTest_TestCaseReference;
aschiffler@6717
    87
aschiffler@6717
    88
/**
aschiffler@6717
    89
 * Holds information about a test suite (multiple test cases).
aschiffler@6717
    90
 */
aschiffler@6721
    91
typedef struct SDLTest_TestSuiteReference {
aschiffler@6717
    92
	/*!< "PlatformSuite" */
aschiffler@6717
    93
	char *name;
aschiffler@6717
    94
	/*!< The function that is run before each test. NULL skips. */
aschiffler@6717
    95
	SDLTest_TestCaseSetUpFp testSetUp;
aschiffler@6717
    96
	/*!< The test cases that are run as part of the suite. Last item should be NULL. */
aschiffler@6717
    97
	const SDLTest_TestCaseReference **testCases;
aschiffler@6717
    98
	/*!< The function that is run after each test. NULL skips. */
aschiffler@6717
    99
	SDLTest_TestCaseTearDownFp testTearDown;
aschiffler@6721
   100
} SDLTest_TestSuiteReference;
aschiffler@6717
   101
aschiffler@6756
   102
aschiffler@6756
   103
/**
aschiffler@6756
   104
 * \brief Execute a test suite using the given run seed and execution key.
aschiffler@6756
   105
 *
aschiffler@6756
   106
 * \param testSuites Suites containing the test case.
aschiffler@6756
   107
 * \param userRunSeed Custom run seed provided by user, or NULL to autogenerate one.
aschiffler@6756
   108
 * \param userExecKey Custom execution key provided by user, or 0 to autogenerate one.
aschiffler@6763
   109
 * \param filter Filter specification. NULL disables. Case sensitive.
aschiffler@6756
   110
 * \param testIterations Number of iterations to run each test case.
aschiffler@6756
   111
 *
aschiffler@6756
   112
 * \returns Test run result; 0 when all tests passed, 1 if any tests failed.
aschiffler@6756
   113
 */
slouken@6768
   114
int SDLTest_RunSuites(SDLTest_TestSuiteReference *testSuites[], const char *userRunSeed, Uint64 userExecKey, const char *filter, int testIterations);
aschiffler@6756
   115
         
aschiffler@6756
   116
aschiffler@6717
   117
/* Ends C function definitions when using C++ */
aschiffler@6717
   118
#ifdef __cplusplus
aschiffler@6717
   119
/* *INDENT-OFF* */
aschiffler@6717
   120
}
aschiffler@6717
   121
/* *INDENT-ON* */
aschiffler@6717
   122
#endif
aschiffler@6717
   123
#include "close_code.h"
aschiffler@6717
   124
aschiffler@6717
   125
#endif /* _SDL_test_harness_h */
aschiffler@6717
   126
aschiffler@6717
   127
/* vi: set ts=4 sw=4 expandtab: */