src/vfer_tests.h

Go to the documentation of this file.

/*
 * Copyright 2005, 2006, Internet2
 * Legal conditions are in file LICENSE
 * (MD5 = c434f2e53b8089d8b4d0172c7ce07360).
 */
/**
 *
 * @file   vfer_tests.h
 * @author Ivan Beschastnikh
 * @brief  Header file that is used by protocol tests
 *
 * This header file includes useful macros & functions for error and debug
 * processing.
 *
 * -     02/04/05        ivan            updated with new macros to report test failure and summary
 * -     08/21/05        ivan            created
 */

#ifndef VFER_TESTS_H
#define VFER_TESTS_H

#include "vfer.h"

/* these can be reset to point to open files, but they are not used if
 * TEST_ERR and/or TEST_OUT are commented out */
FILE* test_out;
FILE* test_err;
/* keeps the tests's name - useful for printing out debug/err messages */
char test_name[32];
char test_file[32];

/* these keep the number of faults and the number of max faults for the test */
int test_faults;
int test_max_faults;

/* determines whether we output any err msgs */
#define TEST_ERR
/* determines whether we output any debug msgs */
#define TEST_OUT

/**/
#ifdef TEST_OUT
        #define TEST_PRINT(FUNC, ...) do { \
                if (test_out != NULL) { \
                fprintf(test_out, "%-13s [ %-20s ] ", test_name, FUNC); \
                fprintf(test_out, __VA_ARGS__); \
                fprintf(test_out, "\n"); }} while (0)
#else
        #define TEST_PRINT(FUNC, ...)
#endif
/**/
#ifdef TEST_ERR
        #define T_ERR(FUNC, ...) do { \
                if (test_err != NULL) { \
                fprintf(test_err, "%-13s [ %-20s ] ERROR ", test_name, FUNC); \
                fprintf(test_err, __VA_ARGS__); \
                fprintf(test_err, "\n"); }} while (0)
#else
        #define T_ERR(FUNC, ...)
#endif
/**/

/*
 * these cars determine the printing of messages for specific tests
 * of the protocol, they are set with TEST_INIT below
 */

/*
 * to specify no debug output, set OUT to NULL
 * NEVER pass a NULL ERR argument (used by TEST_CHECK and TEST_SUMMARY)
 */
void TEST_INIT(char* TEST, char* File, FILE* OUT, FILE* ERR) {
        if (strlen(TEST) > 32) {
                printf("error: test's name too long\n");
                exit(-1);
        }
        if (strlen(File) > 32) {
                printf("error: file's name too long\n");
                exit(-1);
        }
        strncpy(test_name, TEST, 32);
        strncpy(test_file, File, 32);
        test_faults     = 0;
        test_max_faults = 0;
        ReqMem          = 0;
        test_out        = OUT;
        test_err        = ERR;
        debug_out       = OUT;
        error_out       = ERR;
}

#define TEST_CHECK(TO_TEST, MESG) { \
        test_max_faults++; \
        if (!TO_TEST) { \
                fprintf(test_err, "%s *** test failed: %s ***\n", test_name, MESG); \
                test_faults++; \
        }}

#define TEST_SUMMARY() { fprintf(test_err, "%s faulty tests: %d / %d\n", test_name, test_faults, test_max_faults); }

//! abort if test fails
#define ASSERT(TEST) do { \
     bool _ok = (TEST); \
     TEST_CHECK(_ok, #TEST " is false"); \
     if (!_ok) { \
         TEST_SUMMARY(); \
         exit(1); \
     } \
     } while(0)

#endif /* VFER_TESTS_H */

---