e1c485cd52019001007a69e2f86c6dea19e1f3b0
[idzebra-moved-to-github.git] / test / api / testlib.h
1 /* $Id: testlib.h,v 1.4 2004-11-19 10:27:16 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/ylog.h>
27 #include <yaz/pquery.h>
28 #include <idzebra/api.h>
29
30 int log_level;
31
32
33 /** 
34  * start_up : Does all the usual start functions
35  *    - nmem_init
36  *    - build the name of logfile from argv[0], and open it
37  *      if no argv passed, do not open a log
38  *    - read zebra.cfg from env var srcdir if it exists; otherwise current dir 
39  *      default to zebra.cfg, if no name is given
40  */
41 ZebraService start_up(char *cfgname, int argc, char **argv);
42
43 /** 
44  * start_log: open a log file 
45  */
46 /*    FIXME - parse command line arguments to set log levels etc */
47 void start_log(int argc, char **argv);
48
49 /** 
50  * start_service - do a zebra_start with a decent config name 
51  * Takes care of checking the environment for srcdir (as needed by distcheck)
52  * and uses that if need be. 
53  * The name defaults to zebra.cfg, if null or emtpy
54  */
55 ZebraService start_service(char *cfgname);
56
57
58 /** 
59  * close_down closes it all down
60  * Does a zebra_close on zh, if not null.
61  * Does a zebra_stop on zs, if not null 
62  * Writes a log message, OK if retcode is zero, error if not
63  * closes down nmem and xmalloc
64  * returns the retcode, for use in return or exit in main()
65  */
66 int close_down(ZebraHandle zh, ZebraService zs, int retcode);
67
68 /** inits the database and inserts test data */
69 void init_data( ZebraHandle zh, const char **recs);
70
71
72 /**
73  * do_query does a simple query, and checks that the number of hits matches
74  */
75 int do_query(int lineno, ZebraHandle zh, char *query, int exphits);
76
77
78 /** 
79  * ranking_query makes a query, checks number of hits, and for 
80  * the first hit, that it contains the given string, and that it 
81  * gets the right score
82  */
83 void ranking_query(int lineno, ZebraHandle zh, char *query, 
84           int exphits, char *firstrec, int firstscore );
85