Updated copyright headers. Omit CVS ID.
[metaproxy-moved-to-github.git] / src / test_filter_query_rewrite.cpp
1 /* This file is part of Metaproxy.
2    Copyright (C) 2005-2008 Index Data
3
4 Metaproxy is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
7 version.
8
9 Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12 for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17 */
18
19 #include "config.hpp"
20 #include <iostream>
21 #include <stdexcept>
22
23 #include "filter_query_rewrite.hpp"
24 #include "util.hpp"
25 #include "router_chain.hpp"
26 #include "session.hpp"
27 #include "package.hpp"
28
29 #define BOOST_AUTO_TEST_MAIN
30 #define BOOST_TEST_DYN_LINK
31 #include <boost/test/auto_unit_test.hpp>
32
33 using namespace boost::unit_test;
34
35 namespace mp = metaproxy_1;
36 using namespace mp::util;
37
38 class FilterBounceZ3950: public mp::filter::Base {
39 public:
40     void process(mp::Package & package) const {
41         
42         if (package.session().is_closed())
43         {
44             std::cout << "Got Close.\n";
45             return;
46         }
47        
48         Z_GDU *gdu = package.request().get();
49         
50         if (gdu && gdu->which == Z_GDU_Z3950 
51             && gdu->u.z3950->which == Z_APDU_initRequest)
52         {
53             std::cout << "Got Z3950 Init PDU\n";         
54             //Z_InitRequest *req = gdu->u.z3950->u.initRequest;
55             //package.request() = gdu;
56             return;
57         } 
58         else if (gdu && gdu->which == Z_GDU_Z3950 
59                  && gdu->u.z3950->which == Z_APDU_searchRequest)
60         {
61             std::cout << "Got Z3950 Search PDU\n";   
62             //Z_SearchRequest *req = gdu->u.z3950->u.searchRequest;
63             //package.request() = gdu;
64             return;
65         } 
66         else if (gdu && gdu->which == Z_GDU_Z3950 
67                  && gdu->u.z3950->which == Z_APDU_scanRequest)
68         {
69             std::cout << "Got Z3950 Scan PDU\n";   
70             //Z_ScanRequest *req = gdu->u.z3950->u.scanRequest;
71             //package.request() = gdu;
72             return;
73         } 
74         
75         package.move();
76     };
77 };
78
79 void check_query_rewrite_init(mp::RouterChain &router)
80 {
81     //std::cout << "QUERY REWRITE INIT\n";
82
83     // Create package with Z39.50 init request in it
84     mp::Package pack;
85         
86     mp::odr odr;
87     Z_APDU *apdu = zget_APDU(odr, Z_APDU_initRequest);
88     
89     pack.request() = apdu;
90     // Done creating query.
91
92     // Put it in router
93     pack.router(router).move(); 
94     
95     // Inspect bounced back request
96     //yazpp_1::GDU *gdu = &pack.response();
97     yazpp_1::GDU *gdu = &pack.request();
98     
99     Z_GDU *z_gdu = gdu->get();
100
101     //std::cout << "Z_GDU " << z_gdu << "\n";
102     BOOST_CHECK(z_gdu);
103     if (z_gdu) {
104         BOOST_CHECK_EQUAL(z_gdu->which, Z_GDU_Z3950);
105         BOOST_CHECK_EQUAL(z_gdu->u.z3950->which, Z_APDU_initRequest);
106     }
107 }
108
109 void check_query_rewrite_search(mp::RouterChain &router, 
110                                 std::string query_in,
111                                 std::string query_expect)
112 {
113     //std::cout << "QUERY REWRITE SEARCH " 
114     //          << query_in << " " << query_expect << "\n";
115     
116     // Create package with Z39.50 search request in it
117     mp::Package pack;
118         
119     mp::odr odr;
120     Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchRequest);
121
122     // create package PQF query here    
123     mp::util::pqf(odr, apdu, query_in);
124
125     // create package PDF database info (needed!)
126     apdu->u.searchRequest->num_databaseNames = 1;
127     apdu->u.searchRequest->databaseNames 
128         = (char**)odr_malloc(odr, sizeof(char *));
129     apdu->u.searchRequest->databaseNames[0] = odr_strdup(odr, "Default");
130
131     // Done creating request package  
132     pack.request() = apdu;
133     
134     // Put it in router
135     pack.router(router).move(); 
136     
137     // Inspect bounced back request
138     //yazpp_1::GDU *gdu = &pack.response();
139     yazpp_1::GDU *gdu = &pack.request();
140     
141     Z_GDU *z_gdu = gdu->get();
142     //std::cout << "Z_GDU " << z_gdu << "\n";
143     
144     BOOST_CHECK(z_gdu);
145     if (z_gdu) {
146         BOOST_CHECK_EQUAL(z_gdu->which, Z_GDU_Z3950);
147         BOOST_CHECK_EQUAL(z_gdu->u.z3950->which, Z_APDU_searchRequest);
148
149         // take query out of package again and check rewrite
150         std::string query_changed 
151             = zQueryToString(z_gdu->u.z3950->u.searchRequest->query);
152         BOOST_CHECK_EQUAL(query_expect, query_changed);
153     }
154 }
155
156
157 BOOST_AUTO_TEST_CASE( test_filter_query_rewrite_1 )
158 {
159     try 
160     {
161         mp::filter::QueryRewrite f_query_rewrite;
162     }
163     catch ( ... ) {
164         BOOST_CHECK (false);
165     }
166 }
167
168 BOOST_AUTO_TEST_CASE( test_filter_query_rewrite2 )
169 {
170     try 
171     {
172         mp::RouterChain router;
173         
174         mp::filter::QueryRewrite f_query_rewrite;
175         //FilterBounceZ3950 f_bounce_z3950;
176         
177         router.append(f_query_rewrite);
178         //router.append(f_bounce_z3950);
179
180         check_query_rewrite_init(router);
181         check_query_rewrite_search(router, 
182                                    "@attrset Bib-1 @attr 1=4 the", 
183                                    "@attrset Bib-1 @attr 1=4 the");
184
185     }
186     catch ( ... ) {
187         BOOST_CHECK (false);
188     }
189 }
190
191
192 BOOST_AUTO_TEST_CASE( test_filter_query_rewrite3 )
193 {
194     
195
196     try 
197     {
198         mp::RouterChain router;
199         
200
201         std::string xmlconf = 
202             "<?xml version='1.0'?>\n"
203             "<filter xmlns='http://indexdata.com/metaproxy'\n"
204             "        id='qrw1' type='query_rewrite'>\n"
205             "</filter>\n"
206             ;
207          
208         //std::cout << xmlconf  << std::endl;
209
210         // reading and parsing XML conf
211         xmlDocPtr doc = xmlParseMemory(xmlconf.c_str(), xmlconf.size());
212         BOOST_CHECK(doc);
213         xmlNode *root_element = xmlDocGetRootElement(doc);
214
215         // creating and configuring filter
216         mp::filter::QueryRewrite f_query_rewrite;
217         f_query_rewrite.configure(root_element, true);
218         
219         // remeber to free XML DOM
220         xmlFreeDoc(doc);
221         
222         // add only filter to router
223         router.append(f_query_rewrite);
224
225         // start testing
226         check_query_rewrite_init(router);
227         check_query_rewrite_search(router, 
228                                    "@attrset Bib-1 @attr 1=4 the", 
229                                    "@attrset Bib-1 @attr 1=4 the");
230
231     }
232
233     catch (std::exception &e) {
234         std::cout << e.what() << "\n";
235         BOOST_CHECK (false);
236     }
237
238     catch ( ... ) {
239         BOOST_CHECK (false);
240     }
241 }
242
243 /*
244  * Local variables:
245  * c-basic-offset: 4
246  * indent-tabs-mode: nil
247  * c-file-style: "stroustrup"
248  * End:
249  * vim: shiftwidth=4 tabstop=8 expandtab
250  */