X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/2b7eb4906a40cdc6733f41bb3e03c83e78797e2a..2c61fe08a031bd4ccbe47c62c021321e2dff7510:/test/bdd/steps/steps_api_queries.py diff --git a/test/bdd/steps/steps_api_queries.py b/test/bdd/steps/steps_api_queries.py index 78967ad1..de38549e 100644 --- a/test/bdd/steps/steps_api_queries.py +++ b/test/bdd/steps/steps_api_queries.py @@ -1,53 +1,23 @@ -# SPDX-License-Identifier: GPL-2.0-only +# SPDX-License-Identifier: GPL-3.0-or-later # # This file is part of Nominatim. (https://nominatim.org) # -# Copyright (C) 2022 by the Nominatim developer community. +# Copyright (C) 2025 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, 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: @@ -88,71 +58,22 @@ def send_api_query(endpoint, params, fmt, context): for h in context.table.headings: params[h] = context.table[0][h] - if context.nominatim.api_engine is None: - return send_api_query_php(endpoint, params, context) - return asyncio.run(context.nominatim.api_engine(endpoint, params, Path(context.nominatim.website_dir.name), context.nominatim.test_env, getattr(context, 'http_headers', {}))) - -def send_api_query_php(endpoint, params, context): - env = dict(BASE_SERVER_ENV) - env['QUERY_STRING'] = urlencode(params) - - env['SCRIPT_NAME'] = f'/{endpoint}.php' - env['REQUEST_URI'] = f"{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'], - f'{endpoint}.php') - - 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['XDEBUG_MODE'] = 'coverage' - env['COV_SCRIPT_FILENAME'] = env['SCRIPT_FILENAME'] - env['COV_PHP_DIR'] = context.nominatim.src_dir - env['COV_TEST_NAME'] = f"{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(f"{k}={v}") - - outp, err = run_script(cmd, cwd=context.nominatim.website_dir.name, env=env) - - assert len(err) == 0, f"Unexpected PHP error: {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') +@given('the HTTP header') def add_http_header(context): if not hasattr(context, 'http_headers'): 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)?') +@when(r'sending (?P\S+ )?search query "(?P.*)"(?P with address)?') def website_search_request(context, fmt, query, addr): params = {} if query: @@ -164,31 +85,33 @@ def website_search_request(context, fmt, query, addr): 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(r'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 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(u'sending (?P\S+ )?reverse point (?P.+)') -def website_reverse_request(context, fmt, nodeid): + +@when(r'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.*)') +@when(r'sending (?P\S+ )?details query for (?P.*)') def website_details_request(context, fmt, query): params = {} if query[0] in 'NWR': @@ -203,44 +126,52 @@ def website_details_request(context, fmt, query): context.response = GenericResponse(outp, fmt or 'json', status) -@when(u'sending (?P\S+ )?lookup query for (?P.*)') + +@when(r'sending (?P\S+ )?lookup query for (?P.*)') def website_lookup_request(context, fmt, query): - params = { 'osm_ids' : query } + params = {'osm_ids': query} outp, status = send_api_query('lookup', params, fmt, context) context.response = SearchResponse(outp, fmt or 'xml', status) -@when(u'sending (?P\S+ )?status query') + +@when(r'sending (?P\S+ )?status query') def website_status_request(context, fmt): params = {} outp, status = send_api_query('status', params, fmt, context) context.response = StatusResponse(outp, fmt or 'text', status) -@step(u'(?Pless than|more than|exactly|at least|at most) (?P\d+) results? (?:is|are) returned') + +@step(r'(?Pless than|more than|exactly|at least|at most) ' + r'(?P\d+) results? (?:is|are) returned') def validate_result_number(context, operator, number): context.execute_steps("Then a HTTP 200 is returned") numres = len(context.response.result) assert compare(operator, numres, int(number)), \ f"Bad number of results: expected {operator} {number}, got {numres}." -@then(u'a HTTP (?P\d+) is returned') + +@then(r'a HTTP (?P\d+) is returned') def check_http_return_status(context, status): assert context.response.errorcode == int(status), \ - f"Return HTTP status is {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.+)"') +@then(r'the page contents equals "(?P.+)"') def check_page_content_equals(context, text): assert context.response.page == text -@then(u'the result is valid (?P\w+)') + +@then(r'the result is valid (?P\w+)') def step_impl(context, fmt): context.execute_steps("Then a HTTP 200 is returned") if fmt.strip() == 'html': try: tree = ET.fromstring(context.response.page) except Exception as ex: - assert False, f"Could not parse page:\n{context.response.page}" + assert False, f"Could not parse page: {ex}\n{context.response.page}" assert tree.tag == 'html' body = tree.find('./body') @@ -250,7 +181,7 @@ def step_impl(context, fmt): assert context.response.format == fmt -@then(u'a (?P\w+) user error is returned') +@then(r'a (?P\w+) user error is returned') def check_page_error(context, fmt): context.execute_steps("Then a HTTP 400 is returned") assert context.response.format == fmt @@ -260,29 +191,34 @@ def check_page_error(context, fmt): else: assert re.search(r'({"error":)', context.response.page, re.DOTALL) is not None -@then(u'result header contains') + +@then('result header contains') def check_header_attr(context): + context.execute_steps("Then a HTTP 200 is returned") for line in context.table: + assert line['attr'] in context.response.header, \ + f"Field '{line['attr']}' missing in header. " \ + f"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.*)') +@then('result header has (?Pnot )?attributes (?P.*)') def check_header_no_attr(context, neg, attrs): check_for_attributes(context.response.header, attrs, 'absent' if neg else 'present') -@then(u'results contain(?: in field (?P.*))?') -def step_impl(context, field): +@then(r'results contain(?: in field (?P.*))?') +def results_contain_in_field(context, field): context.execute_steps("then at least 1 result is returned") for line in context.table: context.response.match_row(line, context=context, field=field) -@then(u'result (?P\d+ )?has (?Pnot )?attributes (?P.*)') +@then(r'result (?P\d+ )?has (?Pnot )?attributes (?P.*)') def validate_attributes(context, lid, neg, attrs): for i in make_todo_list(context, lid): check_for_attributes(context.response.result[i], attrs, @@ -290,7 +226,7 @@ def validate_attributes(context, lid, neg, attrs): @then(u'result addresses contain') -def step_impl(context): +def result_addresses_contain(context): context.execute_steps("then at least 1 result is returned") for line in context.table: @@ -300,8 +236,9 @@ def step_impl(context): if name != 'ID': context.response.assert_address_field(idx, name, value) -@then(u'address of result (?P\d+) has(?P no)? types (?P.*)') -def check_address(context, lid, neg, attrs): + +@then(r'address of result (?P\d+) has(?P no)? types (?P.*)') +def check_address_has_types(context, lid, neg, attrs): context.execute_steps(f"then more than {lid} results are returned") addr_parts = context.response.result[int(lid)]['address'] @@ -312,7 +249,8 @@ def check_address(context, lid, neg, attrs): else: assert attr in addr_parts -@then(u'address of result (?P\d+) (?Pis|contains)') + +@then(r'address of result (?P\d+) (?Pis|contains)') def check_address(context, lid, complete): context.execute_steps(f"then more than {lid} results are returned") @@ -327,7 +265,7 @@ def check_address(context, lid, complete): assert len(addr_parts) == 0, f"Additional address parts found: {addr_parts!s}" -@then(u'result (?P\d+ )?has bounding box in (?P[\d,.-]+)') +@then(r'result (?P\d+ )?has bounding box in (?P[\d,.-]+)') def check_bounding_box_in_area(context, lid, coords): expected = Bbox(coords) @@ -338,7 +276,7 @@ def check_bounding_box_in_area(context, lid, coords): f"Bbox is not contained in {expected}") -@then(u'result (?P\d+ )?has centroid in (?P[\d,.-]+)') +@then(r'result (?P\d+ )?has centroid in (?P[\d,.-]+)') def check_centroid_in_area(context, lid, coords): expected = Bbox(coords) @@ -349,7 +287,7 @@ def check_centroid_in_area(context, lid, coords): f"Centroid is not inside {expected}") -@then(u'there are(?P no)? duplicates') +@then('there are(?P no)? duplicates') def check_for_duplicates(context, neg): context.execute_steps("then at least 1 result is returned") @@ -367,4 +305,3 @@ def check_for_duplicates(context, neg): assert not has_dupe, f"Found duplicate for {dup}" else: assert has_dupe, "No duplicates found" -