test/python/cli/test_cli.py

   1 # SPDX-License-Identifier: GPL-2.0-only
   2 #
   3 # This file is part of Nominatim. (https://nominatim.org)
   4 #
   5 # Copyright (C) 2022 by the Nominatim developer community.
   6 # For a full list of authors see the git log.
   7 """
   8 Tests for command line interface wrapper.
   9
  10 These tests just check that the various command line parameters route to the
  11 correct functionionality. They use a lot of monkeypatching to avoid executing
  12 the actual functions.
  13 """
  14 import importlib
  15 import pytest
  16
  17 import nominatim.indexer.indexer
  18 import nominatim.tools.add_osm_data
  19 import nominatim.tools.freeze
  20
  21
  22 def test_cli_help(cli_call, capsys):
  23     """ Running nominatim tool without arguments prints help.
  24     """
  25     assert cli_call() == 1
  26
  27     captured = capsys.readouterr()
  28     assert captured.out.startswith('usage:')
  29
  30 def test_cli_version(cli_call, capsys):
  31     """ Running nominatim tool --version prints a version string.
  32     """
  33     assert cli_call('--version') == 0
  34
  35     captured = capsys.readouterr()
  36     assert captured.out.startswith('Nominatim version')
  37
  38 @pytest.mark.parametrize("name,oid", [('file', 'foo.osm'), ('diff', 'foo.osc')])
  39 def test_cli_add_data_file_command(cli_call, mock_func_factory, name, oid):
  40     mock_run_legacy = mock_func_factory(nominatim.tools.add_osm_data, 'add_data_from_file')
  41     assert cli_call('add-data', '--' + name, str(oid)) == 0
  42
  43     assert mock_run_legacy.called == 1
  44
  45
  46 @pytest.mark.parametrize("name,oid", [('node', 12), ('way', 8), ('relation', 32)])
  47 def test_cli_add_data_object_command(cli_call, mock_func_factory, name, oid):
  48     mock_run_legacy = mock_func_factory(nominatim.tools.add_osm_data, 'add_osm_object')
  49     assert cli_call('add-data', '--' + name, str(oid)) == 0
  50
  51     assert mock_run_legacy.called == 1
  52
  53
  54
  55 def test_cli_add_data_tiger_data(cli_call, cli_tokenizer_mock, mock_func_factory):
  56     mock = mock_func_factory(nominatim.tools.tiger_data, 'add_tiger_data')
  57
  58     assert cli_call('add-data', '--tiger-data', 'somewhere') == 0
  59
  60     assert mock.called == 1
  61
  62
  63 def test_cli_serve_php(cli_call, mock_func_factory):
  64     func = mock_func_factory(nominatim.cli, 'run_php_server')
  65
  66     cli_call('serve') == 0
  67
  68     assert func.called == 1
  69
  70
  71 def test_cli_serve_starlette_custom_server(cli_call, mock_func_factory):
  72     pytest.importorskip("starlette")
  73     mod = pytest.importorskip("uvicorn")
  74     func = mock_func_factory(mod, "run")
  75
  76     cli_call('serve', '--engine', 'starlette', '--server', 'foobar:4545') == 0
  77
  78     assert func.called == 1
  79     assert func.last_kwargs['host'] == 'foobar'
  80     assert func.last_kwargs['port'] == 4545
  81
  82
  83 def test_cli_serve_starlette_custom_server_bad_port(cli_call, mock_func_factory):
  84     pytest.importorskip("starlette")
  85     mod = pytest.importorskip("uvicorn")
  86     func = mock_func_factory(mod, "run")
  87
  88     cli_call('serve', '--engine', 'starlette', '--server', 'foobar:45:45') == 1
  89
  90
  91 @pytest.mark.parametrize("engine", ['falcon', 'starlette'])
  92 def test_cli_serve_uvicorn_based(cli_call, engine, mock_func_factory):
  93     pytest.importorskip(engine)
  94     mod = pytest.importorskip("uvicorn")
  95     func = mock_func_factory(mod, "run")
  96
  97     cli_call('serve', '--engine', engine) == 0
  98
  99     assert func.called == 1
 100     assert func.last_kwargs['host'] == '127.0.0.1'
 101     assert func.last_kwargs['port'] == 8088
 102
 103 def test_cli_export_command(cli_call, mock_run_legacy):
 104     assert cli_call('export', '--output-all-postcodes') == 0
 105
 106     assert mock_run_legacy.called == 1
 107     assert mock_run_legacy.last_args[0] == 'export.php'
 108
 109
 110 @pytest.mark.parametrize("param,value", [('output-type', 'country'),
 111                                          ('output-format', 'street;city'),
 112                                          ('language', 'xf'),
 113                                          ('restrict-to-country', 'us'),
 114                                          ('restrict-to-osm-node', '536'),
 115                                          ('restrict-to-osm-way', '727'),
 116                                          ('restrict-to-osm-relation', '197532')
 117                                         ])
 118 def test_export_parameters(src_dir, tmp_path, param, value, monkeypatch):
 119     (tmp_path / 'admin').mkdir()
 120     (tmp_path / 'admin' / 'export.php').write_text(f"""<?php
 121         exit(strpos(implode(' ', $_SERVER['argv']), '--{param} {value}') >= 0 ? 0 : 10);
 122         """)
 123
 124     monkeypatch.setattr(nominatim.paths, 'PHPLIB_DIR', tmp_path)
 125
 126     assert nominatim.cli.nominatim(module_dir='MODULE NOT AVAILABLE',
 127                                    osm2pgsql_path='OSM2PGSQL NOT AVAILABLE',
 128                                    phpcgi_path='/usr/bin/php-cgi',
 129                                    cli_args=['export', '--' + param, value]) == 0
 130
 131
 132
 133 class TestCliWithDb:
 134
 135     @pytest.fixture(autouse=True)
 136     def setup_cli_call(self, cli_call, temp_db, cli_tokenizer_mock):
 137         self.call_nominatim = cli_call
 138         self.tokenizer_mock = cli_tokenizer_mock
 139
 140
 141     def test_freeze_command(self, mock_func_factory):
 142         mock_drop = mock_func_factory(nominatim.tools.freeze, 'drop_update_tables')
 143         mock_flatnode = mock_func_factory(nominatim.tools.freeze, 'drop_flatnode_file')
 144
 145         assert self.call_nominatim('freeze') == 0
 146
 147         assert mock_drop.called == 1
 148         assert mock_flatnode.called == 1
 149
 150
 151     @pytest.mark.parametrize("params,do_bnds,do_ranks", [
 152                               ([], 1, 1),
 153                               (['--boundaries-only'], 1, 0),
 154                               (['--no-boundaries'], 0, 1),
 155                               (['--boundaries-only', '--no-boundaries'], 0, 0)])
 156     def test_index_command(self, mock_func_factory, table_factory,
 157                            params, do_bnds, do_ranks):
 158         table_factory('import_status', 'indexed bool')
 159         bnd_mock = mock_func_factory(nominatim.indexer.indexer.Indexer, 'index_boundaries')
 160         rank_mock = mock_func_factory(nominatim.indexer.indexer.Indexer, 'index_by_rank')
 161
 162         assert self.call_nominatim('index', *params) == 0
 163
 164         assert bnd_mock.called == do_bnds
 165         assert rank_mock.called == do_ranks
 166
 167
 168     def test_special_phrases_wiki_command(self, mock_func_factory):
 169         func = mock_func_factory(nominatim.clicmd.special_phrases.SPImporter, 'import_phrases')
 170
 171         self.call_nominatim('special-phrases', '--import-from-wiki', '--no-replace')
 172
 173         assert func.called == 1
 174
 175
 176     def test_special_phrases_csv_command(self, src_dir, mock_func_factory):
 177         func = mock_func_factory(nominatim.clicmd.special_phrases.SPImporter, 'import_phrases')
 178         testdata = src_dir / 'test' / 'testdb'
 179         csv_path = str((testdata / 'full_en_phrases_test.csv').resolve())
 180
 181         self.call_nominatim('special-phrases', '--import-from-csv', csv_path)
 182
 183         assert func.called == 1
 184
 185
 186     def test_special_phrases_csv_bad_file(self, src_dir):
 187         testdata = src_dir / 'something349053905.csv'
 188
 189         self.call_nominatim('special-phrases', '--import-from-csv',
 190                             str(testdata.resolve())) == 1