chiark / gitweb /
Build: Put build utilities in the config/ subdirectory.
[mLib] / testrig.c
index de93155cef13894ce891a75ecd632551449a49f6..b24ab33b7ff253066b611344442d0e670b08658a 100644 (file)
--- a/testrig.c
+++ b/testrig.c
@@ -1,13 +1,13 @@
 /* -*-c-*-
  *
- * $Id: testrig.c,v 1.3 1999/05/06 19:51:35 mdw Exp $
+ * $Id: testrig.c,v 1.10 2004/04/08 01:36:13 mdw Exp $
  *
  * Generic test driver
  *
  * (c) 1998 Straylight/Edgeware
  */
 
-/*----- Licensing notice --------------------------------------------------* 
+/*----- Licensing notice --------------------------------------------------*
  *
  * This file is part of the mLib utilities library.
  *
  * it under the terms of the GNU Library General Public License as
  * published by the Free Software Foundation; either version 2 of the
  * License, or (at your option) any later version.
- * 
+ *
  * mLib is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU Library General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU Library General Public
  * License along with mLib; if not, write to the Free
  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  * MA 02111-1307, USA.
  */
 
-/*----- Revision history --------------------------------------------------* 
- *
- * $Log: testrig.c,v $
- * Revision 1.3  1999/05/06 19:51:35  mdw
- * Reformatted the LGPL notice a little bit.
- *
- * Revision 1.2  1999/05/05 18:50:31  mdw
- * Change licensing conditions to LGPL.
- *
- * Revision 1.1.1.1  1998/06/17 23:44:42  mdw
- * Initial version of mLib
- *
- */
-
 /*----- Header files ------------------------------------------------------*/
 
 #include <ctype.h>
 
 /*----- Static variables --------------------------------------------------*/
 
-static dstr test__tok;
+static dstr tok = DSTR_INIT;
 
 enum {
-  tok_eof = 0x100,
-  tok_word
+  TOK_EOF = 0x100,
+  TOK_WORD
 };
 
 /*----- Main code ---------------------------------------------------------*/
 
-/* --- @test__decode@ --- *
+/* --- @decode@ --- *
  *
  * Arguments:  @int tok@ = token type to decode
  *
@@ -74,24 +60,24 @@ enum {
  * Use:                Produces a readable representation of a token.
  */
 
-static const char *test__decode(int tok)
+static const char *decode(int t)
 {
   static char buf[4];
 
-  switch (tok) {
-    case tok_eof:
+  switch (t) {
+    case TOK_EOF:
       return ("<eof>");
-    case tok_word:
-      return (test__tok.buf);
+    case TOK_WORD:
+      return (tok.buf);
     default:
-      buf[0] = tok;
+      buf[0] = t;
       buf[1] = 0;
       return (buf);
   }
   return ("<buggy-program>");
 }
 
-/* --- @test__gettok@ --- *
+/* --- @gettok@ --- *
  *
  * Arguments:  @FILE *fp@ = file handle to read from
  *
@@ -100,13 +86,13 @@ static const char *test__decode(int tok)
  * Use:                Reads a token from the input stream.
  */
 
-static int test__gettok(FILE *fp)
+static int gettok(FILE *fp)
 {
   int ch;
 
   /* --- Clear the token accumulator --- */
 
-  dstr_reset(&test__tok);
+  DRESET(&tok);
 
   /* --- Prime the lookahead character --- */
 
@@ -129,9 +115,9 @@ again:
       goto again;
 
     /* --- End of file --- */
-      
+
     case EOF:
-      return (tok_eof);
+      return (TOK_EOF);
 
     /* --- Quote characters --- */
 
@@ -150,35 +136,48 @@ again:
          if (ch == EOF)
            ch = '\\';
        }
-       DPUTC(&test__tok, ch);
+       DPUTC(&tok, ch);
       }
-      DPUTZ(&test__tok);
-      return (tok_word);
+      DPUTZ(&tok);
+      return (TOK_WORD);
     }
 
-    /* --- Anything else is either a word or self-delimiting --- */
+    /* --- Self-delimiting things --- */
+
+    case ';':
+    case '{':
+    case '}':
+      return (ch);
+
+    /* --- Anything else is a word --- */
 
     default:
-      if (isalnum((unsigned char)ch)) {
-       for (;;) {
-         DPUTC(&test__tok, ch);
+      for (;;) {
+       DPUTC(&tok, ch);
+       ch = getc(fp);
+       switch (ch) {
+         case EOF:
+         case ';':
+         case '{':
+         case '}':
+         case '\"':
+         case '\'':
+         case '`':
+           goto done;
+         default:
+           if (isspace((unsigned char)ch))
+             goto done;
+       }
+       if (ch == '\\') {
          ch = getc(fp);
-         if (ch == EOF ||
-             ch == ';' ||
-             ch == '\"' || ch == '\'' || ch == '`' ||
-             isspace((unsigned char)ch))
-           break;
-         if (ch == '\\') {
-           ch = getc(fp);
-           if (ch == EOF)
-             ch = '\\';
-         }
+         if (ch == EOF)
+           ch = '\\';
        }
-       ungetc(ch, fp);
-       DPUTZ(&test__tok);
-       return (tok_word);
-      } else
-       return (ch);
+      }
+    done:
+      ungetc(ch, fp);
+      DPUTZ(&tok);
+      return (TOK_WORD);
   }
 }
 
@@ -208,7 +207,7 @@ static void dump_hex(dstr *d, FILE *fp)
     fprintf(fp, "%02x", *(unsigned char *)p);
 }
 
-test_type type_hex = { cvt_hex, dump_hex };
+const test_type type_hex = { cvt_hex, dump_hex };
 
 /* --- @type_string@ --- */
 
@@ -219,168 +218,198 @@ static void cvt_string(const char *s, dstr *d)
 
 static void dump_string(dstr *d, FILE *fp)
 {
-  dstr_write(d, fp);
+  DWRITE(d, fp);
 }
 
-test_type type_string = { cvt_string, dump_string };
+const test_type type_string = { cvt_string, dump_string };
 
 /* --- @type_int@ --- */
 
 static void cvt_int(const char *s, dstr *d)
 {
-  DENSURE(d, sizeof(long));
-  sscanf(s, "%i", (int *)d->buf + d->len);
+  DENSURE(d, sizeof(int));
+  sscanf(s, "%i", (int *)d->buf);
 }
 
 static void dump_int(dstr *d, FILE *fp)
 {
-  fprintf(fp, "%i", *(int *)(d->buf));
+  fprintf(fp, "%i", *(int *)d->buf);
 }
 
-test_type type_int = { cvt_int, dump_int };
+const test_type type_int = { cvt_int, dump_int };
 
-/* --- @test_run@ --- *
- *
- * Arguments:  @int argc@ = number of command line arguments
- *             @char *argv[]@ = pointer to command line arguments
- *             @const test_chunk chunk[]@ = pointer to chunk definitions
- *             @const char *vec@ = name of default test vector file
- *
- * Returns:    Doesn't.
- *
- * Use:                Runs a set of test vectors to ensure that a component is
- *             working properly.
- */
+/* --- @type_long@ --- */
 
-void test_run(int argc, char *argv[],
-             const test_chunk chunk[],
-             const char *vec)
+static void cvt_long(const char *s, dstr *d)
 {
-  FILE *fp;
-  int i;
-  const test_chunk *cch;
-  dstr dv[TEST_FIELDMAX];
-  int fail = 0, ok = 1;
-  int sofar = 0;
+  DENSURE(d, sizeof(long));
+  *(long *)d->buf = strtol(s, 0, 0);
+}
 
-  /* --- Silly bits of initialisation --- */
+static void dump_long(dstr *d, FILE *fp)
+{
+  fprintf(fp, "%li", *(long *)d->buf);
+}
 
-  ego(argv[0]);
+const test_type type_long = { cvt_long, dump_long };
 
-  for (i = 0; i < TEST_FIELDMAX; i++)
-    dstr_create(&dv[i]);
+/* --- @type_ulong@ --- */
 
-  /* --- Parse command line arguments --- */
+static void cvt_ulong(const char *s, dstr *d)
+{
+  DENSURE(d, sizeof(unsigned long));
+  *(unsigned long *)d->buf = strtoul(s, 0, 0);
+}
 
-  {
-    const char *p = 0;
+static void dump_ulong(dstr *d, FILE *fp)
+{
+  fprintf(fp, "%lu", *(unsigned long *)d->buf);
+}
 
-    i = 0;
-    for (;;) {
-      if (!p || !*p) {
-       if (i >= argc - 1)
-         break;
-       p = argv[++i];
-       if (strcmp(p, "--") == 0) {
-         i++;
-         break;
-       }
-       if (p[0] != '-' || p[1] == 0)
-         break;
-       p++;
-      }
-      switch (*p++) {
-       case 'h':
-         printf("%s test driver\n"
-                "Usage: %s [-f FILENAME]\n", QUIS, QUIS);
-         exit(0);
-       case 'f':
-         if (!*p) {
-           if (i >= argc - 1)
-             die(1, "option `-f' expects an argument");
-           p = argv[++i];
-         }
-         vec = p;
-         p = 0;
-         break;
-       default:
-         die(1, "option `-%c' unknown", p[-1]);
-         break;
-      }
-    }
-  }
+const test_type type_ulong = { cvt_ulong, dump_ulong };
 
-  /* --- Start parsing from the file --- */
+/* --- @type_uint32@ --- */
 
-  if ((fp = fopen(vec, "r")) == 0)
-    die(1, "couldn't open test vector file `%s': %s", vec, strerror(errno));
+static void cvt_uint32(const char *buf, dstr *d)
+{
+  DENSURE(d, sizeof(uint32));
+  *(uint32 *)d->buf = strtoul(buf, 0, 0);
+}
+
+static void dump_uint32(dstr *d, FILE *fp)
+{
+  fprintf(fp, "%lu\n", (unsigned long)*(uint32 *)d->buf);
+}
+
+const test_type type_uint32 = { cvt_uint32, dump_uint32 };
+
+/* --- @test_do@ --- *
+ *
+ * Arguments:  @const test_suite suites[]@ = pointer to suite definitions
+ *             @FILE *fp@ = test vector file, ready opened
+ *             @test_results *results@ = where to put results
+ *
+ * Returns:    Negative if something bad happened, or the number of
+ *             failures.
+ *
+ * Use:                Runs a collection of tests against a file of test vectors and
+ *             reports the results.
+ */
+
+int test_do(const test_suite suites[], FILE *fp, test_results *results)
+{
+  test_results dummy;
+  dstr dv[TEST_FIELDMAX];
+  const test_suite *ss;
+  const test_chunk *chunks = suites[0].chunks;
+  const test_chunk *cch;
+  int rc = -1;
+  int ok;
+  int i;
+
+  for (i = 0; i < TEST_FIELDMAX; i++)
+    DCREATE(&dv[i]);
+
+  if (!results)
+    results = &dummy;
+  results->tests = 0;
+  results->failed = 0;
 
   for (;;) {
-    int tok = test__gettok(fp);
+    int t = gettok(fp);
 
     /* --- This is a reasonable place to stop --- */
 
-    if (tok == tok_eof)
+    if (t == TOK_EOF)
       break;
 
     /* --- Pick out the chunk name --- */
 
-    if (tok != tok_word)
-      die(1, "expected <word>; found `%s'", test__decode(tok));
+    if (t != TOK_WORD) {
+      moan("expected <word>; found `%s'", decode(t));
+      goto done;
+    }
+
+    if (strcmp(tok.buf, "SUITE") == 0) {
+      t = gettok(fp);
+      if (t != TOK_WORD) {
+       moan("expected <word>; found `%s'", decode(t));
+       goto done;
+      }
+      for (ss = suites; ; ss++) {
+       if (!ss->name) {
+         chunks = 0;
+         break;
+       }
+       if (strcmp(tok.buf, ss->name) == 0) {
+         chunks = ss->chunks;
+         break;
+       }
+      }
+      continue;
+    }
 
     /* --- Find the right chunk block --- */
 
-    for (cch = chunk; ; cch++) {
+    if (!chunks)
+      goto skip_chunk;
+    for (cch = chunks; ; cch++) {
       if (!cch->name)
        goto skip_chunk;
-      if (strcmp(test__tok.buf, cch->name) == 0)
+      if (strcmp(tok.buf, cch->name) == 0)
        break;
     }
 
     /* --- Past the open brace to the first chunk --- */
 
-    if ((tok = test__gettok(fp)) != '{')
-      die(1, "expected '{'; found `%s'", test__decode(tok));
+    if ((t = gettok(fp)) != '{') {
+      moan("expected `{'; found `%s'", decode(t));
+      goto done;
+    }
 
     /* --- Start on the test data now --- */
 
     printf("%s: ", cch->name);
     fflush(stdout);
-    sofar = 0;
     ok = 1;
 
     for (;;) {
-      tok = test__gettok(fp);
+      t = gettok(fp);
 
       /* --- Accept a close brace --- */
 
-      if (tok == '}')
+      if (t == '}')
        break;
 
       /* --- Otherwise I expect a list of words --- */
 
       for (i = 0; cch->f[i]; i++) {
-       dstr_reset(&dv[i]);
-       if (tok != tok_word)
-         die(1, "expected <word>; found `%s'", test__decode(tok));
-       cch->f[i]->cvt(test__tok.buf, &dv[i]);
-       tok = test__gettok(fp);
+       DRESET(&dv[i]);
+       if (t != TOK_WORD) {
+         moan("expected <word>; found `%s'", decode(t));
+         goto done;
+       }
+       cch->f[i]->cvt(tok.buf, &dv[i]);
+       t = gettok(fp);
       }
 
       /* --- And a terminating semicolon --- */
 
-      if (tok != ';')
-       die(1, "expected `;'; found `%s'", test__decode(tok));
+      if (t != ';') {
+       moan("expected `;'; found `%s'", decode(t));
+       goto done;
+      }
 
       /* --- Run the test code --- */
 
       if (!cch->test(dv)) {
+       ok = 0;
        printf("%s: ", cch->name);
-       for (i = 0; i < sofar; i++) putchar('.');
-       fail = 1; ok = 0;
+       for (i = 0; i < results->tests; i++) putchar('.');
+       results->failed++;
       }
-      sofar++;
       putchar('.');
+      results->tests++;
       fflush(stdout);
     }
 
@@ -389,20 +418,116 @@ void test_run(int argc, char *argv[],
     continue;
 
   skip_chunk:
-    if ((tok = test__gettok(fp)) != '{')
-      die(1, "expected '{'; found `%s'", test__decode(tok));
+    if ((t = gettok(fp)) != '{') {
+      moan("expected '{'; found `%s'", decode(t));
+      goto done;
+    }
     for (;;) {
-      tok = test__gettok(fp);
-      if (tok == '}')
+      t = gettok(fp);
+      if (t == '}')
        break;
-      while (tok == tok_word)
-       tok = test__gettok(fp);
-      if (tok != ';')
-       die(1, "expected `;'; found `%s'", test__decode(tok));
-    }      
+      while (t == TOK_WORD)
+       t = gettok(fp);
+      if (t != ';') {
+       moan("expected `;'; found `%s'", decode(t));
+       goto done;
+      }
+    }
+  }
+  rc = results->failed;
+
+  /* --- All done --- */
+
+done:
+  for (i = 0; i < TEST_FIELDMAX; i++)
+    dstr_destroy(&dv[i]);
+  return (rc);
+}
+
+/* --- @test_run@ --- *
+ *
+ * Arguments:  @int argc@ = number of command line arguments
+ *             @char *argv[]@ = pointer to command line arguments
+ *             @const test_chunk chunk[]@ = pointer to chunk definitions
+ *             @const char *vec@ = name of default test vector file
+ *
+ * Returns:    Doesn't.
+ *
+ * Use:                Runs a set of test vectors to ensure that a component is
+ *             working properly.
+ */
+
+void test_run(int argc, char *argv[],
+             const test_chunk chunk[],
+             const char *vec)
+{
+  FILE *fp;
+  test_results res;
+  int rc;
+  test_suite suite[2];
+
+  /* --- Silly bits of initialization --- */
+
+  ego(argv[0]);
+
+  /* --- Parse command line arguments --- */
+
+  {
+    const char *p = 0;
+    int i = 0;
+
+    for (;;) {
+      if (!p || !*p) {
+       if (i >= argc - 1)
+         break;
+       p = argv[++i];
+       if (strcmp(p, "--") == 0) {
+         i++;
+         break;
+       }
+       if (p[0] != '-' || p[1] == 0)
+         break;
+       p++;
+      }
+      switch (*p++) {
+       case 'h':
+         printf("%s test driver\n"
+                "Usage: %s [-f FILENAME]\n", QUIS, QUIS);
+         exit(0);
+       case 'f':
+         if (!*p) {
+           if (i >= argc - 1)
+             die(1, "option `-f' expects an argument");
+           p = argv[++i];
+         }
+         vec = p;
+         p = 0;
+         break;
+       default:
+         die(1, "option `-%c' unknown", p[-1]);
+         break;
+      }
+    }
   }
 
-  exit(fail);
+  /* --- Start parsing from the file --- */
+
+  if ((fp = fopen(vec, "r")) == 0)
+    die(1, "couldn't open test vector file `%s': %s", vec, strerror(errno));
+  suite[0].name = "simple";
+  suite[0].chunks = chunk;
+  suite[1].name = 0;
+  rc = test_do(suite, fp, &res);
+  if (rc < 0)
+    exit(127);
+  if (res.failed) {
+    fprintf(stderr, "FAILED %u of %u test%s\n",
+           res.failed, res.tests, res.tests == 1 ? "" : "s");
+  } else {
+    fprintf(stderr, "PASSED all %u test%s\n",
+           res.tests, res.tests == 1 ? "" : "s");
+  }
+  exit(!!res.failed);
 }
 
 /*----- That's all, folks -------------------------------------------------*/