Bump year. Change Aps->ApS
[idzebra-moved-to-github.git] / test / api / testlib.h
index cc60d2f..b1f7726 100644 (file)
@@ -1,6 +1,6 @@
-/* $Id: testlib.h,v 1.1 2004-10-28 10:43:38 heikki Exp $
-   Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004
-   Index Data Aps
+/* $Id: testlib.h,v 1.10 2005-01-15 19:38:35 adam Exp $
+   Copyright (C) 1995-2005
+   Index Data ApS
 
 This file is part of the Zebra server.
 
@@ -22,19 +22,82 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 
 /** testlib - utilities for the api tests */
 
-#include <yaz/log.h>
+#include <stdlib.h>
+#include <yaz/yconfig.h>
 #include <yaz/pquery.h>
+#include <yaz/log.h>
 #include <idzebra/api.h>
 
+int log_level;
 
-/** read zebra.cfg from env var srcdir if it exists; otherwise current dir */
-ZebraService start_service();
 
 /** 
- * makes a query, checks number of hits, and for the first hit, that 
- * it contains the given string, and that it gets the right score
+ * start_up : Does all the usual start functions
+ *    - nmem_init
+ *    - build the name of logfile from argv[0], and open it
+ *      if no argv passed, do not open a log
+ *    - read zebra.cfg from env var srcdir if it exists; otherwise current dir 
+ *      default to zebra.cfg, if no name is given
+ */
+ZebraService start_up(char *cfgname, int argc, char **argv);
+
+/**
+ * get_srcdir : returns the source dir. Most often ".", but when
+ * making distcheck, some other dir 
+ */
+const char *get_srcdir();
+
+/** 
+ * start_log: open a log file 
  */
-void RankingQuery(int lineno, ZebraHandle zh, char *query, 
-           int exphits, char *firstrec, int firstscore );
+/*    FIXME - parse command line arguments to set log levels etc */
+void start_log(int argc, char **argv);
 
+/** 
+ * start_service - do a zebra_start with a decent config name 
+ * Takes care of checking the environment for srcdir (as needed by distcheck)
+ * and uses that if need be. 
+ * The name defaults to zebra.cfg, if null or emtpy
+ */
+ZebraService start_service(char *cfgname);
+
+
+/** 
+ * close_down closes it all down
+ * Does a zebra_close on zh, if not null.
+ * Does a zebra_stop on zs, if not null 
+ * Writes a log message, OK if retcode is zero, error if not
+ * closes down nmem and xmalloc
+ * returns the retcode, for use in return or exit in main()
+ */
+int close_down(ZebraHandle zh, ZebraService zs, int retcode);
 
+/** inits the database and inserts test data */
+void init_data( ZebraHandle zh, const char **recs);
+
+
+/**
+ * do_query does a simple query, and checks that the number of hits matches
+ */
+int do_query(int lineno, ZebraHandle zh, char *query, int exphits);
+
+
+/** 
+ * ranking_query makes a query, checks number of hits, and for 
+ * the first hit, that it contains the given string, and that it 
+ * gets the right score
+ */
+void ranking_query(int lineno, ZebraHandle zh, char *query, 
+          int exphits, char *firstrec, int firstscore );
+
+/** 
+ * meta_query makes a query, checks number of hits, and for 
+ * checks that the all records in result set has the proper identifiers (ids)
+ */
+void meta_query(int lineno, ZebraHandle zh, char *query, int exphits,
+               zint *ids);
+
+/**
+ * if filter given by name does not exist, exit nicely but warn in log 
+ */
+void check_filter(ZebraService zs, const char *name);