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
  26 from mocks import MockParamCapture
  27
  28 SRC_DIR = (Path(__file__) / '..' / '..' / '..').resolve()
  29
  30 def call_nominatim(*args):
  31     return nominatim.cli.nominatim(module_dir='build/module',
  32                                    osm2pgsql_path='build/osm2pgsql/osm2pgsql',
  33                                    phplib_dir=str(SRC_DIR / 'lib-php'),
  34                                    data_dir=str(SRC_DIR / 'data'),
  35                                    phpcgi_path='/usr/bin/php-cgi',
  36                                    sqllib_dir=str(SRC_DIR / 'lib-sql'),
  37                                    config_dir=str(SRC_DIR / 'settings'),
  38                                    cli_args=args)
  39
  40
  41 @pytest.fixture
  42 def mock_run_legacy(monkeypatch):
  43     mock = MockParamCapture()
  44     monkeypatch.setattr(nominatim.cli, 'run_legacy_script', mock)
  45     return mock
  46
  47
  48 @pytest.fixture
  49 def mock_func_factory(monkeypatch):
  50     def get_mock(module, func):
  51         mock = MockParamCapture()
  52         mock.func_name = func
  53         monkeypatch.setattr(module, func, mock)
  54         return mock
  55
  56     return get_mock
  57
  58
  59 def test_cli_help(capsys):
  60     """ Running nominatim tool without arguments prints help.
  61     """
  62     assert 1 == call_nominatim()
  63
  64     captured = capsys.readouterr()
  65     assert captured.out.startswith('usage:')
  66
  67
  68 @pytest.mark.parametrize("command,script", [
  69                          (('add-data', '--file', 'foo.osm'), 'update'),
  70                          (('export',), 'export')
  71                          ])
  72 def test_legacy_commands_simple(mock_run_legacy, command, script):
  73     assert 0 == call_nominatim(*command)
  74
  75     assert mock_run_legacy.called == 1
  76     assert mock_run_legacy.last_args[0] == script + '.php'
  77
  78
  79 def test_import_missing_file(temp_db):
  80     assert 1 == call_nominatim('import', '--osm-file', 'sfsafegweweggdgw.reh.erh')
  81
  82
  83 def test_import_bad_file(temp_db):
  84     assert 1 == call_nominatim('import', '--osm-file', '.')
  85
  86
  87 def test_import_full(temp_db, mock_func_factory):
  88     mocks = [
  89         mock_func_factory(nominatim.tools.database_import, 'setup_database_skeleton'),
  90         mock_func_factory(nominatim.tools.database_import, 'install_module'),
  91         mock_func_factory(nominatim.tools.database_import, 'import_osm_data'),
  92         mock_func_factory(nominatim.tools.refresh, 'import_wikipedia_articles'),
  93         mock_func_factory(nominatim.tools.database_import, 'truncate_data_tables'),
  94         mock_func_factory(nominatim.tools.database_import, 'load_data'),
  95         mock_func_factory(nominatim.tools.database_import, 'create_tables'),
  96         mock_func_factory(nominatim.tools.database_import, 'create_table_triggers'),
  97         mock_func_factory(nominatim.tools.database_import, 'create_partition_tables'),
  98         mock_func_factory(nominatim.tools.database_import, 'create_search_indices'),
  99         mock_func_factory(nominatim.tools.database_import, 'create_country_names'),
 100         mock_func_factory(nominatim.tools.refresh, 'load_address_levels_from_file'),
 101         mock_func_factory(nominatim.tools.postcodes, 'import_postcodes'),
 102         mock_func_factory(nominatim.indexer.indexer.Indexer, 'index_full'),
 103         mock_func_factory(nominatim.tools.refresh, 'setup_website'),
 104         mock_func_factory(nominatim.db.properties, 'set_property')
 105     ]
 106
 107     cf_mock = mock_func_factory(nominatim.tools.refresh, 'create_functions')
 108
 109     assert 0 == call_nominatim('import', '--osm-file', __file__)
 110
 111     assert cf_mock.called > 1
 112
 113     for mock in mocks:
 114         assert mock.called == 1, "Mock '{}' not called".format(mock.func_name)
 115
 116
 117 def test_import_continue_load_data(temp_db, mock_func_factory):
 118     mocks = [
 119         mock_func_factory(nominatim.tools.database_import, 'truncate_data_tables'),
 120         mock_func_factory(nominatim.tools.database_import, 'load_data'),
 121         mock_func_factory(nominatim.tools.database_import, 'create_search_indices'),
 122         mock_func_factory(nominatim.tools.database_import, 'create_country_names'),
 123         mock_func_factory(nominatim.tools.postcodes, 'import_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     assert 0 == call_nominatim('import', '--continue', 'load-data')
 130
 131     for mock in mocks:
 132         assert mock.called == 1, "Mock '{}' not called".format(mock.func_name)
 133
 134
 135 def test_import_continue_indexing(temp_db, mock_func_factory, placex_table, temp_db_conn):
 136     mocks = [
 137         mock_func_factory(nominatim.tools.database_import, 'create_search_indices'),
 138         mock_func_factory(nominatim.tools.database_import, 'create_country_names'),
 139         mock_func_factory(nominatim.indexer.indexer.Indexer, 'index_full'),
 140         mock_func_factory(nominatim.tools.refresh, 'setup_website'),
 141         mock_func_factory(nominatim.db.properties, 'set_property')
 142     ]
 143
 144     assert 0 == call_nominatim('import', '--continue', 'indexing')
 145
 146     for mock in mocks:
 147         assert mock.called == 1, "Mock '{}' not called".format(mock.func_name)
 148
 149     assert temp_db_conn.index_exists('idx_placex_pendingsector')
 150
 151     # Calling it again still works for the index
 152     assert 0 == call_nominatim('import', '--continue', 'indexing')
 153     assert temp_db_conn.index_exists('idx_placex_pendingsector')
 154
 155
 156 def test_import_continue_postprocess(temp_db, mock_func_factory):
 157     mocks = [
 158         mock_func_factory(nominatim.tools.database_import, 'create_search_indices'),
 159         mock_func_factory(nominatim.tools.database_import, 'create_country_names'),
 160         mock_func_factory(nominatim.tools.refresh, 'setup_website'),
 161         mock_func_factory(nominatim.db.properties, 'set_property')
 162     ]
 163
 164     assert 0 == call_nominatim('import', '--continue', 'db-postprocess')
 165
 166     for mock in mocks:
 167         assert mock.called == 1, "Mock '{}' not called".format(mock.func_name)
 168
 169
 170 def test_freeze_command(mock_func_factory, temp_db):
 171     mock_drop = mock_func_factory(nominatim.tools.freeze, 'drop_update_tables')
 172     mock_flatnode = mock_func_factory(nominatim.tools.freeze, 'drop_flatnode_file')
 173
 174     assert 0 == call_nominatim('freeze')
 175
 176     assert mock_drop.called == 1
 177     assert mock_flatnode.called == 1
 178
 179
 180 @pytest.mark.parametrize("params", [('--warm', ),
 181                                     ('--warm', '--reverse-only'),
 182                                     ('--warm', '--search-only')])
 183 def test_admin_command_legacy(mock_func_factory, params):
 184     mock_run_legacy = mock_func_factory(nominatim.clicmd.admin, 'run_legacy_script')
 185
 186     assert 0 == call_nominatim('admin', *params)
 187
 188     assert mock_run_legacy.called == 1
 189
 190
 191 @pytest.mark.parametrize("func, params", [('analyse_indexing', ('--analyse-indexing', ))])
 192 def test_admin_command_tool(temp_db, mock_func_factory, func, params):
 193     mock = mock_func_factory(nominatim.tools.admin, func)
 194
 195     assert 0 == call_nominatim('admin', *params)
 196     assert mock.called == 1
 197
 198
 199 def test_admin_command_check_database(mock_func_factory):
 200     mock = mock_func_factory(nominatim.tools.check_database, 'check_database')
 201
 202     assert 0 == call_nominatim('admin', '--check-database')
 203     assert mock.called == 1
 204
 205
 206 @pytest.mark.parametrize("name,oid", [('file', 'foo.osm'), ('diff', 'foo.osc'),
 207                                       ('node', 12), ('way', 8), ('relation', 32)])
 208 def test_add_data_command(mock_run_legacy, name, oid):
 209     assert 0 == call_nominatim('add-data', '--' + name, str(oid))
 210
 211     assert mock_run_legacy.called == 1
 212     assert mock_run_legacy.last_args == ('update.php', '--import-' + name, oid)
 213
 214
 215 @pytest.mark.parametrize("params,do_bnds,do_ranks", [
 216                           ([], 1, 1),
 217                           (['--boundaries-only'], 1, 0),
 218                           (['--no-boundaries'], 0, 1),
 219                           (['--boundaries-only', '--no-boundaries'], 0, 0)])
 220 def test_index_command(mock_func_factory, temp_db_cursor, params, do_bnds, do_ranks):
 221     temp_db_cursor.execute("CREATE TABLE import_status (indexed bool)")
 222     bnd_mock = mock_func_factory(nominatim.indexer.indexer.Indexer, 'index_boundaries')
 223     rank_mock = mock_func_factory(nominatim.indexer.indexer.Indexer, 'index_by_rank')
 224
 225     assert 0 == call_nominatim('index', *params)
 226
 227     assert bnd_mock.called == do_bnds
 228     assert rank_mock.called == do_ranks
 229
 230 def test_special_phrases_command(temp_db, mock_func_factory):
 231     func = mock_func_factory(nominatim.clicmd.special_phrases.SpecialPhrasesImporter, 'import_from_wiki')
 232
 233     call_nominatim('special-phrases', '--import-from-wiki')
 234
 235     assert func.called == 1
 236
 237 @pytest.mark.parametrize("command,func", [
 238                          ('postcodes', 'update_postcodes'),
 239                          ('word-counts', 'recompute_word_counts'),
 240                          ('address-levels', 'load_address_levels_from_file'),
 241                          ('functions', 'create_functions'),
 242                          ('wiki-data', 'import_wikipedia_articles'),
 243                          ('importance', 'recompute_importance'),
 244                          ('website', 'setup_website'),
 245                          ])
 246 def test_refresh_command(mock_func_factory, temp_db, command, func):
 247     func_mock = mock_func_factory(nominatim.tools.refresh, func)
 248
 249     assert 0 == call_nominatim('refresh', '--' + command)
 250     assert func_mock.called == 1
 251
 252
 253 def test_refresh_importance_computed_after_wiki_import(monkeypatch, temp_db):
 254     calls = []
 255     monkeypatch.setattr(nominatim.tools.refresh, 'import_wikipedia_articles',
 256                         lambda *args, **kwargs: calls.append('import') or 0)
 257     monkeypatch.setattr(nominatim.tools.refresh, 'recompute_importance',
 258                         lambda *args, **kwargs: calls.append('update'))
 259
 260     assert 0 == call_nominatim('refresh', '--importance', '--wiki-data')
 261
 262     assert calls == ['import', 'update']
 263
 264
 265 def test_serve_command(mock_func_factory):
 266     func = mock_func_factory(nominatim.cli, 'run_php_server')
 267
 268     call_nominatim('serve')
 269
 270     assert func.called == 1
 271
 272 @pytest.mark.parametrize("params", [
 273                          ('search', '--query', 'new'),
 274                          ('reverse', '--lat', '0', '--lon', '0'),
 275                          ('lookup', '--id', 'N1'),
 276                          ('details', '--node', '1'),
 277                          ('details', '--way', '1'),
 278                          ('details', '--relation', '1'),
 279                          ('details', '--place_id', '10001'),
 280                          ('status',)
 281                          ])
 282 def test_api_commands_simple(mock_func_factory, params):
 283     mock_run_api = mock_func_factory(nominatim.clicmd.api, 'run_api_script')
 284
 285     assert 0 == call_nominatim(*params)
 286
 287     assert mock_run_api.called == 1
 288     assert mock_run_api.last_args[0] == params[0]