]> git.openstreetmap.org Git - nominatim.git/blob - test/bdd/steps/steps_api_queries.py
switch BDD tests to always use search API
[nominatim.git] / test / bdd / steps / steps_api_queries.py
1 """ Steps that run queries against the API.
2
3     Queries may either be run directly via PHP using the query script
4     or via the HTTP interface using php-cgi.
5 """
6 import json
7 import os
8 import re
9 import logging
10 from urllib.parse import urlencode
11
12 from utils import run_script
13 from http_responses import GenericResponse, SearchResponse, ReverseResponse, StatusResponse
14 from check_functions import Bbox
15 from table_compare import NominatimID
16
17 LOG = logging.getLogger(__name__)
18
19 BASE_SERVER_ENV = {
20     'HTTP_HOST' : 'localhost',
21     'HTTP_USER_AGENT' : 'Mozilla/5.0 (X11; Linux x86_64; rv:51.0) Gecko/20100101 Firefox/51.0',
22     'HTTP_ACCEPT' : 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8',
23     'HTTP_ACCEPT_ENCODING' : 'gzip, deflate',
24     'HTTP_CONNECTION' : 'keep-alive',
25     'SERVER_SIGNATURE' : '<address>Nominatim BDD Tests</address>',
26     'SERVER_SOFTWARE' : 'Nominatim test',
27     'SERVER_NAME' : 'localhost',
28     'SERVER_ADDR' : '127.0.1.1',
29     'SERVER_PORT' : '80',
30     'REMOTE_ADDR' : '127.0.0.1',
31     'DOCUMENT_ROOT' : '/var/www',
32     'REQUEST_SCHEME' : 'http',
33     'CONTEXT_PREFIX' : '/',
34     'SERVER_ADMIN' : 'webmaster@localhost',
35     'REMOTE_PORT' : '49319',
36     'GATEWAY_INTERFACE' : 'CGI/1.1',
37     'SERVER_PROTOCOL' : 'HTTP/1.1',
38     'REQUEST_METHOD' : 'GET',
39     'REDIRECT_STATUS' : 'CGI'
40 }
41
42
43 def compare(operator, op1, op2):
44     if operator == 'less than':
45         return op1 < op2
46     elif operator == 'more than':
47         return op1 > op2
48     elif operator == 'exactly':
49         return op1 == op2
50     elif operator == 'at least':
51         return op1 >= op2
52     elif operator == 'at most':
53         return op1 <= op2
54     else:
55         raise Exception("unknown operator '%s'" % operator)
56
57
58 def send_api_query(endpoint, params, fmt, context):
59     if fmt is not None and fmt.strip() != 'debug':
60         params['format'] = fmt.strip()
61     if context.table:
62         if context.table.headings[0] == 'param':
63             for line in context.table:
64                 params[line['param']] = line['value']
65         else:
66             for h in context.table.headings:
67                 params[h] = context.table[0][h]
68
69     env = dict(BASE_SERVER_ENV)
70     env['QUERY_STRING'] = urlencode(params)
71
72     env['SCRIPT_NAME'] = '/%s.php' % endpoint
73     env['REQUEST_URI'] = '%s?%s' % (env['SCRIPT_NAME'], env['QUERY_STRING'])
74     env['CONTEXT_DOCUMENT_ROOT'] = os.path.join(context.nominatim.website_dir.name, 'website')
75     env['SCRIPT_FILENAME'] = os.path.join(env['CONTEXT_DOCUMENT_ROOT'],
76                                           '%s.php' % endpoint)
77
78     LOG.debug("Environment:" + json.dumps(env, sort_keys=True, indent=2))
79
80     if hasattr(context, 'http_headers'):
81         env.update(context.http_headers)
82
83     cmd = ['/usr/bin/env', 'php-cgi', '-f']
84     if context.nominatim.code_coverage_path:
85         env['COV_SCRIPT_FILENAME'] = env['SCRIPT_FILENAME']
86         env['COV_PHP_DIR'] = context.nominatim.src_dir
87         env['COV_TEST_NAME'] = '%s:%s' % (context.scenario.filename, context.scenario.line)
88         env['SCRIPT_FILENAME'] = \
89                 os.path.join(os.path.split(__file__)[0], 'cgi-with-coverage.php')
90         cmd.append(env['SCRIPT_FILENAME'])
91         env['PHP_CODE_COVERAGE_FILE'] = context.nominatim.next_code_coverage_file()
92     else:
93         cmd.append(env['SCRIPT_FILENAME'])
94
95     for k,v in params.items():
96         cmd.append("%s=%s" % (k, v))
97
98     outp, err = run_script(cmd, cwd=context.nominatim.website_dir.name, env=env)
99
100     assert len(err) == 0, "Unexpected PHP error: %s" % (err)
101
102     if outp.startswith('Status: '):
103         status = int(outp[8:11])
104     else:
105         status = 200
106
107     content_start = outp.find('\r\n\r\n')
108
109     return outp[content_start + 4:], status
110
111 @given(u'the HTTP header')
112 def add_http_header(context):
113     if not hasattr(context, 'http_headers'):
114         context.http_headers = {}
115
116     for h in context.table.headings:
117         envvar = 'HTTP_' + h.upper().replace('-', '_')
118         context.http_headers[envvar] = context.table[0][h]
119
120
121 @when(u'sending (?P<fmt>\S+ )?search query "(?P<query>.*)"(?P<addr> with address)?')
122 def website_search_request(context, fmt, query, addr):
123     params = {}
124     if query:
125         params['q'] = query
126     if addr is not None:
127         params['addressdetails'] = '1'
128     if fmt and fmt.strip() == 'debug':
129         params['debug'] = '1'
130
131     outp, status = send_api_query('search', params, fmt, context)
132
133     context.response = SearchResponse(outp, fmt or 'json', status)
134
135 @when(u'sending (?P<fmt>\S+ )?reverse coordinates (?P<lat>.+)?,(?P<lon>.+)?')
136 def website_reverse_request(context, fmt, lat, lon):
137     params = {}
138     if lat is not None:
139         params['lat'] = lat
140     if lon is not None:
141         params['lon'] = lon
142     if fmt and fmt.strip() == 'debug':
143         params['debug'] = '1'
144
145     outp, status = send_api_query('reverse', params, fmt, context)
146
147     context.response = ReverseResponse(outp, fmt or 'xml', status)
148
149 @when(u'sending (?P<fmt>\S+ )?details query for (?P<query>.*)')
150 def website_details_request(context, fmt, query):
151     params = {}
152     if query[0] in 'NWR':
153         nid = NominatimID(query)
154         params['osmtype'] = nid.typ
155         params['osmid'] = nid.oid
156         if nid.cls:
157             params['class'] = nid.cls
158     else:
159         params['place_id'] = query
160     outp, status = send_api_query('details', params, fmt, context)
161
162     context.response = GenericResponse(outp, fmt or 'json', status)
163
164 @when(u'sending (?P<fmt>\S+ )?lookup query for (?P<query>.*)')
165 def website_lookup_request(context, fmt, query):
166     params = { 'osm_ids' : query }
167     outp, status = send_api_query('lookup', params, fmt, context)
168
169     context.response = SearchResponse(outp, fmt or 'xml', status)
170
171 @when(u'sending (?P<fmt>\S+ )?status query')
172 def website_status_request(context, fmt):
173     params = {}
174     outp, status = send_api_query('status', params, fmt, context)
175
176     context.response = StatusResponse(outp, fmt or 'text', status)
177
178 @step(u'(?P<operator>less than|more than|exactly|at least|at most) (?P<number>\d+) results? (?:is|are) returned')
179 def validate_result_number(context, operator, number):
180     assert context.response.errorcode == 200
181     numres = len(context.response.result)
182     assert compare(operator, numres, int(number)), \
183         "Bad number of results: expected {} {}, got {}.".format(operator, number, numres)
184
185 @then(u'a HTTP (?P<status>\d+) is returned')
186 def check_http_return_status(context, status):
187     assert context.response.errorcode == int(status), \
188            "Return HTTP status is {}.".format(context.response.errorcode)
189
190 @then(u'the page contents equals "(?P<text>.+)"')
191 def check_page_content_equals(context, text):
192     assert context.response.page == text
193
194 @then(u'the result is valid (?P<fmt>\w+)')
195 def step_impl(context, fmt):
196     context.execute_steps("Then a HTTP 200 is returned")
197     assert context.response.format == fmt
198
199 @then(u'a (?P<fmt>\w+) user error is returned')
200 def check_page_error(context, fmt):
201     context.execute_steps("Then a HTTP 400 is returned")
202     assert context.response.format == fmt
203
204     if fmt == 'xml':
205         assert re.search(r'<error>.+</error>', context.response.page, re.DOTALL) is not None
206     else:
207         assert re.search(r'({"error":)', context.response.page, re.DOTALL) is not None
208
209 @then(u'result header contains')
210 def check_header_attr(context):
211     for line in context.table:
212         assert re.fullmatch(line['value'], context.response.header[line['attr']]) is not None, \
213                "attribute '%s': expected: '%s', got '%s'" % (
214                     line['attr'], line['value'],
215                     context.response.header[line['attr']])
216
217 @then(u'result header has (?P<neg>not )?attributes (?P<attrs>.*)')
218 def check_header_no_attr(context, neg, attrs):
219     for attr in attrs.split(','):
220         if neg:
221             assert attr not in context.response.header, \
222                    "Unexpected attribute {}. Full response:\n{}".format(
223                        attr, json.dumps(context.response.header, sort_keys=True, indent=2))
224         else:
225             assert attr in context.response.header, \
226                    "No attribute {}. Full response:\n{}".format(
227                        attr, json.dumps(context.response.header, sort_keys=True, indent=2))
228
229 @then(u'results contain')
230 def step_impl(context):
231     context.execute_steps("then at least 1 result is returned")
232
233     for line in context.table:
234         context.response.match_row(line)
235
236 @then(u'result (?P<lid>\d+ )?has (?P<neg>not )?attributes (?P<attrs>.*)')
237 def validate_attributes(context, lid, neg, attrs):
238     if lid is None:
239         idx = range(len(context.response.result))
240         context.execute_steps("then at least 1 result is returned")
241     else:
242         idx = [int(lid.strip())]
243         context.execute_steps("then more than %sresults are returned" % lid)
244
245     for i in idx:
246         for attr in attrs.split(','):
247             if neg:
248                 assert attr not in context.response.result[i],\
249                        "Unexpected attribute {}. Full response:\n{}".format(
250                            attr, json.dumps(context.response.result[i], sort_keys=True, indent=2))
251             else:
252                 assert attr in context.response.result[i], \
253                        "No attribute {}. Full response:\n{}".format(
254                            attr, json.dumps(context.response.result[i], sort_keys=True, indent=2))
255
256 @then(u'result addresses contain')
257 def step_impl(context):
258     context.execute_steps("then at least 1 result is returned")
259
260     for line in context.table:
261         idx = int(line['ID']) if 'ID' in line.headings else None
262
263         for name, value in zip(line.headings, line.cells):
264             if name != 'ID':
265                 context.response.assert_address_field(idx, name, value)
266
267 @then(u'address of result (?P<lid>\d+) has(?P<neg> no)? types (?P<attrs>.*)')
268 def check_address(context, lid, neg, attrs):
269     context.execute_steps("then more than %s results are returned" % lid)
270
271     addr_parts = context.response.result[int(lid)]['address']
272
273     for attr in attrs.split(','):
274         if neg:
275             assert attr not in addr_parts
276         else:
277             assert attr in addr_parts
278
279 @then(u'address of result (?P<lid>\d+) (?P<complete>is|contains)')
280 def check_address(context, lid, complete):
281     context.execute_steps("then more than %s results are returned" % lid)
282
283     lid = int(lid)
284     addr_parts = dict(context.response.result[lid]['address'])
285
286     for line in context.table:
287         context.response.assert_address_field(lid, line['type'], line['value'])
288         del addr_parts[line['type']]
289
290     if complete == 'is':
291         assert len(addr_parts) == 0, "Additional address parts found: %s" % str(addr_parts)
292
293 @then(u'result (?P<lid>\d+ )?has bounding box in (?P<coords>[\d,.-]+)')
294 def step_impl(context, lid, coords):
295     if lid is None:
296         context.execute_steps("then at least 1 result is returned")
297         bboxes = context.response.property_list('boundingbox')
298     else:
299         context.execute_steps("then more than {}results are returned".format(lid))
300         bboxes = [context.response.result[int(lid)]['boundingbox']]
301
302     expected = Bbox(coords)
303
304     for bbox in bboxes:
305         assert bbox in expected, "Bbox {} is not contained in {}.".format(bbox, expected)
306
307 @then(u'result (?P<lid>\d+ )?has centroid in (?P<coords>[\d,.-]+)')
308 def step_impl(context, lid, coords):
309     if lid is None:
310         context.execute_steps("then at least 1 result is returned")
311         centroids = zip(context.response.property_list('lon'),
312                         context.response.property_list('lat'))
313     else:
314         context.execute_steps("then more than %sresults are returned".format(lid))
315         res = context.response.result[int(lid)]
316         centroids = [(res['lon'], res['lat'])]
317
318     expected = Bbox(coords)
319
320     for centroid in centroids:
321         assert centroid in expected,\
322                "Centroid {} is not inside {}.".format(centroid, expected)
323
324 @then(u'there are(?P<neg> no)? duplicates')
325 def check_for_duplicates(context, neg):
326     context.execute_steps("then at least 1 result is returned")
327
328     resarr = set()
329     has_dupe = False
330
331     for res in context.response.result:
332         dup = (res['osm_type'], res['class'], res['type'], res['display_name'])
333         if dup in resarr:
334             has_dupe = True
335             break
336         resarr.add(dup)
337
338     if neg:
339         assert not has_dupe, "Found duplicate for %s" % (dup, )
340     else:
341         assert has_dupe, "No duplicates found"