TestRun.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 Interface to Run tests.
 *
 *  Aug 2001      Initial implementation. (AK)
 *
 *  09/Aug/2001   Contains generic run tests interface which can be used
 *                for any type of frontend interface framework. (AK)
 *
 *  24/Nov/2001   Added Handler for Group Initialization failure condition. (AK)
 *
 *  05-Aug-2004   New interface.  Since these should be internal functions,
 *                no support for deprecated version 1 names provided now,
 *                eliminated global variables for current test & suite,
 *                moved (renamed) _TestResult here from TestDB.h. (JDS)
 *
 *  05-Sep-2004   Added internal test interface. (JDS)
 *
 *  23-Apr-2006   Moved doxygen comments into header.
 *                Added type marker to CU_FailureRecord.
 *                Added support for tracking inactive suites/tests. (JDS)
 *
 *  08-May-2006   Moved CU_print_run_results() functionality from
 *                console/basic test complete handler.  (JDS)
 *
 *  24-May-2006   Added callbacks for suite start and complete events.
 *                Added tracking/reported of elapsed time.  (JDS)
 */
 
#ifndef CUNIT_TESTRUN_H_SEEN
#define CUNIT_TESTRUN_H_SEEN
 
#include "CUnit/CUnit.h"
#include "CUnit/CUError.h"
#include "CUnit/TestDB.h"
#include <stdio.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum CU_FailureTypes
{
  CUF_SuiteInactive = 1,    
  CUF_SuiteInitFailed,      
  CUF_SuiteCleanupFailed,   
  CUF_TestInactive,         
  CUF_AssertFailed          
} CU_FailureType;           
/* CU_FailureRecord type definition. */
typedef struct CU_FailureRecord
{
  CU_FailureType  type;           
  unsigned int    uiLineNumber;   
  char*           strFileName;    
  char*           strFunction;    
  char*           strCondition;   
  CU_pTest        pTest;          
  CU_pSuite       pSuite;         
  struct CU_FailureRecord* pNext; 
  struct CU_FailureRecord* pPrev; 
} CU_FailureRecord;
typedef CU_FailureRecord* CU_pFailureRecord;  
/* CU_RunSummary type definition. */
typedef struct CU_RunSummary
{
  char PackageName[50];
  unsigned int nSuitesRun;        
  unsigned int nSuitesFailed;     
  unsigned int nSuitesInactive;   
  unsigned int nTestsRun;         
  unsigned int nTestsFailed;      
  unsigned int nTestsInactive;    
  unsigned int nAsserts;          
  unsigned int nAssertsFailed;    
  unsigned int nFailureRecords;   
  double       ElapsedTime;       
  unsigned int nTestsSkipped;     
  unsigned int nSuitesSkipped;    
} CU_RunSummary;
typedef CU_RunSummary* CU_pRunSummary;  
/*--------------------------------------------------------------------
 * Type Definitions for Message Handlers.
 *--------------------------------------------------------------------*/
typedef void (*CU_SuiteStartMessageHandler)(const CU_pSuite pSuite);
typedef void (*CU_TestStartMessageHandler)(const CU_pTest pTest, const CU_pSuite pSuite);
typedef void (*CU_TestCompleteMessageHandler)(const CU_pTest pTest, const CU_pSuite pSuite,
                                              const CU_pFailureRecord pFailure);
typedef void (*CU_TestSkippedMessageHandler)(const CU_pTest pTest, const CU_pSuite pSuite);
typedef void (*CU_SuiteCompleteMessageHandler)(const CU_pSuite pSuite,
                                               const CU_pFailureRecord pFailure);
typedef void (*CU_AllTestsCompleteMessageHandler)(const CU_pFailureRecord pFailure);
typedef void (*CU_SuiteInitFailureMessageHandler)(const CU_pSuite pSuite);
typedef void (*CU_SuiteCleanupFailureMessageHandler)(const CU_pSuite pSuite);
typedef void (*CU_SuiteSkippedMessageHandler)(const CU_pSuite pSuite);
/*--------------------------------------------------------------------
 * Get/Set functions for Message Handlers
 *--------------------------------------------------------------------*/
CU_EXPORT void CU_set_suite_start_handler(CU_SuiteStartMessageHandler pSuiteStartMessage);
CU_EXPORT void CU_set_test_start_handler(CU_TestStartMessageHandler pTestStartMessage);
CU_EXPORT void CU_set_test_complete_handler(CU_TestCompleteMessageHandler pTestCompleteMessage);
CU_EXPORT void CU_set_test_skipped_handler(CU_TestSkippedMessageHandler pTestSkippedMessage);
CU_EXPORT void CU_set_suite_complete_handler(CU_SuiteCompleteMessageHandler pSuiteCompleteMessage);
CU_EXPORT void CU_set_all_test_complete_handler(CU_AllTestsCompleteMessageHandler pAllTestsCompleteMessage);
CU_EXPORT void CU_set_suite_init_failure_handler(CU_SuiteInitFailureMessageHandler pSuiteInitFailureMessage);
CU_EXPORT void CU_set_suite_cleanup_failure_handler(CU_SuiteCleanupFailureMessageHandler pSuiteCleanupFailureMessage);
CU_EXPORT void CU_set_suite_skipped_handler(CU_SuiteSkippedMessageHandler pSuiteSkipped);
CU_EXPORT CU_SuiteStartMessageHandler          CU_get_suite_start_handler(void);
CU_EXPORT CU_TestStartMessageHandler           CU_get_test_start_handler(void);
CU_EXPORT CU_TestCompleteMessageHandler        CU_get_test_complete_handler(void);
CU_EXPORT CU_TestSkippedMessageHandler         CU_get_test_skipped_handler(void);
CU_EXPORT CU_SuiteCompleteMessageHandler       CU_get_suite_complete_handler(void);
CU_EXPORT CU_AllTestsCompleteMessageHandler    CU_get_all_test_complete_handler(void);
CU_EXPORT CU_SuiteInitFailureMessageHandler    CU_get_suite_init_failure_handler(void);
CU_EXPORT CU_SuiteCleanupFailureMessageHandler CU_get_suite_cleanup_failure_handler(void);
/*--------------------------------------------------------------------
 * Functions for running registered tests and suites.
 *--------------------------------------------------------------------*/
CU_EXPORT CU_ErrorCode CU_run_all_tests(void);
CU_EXPORT CU_ErrorCode CU_run_suite(CU_pSuite pSuite);
CU_EXPORT CU_ErrorCode CU_run_test(CU_pSuite pSuite, CU_pTest pTest);
/*--------------------------------------------------------------------
 * Functions for setting runtime behavior.
 *--------------------------------------------------------------------*/
CU_EXPORT void CU_set_fail_on_inactive(CU_BOOL new_inactive);
CU_EXPORT CU_BOOL CU_get_fail_on_inactive(void);
/*--------------------------------------------------------------------
 * Functions for getting information about the previous test run.
 *--------------------------------------------------------------------*/
CU_EXPORT unsigned int CU_get_number_of_suites_run(void);
CU_EXPORT unsigned int CU_get_number_of_suites_failed(void);
CU_EXPORT unsigned int CU_get_number_of_suites_inactive(void);
CU_EXPORT unsigned int CU_get_number_of_tests_run(void);
CU_EXPORT unsigned int CU_get_number_of_tests_failed(void);
CU_EXPORT unsigned int CU_get_number_of_tests_inactive(void);
CU_EXPORT unsigned int CU_get_number_of_asserts(void);
CU_EXPORT unsigned int CU_get_number_of_successes(void);
CU_EXPORT unsigned int CU_get_number_of_failures(void);
CU_EXPORT unsigned int CU_get_number_of_failure_records(void);
CU_EXPORT double CU_get_elapsed_time(void);
CU_EXPORT CU_pFailureRecord CU_get_failure_list(void);
CU_EXPORT CU_pFailureRecord CU_iterate_test_failures(CU_pTest test, CU_pFailureRecord previous);
CU_EXPORT int CU_count_test_failures(CU_pTest pTest);
CU_EXPORT int CU_count_suite_failures(CU_pSuite pSuite);
CU_EXPORT int CU_count_all_failures(CU_pTestRegistry pRegistry);
CU_EXPORT int CU_count_suite_tests(CU_pSuite pSuite);
CU_EXPORT int CU_count_all_tests(CU_pTestRegistry pRegistry);
CU_EXPORT CU_pRunSummary CU_get_run_summary(void);
CU_EXPORT char * CU_get_run_results_string(void);
CU_EXPORT void CU_print_run_results(FILE *file);
CU_EXPORT double CU_get_test_duration(CU_pTest pTest);
CU_EXPORT double CU_get_suite_duration(CU_pSuite pSuite);
/*--------------------------------------------------------------------
 * Functions for internal & testing use.
 *--------------------------------------------------------------------*/
CU_EXPORT CU_pSuite CU_get_current_suite(void);
CU_EXPORT CU_pTest  CU_get_current_test(void);
CU_EXPORT CU_BOOL   CU_is_test_running(void);
CU_EXPORT void      CU_clear_previous_results(void);
CU_EXPORT CU_BOOL CU_assertImplementation(CU_BOOL bValue,
                                          unsigned int uiLine,
                                          const char *strCondition,
                                          const char *strFile,
                                          const char *strFunction,
                                          CU_BOOL bFatal);
CU_EXPORT void CU_SkipImplementation(CU_BOOL bValue,
                                     unsigned int uiLine,
                                     const char *strCondition,
                                     const char *strFile,
                                     const char *strFunction);
#define CU_SKIP_IF(value) \
  { CU_SkipImplementation((value), __LINE__, ("CU_SKIP_IF(" #value ")"), __FILE__, CU_FUNC); }
 
 
 
#ifdef USE_DEPRECATED_CUNIT_NAMES
typedef CU_FailureRecord  _TestResult;  
typedef CU_pFailureRecord PTestResult;  
#endif  /* USE_DEPRECATED_CUNIT_NAMES */
 
#ifdef CUNIT_BUILD_TESTS
void test_cunit_TestRun(void);
#endif
 
#ifdef __cplusplus
}
#endif
#endif  /*  CUNIT_TESTRUN_H_SEEN  */