test/python/cli/test_cli.py

   1 # SPDX-License-Identifier: GPL-3.0-or-later
   2 #
   3 # This file is part of Nominatim. (https://nominatim.org)
   4 #
   5 # Copyright (C) 2024 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 functionality. They use a lot of monkeypatching to avoid executing
  12 the actual functions.
  13 """
  14 import importlib
  15 import pytest
  16
  17 import nominatim_db.indexer.indexer
  18 import nominatim_db.tools.add_osm_data
  19 import nominatim_db.tools.freeze
  20 import nominatim_db.tools.tiger_data
  21
  22
  23 def test_cli_help(cli_call, capsys):
  24     """ Running nominatim tool without arguments prints help.
  25     """
  26     assert cli_call() == 1
  27
  28     captured = capsys.readouterr()
  29     assert captured.out.startswith('usage:')
  30
  31 def test_cli_version(cli_call, capsys):
  32     """ Running nominatim tool --version prints a version string.
  33     """
  34     assert cli_call('--version') == 0
  35
  36     captured = capsys.readouterr()
  37     assert captured.out.startswith('Nominatim version')
  38
  39 @pytest.mark.parametrize("name,oid", [('file', 'foo.osm'), ('diff', 'foo.osc')])
  40 def test_cli_add_data_file_command(cli_call, mock_func_factory, name, oid):
  41     mock_run_legacy = mock_func_factory(nominatim_db.tools.add_osm_data, 'add_data_from_file')
  42     assert cli_call('add-data', '--' + name, str(oid)) == 0
  43
  44     assert mock_run_legacy.called == 1
  45
  46
  47 @pytest.mark.parametrize("name,oid", [('node', 12), ('way', 8), ('relation', 32)])
  48 def test_cli_add_data_object_command(cli_call, mock_func_factory, name, oid):
  49     mock_run_legacy = mock_func_factory(nominatim_db.tools.add_osm_data, 'add_osm_object')
  50     assert cli_call('add-data', '--' + name, str(oid)) == 0
  51
  52     assert mock_run_legacy.called == 1
  53
  54
  55
  56 def test_cli_add_data_tiger_data(cli_call, cli_tokenizer_mock, async_mock_func_factory):
  57     mock = async_mock_func_factory(nominatim_db.tools.tiger_data, 'add_tiger_data')
  58
  59     assert cli_call('add-data', '--tiger-data', 'somewhere') == 0
  60
  61     assert mock.called == 1
  62
  63
  64 def test_cli_serve_php(cli_call, mock_func_factory):
  65     func = mock_func_factory(nominatim_db.cli, 'run_php_server')
  66
  67     cli_call('serve', '--engine', 'php') == 0
  68
  69     assert func.called == 1
  70
  71
  72
  73 class TestCliWithDb:
  74
  75     @pytest.fixture(autouse=True)
  76     def setup_cli_call(self, cli_call, temp_db, cli_tokenizer_mock):
  77         self.call_nominatim = cli_call
  78         self.tokenizer_mock = cli_tokenizer_mock
  79
  80
  81     def test_freeze_command(self, mock_func_factory):
  82         mock_drop = mock_func_factory(nominatim_db.tools.freeze, 'drop_update_tables')
  83         mock_flatnode = mock_func_factory(nominatim_db.tools.freeze, 'drop_flatnode_file')
  84
  85         assert self.call_nominatim('freeze') == 0
  86
  87         assert mock_drop.called == 1
  88         assert mock_flatnode.called == 1
  89
  90
  91     @pytest.mark.parametrize("params,do_bnds,do_ranks", [
  92                               ([], 2, 2),
  93                               (['--boundaries-only'], 2, 0),
  94                               (['--no-boundaries'], 0, 2),
  95                               (['--boundaries-only', '--no-boundaries'], 0, 0)])
  96     def test_index_command(self, monkeypatch, async_mock_func_factory, table_factory,
  97                            params, do_bnds, do_ranks):
  98         table_factory('import_status', 'indexed bool')
  99         bnd_mock = async_mock_func_factory(nominatim_db.indexer.indexer.Indexer, 'index_boundaries')
 100         rank_mock = async_mock_func_factory(nominatim_db.indexer.indexer.Indexer, 'index_by_rank')
 101         postcode_mock = async_mock_func_factory(nominatim_db.indexer.indexer.Indexer, 'index_postcodes')
 102
 103         monkeypatch.setattr(nominatim_db.indexer.indexer.Indexer, 'has_pending',
 104                             [False, True].pop)
 105
 106         assert self.call_nominatim('index', *params) == 0
 107
 108         assert bnd_mock.called == do_bnds
 109         assert rank_mock.called == do_ranks
 110         assert postcode_mock.called == do_ranks
 111
 112
 113     def test_special_phrases_wiki_command(self, mock_func_factory):
 114         func = mock_func_factory(nominatim_db.clicmd.special_phrases.SPImporter, 'import_phrases')
 115
 116         self.call_nominatim('special-phrases', '--import-from-wiki', '--no-replace')
 117
 118         assert func.called == 1
 119
 120
 121     def test_special_phrases_csv_command(self, src_dir, mock_func_factory):
 122         func = mock_func_factory(nominatim_db.clicmd.special_phrases.SPImporter, 'import_phrases')
 123         testdata = src_dir / 'test' / 'testdb'
 124         csv_path = str((testdata / 'full_en_phrases_test.csv').resolve())
 125
 126         self.call_nominatim('special-phrases', '--import-from-csv', csv_path)
 127
 128         assert func.called == 1
 129
 130
 131     def test_special_phrases_csv_bad_file(self, src_dir):
 132         testdata = src_dir / 'something349053905.csv'
 133
 134         self.call_nominatim('special-phrases', '--import-from-csv',
 135                             str(testdata.resolve())) == 1