Merge pull request #3492 from lonvia/drop-waste-disposal

[nominatim.git] / 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 7d8b1928fdf94208666abd45a1fd1486b8aacfc2..aa1b43b8493d387a7323c1fc5ff6b67eb5e7e53e 100644 (file)
--- a/test/bdd/steps/steps_api_queries.py
+++ b/test/bdd/steps/steps_api_queries.py
@@ -15,6 +15,7 @@ import os
 import re
 import logging
 import asyncio
 import re
 import logging
 import asyncio

+import xml.etree.ElementTree as ET

 from urllib.parse import urlencode
 
 from utils import run_script
 from urllib.parse import urlencode
 
 from utils import run_script


@@ -69,12 +70,16 @@ def compare(operator, op1, op2):
     elif operator == 'at most':
         return op1 <= op2
     else:
     elif operator == 'at most':
         return op1 <= op2
     else:

-        raise Exception("unknown operator '%s'" % operator)
+        raise ValueError(f"Unknown operator '{operator}'")

 
 
 def send_api_query(endpoint, params, fmt, context):
 
 
 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:
     if context.table:
         if context.table.headings[0] == 'param':
             for line in context.table:


@@ -97,23 +102,24 @@ def send_api_query_php(endpoint, params, context):
     env = dict(BASE_SERVER_ENV)
     env['QUERY_STRING'] = urlencode(params)
 
     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['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'],
     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)
+                                          f'{endpoint}.php')

 
     LOG.debug("Environment:" + json.dumps(env, sort_keys=True, indent=2))
 
     if hasattr(context, 'http_headers'):
 
     LOG.debug("Environment:" + json.dumps(env, sort_keys=True, indent=2))
 
     if hasattr(context, 'http_headers'):

-        env.update(context.http_headers)
+        for k, v in context.http_headers.items():
+            env['HTTP_' + k.upper().replace('-', '_')] = v

 
     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
 
     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'] = '%s:%s' % (context.scenario.filename, context.scenario.line)
+        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['SCRIPT_FILENAME'] = \
                 os.path.join(os.path.split(__file__)[0], 'cgi-with-coverage.php')
         cmd.append(env['SCRIPT_FILENAME'])


@@ -122,11 +128,11 @@ def send_api_query_php(endpoint, params, context):
         cmd.append(env['SCRIPT_FILENAME'])
 
     for k,v in params.items():
         cmd.append(env['SCRIPT_FILENAME'])
 
     for k,v in params.items():

-        cmd.append("%s=%s" % (k, v))
+        cmd.append(f"{k}={v}")

 
     outp, err = run_script(cmd, cwd=context.nominatim.website_dir.name, env=env)
 
 
     outp, err = run_script(cmd, cwd=context.nominatim.website_dir.name, env=env)
 

-    assert len(err) == 0, "Unexpected PHP error: %s" % (err)
+    assert len(err) == 0, f"Unexpected PHP error: {err}"

 
     if outp.startswith('Status: '):
         status = int(outp[8:11])
 
     if outp.startswith('Status: '):
         status = int(outp[8:11])


@@ -143,8 +149,7 @@ def add_http_header(context):
         context.http_headers = {}
 
     for h in context.table.headings:
         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<fmt>\S+ )?search query "(?P<query>.*)"(?P<addr> with address)?')
 
 
 @when(u'sending (?P<fmt>\S+ )?search query "(?P<query>.*)"(?P<addr> with address)?')


@@ -154,41 +159,37 @@ def website_search_request(context, fmt, query, addr):
         params['q'] = query
     if addr is not None:
         params['addressdetails'] = '1'
         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)
 
 
     outp, status = send_api_query('search', params, fmt, context)
 
     context.response = SearchResponse(outp, fmt or 'json', status)
 

-@when(u'sending (?P<fmt>\S+ )?reverse coordinates (?P<lat>.+)?,(?P<lon>.+)?')
-def website_reverse_request(context, fmt, lat, lon):
+
+@when('sending v1/reverse at (?P<lat>[\d.-]*),(?P<lon>[\d.-]*)(?: with format (?P<fmt>.+))?')
+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
     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)
 
     outp, status = send_api_query('reverse', params, fmt, context)

-

     context.response = ReverseResponse(outp, fmt or 'xml', status)
 
     context.response = ReverseResponse(outp, fmt or 'xml', status)
 

-@when(u'sending (?P<fmt>\S+ )?reverse point (?P<nodeid>.+)')
-def website_reverse_request(context, fmt, nodeid):
+
+@when('sending v1/reverse N(?P<nodeid>\d+)(?: with format (?P<fmt>.+))?')
+def api_endpoint_v1_reverse_from_node(context, nodeid, fmt):

     params = {}
     params = {}

-    if fmt and fmt.strip() == 'debug':
-        params['debug'] = '1'

     params['lon'], params['lat'] = (f'{c:f}' for c in context.osm.grid_node(int(nodeid)))
 
     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)
     outp, status = send_api_query('reverse', params, fmt, context)

-

     context.response = ReverseResponse(outp, fmt or 'xml', status)
 
 
     context.response = ReverseResponse(outp, fmt or 'xml', status)
 
 

-

 @when(u'sending (?P<fmt>\S+ )?details query for (?P<query>.*)')
 def website_details_request(context, fmt, query):
     params = {}
 @when(u'sending (?P<fmt>\S+ )?details query for (?P<query>.*)')
 def website_details_request(context, fmt, query):
     params = {}


@@ -220,15 +221,16 @@ def website_status_request(context, fmt):
 
 @step(u'(?P<operator>less than|more than|exactly|at least|at most) (?P<number>\d+) results? (?:is|are) returned')
 def validate_result_number(context, operator, number):
 
 @step(u'(?P<operator>less than|more than|exactly|at least|at most) (?P<number>\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)), \
     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<status>\d+) is returned')
 def check_http_return_status(context, status):
     assert context.response.errorcode == int(status), \
 
 @then(u'a HTTP (?P<status>\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<text>.+)"')
 def check_page_content_equals(context, text):
 
 @then(u'the page contents equals "(?P<text>.+)"')
 def check_page_content_equals(context, text):


@@ -237,7 +239,19 @@ def check_page_content_equals(context, text):
 @then(u'the result is valid (?P<fmt>\w+)')
 def step_impl(context, fmt):
     context.execute_steps("Then a HTTP 200 is returned")
 @then(u'the result is valid (?P<fmt>\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<fmt>\w+) user error is returned')
 def check_page_error(context, fmt):
 
 @then(u'a (?P<fmt>\w+) user error is returned')
 def check_page_error(context, fmt):


@@ -251,11 +265,13 @@ def check_page_error(context, fmt):
 
 @then(u'result header contains')
 def check_header_attr(context):
 
 @then(u'result header contains')
 def check_header_attr(context):

+    context.execute_steps("Then a HTTP 200 is returned")

     for line in context.table:
     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 (?P<neg>not )?attributes (?P<attrs>.*)')
 
 
 @then(u'result header has (?P<neg>not )?attributes (?P<attrs>.*)')


@@ -292,7 +308,7 @@ def step_impl(context):
 
 @then(u'address of result (?P<lid>\d+) has(?P<neg> no)? types (?P<attrs>.*)')
 def check_address(context, lid, neg, attrs):
 
 @then(u'address of result (?P<lid>\d+) has(?P<neg> no)? types (?P<attrs>.*)')
 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']
 
 
     addr_parts = context.response.result[int(lid)]['address']
 


@@ -304,7 +320,7 @@ def check_address(context, lid, neg, attrs):
 
 @then(u'address of result (?P<lid>\d+) (?P<complete>is|contains)')
 def check_address(context, lid, complete):
 
 @then(u'address of result (?P<lid>\d+) (?P<complete>is|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'])
 
     lid = int(lid)
     addr_parts = dict(context.response.result[lid]['address'])


@@ -314,7 +330,7 @@ def check_address(context, lid, complete):
         del addr_parts[line['type']]
 
     if complete == 'is':
         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<lid>\d+ )?has bounding box in (?P<coords>[\d,.-]+)')
 
 
 @then(u'result (?P<lid>\d+ )?has bounding box in (?P<coords>[\d,.-]+)')


@@ -354,7 +370,7 @@ def check_for_duplicates(context, neg):
         resarr.add(dup)
 
     if 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"
 
     else:
         assert has_dupe, "No duplicates found"