test/python/test_cli.py

   1 """
   2 Tests for command line interface wrapper.
   3
   4 These tests just check that the various command line parameters route to the
   5 correct functionionality. They use a lot of monkeypatching to avoid executing
   6 the actual functions.
   7 """
   8 from pathlib import Path
   9
  10 import pytest
  11
  12 import nominatim.db.properties
  13 import nominatim.cli
  14 import nominatim.clicmd.api
  15 import nominatim.clicmd.refresh
  16 import nominatim.clicmd.admin
  17 import nominatim.clicmd.setup
  18 import nominatim.indexer.indexer
  19 import nominatim.tools.admin
  20 import nominatim.tools.check_database
  21 import nominatim.tools.database_import
  22 import nominatim.tools.freeze
  23 import nominatim.tools.refresh
  24 import nominatim.tools.postcodes
  25 import nominatim.tokenizer.factory
  26
  27 from mocks import MockParamCapture
  28
  29 SRC_DIR = (Path(__file__) / '..' / '..' / '..').resolve()
  30
  31 def call_nominatim(*args):
  32     return nominatim.cli.nominatim(module_dir='build/module',
  33                                    osm2pgsql_path='build/osm2pgsql/osm2pgsql',
  34                                    phplib_dir=str(SRC_DIR / 'lib-php'),
  35                                    data_dir=str(SRC_DIR / 'data'),
  36                                    phpcgi_path='/usr/bin/php-cgi',
  37                                    sqllib_dir=str(SRC_DIR / 'lib-sql'),
  38                                    config_dir=str(SRC_DIR / 'settings'),
  39                                    cli_args=args)
  40
  41
  42 @pytest.fixture
  43 def mock_run_legacy(monkeypatch):
  44     mock = MockParamCapture()
  45     monkeypatch.setattr(nominatim.cli, 'run_legacy_script', mock)
  46     return mock
  47
  48
  49 @pytest.fixture
  50 def mock_func_factory(monkeypatch):
  51     def get_mock(module, func):
  52         mock = MockParamCapture()
  53         mock.func_name = func
  54         monkeypatch.setattr(module, func, mock)
  55         return mock
  56
  57     return get_mock
  58
  59
  60 @pytest.fixture
  61 def tokenizer_mock(monkeypatch):
  62     class DummyTokenizer:
  63         def __init__(self, *args, **kwargs):
  64             self.update_sql_functions_called = False
  65             self.finalize_import_called = False
  66
  67         def update_sql_functions(self, *args):
  68             self.update_sql_functions_called = True
  69
  70         def finalize_import(self, *args):
  71             self.finalize_import_called = True
  72
  73     tok = DummyTokenizer()
  74     monkeypatch.setattr(nominatim.tokenizer.factory, 'get_tokenizer_for_db' ,
  75                         lambda *args: tok)
  76     monkeypatch.setattr(nominatim.tokenizer.factory, 'create_tokenizer' ,
  77                         lambda *args: tok)
  78
  79     return tok
  80
  81
  82 def test_cli_help(capsys):
  83     """ Running nominatim tool without arguments prints help.
  84     """
  85     assert 1 == call_nominatim()
  86
  87     captured = capsys.readouterr()
  88     assert captured.out.startswith('usage:')
  89
  90
  91 @pytest.mark.parametrize("command,script", [
  92                          (('add-data', '--file', 'foo.osm'), 'update'),
  93                          (('export',), 'export')
  94                          ])
  95 def test_legacy_commands_simple(mock_run_legacy, command, script):
  96     assert 0 == call_nominatim(*command)
  97
  98     assert mock_run_legacy.called == 1
  99     assert mock_run_legacy.last_args[0] == script + '.php'
 100
 101
 102 def test_import_missing_file(temp_db):
 103     assert 1 == call_nominatim('import', '--osm-file', 'sfsafegweweggdgw.reh.erh')
 104
 105
 106 def test_import_bad_file(temp_db):
 107     assert 1 == call_nominatim('import', '--osm-file', '.')
 108
 109
 110 def test_import_full(temp_db, mock_func_factory, tokenizer_mock):
 111     mocks = [
 112         mock_func_factory(nominatim.tools.database_import, 'setup_database_skeleton'),
 113         mock_func_factory(nominatim.tools.database_import, 'import_osm_data'),
 114         mock_func_factory(nominatim.tools.refresh, 'import_wikipedia_articles'),
 115         mock_func_factory(nominatim.tools.database_import, 'truncate_data_tables'),
 116         mock_func_factory(nominatim.tools.database_import, 'load_data'),
 117         mock_func_factory(nominatim.tools.database_import, 'create_tables'),
 118         mock_func_factory(nominatim.tools.database_import, 'create_table_triggers'),
 119         mock_func_factory(nominatim.tools.database_import, 'create_partition_tables'),
 120         mock_func_factory(nominatim.tools.database_import, 'create_search_indices'),
 121         mock_func_factory(nominatim.tools.database_import, 'create_country_names'),
 122         mock_func_factory(nominatim.tools.refresh, 'load_address_levels_from_file'),
 123         mock_func_factory(nominatim.tools.postcodes, 'update_postcodes'),
 124         mock_func_factory(nominatim.indexer.indexer.Indexer, 'index_full'),
 125         mock_func_factory(nominatim.tools.refresh, 'setup_website'),
 126         mock_func_factory(nominatim.db.properties, 'set_property')
 127     ]
 128
 129     cf_mock = mock_func_factory(nominatim.tools.refresh, 'create_functions')
 130
 131     assert 0 == call_nominatim('import', '--osm-file', __file__)
 132     assert tokenizer_mock.finalize_import_called
 133
 134     assert cf_mock.called > 1
 135
 136     for mock in mocks:
 137         assert mock.called == 1, "Mock '{}' not called".format(mock.func_name)
 138
 139
 140 def test_import_continue_load_data(temp_db, mock_func_factory, tokenizer_mock):
 141     mocks = [
 142         mock_func_factory(nominatim.tools.database_import, 'truncate_data_tables'),
 143         mock_func_factory(nominatim.tools.database_import, 'load_data'),
 144         mock_func_factory(nominatim.tools.database_import, 'create_search_indices'),
 145         mock_func_factory(nominatim.tools.database_import, 'create_country_names'),
 146         mock_func_factory(nominatim.tools.postcodes, 'update_postcodes'),
 147         mock_func_factory(nominatim.indexer.indexer.Indexer, 'index_full'),
 148         mock_func_factory(nominatim.tools.refresh, 'setup_website'),
 149         mock_func_factory(nominatim.db.properties, 'set_property')
 150     ]
 151
 152     assert 0 == call_nominatim('import', '--continue', 'load-data')
 153     assert tokenizer_mock.finalize_import_called
 154
 155     for mock in mocks:
 156         assert mock.called == 1, "Mock '{}' not called".format(mock.func_name)
 157
 158
 159 def test_import_continue_indexing(temp_db, mock_func_factory, placex_table,
 160                                   temp_db_conn, tokenizer_mock):
 161     mocks = [
 162         mock_func_factory(nominatim.tools.database_import, 'create_search_indices'),
 163         mock_func_factory(nominatim.tools.database_import, 'create_country_names'),
 164         mock_func_factory(nominatim.indexer.indexer.Indexer, 'index_full'),
 165         mock_func_factory(nominatim.tools.refresh, 'setup_website'),
 166         mock_func_factory(nominatim.db.properties, 'set_property')
 167     ]
 168
 169     assert 0 == call_nominatim('import', '--continue', 'indexing')
 170
 171     for mock in mocks:
 172         assert mock.called == 1, "Mock '{}' not called".format(mock.func_name)
 173
 174     assert temp_db_conn.index_exists('idx_placex_pendingsector')
 175
 176     # Calling it again still works for the index
 177     assert 0 == call_nominatim('import', '--continue', 'indexing')
 178     assert temp_db_conn.index_exists('idx_placex_pendingsector')
 179
 180
 181 def test_import_continue_postprocess(temp_db, mock_func_factory, tokenizer_mock):
 182     mocks = [
 183         mock_func_factory(nominatim.tools.database_import, 'create_search_indices'),
 184         mock_func_factory(nominatim.tools.database_import, 'create_country_names'),
 185         mock_func_factory(nominatim.tools.refresh, 'setup_website'),
 186         mock_func_factory(nominatim.db.properties, 'set_property')
 187     ]
 188
 189     assert 0 == call_nominatim('import', '--continue', 'db-postprocess')
 190
 191     assert tokenizer_mock.finalize_import_called
 192
 193     for mock in mocks:
 194         assert mock.called == 1, "Mock '{}' not called".format(mock.func_name)
 195
 196
 197 def test_freeze_command(mock_func_factory, temp_db):
 198     mock_drop = mock_func_factory(nominatim.tools.freeze, 'drop_update_tables')
 199     mock_flatnode = mock_func_factory(nominatim.tools.freeze, 'drop_flatnode_file')
 200
 201     assert 0 == call_nominatim('freeze')
 202
 203     assert mock_drop.called == 1
 204     assert mock_flatnode.called == 1
 205
 206
 207 @pytest.mark.parametrize("params", [('--warm', ),
 208                                     ('--warm', '--reverse-only'),
 209                                     ('--warm', '--search-only')])
 210 def test_admin_command_legacy(mock_func_factory, params):
 211     mock_run_legacy = mock_func_factory(nominatim.clicmd.admin, 'run_legacy_script')
 212
 213     assert 0 == call_nominatim('admin', *params)
 214
 215     assert mock_run_legacy.called == 1
 216
 217
 218 @pytest.mark.parametrize("func, params", [('analyse_indexing', ('--analyse-indexing', ))])
 219 def test_admin_command_tool(temp_db, mock_func_factory, func, params):
 220     mock = mock_func_factory(nominatim.tools.admin, func)
 221
 222     assert 0 == call_nominatim('admin', *params)
 223     assert mock.called == 1
 224
 225
 226 def test_admin_command_check_database(mock_func_factory):
 227     mock = mock_func_factory(nominatim.tools.check_database, 'check_database')
 228
 229     assert 0 == call_nominatim('admin', '--check-database')
 230     assert mock.called == 1
 231
 232
 233 @pytest.mark.parametrize("name,oid", [('file', 'foo.osm'), ('diff', 'foo.osc'),
 234                                       ('node', 12), ('way', 8), ('relation', 32)])
 235 def test_add_data_command(mock_run_legacy, name, oid):
 236     assert 0 == call_nominatim('add-data', '--' + name, str(oid))
 237
 238     assert mock_run_legacy.called == 1
 239     assert mock_run_legacy.last_args == ('update.php', '--import-' + name, oid)
 240
 241
 242 @pytest.mark.parametrize("params,do_bnds,do_ranks", [
 243                           ([], 1, 1),
 244                           (['--boundaries-only'], 1, 0),
 245                           (['--no-boundaries'], 0, 1),
 246                           (['--boundaries-only', '--no-boundaries'], 0, 0)])
 247 def test_index_command(mock_func_factory, temp_db_cursor, tokenizer_mock,
 248                        params, do_bnds, do_ranks):
 249     temp_db_cursor.execute("CREATE TABLE import_status (indexed bool)")
 250     bnd_mock = mock_func_factory(nominatim.indexer.indexer.Indexer, 'index_boundaries')
 251     rank_mock = mock_func_factory(nominatim.indexer.indexer.Indexer, 'index_by_rank')
 252
 253     assert 0 == call_nominatim('index', *params)
 254
 255     assert bnd_mock.called == do_bnds
 256     assert rank_mock.called == do_ranks
 257
 258 @pytest.mark.parametrize("no_replace", [(True), (False)])
 259 def test_special_phrases_wiki_command(temp_db, mock_func_factory, tokenizer_mock, no_replace):
 260     func = mock_func_factory(nominatim.clicmd.special_phrases.SPImporter, 'import_phrases')
 261
 262     if no_replace:
 263         call_nominatim('special-phrases', '--import-from-wiki', '--no-replace')
 264     else:
 265         call_nominatim('special-phrases', '--import-from-wiki')
 266
 267     assert func.called == 1
 268
 269 @pytest.mark.parametrize("no_replace", [(True), (False)])
 270 def test_special_phrases_csv_command(temp_db, mock_func_factory, tokenizer_mock, no_replace):
 271     func = mock_func_factory(nominatim.clicmd.special_phrases.SPImporter, 'import_phrases')
 272     testdata = SRC_DIR / 'test' / 'testdb'
 273     csv_path = str((testdata / 'full_en_phrases_test.csv').resolve())
 274
 275     if no_replace:
 276         call_nominatim('special-phrases', '--import-from-csv', csv_path, '--no-replace')
 277     else:
 278         call_nominatim('special-phrases', '--import-from-csv', csv_path)
 279
 280     assert func.called == 1
 281
 282 @pytest.mark.parametrize("command,func", [
 283                          ('word-counts', 'recompute_word_counts'),
 284                          ('address-levels', 'load_address_levels_from_file'),
 285                          ('wiki-data', 'import_wikipedia_articles'),
 286                          ('importance', 'recompute_importance'),
 287                          ('website', 'setup_website'),
 288                          ])
 289 def test_refresh_command(mock_func_factory, temp_db, command, func, tokenizer_mock):
 290     func_mock = mock_func_factory(nominatim.tools.refresh, func)
 291
 292     assert 0 == call_nominatim('refresh', '--' + command)
 293     assert func_mock.called == 1
 294
 295
 296 def test_refresh_postcodes(mock_func_factory, temp_db, tokenizer_mock):
 297     func_mock = mock_func_factory(nominatim.tools.postcodes, 'update_postcodes')
 298     idx_mock = mock_func_factory(nominatim.indexer.indexer.Indexer, 'index_postcodes')
 299
 300     assert 0 == call_nominatim('refresh', '--postcodes')
 301     assert func_mock.called == 1
 302
 303 def test_refresh_create_functions(mock_func_factory, temp_db, tokenizer_mock):
 304     func_mock = mock_func_factory(nominatim.tools.refresh, 'create_functions')
 305
 306     assert 0 == call_nominatim('refresh', '--functions')
 307     assert func_mock.called == 1
 308     assert tokenizer_mock.update_sql_functions_called
 309
 310
 311 def test_refresh_importance_computed_after_wiki_import(monkeypatch, temp_db, tokenizer_mock):
 312     calls = []
 313     monkeypatch.setattr(nominatim.tools.refresh, 'import_wikipedia_articles',
 314                         lambda *args, **kwargs: calls.append('import') or 0)
 315     monkeypatch.setattr(nominatim.tools.refresh, 'recompute_importance',
 316                         lambda *args, **kwargs: calls.append('update'))
 317
 318     assert 0 == call_nominatim('refresh', '--importance', '--wiki-data')
 319
 320     assert calls == ['import', 'update']
 321
 322
 323 def test_serve_command(mock_func_factory):
 324     func = mock_func_factory(nominatim.cli, 'run_php_server')
 325
 326     call_nominatim('serve')
 327
 328     assert func.called == 1
 329
 330 @pytest.mark.parametrize("params", [
 331                          ('search', '--query', 'new'),
 332                          ('reverse', '--lat', '0', '--lon', '0'),
 333                          ('lookup', '--id', 'N1'),
 334                          ('details', '--node', '1'),
 335                          ('details', '--way', '1'),
 336                          ('details', '--relation', '1'),
 337                          ('details', '--place_id', '10001'),
 338                          ('status',)
 339                          ])
 340 def test_api_commands_simple(mock_func_factory, params):
 341     mock_run_api = mock_func_factory(nominatim.clicmd.api, 'run_api_script')
 342
 343     assert 0 == call_nominatim(*params)
 344
 345     assert mock_run_api.called == 1
 346     assert mock_run_api.last_args[0] == params[0]