+# 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.
"""
Tests for API access commands of command-line interface wrapper.
"""
+import json
import pytest
-import nominatim.clicmd.api
-
-
-@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])
-
-
-@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:
+import nominatim_db.clicmd.api
+import nominatim_api as napi
- @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, '--project-dir', str(tmp_path)) == 0
-
- assert mock_run_api.called == 1
- assert mock_run_api.last_args[0] == params[0]
+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_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
+ def test_status_simple(self, cli_call, tmp_path):
+ result = cli_call('status', '--project-dir', str(tmp_path))
-QUERY_PARAMS = {
- 'search': ('--query', 'somewhere'),
- 'reverse': ('--lat', '20', '--lon', '30'),
- 'lookup': ('--id', 'R345345'),
- 'details': ('--node', '324')
-}
+ assert result == 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
- self.cli_call = cli_call
- self.project_dir = project_env.project_dir
- (self.project_dir / 'website').mkdir()
+ 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
- def expect_param(self, param, expected):
- (self.project_dir / 'website' / (self.endpoint + '.php')).write_text(f"""<?php
- exit($_GET['{param}'] == '{expected}' ? 0 : 10);
- """)
+ json.loads(capsys.readouterr().out)
- def call_nominatim(self, *params):
- return self.cli_call(self.endpoint, *QUERY_PARAMS[self.endpoint],
- '--project-dir', str(self.project_dir), *params)
+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))
- def test_param_output(self):
- self.expect_param('format', 'xml')
- assert self.call_nominatim('--format', 'xml') == 0
+ monkeypatch.setattr(napi.NominatimAPI, 'details',
+ lambda *args, **kwargs: result)
+ @pytest.mark.parametrize("params", [('--node', '1'),
+ ('--way', '1'),
+ ('--relation', '1'),
+ ('--place_id', '10001')])
- def test_param_lang(self):
- self.expect_param('accept-language', 'de')
- assert self.call_nominatim('--lang', 'de') == 0
- assert self.call_nominatim('--accept-language', 'de') == 0
+ 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
- @pytest.mark.parametrize("param", ('addressdetails', 'extratags', 'namedetails'))
- def test_param_extradata(self, param):
- self.expect_param(param, '1')
+ json.loads(capsys.readouterr().out)
- assert self.call_nominatim('--' + param) == 0
- def test_param_polygon_output(self):
- self.expect_param('polygon_geojson', '1')
+class TestCliReverseCall:
- assert self.call_nominatim('--polygon-output', 'geojson') == 0
+ @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'},
+ locale_name='Name',
+ display_name='Name')
+ monkeypatch.setattr(napi.NominatimAPI, 'reverse',
+ lambda *args, **kwargs: result)
- def test_param_polygon_threshold(self):
- self.expect_param('polygon_threshold', '0.3452')
- assert self.call_nominatim('--polygon-threshold', '0.3452') == 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_cli_search_param_bounded(cli_call, project_env):
- webdir = project_env.project_dir / 'website'
- webdir.mkdir()
- (webdir / 'search.php').write_text(f"""<?php
- exit($_GET['bounded'] == '1' ? 0 : 10);
- """)
+ 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 cli_call('search', *QUERY_PARAMS['search'], '--project-dir', str(project_env.project_dir),
- '--bounded') == 0
+ @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)
-def test_cli_search_param_dedupe(cli_call, project_env):
- webdir = project_env.project_dir / 'website'
- webdir.mkdir()
- (webdir / 'search.php').write_text(f"""<?php
- exit($_GET['dedupe'] == '0' ? 0 : 10);
- """)
+ assert result == 0
- assert cli_call('search', *QUERY_PARAMS['search'], '--project-dir', str(project_env.project_dir),
- '--no-dedupe') == 0
+ out = json.loads(capsys.readouterr().out)
+ assert field in out
-def test_cli_details_param_class(cli_call, project_env):
- webdir = project_env.project_dir / 'website'
- webdir.mkdir()
- (webdir / 'details.php').write_text(f"""<?php
- exit($_GET['class'] == 'highway' ? 0 : 10);
- """)
+ 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 cli_call('details', *QUERY_PARAMS['details'], '--project-dir', str(project_env.project_dir),
- '--class', 'highway') == 0
+ assert result == 0
+ out = json.loads(capsys.readouterr().out)
+ assert out['type'] == 'FeatureCollection'
-@pytest.mark.parametrize('param', ('lang', 'accept-language'))
-def test_cli_details_param_lang(cli_call, project_env, param):
- webdir = project_env.project_dir / 'website'
- webdir.mkdir()
- (webdir / 'details.php').write_text(f"""<?php
- exit($_GET['accept-language'] == 'es' ? 0 : 10);
- """)
- assert cli_call('details', *QUERY_PARAMS['details'], '--project-dir', str(project_env.project_dir),
- '--' + param, 'es') == 0
+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'},
+ locale_name='Name',
+ display_name='Name')
+
+ monkeypatch.setattr(napi.NominatimAPI, 'lookup',
+ lambda *args, **kwargs: 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, params', [('search', ('--query', 'Berlin')),
+ ('search_address', ('--city', 'Berlin'))
+ ])
+def test_search(cli_call, tmp_path, capsys, monkeypatch, endpoint, params):
+ result = napi.SearchResult(napi.SourceTable.PLACEX, ('place', 'thing'),
+ napi.Point(1.0, -3.0),
+ names={'name':'Name', 'name:fr': 'Nom'},
+ extratags={'extra':'Extra'},
+ locale_name='Name',
+ display_name='Name')
+
+ monkeypatch.setattr(napi.NominatimAPI, endpoint,
+ lambda *args, **kwargs: napi.SearchResults([result]))
+
+
+ result = cli_call('search', '--project-dir', str(tmp_path), *params)
+
+ 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]
projects / nominatim.git / blobdiff