113755dbbd7924afa05912e09ec7e546b686e408
[idzebra-moved-to-github.git] / test / api / testlib.h
1 /* $Id: testlib.h,v 1.7 2004-12-14 10:30:42 heikki Exp $
2    Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004
3    Index Data Aps
4
5 This file is part of the Zebra server.
6
7 Zebra is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
10 version.
11
12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15 for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with Zebra; see the file LICENSE.zebra.  If not, write to the
19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
20 02111-1307, USA.
21 */
22
23 /** testlib - utilities for the api tests */
24
25 #include <stdlib.h>
26 #include <yaz/yconfig.h>
27 #include <yaz/pquery.h>
28 #include <yaz/log.h>
29 #include <idzebra/api.h>
30
31 int log_level;
32
33
34 /** 
35  * start_up : Does all the usual start functions
36  *    - nmem_init
37  *    - build the name of logfile from argv[0], and open it
38  *      if no argv passed, do not open a log
39  *    - read zebra.cfg from env var srcdir if it exists; otherwise current dir 
40  *      default to zebra.cfg, if no name is given
41  */
42 ZebraService start_up(char *cfgname, int argc, char **argv);
43
44 /** 
45  * start_log: open a log file 
46  */
47 /*    FIXME - parse command line arguments to set log levels etc */
48 void start_log(int argc, char **argv);
49
50 /** 
51  * start_service - do a zebra_start with a decent config name 
52  * Takes care of checking the environment for srcdir (as needed by distcheck)
53  * and uses that if need be. 
54  * The name defaults to zebra.cfg, if null or emtpy
55  */
56 ZebraService start_service(char *cfgname);
57
58
59 /** 
60  * close_down closes it all down
61  * Does a zebra_close on zh, if not null.
62  * Does a zebra_stop on zs, if not null 
63  * Writes a log message, OK if retcode is zero, error if not
64  * closes down nmem and xmalloc
65  * returns the retcode, for use in return or exit in main()
66  */
67 int close_down(ZebraHandle zh, ZebraService zs, int retcode);
68
69 /** inits the database and inserts test data */
70 void init_data( ZebraHandle zh, const char **recs);
71
72
73 /**
74  * do_query does a simple query, and checks that the number of hits matches
75  */
76 int do_query(int lineno, ZebraHandle zh, char *query, int exphits);
77
78
79 /** 
80  * ranking_query makes a query, checks number of hits, and for 
81  * the first hit, that it contains the given string, and that it 
82  * gets the right score
83  */
84 void ranking_query(int lineno, ZebraHandle zh, char *query, 
85           int exphits, char *firstrec, int firstscore );
86
87 /** 
88  * meta_query makes a query, checks number of hits, and for 
89  * checks that the all records in result set has the proper identifiers (ids)
90  */
91 void meta_query(int lineno, ZebraHandle zh, char *query, int exphits,
92                 zint *ids);