TestDB.h

Go to the documentation of this file.

/*
 *  CUnit - A Unit testing framework library for C.
 *  Copyright (C) 2001       Anil Kumar
 *  Copyright (C) 2004-2006  Anil Kumar, Jerry St.Clair
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Library General Public
 *  License as published by the Free Software Foundation; either
 *  version 2 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Library General Public License for more details.
 *
 *  You should have received a copy of the GNU Library General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
 
/*
 *  Contains all the Type Definitions and functions declarations
 *  for the CUnit test database maintenance.
 *
 *  Aug 2001      Initial implementation. (AK)
 *
 *  09/Aug/2001   Added Preprocessor conditionals for the file. (AK)
 *
 *  24/aug/2001   Made the linked list from SLL to DLL(doubly linked list). (AK)
 *
 *  31-Aug-2004   Restructured to eliminate global variables error_number,
 *                g_pTestRegistry; new interface, support for deprecated
 *                version 1 interface, moved error handling code to
 *                CUError.[ch], moved test run counts and _TestResult out
 *                of TestRegistry to TestRun.h. (JDS)
 *
 *  01-Sep-2004   Added jmp_buf to CU_Test. (JDS)
 *
 *  05-Sep-2004   Added internal test interface. (JDS)
 *
 *  15-Apr-2006   Removed constraint that suites/tests be uniquely named.
 *                Added ability to turn individual tests/suites on or off.
 *                Moved doxygen comments for public API here to header. (JDS)
 *
 *  16-Avr-2007   Added setup and teardown functions. (CJN)
 *
 */
 
#ifndef CUNIT_TESTDB_H_SEEN
#define CUNIT_TESTDB_H_SEEN
 
#include <setjmp.h>   /* jmp_buf */
 
#include "CUnit/CUnit.h"
#include "CUnit/CUError.h"
#include "CUnit/Simple.h"
#include "CUnit/TestFixture.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*=================================================================
 *  Typedefs and Data Structures
 *=================================================================*/
 
/*-----------------------------------------------------------------
 * CU_Test, CU_pTest
 *-----------------------------------------------------------------*/
typedef struct CU_Test
{
  char*           pName;      
  CU_BOOL         fActive;    
  CU_TestFunc     pTestFunc;  
  jmp_buf*        pJumpBuf;   
  struct CU_Test* pNext;      
  struct CU_Test* pPrev;      
  CU_BOOL         fSkipped;   
  unsigned        uFailedRuns; 
  double          dStarted;   
  double          dEnded;     
  const char*     pSkipReason;
  const char*     pSkipFunction;
  const char*     pSkipFile;
  unsigned int    uiSkipLine;
 
  CU_BOOL         fSuiteSetup;   
  CU_BOOL         fSuiteCleanup; 
} CU_Test;
typedef CU_Test* CU_pTest;    
/*-----------------------------------------------------------------
 *  CU_Suite, CU_pSuite
 *-----------------------------------------------------------------*/
typedef struct CU_Suite
{
  char*             pName;            
  CU_BOOL           fActive;          
  CU_pTest          pTest;            
  CU_InitializeFunc pInitializeFunc;  
  CU_CleanupFunc    pCleanupFunc;     
  CU_SetUpFunc      pSetUpFunc;       
  CU_TearDownFunc   pTearDownFunc;    
  CU_pTest          pInitializeFuncTest;  
  CU_pTest          pCleanupFuncTest;  
  unsigned int      uiNumberOfTests;  
  struct CU_Suite*  pNext;            
  struct CU_Suite*  pPrev;            
  unsigned int      uiNumberOfTestsFailed;  
  unsigned int      uiNumberOfTestsSuccess; 
  CU_BOOL           fSetUpError;     
  CU_BOOL           fCleanupError;   
  CU_BOOL           fInSetUp;          
  CU_BOOL           fInClean;          
  CU_BOOL           fSkipped;        
  CU_BOOL           fInTestSetup;    
  CU_BOOL           fInTestClean;    
  const char*       pSkipReason;
  const char*       pSkipFunction;
  const char*       pSkipFile;
  unsigned int      uiSkipLine;
 
  double            dStarted;   
  double            dEnded;     
} CU_Suite;
typedef CU_Suite* CU_pSuite;          
/*-----------------------------------------------------------------
 *  CU_TestRegistry, CU_pTestRegistry
 *-----------------------------------------------------------------*/
typedef struct CU_TestRegistry
{
#ifdef USE_DEPRECATED_CUNIT_NAMES
  union {
    unsigned int uiNumberOfSuites;  
    unsigned int uiNumberOfGroups;  
  };
  unsigned int uiNumberOfTests;     
  union {
    CU_pSuite    pSuite;            
    CU_pSuite    pGroup;            
  };
#else
  unsigned int uiNumberOfSuites;    
  unsigned int uiNumberOfTests;     
  CU_pSuite    pSuite;              
#endif
} CU_TestRegistry;
typedef CU_TestRegistry* CU_pTestRegistry;  
/*=================================================================
 *  Public interface functions
 *=================================================================*/
 
CU_EXPORT
CU_ErrorCode CU_initialize_registry(void);
CU_EXPORT
void CU_sort_suites(CU_pTestRegistry pRegistry);
 
CU_EXPORT
void CU_cleanup_registry(void);
CU_EXPORT CU_BOOL CU_registry_initialized(void);
CU_EXPORT
CU_pSuite CU_add_suite(const char *strName,
                       CU_InitializeFunc pInit,
                       CU_CleanupFunc pClean);
CU_EXPORT
CU_pSuite CU_add_suite_with_setup_and_teardown(const char *strName,
                       CU_InitializeFunc pInit,
                       CU_CleanupFunc pClean,
                       CU_SetUpFunc pSetup,
                       CU_TearDownFunc pTear);
CU_EXPORT
CU_ErrorCode CU_set_suite_active(CU_pSuite pSuite, CU_BOOL fNewActive);
CU_EXPORT
CU_ErrorCode CU_set_suite_name(CU_pSuite pSuite, const char *strNewName);
CU_EXPORT
CU_ErrorCode CU_set_suite_initfunc(CU_pSuite pSuite, CU_InitializeFunc pNewInit);
CU_EXPORT
CU_ErrorCode CU_set_suite_cleanupfunc(CU_pSuite pSuite, CU_CleanupFunc pNewClean);
CU_EXPORT
CU_pSuite CU_get_suite(const char* strName);
CU_EXPORT
CU_pSuite CU_get_suite_at_pos(unsigned int pos);
CU_EXPORT
unsigned int CU_get_suite_pos(CU_pSuite pSuite);
CU_EXPORT
unsigned int CU_get_suite_pos_by_name(const char* strName);
CU_EXPORT
CU_pTest CU_add_test(CU_pSuite pSuite, const char* strName, CU_TestFunc pTestFunc);
CU_EXPORT
CU_ErrorCode CU_set_test_active(CU_pTest pTest, CU_BOOL fNewActive);
CU_EXPORT
CU_ErrorCode CU_set_test_name(CU_pTest pTest, const char *strNewName);
CU_EXPORT
CU_ErrorCode CU_set_test_func(CU_pTest pTest, CU_TestFunc pNewFunc);
CU_EXPORT
CU_pTest CU_get_test(CU_pSuite pSuite, const char *strName);
CU_EXPORT
CU_pTest CU_get_test_at_pos(CU_pSuite pSuite, unsigned int pos);
CU_EXPORT
unsigned int CU_get_test_pos(CU_pSuite pSuite, CU_pTest pTest);
CU_EXPORT
unsigned int CU_get_test_pos_by_name(CU_pSuite pSuite, const char *strName);
#define CU_ADD_TEST(suite, test) (CU_add_test(suite, #test, (CU_TestFunc)test))
CU_EXPORT
CU_ErrorCode CU_set_all_active(CU_BOOL fNewActive);
/*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*/
/*  This section is based conceptually on code
 *  Copyright (C) 2004  Aurema Pty Ltd.
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Library General Public
 *  License as published by the Free Software Foundation; either
 *  version 2 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Library General Public License for more details.
 *
 *  You should have received a copy of the GNU Library General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Derived from code contributed by K. Cheung and Aurema Pty Ltd. (thanks!)
 *    test_case_t, test_group_t, test_suite_t
 */
 
typedef struct CU_TestInfo {
        const char  *pName;      
        CU_TestFunc pTestFunc;  
} CU_TestInfo;
typedef CU_TestInfo* CU_pTestInfo;  
typedef struct CU_SuiteInfo {
    const char       *pName;         
    CU_InitializeFunc pInitFunc;     
    CU_CleanupFunc    pCleanupFunc;  
    CU_SetUpFunc      pSetUpFunc;    
    CU_TearDownFunc   pTearDownFunc; 
    CU_TestInfo      *pTests;        
} CU_SuiteInfo;
typedef CU_SuiteInfo* CU_pSuiteInfo;  
#define CU_TEST_INFO_NULL { NULL, NULL }
#define CU_SUITE_INFO_NULL { NULL, NULL, NULL, NULL, NULL, NULL }
CU_EXPORT CU_ErrorCode CU_register_suites(CU_SuiteInfo suite_info[]);
CU_EXPORT CU_ErrorCode CU_register_nsuites(int suite_count, ...);
#ifdef USE_DEPRECATED_CUNIT_NAMES
typedef CU_TestInfo test_case_t;    
typedef CU_SuiteInfo test_group_t;  
typedef struct test_suite {
        char *name;            
        test_group_t *groups;  
} test_suite_t;
 
#define TEST_CASE_NULL { NULL, NULL }
#define TEST_GROUP_NULL { NULL, NULL, NULL, NULL }
 
#define test_group_register(tg) CU_register_suites(tg)
 
CU_EXPORT int test_suite_register(test_suite_t *ts)
{
        test_group_t *tg;
        int error;
 
        for (tg = ts->groups; tg->pName; tg++)
                if ((error = CU_register_suites(tg)) != CUE_SUCCESS)
                        return error;
 
        return CUE_SUCCESS;
}
#endif    /* USE_DEPRECATED_CUNIT_NAMES */
/*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*/
 
#ifdef USE_DEPRECATED_CUNIT_NAMES
typedef CU_InitializeFunc InitializeFunc; 
typedef CU_CleanupFunc CleanupFunc;       
typedef CU_TestFunc TestFunc;             
typedef CU_Test _TestCase;                
typedef CU_pTest PTestCase;               
typedef CU_Suite  _TestGroup;             
typedef CU_pSuite PTestGroup;             
typedef CU_TestRegistry  _TestRegistry;   
typedef CU_pTestRegistry PTestRegistry;   
/* Public interface functions */
#define initialize_registry() CU_initialize_registry()
#define cleanup_registry() CU_cleanup_registry()
#define add_test_group(name, init, clean) CU_add_suite(name, init, clean)
#define add_test_case(group, name, test) CU_add_test(group, name, test)
 
/* private internal CUnit testing functions */
#define get_registry() CU_get_registry()
#define set_registry(reg) CU_set_registry((reg))
 
#define get_group_by_name(group, reg) CU_get_suite_by_name(group, reg)
#define get_test_by_name(test, group) CU_get_test_by_name(test, group)
 
#define ADD_TEST_TO_GROUP(group, test) (CU_add_test(group, #test, (CU_TestFunc)test))
#endif  /* USE_DEPRECATED_CUNIT_NAMES */
 
/*=================================================================
 *  Internal CUnit system functions.
 *  Should not be routinely called by users.
 *=================================================================*/
 
CU_EXPORT CU_pTestRegistry CU_get_registry(void);
CU_EXPORT CU_pTestRegistry CU_set_registry(CU_pTestRegistry pTestRegistry);
CU_EXPORT CU_pTestRegistry CU_create_new_registry(void);
CU_EXPORT
void CU_destroy_existing_registry(CU_pTestRegistry* ppRegistry);
CU_EXPORT
CU_pSuite CU_get_suite_by_name(const char *szSuiteName, CU_pTestRegistry pRegistry);
CU_EXPORT
CU_pSuite CU_get_suite_by_index(unsigned int index, CU_pTestRegistry pRegistry);
CU_EXPORT
CU_pTest CU_get_test_by_name(const char* szTestName, CU_pSuite pSuite);
CU_EXPORT
CU_pTest CU_get_test_by_index(unsigned int index, CU_pSuite pSuite);
#ifdef CUNIT_BUILD_TESTS
void test_cunit_TestDB(void);
#endif
 
#ifdef __cplusplus
}
#endif
#endif  /*  CUNIT_TESTDB_H_SEEN  */