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