test.h

/**************************************************************
 HISTORY
 7-Dec-2004     Graeme McKerrell    
    Updated to use the "lub_test_" prefix rather than "unittest_"
 18-Mar-2002        Graeme McKerrell    
  added unittest_stop_here() prototype
 16-Mar-2002        Graeme McKerrell    
  LINTed...
 4-Mar-2002     Graeme McKerrell    
  Ported across for use in Garibaldi
 28-Feb-2002        Graeme McKerrell    
  Created based on implentation header file.
  
---------------------------------------------------------------
 Copyright (c) 3Com Corporation. All Rights Reserved
***************************************************************/
#ifndef _lub_test_h
#define _lub_test_h

#include <stdarg.h>
#include "lub/types.h"

#ifdef __cplusplus
extern "C"
{
#endif /* __cplusplus */
 
typedef enum {
  LUB_TEST_PASS, 
  LUB_TEST_FAIL  
} lub_test_status_t;

typedef enum {
  LUB_TEST_TERSE=0,
  LUB_TEST_NORMAL, 
  LUB_TEST_VERBOSE 
} lub_test_verbosity_t;

/*
 ************************************************************
 UNIT-TEST LEVEL FUNCTIONS
 ************************************************************
 */

void lub_test_parse_command_line(
                            int argc, 
                            const char * const *argv);
  
void lub_test_begin(
                   const char *fmt, 
                   ...);
  
void 
        lub_test_log(
                         lub_test_verbosity_t level, 
                     const char *fmt, 
                         ...);

lub_test_status_t 
        lub_test_get_status(void);

int 
        lub_test_failure_count(void);

void
        lub_test_end(void);

void 
        lub_test_stop_here(void);

/*
 ************************************************************
 SEQUENCE LEVEL FUNCTIONS
 ************************************************************
 */

void
        lub_test_seq_begin(
                           int seq, 
                                   const char *fmt, 
                                   ...);

void
        lub_test_seq_log(
                                 lub_test_verbosity_t level, 
                                 const char *fmt, 
                                 ...);

void 
        lub_test_seq_end(void);

/*
 ************************************************************
 TEST LEVEL FUNCTIONS
 ************************************************************
 */

/*lint -esym(534,lub_test_check,lub_test_check_int,lub_test_check_float)
 Make LINT not moan about people ignoring the return values for
 certain files, the value return is for utility purpose rather than
 a value that ought to be used.

************************************************************/
lub_test_status_t
    lub_test_check(
                       bool_t expr, 
                       const char *fmt, 
                       ...);

lub_test_status_t
        lub_test_check_int(
                               int expect,
                                   int actual,
                                   const char *fmt, 
                                   ... );

lub_test_status_t
        lag_test_test_float(
                            double      min,
                                    double      max,
                                    double      actual,
                                    const char *fmt, 
                                    ...);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* _lub_test_h */

---