X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/8f0885f6cb24f545a2f5021d53d8aec64a72bf9b..101a1f895d25451535f5c186d2ce1f5b7e753e3b:/test/python/test_cli.py diff --git a/test/python/test_cli.py b/test/python/test_cli.py index 71e3ff65..e1df9478 100644 --- a/test/python/test_cli.py +++ b/test/python/test_cli.py @@ -1,29 +1,43 @@ """ Tests for command line interface wrapper. + +These tests just check that the various command line parameters route to the +correct functionionality. They use a lot of monkeypatching to avoid executing +the actual functions. """ +import datetime as dt import psycopg2 import pytest +import time import nominatim.cli +import nominatim.clicmd.api +import nominatim.clicmd.refresh +import nominatim.clicmd.admin import nominatim.indexer.indexer import nominatim.tools.refresh import nominatim.tools.replication +import nominatim.tools.freeze +from nominatim.errors import UsageError +from nominatim.db import status def call_nominatim(*args): return nominatim.cli.nominatim(module_dir='build/module', osm2pgsql_path='build/osm2pgsql/osm2pgsql', - phplib_dir='lib', + phplib_dir='lib-php', data_dir='.', phpcgi_path='/usr/bin/php-cgi', + sqllib_dir='lib-sql', + config_dir='settings', cli_args=args) class MockParamCapture: """ Mock that records the parameters with which a function was called as well as the number of calls. """ - def __init__(self): + def __init__(self, retval=0): self.called = 0 - self.return_value = 0 + self.return_value = retval def __call__(self, *args, **kwargs): self.called += 1 @@ -38,11 +52,13 @@ def mock_run_legacy(monkeypatch): return mock @pytest.fixture -def mock_run_api(monkeypatch): - mock = MockParamCapture() - monkeypatch.setattr(nominatim.cli, 'run_api_script', mock) - return mock +def mock_func_factory(monkeypatch): + def get_mock(module, func): + mock = MockParamCapture() + monkeypatch.setattr(module, func, mock) + return mock + return get_mock def test_cli_help(capsys): """ Running nominatim tool without arguments prints help. @@ -55,12 +71,9 @@ def test_cli_help(capsys): @pytest.mark.parametrize("command,script", [ (('import', '--continue', 'load-data'), 'setup'), - (('freeze',), 'setup'), (('special-phrases',), 'specialphrases'), (('add-data', '--tiger-data', 'tiger'), 'setup'), (('add-data', '--file', 'foo.osm'), 'update'), - (('check-database',), 'check_import_finished'), - (('warm',), 'warm'), (('export',), 'export') ]) def test_legacy_commands_simple(mock_run_legacy, command, script): @@ -70,6 +83,34 @@ def test_legacy_commands_simple(mock_run_legacy, command, script): assert mock_run_legacy.last_args[0] == script + '.php' +def test_freeze_command(mock_func_factory, temp_db): + mock_drop = mock_func_factory(nominatim.tools.freeze, 'drop_update_tables') + mock_flatnode = mock_func_factory(nominatim.tools.freeze, 'drop_flatnode_file') + + assert 0 == call_nominatim('freeze') + + assert mock_drop.called == 1 + assert mock_flatnode.called == 1 + + +@pytest.mark.parametrize("params", [('--warm', ), + ('--warm', '--reverse-only'), + ('--warm', '--search-only'), + ('--check-database', )]) +def test_admin_command_legacy(mock_func_factory, params): + mock_run_legacy = mock_func_factory(nominatim.clicmd.admin, 'run_legacy_script') + + assert 0 == call_nominatim('admin', *params) + + assert mock_run_legacy.called == 1 + +@pytest.mark.parametrize("func, params", [('analyse_indexing', ('--analyse-indexing', ))]) +def test_admin_command_tool(temp_db, mock_func_factory, func, params): + mock = mock_func_factory(nominatim.tools.admin, func) + + assert 0 == call_nominatim('admin', *params) + assert mock.called == 1 + @pytest.mark.parametrize("name,oid", [('file', 'foo.osm'), ('diff', 'foo.osc'), ('node', 12), ('way', 8), ('relation', 32)]) def test_add_data_command(mock_run_legacy, name, oid): @@ -84,12 +125,10 @@ def test_add_data_command(mock_run_legacy, name, oid): (['--boundaries-only'], 1, 0), (['--no-boundaries'], 0, 1), (['--boundaries-only', '--no-boundaries'], 0, 0)]) -def test_index_command(monkeypatch, temp_db_cursor, params, do_bnds, do_ranks): +def test_index_command(mock_func_factory, temp_db_cursor, params, do_bnds, do_ranks): temp_db_cursor.execute("CREATE TABLE import_status (indexed bool)") - bnd_mock = MockParamCapture() - monkeypatch.setattr(nominatim.indexer.indexer.Indexer, 'index_boundaries', bnd_mock) - rank_mock = MockParamCapture() - monkeypatch.setattr(nominatim.indexer.indexer.Indexer, 'index_by_rank', rank_mock) + bnd_mock = mock_func_factory(nominatim.indexer.indexer.Indexer, 'index_boundaries') + rank_mock = mock_func_factory(nominatim.indexer.indexer.Indexer, 'index_by_rank') assert 0 == call_nominatim('index', *params) @@ -102,7 +141,9 @@ def test_index_command(monkeypatch, temp_db_cursor, params, do_bnds, do_ranks): ('importance', ('update.php', '--recompute-importance')), ('website', ('setup.php', '--setup-website')), ]) -def test_refresh_legacy_command(mock_run_legacy, temp_db, command, params): +def test_refresh_legacy_command(mock_func_factory, temp_db, command, params): + mock_run_legacy = mock_func_factory(nominatim.clicmd.refresh, 'run_legacy_script') + assert 0 == call_nominatim('refresh', '--' + command) assert mock_run_legacy.called == 1 @@ -115,15 +156,16 @@ def test_refresh_legacy_command(mock_run_legacy, temp_db, command, params): ('address-levels', 'load_address_levels_from_file'), ('functions', 'create_functions'), ]) -def test_refresh_command(monkeypatch, temp_db, command, func): - func_mock = MockParamCapture() - monkeypatch.setattr(nominatim.tools.refresh, func, func_mock) +def test_refresh_command(mock_func_factory, temp_db, command, func): + func_mock = mock_func_factory(nominatim.tools.refresh, func) assert 0 == call_nominatim('refresh', '--' + command) assert func_mock.called == 1 -def test_refresh_importance_computed_after_wiki_import(mock_run_legacy, temp_db): +def test_refresh_importance_computed_after_wiki_import(mock_func_factory, temp_db): + mock_run_legacy = mock_func_factory(nominatim.clicmd.refresh, 'run_legacy_script') + assert 0 == call_nominatim('refresh', '--importance', '--wiki-data') assert mock_run_legacy.called == 2 @@ -134,14 +176,82 @@ def test_refresh_importance_computed_after_wiki_import(mock_run_legacy, temp_db) (('--init', '--no-update-functions'), 'init_replication'), (('--check-for-updates',), 'check_for_updates') ]) -def test_replication_command(monkeypatch, temp_db, params, func): - func_mock = MockParamCapture() - monkeypatch.setattr(nominatim.tools.replication, func, func_mock) +def test_replication_command(mock_func_factory, temp_db, params, func): + func_mock = mock_func_factory(nominatim.tools.replication, func) assert 0 == call_nominatim('replication', *params) assert func_mock.called == 1 +def test_replication_update_bad_interval(monkeypatch, temp_db): + monkeypatch.setenv('NOMINATIM_REPLICATION_UPDATE_INTERVAL', 'xx') + + assert call_nominatim('replication') == 1 + + +def test_replication_update_bad_interval_for_geofabrik(monkeypatch, temp_db): + monkeypatch.setenv('NOMINATIM_REPLICATION_URL', + 'https://download.geofabrik.de/europe/ireland-and-northern-ireland-updates') + + assert call_nominatim('replication') == 1 + + +@pytest.mark.parametrize("state", [nominatim.tools.replication.UpdateState.UP_TO_DATE, + nominatim.tools.replication.UpdateState.NO_CHANGES]) +def test_replication_update_once_no_index(mock_func_factory, temp_db, temp_db_conn, + status_table, state): + status.set_status(temp_db_conn, date=dt.datetime.now(dt.timezone.utc), seq=1) + func_mock = mock_func_factory(nominatim.tools.replication, 'update') + + assert 0 == call_nominatim('replication', '--once', '--no-index') + + +def test_replication_update_continuous(monkeypatch, temp_db_conn, status_table): + status.set_status(temp_db_conn, date=dt.datetime.now(dt.timezone.utc), seq=1) + states = [nominatim.tools.replication.UpdateState.UP_TO_DATE, + nominatim.tools.replication.UpdateState.UP_TO_DATE] + monkeypatch.setattr(nominatim.tools.replication, 'update', + lambda *args, **kwargs: states.pop()) + + index_mock = MockParamCapture() + monkeypatch.setattr(nominatim.indexer.indexer.Indexer, 'index_boundaries', index_mock) + monkeypatch.setattr(nominatim.indexer.indexer.Indexer, 'index_by_rank', index_mock) + + with pytest.raises(IndexError): + call_nominatim('replication') + + assert index_mock.called == 4 + + +def test_replication_update_continuous_no_change(monkeypatch, temp_db_conn, status_table): + status.set_status(temp_db_conn, date=dt.datetime.now(dt.timezone.utc), seq=1) + states = [nominatim.tools.replication.UpdateState.NO_CHANGES, + nominatim.tools.replication.UpdateState.UP_TO_DATE] + monkeypatch.setattr(nominatim.tools.replication, 'update', + lambda *args, **kwargs: states.pop()) + + index_mock = MockParamCapture() + monkeypatch.setattr(nominatim.indexer.indexer.Indexer, 'index_boundaries', index_mock) + monkeypatch.setattr(nominatim.indexer.indexer.Indexer, 'index_by_rank', index_mock) + + sleep_mock = MockParamCapture() + monkeypatch.setattr(time, 'sleep', sleep_mock) + + with pytest.raises(IndexError): + call_nominatim('replication') + + assert index_mock.called == 2 + assert sleep_mock.called == 1 + assert sleep_mock.last_args[0] == 60 + + +def test_serve_command(mock_func_factory): + func = mock_func_factory(nominatim.cli, 'run_php_server') + + call_nominatim('serve') + + assert func.called == 1 + @pytest.mark.parametrize("params", [ ('search', '--query', 'new'), ('reverse', '--lat', '0', '--lon', '0'), @@ -152,7 +262,9 @@ def test_replication_command(monkeypatch, temp_db, params, func): ('details', '--place_id', '10001'), ('status',) ]) -def test_api_commands_simple(mock_run_api, params): +def test_api_commands_simple(mock_func_factory, params): + mock_run_api = mock_func_factory(nominatim.clicmd.api, 'run_api_script') + assert 0 == call_nominatim(*params) assert mock_run_api.called == 1