X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/54d35ddfe9054f3bc49896fc47c2a02b3fc43066..1dce2b98b49ba79c40ee26598bad8d3b669427f6:/test/python/cli/test_cmd_api.py diff --git a/test/python/cli/test_cmd_api.py b/test/python/cli/test_cmd_api.py index 9575d676..e8c447aa 100644 --- a/test/python/cli/test_cmd_api.py +++ b/test/python/cli/test_cmd_api.py @@ -1,81 +1,203 @@ +# SPDX-License-Identifier: GPL-2.0-only +# +# This file is part of Nominatim. (https://nominatim.org) +# +# Copyright (C) 2023 by the Nominatim developer community. +# For a full list of authors see the git log. """ Tests for API access commands of command-line interface wrapper. """ +import json import pytest import nominatim.clicmd.api +import nominatim.api as napi @pytest.mark.parametrize("endpoint", (('search', 'reverse', 'lookup', 'details', 'status'))) -def test_no_api_without_phpcgi(src_dir, endpoint): - with pytest.raises(SystemExit): - nominatim.cli.nominatim(module_dir='MODULE NOT AVAILABLE', - osm2pgsql_path='OSM2PGSQL NOT AVAILABLE', - phplib_dir=str(src_dir / 'lib-php'), - data_dir=str(src_dir / 'data'), - phpcgi_path=None, - sqllib_dir=str(src_dir / 'lib-sql'), - config_dir=str(src_dir / 'settings'), - cli_args=[endpoint]) +def test_no_api_without_phpcgi(endpoint): + assert nominatim.cli.nominatim(module_dir='MODULE NOT AVAILABLE', + osm2pgsql_path='OSM2PGSQL NOT AVAILABLE', + phpcgi_path=None, + cli_args=[endpoint]) == 1 @pytest.mark.parametrize("params", [('search', '--query', 'new'), - ('search', '--city', 'Berlin'), - ('reverse', '--lat', '0', '--lon', '0', '--zoom', '13'), - ('lookup', '--id', 'N1'), - ('details', '--node', '1'), - ('details', '--way', '1'), - ('details', '--relation', '1'), - ('details', '--place_id', '10001'), - ('status',)]) -class TestCliApiCall: + ('search', '--city', 'Berlin')]) +class TestCliApiCallPhp: @pytest.fixture(autouse=True) - def setup_cli_call(self, cli_call): - self.call_nominatim = cli_call + def setup_cli_call(self, params, cli_call, mock_func_factory, tmp_path): + self.mock_run_api = mock_func_factory(nominatim.clicmd.api, 'run_api_script') - def test_api_commands_simple(self, mock_func_factory, params, tmp_path): + def _run(): + return cli_call(*params, '--project-dir', str(tmp_path)) + + self.run_nominatim = _run + + + def test_api_commands_simple(self, tmp_path, params): (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, '--project-dir', str(tmp_path)) == 0 + assert self.run_nominatim() == 0 + + assert self.mock_run_api.called == 1 + assert self.mock_run_api.last_args[0] == params[0] + + + def test_bad_project_dir(self): + assert self.run_nominatim() == 1 + + +class TestCliStatusCall: + + @pytest.fixture(autouse=True) + def setup_status_mock(self, monkeypatch): + monkeypatch.setattr(napi.NominatimAPI, 'status', + lambda self: napi.StatusResult(200, 'OK')) + + + def test_status_simple(self, cli_call, tmp_path): + result = cli_call('status', '--project-dir', str(tmp_path)) + + assert result == 0 + + + def test_status_json_format(self, cli_call, tmp_path, capsys): + result = cli_call('status', '--project-dir', str(tmp_path), + '--format', 'json') + + assert result == 0 + + json.loads(capsys.readouterr().out) + + +class TestCliDetailsCall: + + @pytest.fixture(autouse=True) + def setup_status_mock(self, monkeypatch): + result = napi.DetailedResult(napi.SourceTable.PLACEX, ('place', 'thing'), + napi.Point(1.0, -3.0)) + + monkeypatch.setattr(napi.NominatimAPI, 'details', + lambda *args: result) + + @pytest.mark.parametrize("params", [('--node', '1'), + ('--way', '1'), + ('--relation', '1'), + ('--place_id', '10001')]) + + def test_details_json_format(self, cli_call, tmp_path, capsys, params): + result = cli_call('details', '--project-dir', str(tmp_path), *params) + + assert result == 0 + + json.loads(capsys.readouterr().out) + + +class TestCliReverseCall: + + @pytest.fixture(autouse=True) + def setup_reverse_mock(self, monkeypatch): + result = napi.ReverseResult(napi.SourceTable.PLACEX, ('place', 'thing'), + napi.Point(1.0, -3.0), + names={'name':'Name', 'name:fr': 'Nom'}, + extratags={'extra':'Extra'}) + + monkeypatch.setattr(napi.NominatimAPI, 'reverse', + lambda *args: result) + - assert mock_run_api.called == 1 - assert mock_run_api.last_args[0] == params[0] + def test_reverse_simple(self, cli_call, tmp_path, capsys): + result = cli_call('reverse', '--project-dir', str(tmp_path), + '--lat', '34', '--lon', '34') + assert result == 0 - def test_bad_project_idr(self, mock_func_factory, params): - mock_run_api = mock_func_factory(nominatim.clicmd.api, 'run_api_script') + out = json.loads(capsys.readouterr().out) + assert out['name'] == 'Name' + assert 'address' not in out + assert 'extratags' not in out + assert 'namedetails' not in out - assert self.call_nominatim(*params) == 1 -QUERY_PARAMS = { - 'search': ('--query', 'somewhere'), - 'reverse': ('--lat', '20', '--lon', '30'), - 'lookup': ('--id', 'R345345'), - 'details': ('--node', '324') -} + @pytest.mark.parametrize('param,field', [('--addressdetails', 'address'), + ('--extratags', 'extratags'), + ('--namedetails', 'namedetails')]) + def test_reverse_extra_stuff(self, cli_call, tmp_path, capsys, param, field): + result = cli_call('reverse', '--project-dir', str(tmp_path), + '--lat', '34', '--lon', '34', param) + + assert result == 0 + + out = json.loads(capsys.readouterr().out) + assert field in out + + + def test_reverse_format(self, cli_call, tmp_path, capsys): + result = cli_call('reverse', '--project-dir', str(tmp_path), + '--lat', '34', '--lon', '34', '--format', 'geojson') + + assert result == 0 + + out = json.loads(capsys.readouterr().out) + assert out['type'] == 'FeatureCollection' + + + def test_reverse_language(self, cli_call, tmp_path, capsys): + result = cli_call('reverse', '--project-dir', str(tmp_path), + '--lat', '34', '--lon', '34', '--lang', 'fr') + + assert result == 0 + + out = json.loads(capsys.readouterr().out) + assert out['name'] == 'Nom' + + +class TestCliLookupCall: + + @pytest.fixture(autouse=True) + def setup_lookup_mock(self, monkeypatch): + result = napi.SearchResult(napi.SourceTable.PLACEX, ('place', 'thing'), + napi.Point(1.0, -3.0), + names={'name':'Name', 'name:fr': 'Nom'}, + extratags={'extra':'Extra'}) + + monkeypatch.setattr(napi.NominatimAPI, 'lookup', + lambda *args: napi.SearchResults([result])) + + def test_lookup_simple(self, cli_call, tmp_path, capsys): + result = cli_call('lookup', '--project-dir', str(tmp_path), + '--id', 'N34') + + assert result == 0 + + out = json.loads(capsys.readouterr().out) + assert len(out) == 1 + assert out[0]['name'] == 'Name' + assert 'address' not in out[0] + assert 'extratags' not in out[0] + assert 'namedetails' not in out[0] + -@pytest.mark.parametrize("endpoint", (('search', 'reverse', 'lookup'))) class TestCliApiCommonParameters: @pytest.fixture(autouse=True) - def setup_website_dir(self, cli_call, project_env, endpoint): - self.endpoint = endpoint + def setup_website_dir(self, cli_call, project_env): self.cli_call = cli_call self.project_dir = project_env.project_dir (self.project_dir / 'website').mkdir() def expect_param(self, param, expected): - (self.project_dir / 'website' / (self.endpoint + '.php')).write_text(f"""