always return 0 for updates unless there is an error

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

diff --git a/test/python/test_cli.py b/test/python/test_cli.py
index 71e3ff65cd8e9aed9005223353fff0c08ba9aca0..0c0a689e28b9f99a5897332babd711d9f7cacfa5 100644 (file)
--- a/test/python/test_cli.py
+++ b/test/python/test_cli.py
@@ -1,29 +1,42 @@
 """
 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.

 """
 """

+import datetime as dt

 import psycopg2
 import pytest
 import psycopg2
 import pytest

+import time

 
 import nominatim.cli
 
 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.indexer.indexer
 import nominatim.tools.refresh
 import nominatim.tools.replication

+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',
 
 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',
                                    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.
     """
                                    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.called = 0

-        self.return_value = 0
+        self.return_value = retval

 
     def __call__(self, *args, **kwargs):
         self.called += 1
 
     def __call__(self, *args, **kwargs):
         self.called += 1


@@ -37,12 +50,6 @@ 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
-def mock_run_api(monkeypatch):
-    mock = MockParamCapture()
-    monkeypatch.setattr(nominatim.cli, 'run_api_script', mock)
-    return mock
-

 
 def test_cli_help(capsys):
     """ Running nominatim tool without arguments prints help.
 
 def test_cli_help(capsys):
     """ Running nominatim tool without arguments prints help.


@@ -59,8 +66,6 @@ def test_cli_help(capsys):
                          (('special-phrases',), 'specialphrases'),
                          (('add-data', '--tiger-data', 'tiger'), 'setup'),
                          (('add-data', '--file', 'foo.osm'), 'update'),
                          (('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):
                          (('export',), 'export')
                          ])
 def test_legacy_commands_simple(mock_run_legacy, command, script):


@@ -70,6 +75,26 @@ 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'
 
 

+@pytest.mark.parametrize("params", [('--warm', ),
+                                    ('--warm', '--reverse-only'),
+                                    ('--warm', '--search-only'),
+                                    ('--check-database', )])
+def test_admin_command_legacy(monkeypatch, params):
+    mock_run_legacy = MockParamCapture()
+    monkeypatch.setattr(nominatim.clicmd.admin, 'run_legacy_script', mock_run_legacy)
+
+    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, monkeypatch, func, params):
+    mock = MockParamCapture()
+    monkeypatch.setattr(nominatim.tools.admin, func, mock)
+
+    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):
 @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):


@@ -102,7 +127,10 @@ def test_index_command(monkeypatch, temp_db_cursor, params, do_bnds, do_ranks):
                          ('importance', ('update.php', '--recompute-importance')),
                          ('website', ('setup.php', '--setup-website')),
                          ])
                          ('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(monkeypatch, temp_db, command, params):
+    mock_run_legacy = MockParamCapture()
+    monkeypatch.setattr(nominatim.clicmd.refresh, 'run_legacy_script', mock_run_legacy)
+

     assert 0 == call_nominatim('refresh', '--' + command)
 
     assert mock_run_legacy.called == 1
     assert 0 == call_nominatim('refresh', '--' + command)
 
     assert mock_run_legacy.called == 1


@@ -123,7 +151,10 @@ def test_refresh_command(monkeypatch, temp_db, command, func):
     assert func_mock.called == 1
 
 
     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(monkeypatch, temp_db):
+    mock_run_legacy = MockParamCapture()
+    monkeypatch.setattr(nominatim.clicmd.refresh, 'run_legacy_script', mock_run_legacy)
+

     assert 0 == call_nominatim('refresh', '--importance', '--wiki-data')
 
     assert mock_run_legacy.called == 2
     assert 0 == call_nominatim('refresh', '--importance', '--wiki-data')
 
     assert mock_run_legacy.called == 2


@@ -142,6 +173,77 @@ def test_replication_command(monkeypatch, temp_db, params, func):
     assert func_mock.called == 1
 
 
     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(monkeypatch, 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 = MockParamCapture(retval=state)
+    monkeypatch.setattr(nominatim.tools.replication, 'update', func_mock)
+
+    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(monkeypatch):
+    func = MockParamCapture()
+    monkeypatch.setattr(nominatim.cli, 'run_php_server', func)
+
+    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'),


@@ -152,7 +254,10 @@ def test_replication_command(monkeypatch, temp_db, params, func):
                          ('details', '--place_id', '10001'),
                          ('status',)
                          ])
                          ('details', '--place_id', '10001'),
                          ('status',)
                          ])

-def test_api_commands_simple(mock_run_api, params):
+def test_api_commands_simple(monkeypatch, params):
+    mock_run_api = MockParamCapture()
+    monkeypatch.setattr(nominatim.clicmd.api, 'run_api_script', mock_run_api)
+

     assert 0 == call_nominatim(*params)
 
     assert mock_run_api.called == 1
     assert 0 == call_nominatim(*params)
 
     assert mock_run_api.called == 1