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'], 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_html(self):
 118         content, errors = tidy_document(self.page,
 119                                         options={'char-encoding' : 'utf8'})
 120         #eq_(len(errors), 0 , "Errors found in HTML document:\n%s" % errors)
 121
 122         b = content.find('nominatim_results =')
 123         e = content.find('</script>')
 124         content = content[b:e]
 125         b = content.find('[')
 126         e = content.rfind(']')
 127
 128         self.result = json.JSONDecoder(object_pairs_hook=OrderedDict).decode(content[b:e+1])
 129
 130     def parse_xml(self):
 131         et = ET.fromstring(self.page)
 132
 133         self.header = dict(et.attrib)
 134
 135         for child in et:
 136             assert_equal(child.tag, "place")
 137             self.result.append(dict(child.attrib))
 138
 139             address = {}
 140             for sub in child:
 141                 if sub.tag == 'extratags':
 142                     self.result[-1]['extratags'] = {}
 143                     for tag in sub:
 144                         self.result[-1]['extratags'][tag.attrib['key']] = tag.attrib['value']
 145                 elif sub.tag == 'namedetails':
 146                     self.result[-1]['namedetails'] = {}
 147                     for tag in sub:
 148                         self.result[-1]['namedetails'][tag.attrib['desc']] = tag.text
 149                 elif sub.tag in ('geokml'):
 150                     self.result[-1][sub.tag] = True
 151                 else:
 152                     address[sub.tag] = sub.text
 153
 154             if len(address) > 0:
 155                 self.result[-1]['address'] = address
 156
 157
 158 class ReverseResponse(GenericResponse):
 159
 160     def __init__(self, page, fmt='json', errorcode=200):
 161         self.page = page
 162         self.format = fmt
 163         self.errorcode = errorcode
 164         self.result = []
 165         self.header = dict()
 166
 167         if errorcode == 200:
 168             getattr(self, 'parse_' + fmt)()
 169
 170     def parse_html(self):
 171         content, errors = tidy_document(self.page,
 172                                         options={'char-encoding' : 'utf8'})
 173         #eq_(len(errors), 0 , "Errors found in HTML document:\n%s" % errors)
 174
 175         b = content.find('nominatim_results =')
 176         e = content.find('</script>')
 177         content = content[b:e]
 178         b = content.find('[')
 179         e = content.rfind(']')
 180
 181         self.result = json.JSONDecoder(object_pairs_hook=OrderedDict).decode(content[b:e+1])
 182
 183     def parse_json(self):
 184         m = re.fullmatch(r'([\w$][^(]*)\((.*)\)', self.page)
 185         if m is None:
 186             code = self.page
 187         else:
 188             code = m.group(2)
 189             self.header['json_func'] = m.group(1)
 190         self.result = [json.JSONDecoder(object_pairs_hook=OrderedDict).decode(code)]
 191
 192     def parse_geojson(self):
 193         self.parse_json()
 194         if 'error' in self.result:
 195             return
 196         self.result = geojson_results_to_json_results(self.result[0])
 197
 198     def parse_xml(self):
 199         et = ET.fromstring(self.page)
 200
 201         self.header = dict(et.attrib)
 202         self.result = []
 203
 204         for child in et:
 205             if child.tag == 'result':
 206                 eq_(0, len(self.result), "More than one result in reverse result")
 207                 self.result.append(dict(child.attrib))
 208             elif child.tag == 'addressparts':
 209                 address = {}
 210                 for sub in child:
 211                     address[sub.tag] = sub.text
 212                 self.result[0]['address'] = address
 213             elif child.tag == 'extratags':
 214                 self.result[0]['extratags'] = {}
 215                 for tag in child:
 216                     self.result[0]['extratags'][tag.attrib['key']] = tag.attrib['value']
 217             elif child.tag == 'namedetails':
 218                 self.result[0]['namedetails'] = {}
 219                 for tag in child:
 220                     self.result[0]['namedetails'][tag.attrib['desc']] = tag.text
 221             elif child.tag in ('geokml'):
 222                 self.result[0][child.tag] = True
 223             else:
 224                 assert child.tag == 'error', \
 225                         "Unknown XML tag %s on page: %s" % (child.tag, self.page)
 226
 227
 228 class DetailsResponse(GenericResponse):
 229
 230     def __init__(self, page, fmt='json', errorcode=200):
 231         self.page = page
 232         self.format = fmt
 233         self.errorcode = errorcode
 234         self.result = []
 235         self.header = dict()
 236
 237         if errorcode == 200:
 238             getattr(self, 'parse_' + fmt)()
 239
 240     def parse_html(self):
 241         content, errors = tidy_document(self.page,
 242                                         options={'char-encoding' : 'utf8'})
 243         self.result = {}
 244
 245     def parse_json(self):
 246         self.result = [json.JSONDecoder(object_pairs_hook=OrderedDict).decode(self.page)]
 247
 248
 249 class StatusResponse(GenericResponse):
 250
 251     def __init__(self, page, fmt='text', errorcode=200):
 252         self.page = page
 253         self.format = fmt
 254         self.errorcode = errorcode
 255
 256         if errorcode == 200 and fmt != 'text':
 257             getattr(self, 'parse_' + fmt)()
 258
 259     def parse_json(self):
 260         self.result = [json.JSONDecoder(object_pairs_hook=OrderedDict).decode(self.page)]
 261
 262
 263 def geojson_result_to_json_result(geojson_result):
 264     result = geojson_result['properties']
 265     result['geojson'] = geojson_result['geometry']
 266     if 'bbox' in geojson_result:
 267         # bbox is  minlon, minlat, maxlon, maxlat
 268         # boundingbox is minlat, maxlat, minlon, maxlon
 269         result['boundingbox'] = [
 270                                     geojson_result['bbox'][1],
 271                                     geojson_result['bbox'][3],
 272                                     geojson_result['bbox'][0],
 273                                     geojson_result['bbox'][2]
 274                                 ]
 275     return result
 276
 277
 278 def geojson_results_to_json_results(geojson_results):
 279     if 'error' in geojson_results:
 280         return
 281     return list(map(geojson_result_to_json_result, geojson_results['features']))
 282
 283
 284 @when(u'searching for "(?P<query>.*)"(?P<dups> with dups)?')
 285 def query_cmd(context, query, dups):
 286     """ Query directly via PHP script.
 287     """
 288     cmd = ['/usr/bin/env', 'php']
 289     cmd.append(os.path.join(context.nominatim.build_dir, 'utils', 'query.php'))
 290     cmd.extend(['--search', query])
 291     # add more parameters in table form
 292     if context.table:
 293         for h in context.table.headings:
 294             value = context.table[0][h].strip()
 295             if value:
 296                 cmd.extend(('--' + h, value))
 297
 298     if dups:
 299         cmd.extend(('--dedupe', '0'))
 300
 301     proc = subprocess.Popen(cmd, cwd=context.nominatim.build_dir,
 302                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 303     (outp, err) = proc.communicate()
 304
 305     assert_equals (0, proc.returncode, "query.php failed with message: %s\noutput: %s" % (err, outp))
 306
 307     context.response = SearchResponse(outp.decode('utf-8'), 'json')
 308
 309 def send_api_query(endpoint, params, fmt, context):
 310     if fmt is not None:
 311         params['format'] = fmt.strip()
 312     if context.table:
 313         if context.table.headings[0] == 'param':
 314             for line in context.table:
 315                 params[line['param']] = line['value']
 316         else:
 317             for h in context.table.headings:
 318                 params[h] = context.table[0][h]
 319
 320     env = dict(BASE_SERVER_ENV)
 321     env['QUERY_STRING'] = urlencode(params)
 322
 323     env['SCRIPT_NAME'] = '/%s.php' % endpoint
 324     env['REQUEST_URI'] = '%s?%s' % (env['SCRIPT_NAME'], env['QUERY_STRING'])
 325     env['CONTEXT_DOCUMENT_ROOT'] = os.path.join(context.nominatim.build_dir, 'website')
 326     env['SCRIPT_FILENAME'] = os.path.join(env['CONTEXT_DOCUMENT_ROOT'],
 327                                           '%s.php' % endpoint)
 328     env['NOMINATIM_SETTINGS'] = context.nominatim.local_settings_file
 329
 330     logger.debug("Environment:" + json.dumps(env, sort_keys=True, indent=2))
 331
 332     if hasattr(context, 'http_headers'):
 333         env.update(context.http_headers)
 334
 335     cmd = ['/usr/bin/env', 'php-cgi', '-f']
 336     if context.nominatim.code_coverage_path:
 337         env['COV_SCRIPT_FILENAME'] = env['SCRIPT_FILENAME']
 338         env['COV_PHP_DIR'] = os.path.join(context.nominatim.src_dir, "lib")
 339         env['COV_TEST_NAME'] = '%s:%s' % (context.scenario.filename, context.scenario.line)
 340         env['SCRIPT_FILENAME'] = \
 341                 os.path.join(os.path.split(__file__)[0], 'cgi-with-coverage.php')
 342         cmd.append(env['SCRIPT_FILENAME'])
 343         env['PHP_CODE_COVERAGE_FILE'] = context.nominatim.next_code_coverage_file()
 344     else:
 345         cmd.append(env['SCRIPT_FILENAME'])
 346
 347     for k,v in params.items():
 348         cmd.append("%s=%s" % (k, v))
 349
 350     proc = subprocess.Popen(cmd, cwd=context.nominatim.build_dir, env=env,
 351                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 352
 353     (outp, err) = proc.communicate()
 354     outp = outp.decode('utf-8')
 355     err = err.decode("utf-8")
 356
 357     logger.debug("Result: \n===============================\n"
 358                  + outp + "\n===============================\n")
 359
 360     assert_equals(0, proc.returncode,
 361                   "%s failed with message: %s" % (
 362                       os.path.basename(env['SCRIPT_FILENAME']),
 363                       err))
 364
 365     assert_equals(0, len(err), "Unexpected PHP error: %s" % (err))
 366
 367     if outp.startswith('Status: '):
 368         status = int(outp[8:11])
 369     else:
 370         status = 200
 371
 372     content_start = outp.find('\r\n\r\n')
 373
 374     return outp[content_start + 4:], status
 375
 376 @given(u'the HTTP header')
 377 def add_http_header(context):
 378     if not hasattr(context, 'http_headers'):
 379         context.http_headers = {}
 380
 381     for h in context.table.headings:
 382         envvar = 'HTTP_' + h.upper().replace('-', '_')
 383         context.http_headers[envvar] = context.table[0][h]
 384
 385
 386 @when(u'sending (?P<fmt>\S+ )?search query "(?P<query>.*)"(?P<addr> with address)?')
 387 def website_search_request(context, fmt, query, addr):
 388     params = {}
 389     if query:
 390         params['q'] = query
 391     if addr is not None:
 392         params['addressdetails'] = '1'
 393
 394     outp, status = send_api_query('search', params, fmt, context)
 395
 396     if fmt is None:
 397         outfmt = 'html'
 398     elif fmt == 'jsonv2 ':
 399         outfmt = 'json'
 400     else:
 401         outfmt = fmt.strip()
 402
 403     context.response = SearchResponse(outp, outfmt, status)
 404
 405 @when(u'sending (?P<fmt>\S+ )?reverse coordinates (?P<lat>.+)?,(?P<lon>.+)?')
 406 def website_reverse_request(context, fmt, lat, lon):
 407     params = {}
 408     if lat is not None:
 409         params['lat'] = lat
 410     if lon is not None:
 411         params['lon'] = lon
 412
 413     outp, status = send_api_query('reverse', params, fmt, context)
 414
 415     if fmt is None:
 416         outfmt = 'xml'
 417     elif fmt == 'jsonv2 ':
 418         outfmt = 'json'
 419     else:
 420         outfmt = fmt.strip()
 421
 422     context.response = ReverseResponse(outp, outfmt, status)
 423
 424 @when(u'sending (?P<fmt>\S+ )?details query for (?P<query>.*)')
 425 def website_details_request(context, fmt, query):
 426     params = {}
 427     if query[0] in 'NWR':
 428         params['osmtype'] = query[0]
 429         params['osmid'] = query[1:]
 430     else:
 431         params['place_id'] = query
 432     outp, status = send_api_query('details', params, fmt, context)
 433
 434     if fmt is None:
 435         outfmt = 'html'
 436     else:
 437         outfmt = fmt.strip()
 438
 439     context.response = DetailsResponse(outp, outfmt, status)
 440
 441 @when(u'sending (?P<fmt>\S+ )?lookup query for (?P<query>.*)')
 442 def website_lookup_request(context, fmt, query):
 443     params = { 'osm_ids' : query }
 444     outp, status = send_api_query('lookup', params, fmt, context)
 445
 446     if fmt == 'json ':
 447         outfmt = 'json'
 448     elif fmt == 'geojson ':
 449         outfmt = 'geojson'
 450     else:
 451         outfmt = 'xml'
 452
 453     context.response = SearchResponse(outp, outfmt, status)
 454
 455 @when(u'sending (?P<fmt>\S+ )?status query')
 456 def website_status_request(context, fmt):
 457     params = {}
 458     outp, status = send_api_query('status', params, fmt, context)
 459
 460     if fmt is None:
 461         outfmt = 'text'
 462     else:
 463         outfmt = fmt.strip()
 464
 465     context.response = StatusResponse(outp, outfmt, status)
 466
 467 @step(u'(?P<operator>less than|more than|exactly|at least|at most) (?P<number>\d+) results? (?:is|are) returned')
 468 def validate_result_number(context, operator, number):
 469     eq_(context.response.errorcode, 200)
 470     numres = len(context.response.result)
 471     ok_(compare(operator, numres, int(number)),
 472         "Bad number of results: expected %s %s, got %d." % (operator, number, numres))
 473
 474 @then(u'a HTTP (?P<status>\d+) is returned')
 475 def check_http_return_status(context, status):
 476     eq_(context.response.errorcode, int(status))
 477
 478 @then(u'the page contents equals "(?P<text>.+)"')
 479 def check_page_content_equals(context, text):
 480     eq_(context.response.page, text)
 481
 482 @then(u'the result is valid (?P<fmt>\w+)')
 483 def step_impl(context, fmt):
 484     context.execute_steps("Then a HTTP 200 is returned")
 485     eq_(context.response.format, fmt)
 486
 487 @then(u'result header contains')
 488 def check_header_attr(context):
 489     for line in context.table:
 490         assert_is_not_none(re.fullmatch(line['value'], context.response.header[line['attr']]),
 491                      "attribute '%s': expected: '%s', got '%s'"
 492                        % (line['attr'], line['value'],
 493                           context.response.header[line['attr']]))
 494
 495 @then(u'result header has (?P<neg>not )?attributes (?P<attrs>.*)')
 496 def check_header_no_attr(context, neg, attrs):
 497     for attr in attrs.split(','):
 498         if neg:
 499             assert_not_in(attr, context.response.header)
 500         else:
 501             assert_in(attr, context.response.header)
 502
 503 @then(u'results contain')
 504 def step_impl(context):
 505     context.execute_steps("then at least 1 result is returned")
 506
 507     for line in context.table:
 508         context.response.match_row(line)
 509
 510 @then(u'result (?P<lid>\d+ )?has (?P<neg>not )?attributes (?P<attrs>.*)')
 511 def validate_attributes(context, lid, neg, attrs):
 512     if lid is None:
 513         idx = range(len(context.response.result))
 514         context.execute_steps("then at least 1 result is returned")
 515     else:
 516         idx = [int(lid.strip())]
 517         context.execute_steps("then more than %sresults are returned" % lid)
 518
 519     for i in idx:
 520         for attr in attrs.split(','):
 521             if neg:
 522                 assert_not_in(attr, context.response.result[i])
 523             else:
 524                 assert_in(attr, context.response.result[i])
 525
 526 @then(u'result addresses contain')
 527 def step_impl(context):
 528     context.execute_steps("then at least 1 result is returned")
 529
 530     if 'ID' not in context.table.headings:
 531         addr_parts = context.response.property_list('address')
 532
 533     for line in context.table:
 534         if 'ID' in context.table.headings:
 535             addr_parts = [dict(context.response.result[int(line['ID'])]['address'])]
 536
 537         for h in context.table.headings:
 538             if h != 'ID':
 539                 for p in addr_parts:
 540                     assert_in(h, p)
 541                     assert_equal(p[h], line[h], "Bad address value for %s" % h)
 542
 543 @then(u'address of result (?P<lid>\d+) has(?P<neg> no)? types (?P<attrs>.*)')
 544 def check_address(context, lid, neg, attrs):
 545     context.execute_steps("then more than %s results are returned" % lid)
 546
 547     addr_parts = context.response.result[int(lid)]['address']
 548
 549     for attr in attrs.split(','):
 550         if neg:
 551             assert_not_in(attr, addr_parts)
 552         else:
 553             assert_in(attr, addr_parts)
 554
 555 @then(u'address of result (?P<lid>\d+) is')
 556 def check_address(context, lid):
 557     context.execute_steps("then more than %s results are returned" % lid)
 558
 559     addr_parts = dict(context.response.result[int(lid)]['address'])
 560
 561     for line in context.table:
 562         assert_in(line['type'], addr_parts)
 563         assert_equal(addr_parts[line['type']], line['value'],
 564                      "Bad address value for %s" % line['type'])
 565         del addr_parts[line['type']]
 566
 567     eq_(0, len(addr_parts), "Additional address parts found: %s" % str(addr_parts))
 568
 569 @then(u'result (?P<lid>\d+ )?has bounding box in (?P<coords>[\d,.-]+)')
 570 def step_impl(context, lid, coords):
 571     if lid is None:
 572         context.execute_steps("then at least 1 result is returned")
 573         bboxes = context.response.property_list('boundingbox')
 574     else:
 575         context.execute_steps("then more than %sresults are returned" % lid)
 576         bboxes = [ context.response.result[int(lid)]['boundingbox']]
 577
 578     coord = [ float(x) for x in coords.split(',') ]
 579
 580     for bbox in bboxes:
 581         if isinstance(bbox, str):
 582             bbox = bbox.split(',')
 583         bbox = [ float(x) for x in bbox ]
 584
 585         assert_greater_equal(bbox[0], coord[0])
 586         assert_less_equal(bbox[1], coord[1])
 587         assert_greater_equal(bbox[2], coord[2])
 588         assert_less_equal(bbox[3], coord[3])
 589
 590 @then(u'there are(?P<neg> no)? duplicates')
 591 def check_for_duplicates(context, neg):
 592     context.execute_steps("then at least 1 result is returned")
 593
 594     resarr = set()
 595     has_dupe = False
 596
 597     for res in context.response.result:
 598         dup = (res['osm_type'], res['class'], res['type'], res['display_name'])
 599         if dup in resarr:
 600             has_dupe = True
 601             break
 602         resarr.add(dup)
 603
 604     if neg:
 605         assert not has_dupe, "Found duplicate for %s" % (dup, )
 606     else:
 607         assert has_dupe, "No duplicates found"