-/* $Id: testlib.h,v 1.2 2004-10-28 15:24:36 heikki Exp $
- Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004
- Index Data Aps
+/* $Id: testlib.h,v 1.16 2005-09-13 11:51:07 adam Exp $
+ Copyright (C) 1995-2005
+ Index Data ApS
This file is part of the Zebra server.
/** 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>
+/**
+ * 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);
-/** read zebra.cfg from env var srcdir if it exists; otherwise current dir */
-ZebraService start_service(char *cfgfile);
+/**
+ * get_srcdir : returns the source dir. Most often ".", but when
+ * making distcheck, some other dir
+ */
+const char *get_srcdir();
-/** initialises the zebra base and inserts some test data in it */
-void init_data( ZebraHandle zh, const char **recs);
+/**
+ * start_log: open a log file
+ */
+/* 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(const 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);
-/** makes a query, and compares the number of hits to the expected */
-void Query(int lineno, ZebraHandle zh, char *query, int exphits);
+/** 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, const char *query, zint exphits);
+
+
+/**
+ * do_query does a simple query, and checks that error is what is expected
+ */
+int do_query_x(int lineno, ZebraHandle zh, const char *query, zint exphits,
+ int experror);
+
+/**
+ * do_scan is a utility for scan testing
+ */
+void do_scan(int lineno, ZebraHandle zh, const char *query,
+ int pos, int num, /* input params */
+ int exp_pos, int exp_num, int exp_partial, /* expected result */
+ const char **exp_entries /* expected entries (or NULL) */
+ );
+
+void do_sort(ZebraHandle zh, const char *query, zint hits, zint *exp);
+
+/**
+ * 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 );
+
/**
- * 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
+ * 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 RankingQuery(int lineno, ZebraHandle zh, char *query,
- int exphits, char *firstrec, int firstscore );
+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);