chiark - git - mdw - mLib/blob - testrig.h

   1 /* -*-c-*-
   2  *
   3  * $Id: testrig.h,v 1.7 2004/04/08 01:36:13 mdw Exp $
   4  *
   5  * Generic test driver
   6  *
   7  * (c) 1998 Straylight/Edgeware
   8  */
   9
  10 /*----- Licensing notice --------------------------------------------------*
  11  *
  12  * This file is part of the mLib utilities library.
  13  *
  14  * mLib is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU Library General Public License as
  16  * published by the Free Software Foundation; either version 2 of the
  17  * License, or (at your option) any later version.
  18  *
  19  * mLib is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Library General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU Library General Public
  25  * License along with mLib; if not, write to the Free
  26  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  27  * MA 02111-1307, USA.
  28  */
  29
  30 #ifndef MLIB_TESTER_H
  31 #define MLIB_TESTER_H
  32
  33 #ifdef __cplusplus
  34   extern "C" {
  35 #endif
  36
  37 /*----- Header files ------------------------------------------------------*/
  38
  39 #include <stddef.h>
  40
  41 #include "bits.h"
  42 #include "dstr.h"
  43
  44 /*----- Magical numbers ---------------------------------------------------*/
  45
  46 #define TEST_FIELDMAX 16                /* Maximum fields in a line */
  47
  48 /*----- Data structures ---------------------------------------------------*/
  49
  50 typedef struct test_results {
  51   unsigned tests, failed;
  52 } test_results;
  53
  54 /* --- Test field definition --- */
  55
  56 typedef struct test_type {
  57   void (*cvt)(const char *buf, dstr *d); /* Conversion function */
  58   void (*dump)(dstr *d, FILE *fp);      /* Dump function */
  59 } test_type;
  60
  61 /* --- Test chunk definition --- */
  62
  63 typedef struct test_chunk {
  64   const char *name;                     /* Name of this chunk */
  65   int (*test)(dstr /*dv*/[]);           /* Test verification function */
  66   const test_type *f[TEST_FIELDMAX];    /* Field definitions */
  67 } test_chunk;
  68
  69 typedef struct test_suite {
  70   const char *name;                     /* Name of this suite */
  71   const test_chunk *chunks;             /* Chunks contained in this suite */
  72 } test_suite;
  73
  74 /*----- Predefined data types ---------------------------------------------*/
  75
  76 extern const test_type type_hex;
  77 extern const test_type type_string;
  78 extern const test_type type_int;
  79 extern const test_type type_long;
  80 extern const test_type type_ulong;
  81 extern const test_type type_uint32;
  82
  83 /*----- Functions provided ------------------------------------------------*/
  84
  85 /* --- @test_do@ --- *
  86  *
  87  * Arguments:   @const test_suite suites[]@ = pointer to suite definitions
  88  *              @FILE *fp@ = test vector file, ready opened
  89  *              @test_results *results@ = where to put results
  90  *
  91  * Returns:     Negative if something bad happened, or the number of
  92  *              failures.
  93  *
  94  * Use:         Runs a collection of tests against a file of test vectors and
  95  *              reports the results.
  96  */
  97
  98 extern int test_do(const test_suite /*suite*/[],
  99                    FILE */*fp*/,
 100                    test_results */*results*/);
 101
 102 /* --- @test_run@ --- *
 103  *
 104  * Arguments:   @int argc@ = number of command line arguments
 105  *              @char *argv[]@ = pointer to command line arguments
 106  *              @const test_chunk chunk[]@ = pointer to chunk definitions
 107  *              @const char *def@ = name of default test vector file
 108  *
 109  * Returns:     Doesn't.
 110  *
 111  * Use:         Runs a set of test vectors to ensure that a component is
 112  *              working properly.
 113  */
 114
 115 extern void test_run(int /*argc*/, char */*argv*/[],
 116                      const test_chunk /*chunk*/[],
 117                      const char */*def*/);
 118
 119 /*----- That's all, folks -------------------------------------------------*/
 120
 121 #ifdef __cplusplus
 122   }
 123 #endif
 124
 125 #endif