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