Make YAZ checks Emacs friendly

[yaz-moved-to-github.git] / src / test.c

diff --git a/src/test.c b/src/test.c
index 79083d1..c186bc5 100644 (file)
--- a/src/test.c
+++ b/src/test.c
@@ -1,21 +1,51 @@
-/*
- * Copyright (C) 1995-2005, Index Data ApS
+/* This file is part of the YAZ toolkit.
+ * Copyright (C) 1995-2009 Index Data
  * See the file LICENSE for details.
- *
- * $Id: test.c,v 1.1 2006-01-27 18:58:58 adam Exp $
  */
+
+/** \file test.c
+    \brief Unit Test for YAZ
+*/
+
 #if HAVE_CONFIG_H
 #include <config.h>
 #endif
 
+#include <stdio.h>
 #include <string.h>
 #include <stdlib.h>
+#if HAVE_UNISTSD_H
+#include <unistd.h>
+#endif
 
 #include <yaz/test.h>
+#include <yaz/log.h>
+
+static FILE *test_fout = 0; /* can't use '= stdout' on some systems */
+static int test_total = 0;
+static int test_failed = 0;
+static int test_todo = 0;
+static int test_verbose = 1;
+static const char *test_prog = 0;
+static int log_tests = 0; 
 
-static FILE *test_fout;
-static int test_number = 0;
-static int test_verbose = 0;
+static FILE *get_file(void)
+{
+    if (test_fout)
+        return test_fout;
+    return stdout;
+}
+
+static const char *progname(const char *argv0)
+{
+    const char *cp = strrchr(argv0, '/');
+    if (cp)
+        return cp+1;
+    cp = strrchr(argv0, '\\');
+    if (cp)
+        return cp+1;
+    return argv0;
+}
 
 void yaz_check_init1(int *argc_p, char ***argv_p)
 {
@@ -23,7 +53,8 @@ void yaz_check_init1(int *argc_p, char ***argv_p)
     int argc = *argc_p;
     char **argv = *argv_p;
 
-    test_fout = 0;
+    test_prog = progname(argv[0]);
+
     for (i = 1; i<argc; i++)
     {
         if (strlen(argv[i]) >= 7 && !memcmp(argv[i], "--test-", 7))
@@ -47,8 +78,14 @@ void yaz_check_init1(int *argc_p, char ***argv_p)
             {
                 fprintf(stderr, 
                         "--test-help           help\n"
-                        "--test-verbose level  verbose; 0=quiet; 1=normal; 2=more\n"
-                        "--test-file fname     output to fname\n");
+                        "--test-file fname     output to fname\n"
+                        "--test-verbose level  verbose level\n"
+                        "       0=Quiet. Only exit code tells what's wrong\n"
+                        "       1=Report+Summary only if tests fail.\n"
+                        "       2=Report failures. Print summary always\n"
+                        "       3=Report + summary always\n"
+                        "       4=Report + summary + extra prints from tests\n"
+                    );
                 exit(0);
             }
             else
@@ -67,35 +104,113 @@ void yaz_check_init1(int *argc_p, char ***argv_p)
     --i;
     *argc_p -= i;
     *argv_p += i;
-    if (!test_fout)
-        test_fout = stdout;
 }
 
-void yaz_check_print1(int type, const char *file, int line, const char *expr)
+/** \brief  Initialize the log system */
+void yaz_check_init_log(const char *argv0)
+{
+    char logfilename[2048];
+    log_tests = 1; 
+    sprintf(logfilename,"%s.log", progname(argv0) );
+    yaz_log_init_file(logfilename);
+    yaz_log_trunc();
+
+}
+
+void  yaz_check_inc_todo(void)
+{
+    test_todo++;
+}
+
+void yaz_check_term1(void)
+{
+    /* summary */
+    if (test_failed)
+    {
+        if (test_verbose >= 1) {
+            if (test_todo)
+                fprintf(get_file(), "%d out of %d tests failed for program %s"
+                        " (%d TODO's remaining)\n",
+                    test_failed, test_total, test_prog,test_todo);
+            else
+                fprintf(get_file(), "%d out of %d tests failed for program %s\n",
+                    test_failed, test_total, test_prog);
+        }
+    }
+    else
+    {
+        if (test_verbose >= 2) {
+            if (test_todo)
+                fprintf(get_file(), "%d tests passed for program %s"
+                        " (%d TODO's remaining)\n",
+                    test_total, test_prog,test_todo);
+            else
+                fprintf(get_file(), "%d tests passed for program %s\n",
+                    test_total, test_prog);
+        }
+    }
+    if (test_fout)
+        fclose(test_fout);
+    if (test_failed)
+        exit(1);
+    exit(0);
+}
+
+void yaz_check_eq1(int type, const char *file, int line,
+                   const char *left, const char *right, int lval, int rval)
+{
+    char formstr[2048];
+    
+    if (type == YAZ_TEST_TYPE_OK) 
+        sprintf(formstr, "%.500s == %.500s ", left, right);
+    else
+        sprintf(formstr, "%.500s != %.500s\n %d != %d", left, right, lval,rval);
+    yaz_check_print1(type, file, line, formstr);
+}
+
+void yaz_check_print1(int type, const char *file, int line, 
+                      const char *expr)
 {
     const char *msg = "unknown";
+    int printit = 1;
 
-    test_number++;
+    test_total++;
     switch(type)
     {
     case YAZ_TEST_TYPE_FAIL:
-        msg = "failed";
+        test_failed++;
+        msg = "FAILED";
         if (test_verbose < 1)
-            return;
+            printit = 0;
         break;
     case YAZ_TEST_TYPE_OK:
-        msg = "OK";
-        if (test_verbose < 2)
-            return;
+        msg = "ok";
+        if (test_verbose < 3)
+            printit = 0;
         break;
     }
-    fprintf(test_fout, "%s:%d %s: %s\n", file, line, msg, expr);
+    if (printit)
+    {
+        fprintf(get_file(), "%s:%d: %s: ", file, line, msg);
+        fprintf(get_file(), "%s\n", expr);
+    }
+    if (log_tests)
+    {
+        yaz_log(YLOG_LOG, "%s:%d %s: ", file, line, msg);
+        yaz_log(YLOG_LOG, "%s", expr);
+    }
 }
 
 
+int yaz_test_get_verbosity()
+{
+    return test_verbose;
+}
+
 /*
  * Local variables:
  * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
  * indent-tabs-mode: nil
  * End:
  * vim: shiftwidth=4 tabstop=8 expandtab