Special phrases documentation updated

[nominatim.git] / test / python / test_cli.py

diff --git a/test/python/test_cli.py b/test/python/test_cli.py
index eae4f65a28c7bc98aacdc86588fc1ae01e5f6887..1d89ec699e38de8db1902ae2ecf9ef03a90745e4 100644 (file)
--- a/test/python/test_cli.py
+++ b/test/python/test_cli.py
@@ -1,31 +1,43 @@
 """
 Tests for command line interface wrapper.
 """
 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.

 """
 """

+from pathlib import Path
+

 import pytest
 
 import pytest
 

+import nominatim.db.properties

 import nominatim.cli
 import nominatim.cli

+import nominatim.clicmd.api
+import nominatim.clicmd.refresh
+import nominatim.clicmd.admin
+import nominatim.clicmd.setup
+import nominatim.indexer.indexer
+import nominatim.tools.admin
+import nominatim.tools.check_database
+import nominatim.tools.database_import
+import nominatim.tools.freeze
+import nominatim.tools.refresh
+import nominatim.tools.postcodes
+import nominatim.tokenizer.factory
+
+from mocks import MockParamCapture
+
+SRC_DIR = (Path(__file__) / '..' / '..' / '..').resolve()

 
 def call_nominatim(*args):
     return nominatim.cli.nominatim(module_dir='build/module',
                                    osm2pgsql_path='build/osm2pgsql/osm2pgsql',
 
 def call_nominatim(*args):
     return nominatim.cli.nominatim(module_dir='build/module',
                                    osm2pgsql_path='build/osm2pgsql/osm2pgsql',

-                                   phplib_dir='lib',
-                                   data_dir='.',
+                                   phplib_dir=str(SRC_DIR / 'lib-php'),
+                                   data_dir=str(SRC_DIR / 'data'),

                                    phpcgi_path='/usr/bin/php-cgi',
                                    phpcgi_path='/usr/bin/php-cgi',

+                                   sqllib_dir=str(SRC_DIR / 'lib-sql'),
+                                   config_dir=str(SRC_DIR / 'settings'),

                                    cli_args=args)
 
                                    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):
-        self.called = 0
-        self.return_value = 0
-
-    def __call__(self, *args, **kwargs):
-        self.called += 1
-        self.last_args = args
-        self.last_kwargs = kwargs
-        return self.return_value

 
 @pytest.fixture
 def mock_run_legacy(monkeypatch):
 
 @pytest.fixture
 def mock_run_legacy(monkeypatch):


@@ -33,11 +45,38 @@ def mock_run_legacy(monkeypatch):
     monkeypatch.setattr(nominatim.cli, 'run_legacy_script', mock)
     return mock
 
     monkeypatch.setattr(nominatim.cli, 'run_legacy_script', mock)
     return mock
 

+

 @pytest.fixture
 @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()
+        mock.func_name = func
+        monkeypatch.setattr(module, func, mock)
+        return mock
+
+    return get_mock
+
+
+@pytest.fixture
+def tokenizer_mock(monkeypatch):
+    class DummyTokenizer:
+        def __init__(self, *args, **kwargs):
+            self.update_sql_functions_called = False
+            self.finalize_import_called = False
+
+        def update_sql_functions(self, *args):
+            self.update_sql_functions_called = True
+
+        def finalize_import(self, *args):
+            self.finalize_import_called = True
+
+    tok = DummyTokenizer()
+    monkeypatch.setattr(nominatim.tokenizer.factory, 'get_tokenizer_for_db' ,
+                        lambda *args: tok)
+    monkeypatch.setattr(nominatim.tokenizer.factory, 'create_tokenizer' ,
+                        lambda *args: tok)
+
+    return tok

 
 
 def test_cli_help(capsys):
 
 
 def test_cli_help(capsys):


@@ -50,14 +89,7 @@ def test_cli_help(capsys):
 
 
 @pytest.mark.parametrize("command,script", [
 
 
 @pytest.mark.parametrize("command,script", [

-                         (('import', '--continue', 'load-data'), 'setup'),
-                         (('freeze',), 'setup'),
-                         (('special-phrases',), 'specialphrases'),
-                         (('replication',), 'update'),
-                         (('add-data', '--tiger-data', 'tiger'), 'setup'),

                          (('add-data', '--file', 'foo.osm'), 'update'),
                          (('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):
                          (('export',), 'export')
                          ])
 def test_legacy_commands_simple(mock_run_legacy, command, script):


@@ -67,6 +99,137 @@ def test_legacy_commands_simple(mock_run_legacy, command, script):
     assert mock_run_legacy.last_args[0] == script + '.php'
 
 
     assert mock_run_legacy.last_args[0] == script + '.php'
 
 

+def test_import_missing_file(temp_db):
+    assert 1 == call_nominatim('import', '--osm-file', 'sfsafegweweggdgw.reh.erh')
+
+
+def test_import_bad_file(temp_db):
+    assert 1 == call_nominatim('import', '--osm-file', '.')
+
+
+def test_import_full(temp_db, mock_func_factory, tokenizer_mock):
+    mocks = [
+        mock_func_factory(nominatim.tools.database_import, 'setup_database_skeleton'),
+        mock_func_factory(nominatim.tools.database_import, 'import_osm_data'),
+        mock_func_factory(nominatim.tools.refresh, 'import_wikipedia_articles'),
+        mock_func_factory(nominatim.tools.database_import, 'truncate_data_tables'),
+        mock_func_factory(nominatim.tools.database_import, 'load_data'),
+        mock_func_factory(nominatim.tools.database_import, 'create_tables'),
+        mock_func_factory(nominatim.tools.database_import, 'create_table_triggers'),
+        mock_func_factory(nominatim.tools.database_import, 'create_partition_tables'),
+        mock_func_factory(nominatim.tools.database_import, 'create_search_indices'),
+        mock_func_factory(nominatim.tools.database_import, 'create_country_names'),
+        mock_func_factory(nominatim.tools.refresh, 'load_address_levels_from_file'),
+        mock_func_factory(nominatim.tools.postcodes, 'import_postcodes'),
+        mock_func_factory(nominatim.indexer.indexer.Indexer, 'index_full'),
+        mock_func_factory(nominatim.tools.refresh, 'setup_website'),
+        mock_func_factory(nominatim.db.properties, 'set_property')
+    ]
+
+    cf_mock = mock_func_factory(nominatim.tools.refresh, 'create_functions')
+
+    assert 0 == call_nominatim('import', '--osm-file', __file__)
+    assert tokenizer_mock.finalize_import_called
+
+    assert cf_mock.called > 1
+
+    for mock in mocks:
+        assert mock.called == 1, "Mock '{}' not called".format(mock.func_name)
+
+
+def test_import_continue_load_data(temp_db, mock_func_factory, tokenizer_mock):
+    mocks = [
+        mock_func_factory(nominatim.tools.database_import, 'truncate_data_tables'),
+        mock_func_factory(nominatim.tools.database_import, 'load_data'),
+        mock_func_factory(nominatim.tools.database_import, 'create_search_indices'),
+        mock_func_factory(nominatim.tools.database_import, 'create_country_names'),
+        mock_func_factory(nominatim.tools.postcodes, 'import_postcodes'),
+        mock_func_factory(nominatim.indexer.indexer.Indexer, 'index_full'),
+        mock_func_factory(nominatim.tools.refresh, 'setup_website'),
+        mock_func_factory(nominatim.db.properties, 'set_property')
+    ]
+
+    assert 0 == call_nominatim('import', '--continue', 'load-data')
+    assert tokenizer_mock.finalize_import_called
+
+    for mock in mocks:
+        assert mock.called == 1, "Mock '{}' not called".format(mock.func_name)
+
+
+def test_import_continue_indexing(temp_db, mock_func_factory, placex_table,
+                                  temp_db_conn, tokenizer_mock):
+    mocks = [
+        mock_func_factory(nominatim.tools.database_import, 'create_search_indices'),
+        mock_func_factory(nominatim.tools.database_import, 'create_country_names'),
+        mock_func_factory(nominatim.indexer.indexer.Indexer, 'index_full'),
+        mock_func_factory(nominatim.tools.refresh, 'setup_website'),
+        mock_func_factory(nominatim.db.properties, 'set_property')
+    ]
+
+    assert 0 == call_nominatim('import', '--continue', 'indexing')
+
+    for mock in mocks:
+        assert mock.called == 1, "Mock '{}' not called".format(mock.func_name)
+
+    assert temp_db_conn.index_exists('idx_placex_pendingsector')
+
+    # Calling it again still works for the index
+    assert 0 == call_nominatim('import', '--continue', 'indexing')
+    assert temp_db_conn.index_exists('idx_placex_pendingsector')
+
+
+def test_import_continue_postprocess(temp_db, mock_func_factory, tokenizer_mock):
+    mocks = [
+        mock_func_factory(nominatim.tools.database_import, 'create_search_indices'),
+        mock_func_factory(nominatim.tools.database_import, 'create_country_names'),
+        mock_func_factory(nominatim.tools.refresh, 'setup_website'),
+        mock_func_factory(nominatim.db.properties, 'set_property')
+    ]
+
+    assert 0 == call_nominatim('import', '--continue', 'db-postprocess')
+
+    assert tokenizer_mock.finalize_import_called
+
+    for mock in mocks:
+        assert mock.called == 1, "Mock '{}' not called".format(mock.func_name)
+
+
+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')])
+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
+
+
+def test_admin_command_check_database(mock_func_factory):
+    mock = mock_func_factory(nominatim.tools.check_database, 'check_database')
+
+    assert 0 == call_nominatim('admin', '--check-database')
+    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):
 @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):


@@ -81,42 +244,83 @@ def test_add_data_command(mock_run_legacy, name, oid):
                           (['--boundaries-only'], 1, 0),
                           (['--no-boundaries'], 0, 1),
                           (['--boundaries-only', '--no-boundaries'], 0, 0)])
                           (['--boundaries-only'], 1, 0),
                           (['--no-boundaries'], 0, 1),
                           (['--boundaries-only', '--no-boundaries'], 0, 0)])

-def test_index_command(monkeypatch, params, do_bnds, do_ranks):
-    bnd_mock = MockParamCapture()
-    monkeypatch.setattr(nominatim.cli.Indexer, 'index_boundaries', bnd_mock)
-    rank_mock = MockParamCapture()
-    monkeypatch.setattr(nominatim.cli.Indexer, 'index_by_rank', rank_mock)
+def test_index_command(mock_func_factory, temp_db_cursor, tokenizer_mock,
+                       params, do_bnds, do_ranks):
+    temp_db_cursor.execute("CREATE TABLE import_status (indexed bool)")
+    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)
 
     assert bnd_mock.called == do_bnds
     assert rank_mock.called == do_ranks
 
 
     assert 0 == call_nominatim('index', *params)
 
     assert bnd_mock.called == do_bnds
     assert rank_mock.called == do_ranks
 

+@pytest.mark.parametrize("no_replace", [(True), (False)])
+def test_special_phrases_wiki_command(temp_db, mock_func_factory, tokenizer_mock, no_replace):
+    func = mock_func_factory(nominatim.clicmd.special_phrases.SPImporter, 'import_phrases')
+
+    if no_replace:
+        call_nominatim('special-phrases', '--import-from-wiki', '--no-replace')
+    else:
+        call_nominatim('special-phrases', '--import-from-wiki')
+
+    assert func.called == 1

 
 

-@pytest.mark.parametrize("command,params", [
-                         ('postcodes', ('update.php', '--calculate-postcodes')),
-                         ('word-counts', ('update.php', '--recompute-word-counts')),
-                         ('address-levels', ('update.php', '--update-address-levels')),
-                         ('functions', ('setup.php',)),
-                         ('wiki-data', ('setup.php', '--import-wikipedia-articles')),
-                         ('importance', ('update.php', '--recompute-importance')),
-                         ('website', ('setup.php', '--setup-website')),
+@pytest.mark.parametrize("no_replace", [(True), (False)])
+def test_special_phrases_csv_command(temp_db, mock_func_factory, tokenizer_mock, no_replace):
+    func = mock_func_factory(nominatim.clicmd.special_phrases.SPImporter, 'import_phrases')
+    testdata = SRC_DIR / 'test' / 'testdb'
+    csv_path = str((testdata / 'full_en_phrases_test.csv').resolve())
+
+    if no_replace:
+        call_nominatim('special-phrases', '--import-from-csv', csv_path, '--no-replace')
+    else:
+        call_nominatim('special-phrases', '--import-from-csv', csv_path)
+
+    assert func.called == 1
+
+@pytest.mark.parametrize("command,func", [
+                         ('postcodes', 'update_postcodes'),
+                         ('word-counts', 'recompute_word_counts'),
+                         ('address-levels', 'load_address_levels_from_file'),
+                         ('wiki-data', 'import_wikipedia_articles'),
+                         ('importance', 'recompute_importance'),
+                         ('website', 'setup_website'),

                          ])
                          ])

-def test_refresh_command(mock_run_legacy, command, params):
+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 0 == call_nominatim('refresh', '--' + command)

+    assert func_mock.called == 1
+
+
+def test_refresh_create_functions(mock_func_factory, temp_db, tokenizer_mock):
+    func_mock = mock_func_factory(nominatim.tools.refresh, 'create_functions')
+
+    assert 0 == call_nominatim('refresh', '--functions')
+    assert func_mock.called == 1
+    assert tokenizer_mock.update_sql_functions_called

 
 

-    assert mock_run_legacy.called == 1
-    assert len(mock_run_legacy.last_args) >= len(params)
-    assert mock_run_legacy.last_args[:len(params)] == params

 
 

+def test_refresh_importance_computed_after_wiki_import(monkeypatch, temp_db):
+    calls = []
+    monkeypatch.setattr(nominatim.tools.refresh, 'import_wikipedia_articles',
+                        lambda *args, **kwargs: calls.append('import') or 0)
+    monkeypatch.setattr(nominatim.tools.refresh, 'recompute_importance',
+                        lambda *args, **kwargs: calls.append('update'))

 
 

-def test_refresh_importance_computed_after_wiki_import(mock_run_legacy):

     assert 0 == call_nominatim('refresh', '--importance', '--wiki-data')
 
     assert 0 == call_nominatim('refresh', '--importance', '--wiki-data')
 

-    assert mock_run_legacy.called == 2
-    assert mock_run_legacy.last_args == ('update.php', '--recompute-importance')
+    assert calls == ['import', 'update']

 
 
 
 

+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'),
 @pytest.mark.parametrize("params", [
                          ('search', '--query', 'new'),
                          ('reverse', '--lat', '0', '--lon', '0'),


@@ -127,7 +331,9 @@ def test_refresh_importance_computed_after_wiki_import(mock_run_legacy):
                          ('details', '--place_id', '10001'),
                          ('status',)
                          ])
                          ('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
     assert 0 == call_nominatim(*params)
 
     assert mock_run_api.called == 1