include/yaz/test.h

   1 /*
   2  * Copyright (c) 1995-2006, Index Data
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of Index Data nor the names of its contributors
  13  *       may be used to endorse or promote products derived from this
  14  *       software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27 /* $Id: test.h,v 1.11 2006-10-09 21:02:41 adam Exp $ */
  28
  29 /*
  30  * Copyright (C) 1995-2006, Index Data ApS
  31  * See the file LICENSE for details.
  32  *
  33  * $Id: test.h,v 1.11 2006-10-09 21:02:41 adam Exp $
  34  */
  35
  36 /** \file test.h
  37     \brief Unit Test for YAZ
  38 */
  39
  40 #ifndef YAZ_TEST_H
  41 #define YAZ_TEST_H
  42
  43 #include <yaz/yconfig.h>
  44 #include <stdio.h>
  45
  46 /** \brief Get the verbosity level */
  47 int yaz_test_get_verbosity(void);
  48
  49 /** \brief Test OK */
  50 #define YAZ_TEST_TYPE_OK 1
  51 /** \brief Test failed */
  52 #define YAZ_TEST_TYPE_FAIL 2
  53
  54 /** \brief boolean test. as only evaluated once */
  55 #define YAZ_CHECK(as) { \
  56   if (as) { \
  57     yaz_check_print1(YAZ_TEST_TYPE_OK, __FILE__, __LINE__, #as); \
  58   } else { \
  59     yaz_check_print1(YAZ_TEST_TYPE_FAIL, __FILE__, __LINE__, #as); \
  60   } \
  61 }
  62
  63 /** \brief a test we know will fail at this time.
  64  *
  65  * Later, when the bug is fixed, this test will suddenly pass,
  66  * which will be reported as an error, to remind you to go and fix
  67  * your tests.
  68  */
  69
  70 #define YAZ_CHECK_TODO(as) { \
  71   yaz_check_inc_todo(); \
  72   if (!as) { \
  73     yaz_check_print1(YAZ_TEST_TYPE_OK, __FILE__, __LINE__, "TODO: " #as); \
  74   } else { \
  75     yaz_check_print1(YAZ_TEST_TYPE_FAIL, __FILE__, __LINE__, "TODO: "#as); \
  76   } \
  77 }
  78
  79 /** \brief equality test. left, right only evaluated once */
  80 #define YAZ_CHECK_EQ(left, right) { \
  81   int lval = left; \
  82   int rval = right; \
  83   if (lval == rval) { \
  84     yaz_check_eq1(YAZ_TEST_TYPE_OK, __FILE__, __LINE__, \
  85      #left, #right, lval, rval); \
  86   } else { \
  87     yaz_check_eq1(YAZ_TEST_TYPE_FAIL, __FILE__, __LINE__, \
  88      #left, #right, lval, rval); \
  89   } \
  90 }
  91
  92 /** \brief Macro to initialize the system (in start of main typically) */
  93 #define YAZ_CHECK_INIT(argc, argv) yaz_check_init1(&argc, &argv)
  94 /** \brief Macro to terminate the system (end of main, normally) */
  95 #define YAZ_CHECK_TERM yaz_check_term1(); return 0
  96
  97 /** \brief Macro to enable and initialize the yaz_log(start of main) */
  98 #define YAZ_CHECK_LOG() yaz_check_init_log(argv[0])
  99
 100 YAZ_BEGIN_CDECL
 101
 102 /** \brief used by macro. Should not be called directly */
 103 YAZ_EXPORT void yaz_check_init1(int *argc, char ***argv);
 104
 105 /** \brief used by macro. Should not be called directly */
 106 YAZ_EXPORT void yaz_check_term1(void);
 107
 108 /** \brief used by macro. Should not be called directly */
 109 YAZ_EXPORT void yaz_check_init_log(const char *argv0);
 110
 111 /** \brief used by macro. Should not be called directly */
 112 YAZ_EXPORT void yaz_check_print1(int type, const char *file, int line,
 113                                  const char *expr);
 114 /** \brief used by macro. Should not be called directly */
 115 YAZ_EXPORT void yaz_check_eq1(int type, const char *file, int line,
 116                               const char *left, const char *right,
 117                               int lval, int rval);
 118 /** \brief used by macro. Should not be called directly */
 119 YAZ_EXPORT void  yaz_check_inc_todo(void);
 120 YAZ_END_CDECL
 121
 122 #endif
 123 /*
 124  * Local variables:
 125  * c-basic-offset: 4
 126  * indent-tabs-mode: nil
 127  * End:
 128  * vim: shiftwidth=4 tabstop=8 expandtab
 129  */
 130