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

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