-/* $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
-
-This file is part of the Zebra server.
+/* This file is part of the Zebra server.
+ Copyright (C) 1995-2008 Index Data
Zebra is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
for more details.
You should have received a copy of the GNU General Public License
-along with Zebra; see the file LICENSE.zebra. If not, write to the
-Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
-02111-1307, USA.
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
*/
/** 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>
+#include <yaz/test.h>
+#include <yaz/oid_db.h>
+
+/**
+ * tl_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 tl_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 *tl_get_srcdir(void);
+
+/**
+ * start_log: open a log file
+ */
+/* FIXME - parse command line arguments to set log levels etc */
+void tl_start_log(int argc, char **argv);
+
+/**
+ * tl_zebra_start - 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 tl_zebra_start(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 tl_close_down(ZebraHandle zh, ZebraService zs
+ ) ZEBRA_GCC_ATTR((warn_unused_result));
+
+/** inits the database and inserts test data */
+int tl_init_data(ZebraHandle zh, const char **recs
+ ) ZEBRA_GCC_ATTR((warn_unused_result));
+
+/**
+ * tl_query does a simple query, and checks that the number of hits matches
+ */
+int tl_query(ZebraHandle zh, const char *query, zint exphits
+ ) ZEBRA_GCC_ATTR((warn_unused_result));
+
+
+/**
+ * tl_query does a simple query, and checks that error is what is expected
+ */
+int tl_query_x(ZebraHandle zh, const char *query, zint exphits,
+ int experror
+ ) ZEBRA_GCC_ATTR((warn_unused_result));
+
+/**
+ * tl_scan is a utility for scan testing
+ */
+int tl_scan(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) */
+ ) ZEBRA_GCC_ATTR((warn_unused_result));
+int tl_sort(ZebraHandle zh, const char *query, zint hits, zint *exp
+ ) ZEBRA_GCC_ATTR((warn_unused_result));
-/** read zebra.cfg from env var srcdir if it exists; otherwise current dir */
-ZebraService start_service();
+/**
+ * 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
+ */
+int tl_ranking_query(ZebraHandle zh, char *query,
+ int exphits, char *firstrec, int firstscore
+ ) ZEBRA_GCC_ATTR((warn_unused_result));
/**
- * 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)
+ */
+int tl_meta_query(ZebraHandle zh, char *query, int exphits,
+ zint *ids
+ ) ZEBRA_GCC_ATTR((warn_unused_result));
+
+/**
+ * if filter given by name does not exist, exit nicely but warn in log
*/
-void RankingQuery(int lineno, ZebraHandle zh, char *query,
- int exphits, char *firstrec, int firstscore );
+void tl_check_filter(ZebraService zs, const char *name);
+
+ZEBRA_RES tl_fetch_first_compare(ZebraHandle zh,
+ const char *element_set,
+ const Odr_oid *format, const char *cmp_rec);
+ZEBRA_RES tl_fetch(ZebraHandle zh,
+ int position, const char *element_set,
+ const Odr_oid * format, ODR odr,
+ const char **rec_buf, size_t *rec_len);
+ZEBRA_RES tl_fetch_compare(ZebraHandle zh,
+ int position, const char *element_set,
+ const Odr_oid *format, const char *cmp_rec);
+
+#define TL_MAIN int main(int argc, char **argv) { \
+ YAZ_CHECK_INIT(argc, argv); YAZ_CHECK_LOG(); tst(argc, argv); YAZ_CHECK_TERM; }
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
projects / idzebra-moved-to-github.git / blobdiff