test/python/test_cli.py

   1 """
   2 Tests for command line interface wrapper.
   3 """
   4 import psycopg2
   5 import pytest
   6
   7 import nominatim.cli
   8 import nominatim.indexer.indexer
   9
  10 def call_nominatim(*args):
  11     return nominatim.cli.nominatim(module_dir='build/module',
  12                                    osm2pgsql_path='build/osm2pgsql/osm2pgsql',
  13                                    phplib_dir='lib',
  14                                    data_dir='.',
  15                                    phpcgi_path='/usr/bin/php-cgi',
  16                                    cli_args=args)
  17
  18 class MockParamCapture:
  19     """ Mock that records the parameters with which a function was called
  20         as well as the number of calls.
  21     """
  22     def __init__(self):
  23         self.called = 0
  24         self.return_value = 0
  25
  26     def __call__(self, *args, **kwargs):
  27         self.called += 1
  28         self.last_args = args
  29         self.last_kwargs = kwargs
  30         return self.return_value
  31
  32 @pytest.fixture
  33 def mock_run_legacy(monkeypatch):
  34     mock = MockParamCapture()
  35     monkeypatch.setattr(nominatim.cli, 'run_legacy_script', mock)
  36     return mock
  37
  38 @pytest.fixture
  39 def mock_run_api(monkeypatch):
  40     mock = MockParamCapture()
  41     monkeypatch.setattr(nominatim.cli, 'run_api_script', mock)
  42     return mock
  43
  44
  45 def test_cli_help(capsys):
  46     """ Running nominatim tool without arguments prints help.
  47     """
  48     assert 1 == call_nominatim()
  49
  50     captured = capsys.readouterr()
  51     assert captured.out.startswith('usage:')
  52
  53
  54 @pytest.mark.parametrize("command,script", [
  55                          (('import', '--continue', 'load-data'), 'setup'),
  56                          (('freeze',), 'setup'),
  57                          (('special-phrases',), 'specialphrases'),
  58                          (('replication',), 'update'),
  59                          (('add-data', '--tiger-data', 'tiger'), 'setup'),
  60                          (('add-data', '--file', 'foo.osm'), 'update'),
  61                          (('check-database',), 'check_import_finished'),
  62                          (('warm',), 'warm'),
  63                          (('export',), 'export')
  64                          ])
  65 def test_legacy_commands_simple(mock_run_legacy, command, script):
  66     assert 0 == call_nominatim(*command)
  67
  68     assert mock_run_legacy.called == 1
  69     assert mock_run_legacy.last_args[0] == script + '.php'
  70
  71
  72 @pytest.mark.parametrize("name,oid", [('file', 'foo.osm'), ('diff', 'foo.osc'),
  73                                       ('node', 12), ('way', 8), ('relation', 32)])
  74 def test_add_data_command(mock_run_legacy, name, oid):
  75     assert 0 == call_nominatim('add-data', '--' + name, str(oid))
  76
  77     assert mock_run_legacy.called == 1
  78     assert mock_run_legacy.last_args == ('update.php', '--import-' + name, oid)
  79
  80
  81 @pytest.mark.parametrize("params,do_bnds,do_ranks", [
  82                           ([], 1, 1),
  83                           (['--boundaries-only'], 1, 0),
  84                           (['--no-boundaries'], 0, 1),
  85                           (['--boundaries-only', '--no-boundaries'], 0, 0)])
  86 def test_index_command(monkeypatch, temp_db, params, do_bnds, do_ranks):
  87     with psycopg2.connect(database=temp_db) as conn:
  88         with conn.cursor() as cur:
  89             cur.execute("CREATE TABLE import_status (indexed bool)")
  90     bnd_mock = MockParamCapture()
  91     monkeypatch.setattr(nominatim.indexer.indexer.Indexer, 'index_boundaries', bnd_mock)
  92     rank_mock = MockParamCapture()
  93     monkeypatch.setattr(nominatim.indexer.indexer.Indexer, 'index_by_rank', rank_mock)
  94
  95     assert 0 == call_nominatim('index', *params)
  96
  97     assert bnd_mock.called == do_bnds
  98     assert rank_mock.called == do_ranks
  99
 100
 101 @pytest.mark.parametrize("command,params", [
 102                          ('postcodes', ('update.php', '--calculate-postcodes')),
 103                          ('word-counts', ('update.php', '--recompute-word-counts')),
 104                          ('address-levels', ('update.php', '--update-address-levels')),
 105                          ('functions', ('setup.php',)),
 106                          ('wiki-data', ('setup.php', '--import-wikipedia-articles')),
 107                          ('importance', ('update.php', '--recompute-importance')),
 108                          ('website', ('setup.php', '--setup-website')),
 109                          ])
 110 def test_refresh_command(mock_run_legacy, command, params):
 111     assert 0 == call_nominatim('refresh', '--' + command)
 112
 113     assert mock_run_legacy.called == 1
 114     assert len(mock_run_legacy.last_args) >= len(params)
 115     assert mock_run_legacy.last_args[:len(params)] == params
 116
 117
 118 def test_refresh_importance_computed_after_wiki_import(mock_run_legacy):
 119     assert 0 == call_nominatim('refresh', '--importance', '--wiki-data')
 120
 121     assert mock_run_legacy.called == 2
 122     assert mock_run_legacy.last_args == ('update.php', '--recompute-importance')
 123
 124
 125 @pytest.mark.parametrize("params", [
 126                          ('search', '--query', 'new'),
 127                          ('reverse', '--lat', '0', '--lon', '0'),
 128                          ('lookup', '--id', 'N1'),
 129                          ('details', '--node', '1'),
 130                          ('details', '--way', '1'),
 131                          ('details', '--relation', '1'),
 132                          ('details', '--place_id', '10001'),
 133                          ('status',)
 134                          ])
 135 def test_api_commands_simple(mock_run_api, params):
 136     assert 0 == call_nominatim(*params)
 137
 138     assert mock_run_api.called == 1
 139     assert mock_run_api.last_args[0] == params[0]