]> git.openstreetmap.org Git - nominatim.git/blob - test/bdd/steps/queries.py
linked centroids must always be within geometry
[nominatim.git] / test / bdd / steps / queries.py
1 """ Steps that run search queries.
2
3     Queries may either be run directly via PHP using the query script
4     or via the HTTP interface.
5 """
6
7 import json
8 import os
9 import io
10 import re
11 import logging
12 from tidylib import tidy_document
13 import xml.etree.ElementTree as ET
14 import subprocess
15 from urllib.parse import urlencode
16 from collections import OrderedDict
17 from nose.tools import * # for assert functions
18
19 logger = logging.getLogger(__name__)
20
21 BASE_SERVER_ENV = {
22     'HTTP_HOST' : 'localhost',
23     'HTTP_USER_AGENT' : 'Mozilla/5.0 (X11; Linux x86_64; rv:51.0) Gecko/20100101 Firefox/51.0',
24     'HTTP_ACCEPT' : 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8',
25     'HTTP_ACCEPT_ENCODING' : 'gzip, deflate',
26     'HTTP_CONNECTION' : 'keep-alive',
27     'SERVER_SIGNATURE' : '<address>Nominatim BDD Tests</address>',
28     'SERVER_SOFTWARE' : 'Nominatim test',
29     'SERVER_NAME' : 'localhost',
30     'SERVER_ADDR' : '127.0.1.1',
31     'SERVER_PORT' : '80',
32     'REMOTE_ADDR' : '127.0.0.1',
33     'DOCUMENT_ROOT' : '/var/www',
34     'REQUEST_SCHEME' : 'http',
35     'CONTEXT_PREFIX' : '/',
36     'SERVER_ADMIN' : 'webmaster@localhost',
37     'REMOTE_PORT' : '49319',
38     'GATEWAY_INTERFACE' : 'CGI/1.1',
39     'SERVER_PROTOCOL' : 'HTTP/1.1',
40     'REQUEST_METHOD' : 'GET',
41     'REDIRECT_STATUS' : 'CGI'
42 }
43
44
45 def compare(operator, op1, op2):
46     if operator == 'less than':
47         return op1 < op2
48     elif operator == 'more than':
49         return op1 > op2
50     elif operator == 'exactly':
51         return op1 == op2
52     elif operator == 'at least':
53         return op1 >= op2
54     elif operator == 'at most':
55         return op1 <= op2
56     else:
57         raise Exception("unknown operator '%s'" % operator)
58
59 class GenericResponse(object):
60
61     def match_row(self, row):
62         if 'ID' in row.headings:
63             todo = [int(row['ID'])]
64         else:
65             todo = range(len(self.result))
66
67         for i in todo:
68             res = self.result[i]
69             for h in row.headings:
70                 if h == 'ID':
71                     pass
72                 elif h == 'osm':
73                     assert_equal(res['osm_type'], row[h][0])
74                     assert_equal(res['osm_id'], int(row[h][1:]))
75                 elif h == 'centroid':
76                     x, y = row[h].split(' ')
77                     assert_almost_equal(float(y), float(res['lat']))
78                     assert_almost_equal(float(x), float(res['lon']))
79                 elif row[h].startswith("^"):
80                     assert_in(h, res)
81                     assert_is_not_none(re.fullmatch(row[h], res[h]),
82                                        "attribute '%s': expected: '%s', got '%s'"
83                                           % (h, row[h], res[h]))
84                 else:
85                     assert_in(h, res)
86                     assert_equal(str(res[h]), str(row[h]))
87
88     def property_list(self, prop):
89         return [ x[prop] for x in self.result ]
90
91
92 class SearchResponse(GenericResponse):
93
94     def __init__(self, page, fmt='json', errorcode=200):
95         self.page = page
96         self.format = fmt
97         self.errorcode = errorcode
98         self.result = []
99         self.header = dict()
100
101         if errorcode == 200:
102             getattr(self, 'parse_' + fmt)()
103
104     def parse_json(self):
105         m = re.fullmatch(r'([\w$][^(]*)\((.*)\)', self.page)
106         if m is None:
107             code = self.page
108         else:
109             code = m.group(2)
110             self.header['json_func'] = m.group(1)
111         self.result = json.JSONDecoder(object_pairs_hook=OrderedDict).decode(code)
112
113     def parse_geojson(self):
114         self.parse_json()
115         self.result = geojson_results_to_json_results(self.result)
116
117     def parse_geocodejson(self):
118         return self.parse_geojson()
119
120     def parse_html(self):
121         content, errors = tidy_document(self.page,
122                                         options={'char-encoding' : 'utf8'})
123         #eq_(len(errors), 0 , "Errors found in HTML document:\n%s" % errors)
124
125         self.result = []
126         b = content.find('nominatim_results =')
127         e = content.find('</script>')
128         if b >= 0 and e >= 0:
129             content = content[b:e]
130
131             b = content.find('[')
132             e = content.rfind(']')
133             if b >= 0 and e >= 0:
134                 self.result = json.JSONDecoder(object_pairs_hook=OrderedDict)\
135                                   .decode(content[b:e+1])
136
137     def parse_xml(self):
138         et = ET.fromstring(self.page)
139
140         self.header = dict(et.attrib)
141
142         for child in et:
143             assert_equal(child.tag, "place")
144             self.result.append(dict(child.attrib))
145
146             address = {}
147             for sub in child:
148                 if sub.tag == 'extratags':
149                     self.result[-1]['extratags'] = {}
150                     for tag in sub:
151                         self.result[-1]['extratags'][tag.attrib['key']] = tag.attrib['value']
152                 elif sub.tag == 'namedetails':
153                     self.result[-1]['namedetails'] = {}
154                     for tag in sub:
155                         self.result[-1]['namedetails'][tag.attrib['desc']] = tag.text
156                 elif sub.tag in ('geokml'):
157                     self.result[-1][sub.tag] = True
158                 else:
159                     address[sub.tag] = sub.text
160
161             if len(address) > 0:
162                 self.result[-1]['address'] = address
163
164
165 class ReverseResponse(GenericResponse):
166
167     def __init__(self, page, fmt='json', errorcode=200):
168         self.page = page
169         self.format = fmt
170         self.errorcode = errorcode
171         self.result = []
172         self.header = dict()
173
174         if errorcode == 200:
175             getattr(self, 'parse_' + fmt)()
176
177     def parse_html(self):
178         content, errors = tidy_document(self.page,
179                                         options={'char-encoding' : 'utf8'})
180         #eq_(len(errors), 0 , "Errors found in HTML document:\n%s" % errors)
181
182         b = content.find('nominatim_results =')
183         e = content.find('</script>')
184         content = content[b:e]
185         b = content.find('[')
186         e = content.rfind(']')
187
188         self.result = json.JSONDecoder(object_pairs_hook=OrderedDict).decode(content[b:e+1])
189
190     def parse_json(self):
191         m = re.fullmatch(r'([\w$][^(]*)\((.*)\)', self.page)
192         if m is None:
193             code = self.page
194         else:
195             code = m.group(2)
196             self.header['json_func'] = m.group(1)
197         self.result = [json.JSONDecoder(object_pairs_hook=OrderedDict).decode(code)]
198
199     def parse_geojson(self):
200         self.parse_json()
201         if 'error' in self.result:
202             return
203         self.result = geojson_results_to_json_results(self.result[0])
204
205     def parse_geocodejson(self):
206         return self.parse_geojson()
207
208     def parse_xml(self):
209         et = ET.fromstring(self.page)
210
211         self.header = dict(et.attrib)
212         self.result = []
213
214         for child in et:
215             if child.tag == 'result':
216                 eq_(0, len(self.result), "More than one result in reverse result")
217                 self.result.append(dict(child.attrib))
218             elif child.tag == 'addressparts':
219                 address = {}
220                 for sub in child:
221                     address[sub.tag] = sub.text
222                 self.result[0]['address'] = address
223             elif child.tag == 'extratags':
224                 self.result[0]['extratags'] = {}
225                 for tag in child:
226                     self.result[0]['extratags'][tag.attrib['key']] = tag.attrib['value']
227             elif child.tag == 'namedetails':
228                 self.result[0]['namedetails'] = {}
229                 for tag in child:
230                     self.result[0]['namedetails'][tag.attrib['desc']] = tag.text
231             elif child.tag in ('geokml'):
232                 self.result[0][child.tag] = True
233             else:
234                 assert child.tag == 'error', \
235                         "Unknown XML tag %s on page: %s" % (child.tag, self.page)
236
237
238 class DetailsResponse(GenericResponse):
239
240     def __init__(self, page, fmt='json', errorcode=200):
241         self.page = page
242         self.format = fmt
243         self.errorcode = errorcode
244         self.result = []
245         self.header = dict()
246
247         if errorcode == 200:
248             getattr(self, 'parse_' + fmt)()
249
250     def parse_html(self):
251         content, errors = tidy_document(self.page,
252                                         options={'char-encoding' : 'utf8'})
253         self.result = {}
254
255     def parse_json(self):
256         self.result = [json.JSONDecoder(object_pairs_hook=OrderedDict).decode(self.page)]
257
258
259 class StatusResponse(GenericResponse):
260
261     def __init__(self, page, fmt='text', errorcode=200):
262         self.page = page
263         self.format = fmt
264         self.errorcode = errorcode
265
266         if errorcode == 200 and fmt != 'text':
267             getattr(self, 'parse_' + fmt)()
268
269     def parse_json(self):
270         self.result = [json.JSONDecoder(object_pairs_hook=OrderedDict).decode(self.page)]
271
272
273 def geojson_result_to_json_result(geojson_result):
274     result = geojson_result['properties']
275     result['geojson'] = geojson_result['geometry']
276     if 'bbox' in geojson_result:
277         # bbox is  minlon, minlat, maxlon, maxlat
278         # boundingbox is minlat, maxlat, minlon, maxlon
279         result['boundingbox'] = [
280                                     geojson_result['bbox'][1],
281                                     geojson_result['bbox'][3],
282                                     geojson_result['bbox'][0],
283                                     geojson_result['bbox'][2]
284                                 ]
285     return result
286
287
288 def geojson_results_to_json_results(geojson_results):
289     if 'error' in geojson_results:
290         return
291     return list(map(geojson_result_to_json_result, geojson_results['features']))
292
293
294 @when(u'searching for "(?P<query>.*)"(?P<dups> with dups)?')
295 def query_cmd(context, query, dups):
296     """ Query directly via PHP script.
297     """
298     cmd = ['/usr/bin/env', 'php']
299     cmd.append(os.path.join(context.nominatim.build_dir, 'utils', 'query.php'))
300     if query:
301         cmd.extend(['--search', query])
302     # add more parameters in table form
303     if context.table:
304         for h in context.table.headings:
305             value = context.table[0][h].strip()
306             if value:
307                 cmd.extend(('--' + h, value))
308
309     if dups:
310         cmd.extend(('--dedupe', '0'))
311
312     proc = subprocess.Popen(cmd, cwd=context.nominatim.build_dir,
313                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
314     (outp, err) = proc.communicate()
315
316     assert_equals (0, proc.returncode, "query.php failed with message: %s\noutput: %s" % (err, outp))
317
318     context.response = SearchResponse(outp.decode('utf-8'), 'json')
319
320 def send_api_query(endpoint, params, fmt, context):
321     if fmt is not None:
322         params['format'] = fmt.strip()
323     if context.table:
324         if context.table.headings[0] == 'param':
325             for line in context.table:
326                 params[line['param']] = line['value']
327         else:
328             for h in context.table.headings:
329                 params[h] = context.table[0][h]
330
331     env = dict(BASE_SERVER_ENV)
332     env['QUERY_STRING'] = urlencode(params)
333
334     env['SCRIPT_NAME'] = '/%s.php' % endpoint
335     env['REQUEST_URI'] = '%s?%s' % (env['SCRIPT_NAME'], env['QUERY_STRING'])
336     env['CONTEXT_DOCUMENT_ROOT'] = os.path.join(context.nominatim.build_dir, 'website')
337     env['SCRIPT_FILENAME'] = os.path.join(env['CONTEXT_DOCUMENT_ROOT'],
338                                           '%s.php' % endpoint)
339     env['NOMINATIM_SETTINGS'] = context.nominatim.local_settings_file
340
341     logger.debug("Environment:" + json.dumps(env, sort_keys=True, indent=2))
342
343     if hasattr(context, 'http_headers'):
344         env.update(context.http_headers)
345
346     cmd = ['/usr/bin/env', 'php-cgi', '-f']
347     if context.nominatim.code_coverage_path:
348         env['COV_SCRIPT_FILENAME'] = env['SCRIPT_FILENAME']
349         env['COV_PHP_DIR'] = os.path.join(context.nominatim.src_dir, "lib")
350         env['COV_TEST_NAME'] = '%s:%s' % (context.scenario.filename, context.scenario.line)
351         env['SCRIPT_FILENAME'] = \
352                 os.path.join(os.path.split(__file__)[0], 'cgi-with-coverage.php')
353         cmd.append(env['SCRIPT_FILENAME'])
354         env['PHP_CODE_COVERAGE_FILE'] = context.nominatim.next_code_coverage_file()
355     else:
356         cmd.append(env['SCRIPT_FILENAME'])
357
358     for k,v in params.items():
359         cmd.append("%s=%s" % (k, v))
360
361     proc = subprocess.Popen(cmd, cwd=context.nominatim.build_dir, env=env,
362                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
363
364     (outp, err) = proc.communicate()
365     outp = outp.decode('utf-8')
366     err = err.decode("utf-8")
367
368     logger.debug("Result: \n===============================\n"
369                  + outp + "\n===============================\n")
370
371     assert_equals(0, proc.returncode,
372                   "%s failed with message: %s" % (
373                       os.path.basename(env['SCRIPT_FILENAME']),
374                       err))
375
376     assert_equals(0, len(err), "Unexpected PHP error: %s" % (err))
377
378     if outp.startswith('Status: '):
379         status = int(outp[8:11])
380     else:
381         status = 200
382
383     content_start = outp.find('\r\n\r\n')
384
385     return outp[content_start + 4:], status
386
387 @given(u'the HTTP header')
388 def add_http_header(context):
389     if not hasattr(context, 'http_headers'):
390         context.http_headers = {}
391
392     for h in context.table.headings:
393         envvar = 'HTTP_' + h.upper().replace('-', '_')
394         context.http_headers[envvar] = context.table[0][h]
395
396
397 @when(u'sending (?P<fmt>\S+ )?search query "(?P<query>.*)"(?P<addr> with address)?')
398 def website_search_request(context, fmt, query, addr):
399     params = {}
400     if query:
401         params['q'] = query
402     if addr is not None:
403         params['addressdetails'] = '1'
404
405     outp, status = send_api_query('search', params, fmt, context)
406
407     if fmt is None:
408         outfmt = 'html'
409     elif fmt == 'jsonv2 ':
410         outfmt = 'json'
411     else:
412         outfmt = fmt.strip()
413
414     context.response = SearchResponse(outp, outfmt, status)
415
416 @when(u'sending (?P<fmt>\S+ )?reverse coordinates (?P<lat>.+)?,(?P<lon>.+)?')
417 def website_reverse_request(context, fmt, lat, lon):
418     params = {}
419     if lat is not None:
420         params['lat'] = lat
421     if lon is not None:
422         params['lon'] = lon
423
424     outp, status = send_api_query('reverse', params, fmt, context)
425
426     if fmt is None:
427         outfmt = 'xml'
428     elif fmt == 'jsonv2 ':
429         outfmt = 'json'
430     else:
431         outfmt = fmt.strip()
432
433     context.response = ReverseResponse(outp, outfmt, status)
434
435 @when(u'sending (?P<fmt>\S+ )?details query for (?P<query>.*)')
436 def website_details_request(context, fmt, query):
437     params = {}
438     if query[0] in 'NWR':
439         params['osmtype'] = query[0]
440         params['osmid'] = query[1:]
441     else:
442         params['place_id'] = query
443     outp, status = send_api_query('details', params, fmt, context)
444
445     if fmt is None:
446         outfmt = 'html'
447     else:
448         outfmt = fmt.strip()
449
450     context.response = DetailsResponse(outp, outfmt, status)
451
452 @when(u'sending (?P<fmt>\S+ )?lookup query for (?P<query>.*)')
453 def website_lookup_request(context, fmt, query):
454     params = { 'osm_ids' : query }
455     outp, status = send_api_query('lookup', params, fmt, context)
456
457     if fmt == 'json ':
458         outfmt = 'json'
459     elif fmt == 'jsonv2 ':
460         outfmt = 'json'
461     elif fmt == 'geojson ':
462         outfmt = 'geojson'
463     elif fmt == 'geocodejson ':
464         outfmt = 'geocodejson'
465     else:
466         outfmt = 'xml'
467
468     context.response = SearchResponse(outp, outfmt, status)
469
470 @when(u'sending (?P<fmt>\S+ )?status query')
471 def website_status_request(context, fmt):
472     params = {}
473     outp, status = send_api_query('status', params, fmt, context)
474
475     if fmt is None:
476         outfmt = 'text'
477     else:
478         outfmt = fmt.strip()
479
480     context.response = StatusResponse(outp, outfmt, status)
481
482 @step(u'(?P<operator>less than|more than|exactly|at least|at most) (?P<number>\d+) results? (?:is|are) returned')
483 def validate_result_number(context, operator, number):
484     eq_(context.response.errorcode, 200)
485     numres = len(context.response.result)
486     ok_(compare(operator, numres, int(number)),
487         "Bad number of results: expected %s %s, got %d." % (operator, number, numres))
488
489 @then(u'a HTTP (?P<status>\d+) is returned')
490 def check_http_return_status(context, status):
491     eq_(context.response.errorcode, int(status))
492
493 @then(u'the page contents equals "(?P<text>.+)"')
494 def check_page_content_equals(context, text):
495     eq_(context.response.page, text)
496
497 @then(u'the result is valid (?P<fmt>\w+)')
498 def step_impl(context, fmt):
499     context.execute_steps("Then a HTTP 200 is returned")
500     eq_(context.response.format, fmt)
501
502 @then(u'a (?P<fmt>\w+) user error is returned')
503 def check_page_error(context, fmt):
504     context.execute_steps("Then a HTTP 400 is returned")
505     eq_(context.response.format, fmt)
506
507     if fmt == 'html':
508         assert_is_not_none(re.search(r'<html( |>).+</html>', context.response.page, re.DOTALL))
509     elif fmt == 'xml':
510         assert_is_not_none(re.search(r'<error>.+</error>', context.response.page, re.DOTALL))
511     else:
512         assert_is_not_none(re.search(r'({"error":)', context.response.page, re.DOTALL))
513
514 @then(u'result header contains')
515 def check_header_attr(context):
516     for line in context.table:
517         assert_is_not_none(re.fullmatch(line['value'], context.response.header[line['attr']]),
518                      "attribute '%s': expected: '%s', got '%s'"
519                        % (line['attr'], line['value'],
520                           context.response.header[line['attr']]))
521
522 @then(u'result header has (?P<neg>not )?attributes (?P<attrs>.*)')
523 def check_header_no_attr(context, neg, attrs):
524     for attr in attrs.split(','):
525         if neg:
526             assert_not_in(attr, context.response.header)
527         else:
528             assert_in(attr, context.response.header)
529
530 @then(u'results contain')
531 def step_impl(context):
532     context.execute_steps("then at least 1 result is returned")
533
534     for line in context.table:
535         context.response.match_row(line)
536
537 @then(u'result (?P<lid>\d+ )?has (?P<neg>not )?attributes (?P<attrs>.*)')
538 def validate_attributes(context, lid, neg, attrs):
539     if lid is None:
540         idx = range(len(context.response.result))
541         context.execute_steps("then at least 1 result is returned")
542     else:
543         idx = [int(lid.strip())]
544         context.execute_steps("then more than %sresults are returned" % lid)
545
546     for i in idx:
547         for attr in attrs.split(','):
548             if neg:
549                 assert_not_in(attr, context.response.result[i])
550             else:
551                 assert_in(attr, context.response.result[i])
552
553 @then(u'result addresses contain')
554 def step_impl(context):
555     context.execute_steps("then at least 1 result is returned")
556
557     if 'ID' not in context.table.headings:
558         addr_parts = context.response.property_list('address')
559
560     for line in context.table:
561         if 'ID' in context.table.headings:
562             addr_parts = [dict(context.response.result[int(line['ID'])]['address'])]
563
564         for h in context.table.headings:
565             if h != 'ID':
566                 for p in addr_parts:
567                     assert_in(h, p)
568                     assert_equal(p[h], line[h], "Bad address value for %s" % h)
569
570 @then(u'address of result (?P<lid>\d+) has(?P<neg> no)? types (?P<attrs>.*)')
571 def check_address(context, lid, neg, attrs):
572     context.execute_steps("then more than %s results are returned" % lid)
573
574     addr_parts = context.response.result[int(lid)]['address']
575
576     for attr in attrs.split(','):
577         if neg:
578             assert_not_in(attr, addr_parts)
579         else:
580             assert_in(attr, addr_parts)
581
582 @then(u'address of result (?P<lid>\d+) is')
583 def check_address(context, lid):
584     context.execute_steps("then more than %s results are returned" % lid)
585
586     addr_parts = dict(context.response.result[int(lid)]['address'])
587
588     for line in context.table:
589         assert_in(line['type'], addr_parts)
590         assert_equal(addr_parts[line['type']], line['value'],
591                      "Bad address value for %s" % line['type'])
592         del addr_parts[line['type']]
593
594     eq_(0, len(addr_parts), "Additional address parts found: %s" % str(addr_parts))
595
596 @then(u'result (?P<lid>\d+ )?has bounding box in (?P<coords>[\d,.-]+)')
597 def step_impl(context, lid, coords):
598     if lid is None:
599         context.execute_steps("then at least 1 result is returned")
600         bboxes = context.response.property_list('boundingbox')
601     else:
602         context.execute_steps("then more than %sresults are returned" % lid)
603         bboxes = [ context.response.result[int(lid)]['boundingbox']]
604
605     coord = [ float(x) for x in coords.split(',') ]
606
607     for bbox in bboxes:
608         if isinstance(bbox, str):
609             bbox = bbox.split(',')
610         bbox = [ float(x) for x in bbox ]
611
612         assert_greater_equal(bbox[0], coord[0])
613         assert_less_equal(bbox[1], coord[1])
614         assert_greater_equal(bbox[2], coord[2])
615         assert_less_equal(bbox[3], coord[3])
616
617 @then(u'result (?P<lid>\d+ )?has centroid in (?P<coords>[\d,.-]+)')
618 def step_impl(context, lid, coords):
619     if lid is None:
620         context.execute_steps("then at least 1 result is returned")
621         bboxes = zip(context.response.property_list('lat'),
622                      context.response.property_list('lon'))
623     else:
624         context.execute_steps("then more than %sresults are returned" % lid)
625         res = context.response.result[int(lid)]
626         bboxes = [ (res['lat'], res['lon']) ]
627
628     coord = [ float(x) for x in coords.split(',') ]
629
630     for lat, lon in bboxes:
631         lat = float(lat)
632         lon = float(lon)
633         assert_greater_equal(lat, coord[0])
634         assert_less_equal(lat, coord[1])
635         assert_greater_equal(lon, coord[2])
636         assert_less_equal(lon, coord[3])
637
638 @then(u'there are(?P<neg> no)? duplicates')
639 def check_for_duplicates(context, neg):
640     context.execute_steps("then at least 1 result is returned")
641
642     resarr = set()
643     has_dupe = False
644
645     for res in context.response.result:
646         dup = (res['osm_type'], res['class'], res['type'], res['display_name'])
647         if dup in resarr:
648             has_dupe = True
649             break
650         resarr.add(dup)
651
652     if neg:
653         assert not has_dupe, "Found duplicate for %s" % (dup, )
654     else:
655         assert has_dupe, "No duplicates found"