X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/cd0001b55a4706e5c20a72e4209ccc7a330ba878..0af8dac3d35a94afe0b6ad775f3226d8d147501d:/test/bdd/steps/steps_api_queries.py?ds=inline diff --git a/test/bdd/steps/steps_api_queries.py b/test/bdd/steps/steps_api_queries.py index ad4a8515..4d15381d 100644 --- a/test/bdd/steps/steps_api_queries.py +++ b/test/bdd/steps/steps_api_queries.py @@ -1,43 +1,35 @@ +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This file is part of Nominatim. (https://nominatim.org) +# +# Copyright (C) 2024 by the Nominatim developer community. +# For a full list of authors see the git log. """ Steps that run queries against the API. - - Queries may either be run directly via PHP using the query script - or via the HTTP interface using php-cgi. """ +from pathlib import Path import json import os import re import logging +import asyncio +import xml.etree.ElementTree as ET from urllib.parse import urlencode from utils import run_script from http_responses import GenericResponse, SearchResponse, ReverseResponse, StatusResponse -from check_functions import Bbox +from check_functions import Bbox, check_for_attributes from table_compare import NominatimID LOG = logging.getLogger(__name__) -BASE_SERVER_ENV = { - 'HTTP_HOST' : 'localhost', - 'HTTP_USER_AGENT' : 'Mozilla/5.0 (X11; Linux x86_64; rv:51.0) Gecko/20100101 Firefox/51.0', - 'HTTP_ACCEPT' : 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8', - 'HTTP_ACCEPT_ENCODING' : 'gzip, deflate', - 'HTTP_CONNECTION' : 'keep-alive', - 'SERVER_SIGNATURE' : '
Nominatim BDD Tests
', - 'SERVER_SOFTWARE' : 'Nominatim test', - 'SERVER_NAME' : 'localhost', - 'SERVER_ADDR' : '127.0.1.1', - 'SERVER_PORT' : '80', - 'REMOTE_ADDR' : '127.0.0.1', - 'DOCUMENT_ROOT' : '/var/www', - 'REQUEST_SCHEME' : 'http', - 'CONTEXT_PREFIX' : '/', - 'SERVER_ADMIN' : 'webmaster@localhost', - 'REMOTE_PORT' : '49319', - 'GATEWAY_INTERFACE' : 'CGI/1.1', - 'SERVER_PROTOCOL' : 'HTTP/1.1', - 'REQUEST_METHOD' : 'GET', - 'REDIRECT_STATUS' : 'CGI' -} + +def make_todo_list(context, result_id): + if result_id is None: + context.execute_steps("then at least 1 result is returned") + return range(len(context.response.result)) + + context.execute_steps(f"then more than {result_id}results are returned") + return (int(result_id.strip()), ) def compare(operator, op1, op2): @@ -52,35 +44,16 @@ def compare(operator, op1, op2): elif operator == 'at most': return op1 <= op2 else: - raise Exception("unknown operator '%s'" % operator) + raise ValueError(f"Unknown operator '{operator}'") -@when(u'searching for "(?P.*)"(?P with dups)?') -def query_cmd(context, query, dups): - """ Query directly via PHP script. - """ - cmd = ['/usr/bin/env', 'php'] - cmd.append(context.nominatim.src_dir / 'lib' / 'admin' / 'query.php') - if query: - cmd.extend(['--search', query]) - # add more parameters in table form - if context.table: - for h in context.table.headings: - value = context.table[0][h].strip() - if value: - cmd.extend(('--' + h, value)) - - if dups: - cmd.extend(('--dedupe', '0')) - - outp, err = run_script(cmd, cwd=context.nominatim.website_dir.name, - env=context.nominatim.test_env) - - context.response = SearchResponse(outp, 'json') - def send_api_query(endpoint, params, fmt, context): - if fmt is not None and fmt.strip() != 'debug': - params['format'] = fmt.strip() + if fmt is not None: + if fmt.strip() == 'debug': + params['debug'] = '1' + else: + params['format'] = fmt.strip() + if context.table: if context.table.headings[0] == 'param': for line in context.table: @@ -89,47 +62,11 @@ def send_api_query(endpoint, params, fmt, context): for h in context.table.headings: params[h] = context.table[0][h] - env = dict(BASE_SERVER_ENV) - env['QUERY_STRING'] = urlencode(params) - - env['SCRIPT_NAME'] = '/%s.php' % endpoint - env['REQUEST_URI'] = '%s?%s' % (env['SCRIPT_NAME'], env['QUERY_STRING']) - env['CONTEXT_DOCUMENT_ROOT'] = os.path.join(context.nominatim.website_dir.name, 'website') - env['SCRIPT_FILENAME'] = os.path.join(env['CONTEXT_DOCUMENT_ROOT'], - '%s.php' % endpoint) - - LOG.debug("Environment:" + json.dumps(env, sort_keys=True, indent=2)) - - if hasattr(context, 'http_headers'): - env.update(context.http_headers) - - cmd = ['/usr/bin/env', 'php-cgi', '-f'] - if context.nominatim.code_coverage_path: - env['COV_SCRIPT_FILENAME'] = env['SCRIPT_FILENAME'] - env['COV_PHP_DIR'] = context.nominatim.src_dir - env['COV_TEST_NAME'] = '%s:%s' % (context.scenario.filename, context.scenario.line) - env['SCRIPT_FILENAME'] = \ - os.path.join(os.path.split(__file__)[0], 'cgi-with-coverage.php') - cmd.append(env['SCRIPT_FILENAME']) - env['PHP_CODE_COVERAGE_FILE'] = context.nominatim.next_code_coverage_file() - else: - cmd.append(env['SCRIPT_FILENAME']) - - for k,v in params.items(): - cmd.append("%s=%s" % (k, v)) - - outp, err = run_script(cmd, cwd=context.nominatim.website_dir.name, env=env) + return asyncio.run(context.nominatim.api_engine(endpoint, params, + Path(context.nominatim.website_dir.name), + context.nominatim.test_env, + getattr(context, 'http_headers', {}))) - assert len(err) == 0, "Unexpected PHP error: %s" % (err) - - if outp.startswith('Status: '): - status = int(outp[8:11]) - else: - status = 200 - - content_start = outp.find('\r\n\r\n') - - return outp[content_start + 4:], status @given(u'the HTTP header') def add_http_header(context): @@ -137,8 +74,7 @@ def add_http_header(context): context.http_headers = {} for h in context.table.headings: - envvar = 'HTTP_' + h.upper().replace('-', '_') - context.http_headers[envvar] = context.table[0][h] + context.http_headers[h] = context.table[0][h] @when(u'sending (?P\S+ )?search query "(?P.*)"(?P with address)?') @@ -148,27 +84,37 @@ def website_search_request(context, fmt, query, addr): params['q'] = query if addr is not None: params['addressdetails'] = '1' - if fmt and fmt.strip() == 'debug': - params['debug'] = '1' outp, status = send_api_query('search', params, fmt, context) context.response = SearchResponse(outp, fmt or 'json', status) -@when(u'sending (?P\S+ )?reverse coordinates (?P.+)?,(?P.+)?') -def website_reverse_request(context, fmt, lat, lon): + +@when('sending v1/reverse at (?P[\d.-]*),(?P[\d.-]*)(?: with format (?P.+))?') +def api_endpoint_v1_reverse(context, lat, lon, fmt): params = {} if lat is not None: params['lat'] = lat if lon is not None: params['lon'] = lon - if fmt and fmt.strip() == 'debug': - params['debug'] = '1' + if fmt is None: + fmt = 'jsonv2' + elif fmt == "''": + fmt = None outp, status = send_api_query('reverse', params, fmt, context) + context.response = ReverseResponse(outp, fmt or 'xml', status) + + +@when('sending v1/reverse N(?P\d+)(?: with format (?P.+))?') +def api_endpoint_v1_reverse_from_node(context, nodeid, fmt): + params = {} + params['lon'], params['lat'] = (f'{c:f}' for c in context.osm.grid_node(int(nodeid))) + outp, status = send_api_query('reverse', params, fmt, context) context.response = ReverseResponse(outp, fmt or 'xml', status) + @when(u'sending (?P\S+ )?details query for (?P.*)') def website_details_request(context, fmt, query): params = {} @@ -200,15 +146,16 @@ def website_status_request(context, fmt): @step(u'(?Pless than|more than|exactly|at least|at most) (?P\d+) results? (?:is|are) returned') def validate_result_number(context, operator, number): - assert context.response.errorcode == 200 + context.execute_steps("Then a HTTP 200 is returned") numres = len(context.response.result) assert compare(operator, numres, int(number)), \ - "Bad number of results: expected {} {}, got {}.".format(operator, number, numres) + f"Bad number of results: expected {operator} {number}, got {numres}." @then(u'a HTTP (?P\d+) is returned') def check_http_return_status(context, status): assert context.response.errorcode == int(status), \ - "Return HTTP status is {}.".format(context.response.errorcode) + f"Return HTTP status is {context.response.errorcode}."\ + f" Full response:\n{context.response.page}" @then(u'the page contents equals "(?P.+)"') def check_page_content_equals(context, text): @@ -217,7 +164,19 @@ def check_page_content_equals(context, text): @then(u'the result is valid (?P\w+)') def step_impl(context, fmt): context.execute_steps("Then a HTTP 200 is returned") - assert context.response.format == fmt + if fmt.strip() == 'html': + try: + tree = ET.fromstring(context.response.page) + except Exception as ex: + assert False, f"Could not parse page: {ex}\n{context.response.page}" + + assert tree.tag == 'html' + body = tree.find('./body') + assert body is not None + assert body.find('.//script') is None + else: + assert context.response.format == fmt + @then(u'a (?P\w+) user error is returned') def check_page_error(context, fmt): @@ -231,50 +190,35 @@ def check_page_error(context, fmt): @then(u'result header contains') def check_header_attr(context): + context.execute_steps("Then a HTTP 200 is returned") for line in context.table: - assert re.fullmatch(line['value'], context.response.header[line['attr']]) is not None, \ - "attribute '%s': expected: '%s', got '%s'" % ( - line['attr'], line['value'], - context.response.header[line['attr']]) + assert line['attr'] in context.response.header, \ + f"Field '{line['attr']}' missing in header. Full header:\n{context.response.header}" + value = context.response.header[line['attr']] + assert re.fullmatch(line['value'], value) is not None, \ + f"Attribute '{line['attr']}': expected: '{line['value']}', got '{value}'" + @then(u'result header has (?Pnot )?attributes (?P.*)') def check_header_no_attr(context, neg, attrs): - for attr in attrs.split(','): - if neg: - assert attr not in context.response.header, \ - "Unexpected attribute {}. Full response:\n{}".format( - attr, json.dumps(context.response.header, sort_keys=True, indent=2)) - else: - assert attr in context.response.header, \ - "No attribute {}. Full response:\n{}".format( - attr, json.dumps(context.response.header, sort_keys=True, indent=2)) + check_for_attributes(context.response.header, attrs, + 'absent' if neg else 'present') -@then(u'results contain') -def step_impl(context): + +@then(u'results contain(?: in field (?P.*))?') +def step_impl(context, field): context.execute_steps("then at least 1 result is returned") for line in context.table: - context.response.match_row(line) + context.response.match_row(line, context=context, field=field) + @then(u'result (?P\d+ )?has (?Pnot )?attributes (?P.*)') def validate_attributes(context, lid, neg, attrs): - if lid is None: - idx = range(len(context.response.result)) - context.execute_steps("then at least 1 result is returned") - else: - idx = [int(lid.strip())] - context.execute_steps("then more than %sresults are returned" % lid) - - for i in idx: - for attr in attrs.split(','): - if neg: - assert attr not in context.response.result[i],\ - "Unexpected attribute {}. Full response:\n{}".format( - attr, json.dumps(context.response.result[i], sort_keys=True, indent=2)) - else: - assert attr in context.response.result[i], \ - "No attribute {}. Full response:\n{}".format( - attr, json.dumps(context.response.result[i], sort_keys=True, indent=2)) + for i in make_todo_list(context, lid): + check_for_attributes(context.response.result[i], attrs, + 'absent' if neg else 'present') + @then(u'result addresses contain') def step_impl(context): @@ -289,7 +233,7 @@ def step_impl(context): @then(u'address of result (?P\d+) has(?P no)? types (?P.*)') def check_address(context, lid, neg, attrs): - context.execute_steps("then more than %s results are returned" % lid) + context.execute_steps(f"then more than {lid} results are returned") addr_parts = context.response.result[int(lid)]['address'] @@ -301,7 +245,7 @@ def check_address(context, lid, neg, attrs): @then(u'address of result (?P\d+) (?Pis|contains)') def check_address(context, lid, complete): - context.execute_steps("then more than %s results are returned" % lid) + context.execute_steps(f"then more than {lid} results are returned") lid = int(lid) addr_parts = dict(context.response.result[lid]['address']) @@ -311,38 +255,30 @@ def check_address(context, lid, complete): del addr_parts[line['type']] if complete == 'is': - assert len(addr_parts) == 0, "Additional address parts found: %s" % str(addr_parts) + assert len(addr_parts) == 0, f"Additional address parts found: {addr_parts!s}" -@then(u'result (?P\d+ )?has bounding box in (?P[\d,.-]+)') -def step_impl(context, lid, coords): - if lid is None: - context.execute_steps("then at least 1 result is returned") - bboxes = context.response.property_list('boundingbox') - else: - context.execute_steps("then more than {}results are returned".format(lid)) - bboxes = [context.response.result[int(lid)]['boundingbox']] +@then(u'result (?P\d+ )?has bounding box in (?P[\d,.-]+)') +def check_bounding_box_in_area(context, lid, coords): expected = Bbox(coords) - for bbox in bboxes: - assert bbox in expected, "Bbox {} is not contained in {}.".format(bbox, expected) + for idx in make_todo_list(context, lid): + res = context.response.result[idx] + check_for_attributes(res, 'boundingbox') + context.response.check_row(idx, res['boundingbox'] in expected, + f"Bbox is not contained in {expected}") -@then(u'result (?P\d+ )?has centroid in (?P[\d,.-]+)') -def step_impl(context, lid, coords): - if lid is None: - context.execute_steps("then at least 1 result is returned") - centroids = zip(context.response.property_list('lon'), - context.response.property_list('lat')) - else: - context.execute_steps("then more than %sresults are returned".format(lid)) - res = context.response.result[int(lid)] - centroids = [(res['lon'], res['lat'])] +@then(u'result (?P\d+ )?has centroid in (?P[\d,.-]+)') +def check_centroid_in_area(context, lid, coords): expected = Bbox(coords) - for centroid in centroids: - assert centroid in expected,\ - "Centroid {} is not inside {}.".format(centroid, expected) + for idx in make_todo_list(context, lid): + res = context.response.result[idx] + check_for_attributes(res, 'lat,lon') + context.response.check_row(idx, (res['lon'], res['lat']) in expected, + f"Centroid is not inside {expected}") + @then(u'there are(?P no)? duplicates') def check_for_duplicates(context, neg): @@ -359,6 +295,7 @@ def check_for_duplicates(context, neg): resarr.add(dup) if neg: - assert not has_dupe, "Found duplicate for %s" % (dup, ) + assert not has_dupe, f"Found duplicate for {dup}" else: assert has_dupe, "No duplicates found" +