osm-search/Nominatim
1
1
Fork 0
mirror of https://github.com/osm-search/Nominatim.git synced 2024-12-28 15:34:34 +03:00
Code Issues Packages Projects Releases Wiki Activity

better error reporting when API script does not exist

Browse Source 
Check if the API script exists on the expected location before
running php-cli. This way we can add a useful hint about the
project directory.

Fixes #2513.
This commit is contained in:
Sarah Hoffmann 2021-11-10 09:42:49 +01:00
parent d479a0585d
commit 345c812e43
2 changed files with 41 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
nominatim/clicmd/api.py
View File

@ -4,6 +4,7 @@ Subcommand definitions for API calls from the command line.
import logging
from nominatim.tools.exec_utils import run_api_script
from nominatim.errors import UsageError
# Do not repeat documentation of subcommand classes.
# pylint: disable=C0111
@ -53,6 +54,18 @@ def _add_api_output_arguments(parser):
"Parameter is difference tolerance in degrees."))
def _run_api(endpoint, args, params):
script_file = args.project_dir / 'website' / (endpoint + '.php')
if not script_file.exists():
LOG.error("Cannot find API script file.\n\n"
"Make sure to run 'nominatim' from the project directory \n"
"or use the option --project-dir.")
raise UsageError("API script not found.")
return run_api_script(endpoint, args.project_dir,
phpcgi_bin=args.phpcgi_path, params=params)
class APISearch:
"""\
Execute a search query.
@ -114,8 +127,7 @@ class APISearch:
if not args.dedupe:
params['dedupe'] = '0'
return run_api_script('search', args.project_dir,
phpcgi_bin=args.phpcgi_path, params=params)
return _run_api('search', args, params)
class APIReverse:
"""\
@ -158,8 +170,7 @@ class APIReverse:
if args.polygon_threshold:
params['polygon_threshold'] = args.polygon_threshold
return run_api_script('reverse', args.project_dir,
phpcgi_bin=args.phpcgi_path, params=params)
return _run_api('reverse', args, params)
class APILookup:
@ -198,8 +209,7 @@ class APILookup:
if args.polygon_threshold:
params['polygon_threshold'] = args.polygon_threshold
return run_api_script('lookup', args.project_dir,
phpcgi_bin=args.phpcgi_path, params=params)
return _run_api('lookup', args, params)
class APIDetails:
@ -249,8 +259,7 @@ class APIDetails:
for name, _ in DETAILS_SWITCHES:
params[name] = '1' if getattr(args, name) else '0'
return run_api_script('details', args.project_dir,
phpcgi_bin=args.phpcgi_path, params=params)
return _run_api('details', args, params)
class APIStatus:
@ -271,6 +280,4 @@ class APIStatus:
@staticmethod
def run(args):
return run_api_script('status', args.project_dir,
phpcgi_bin=args.phpcgi_path,
params=dict(format=args.format))
return _run_api('status', args, dict(format=args.format))

19
test/python/test_cli.py
View File

@ -113,7 +113,7 @@ class TestCli:
assert func.called == 1
@pytest.mark.parametrize("params", [('search', '--query', 'new'),
@pytest.mark.parametrize("params", [('search', '--query', 'new'),
('reverse', '--lat', '0', '--lon', '0'),
('lookup', '--id', 'N1'),
('details', '--node', '1'),
@ -121,15 +121,28 @@ class TestCli:
('details', '--relation', '1'),
('details', '--place_id', '10001'),
('status',)])
def test_api_commands_simple(self, mock_func_factory, params):
class TestCliApiCall:
@pytest.fixture(autouse=True)
def setup_cli_call(self, cli_call):
self.call_nominatim = cli_call
def test_api_commands_simple(self, mock_func_factory, params, tmp_path):
(tmp_path / 'website').mkdir()
(tmp_path / 'website' / (params[0] + '.php')).write_text('')
mock_run_api = mock_func_factory(nominatim.clicmd.api, 'run_api_script')
assert self.call_nominatim(*params) == 0
assert self.call_nominatim(*params, '--project-dir', str(tmp_path)) == 0
assert mock_run_api.called == 1
assert mock_run_api.last_args[0] == params[0]
def test_bad_project_idr(self, mock_func_factory, params):
mock_run_api = mock_func_factory(nominatim.clicmd.api, 'run_api_script')
assert self.call_nominatim(*params) == 1
class TestCliWithDb: