test/python/cli/conftest.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 import pytest
   8
   9 import nominatim_db.cli
  10
  11 class MockParamCapture:
  12     """ Mock that records the parameters with which a function was called
  13         as well as the number of calls.
  14     """
  15     def __init__(self, retval=0):
  16         self.called = 0
  17         self.return_value = retval
  18         self.last_args = None
  19         self.last_kwargs = None
  20
  21     def __call__(self, *args, **kwargs):
  22         self.called += 1
  23         self.last_args = args
  24         self.last_kwargs = kwargs
  25         return self.return_value
  26
  27
  28 class DummyTokenizer:
  29     def __init__(self, *args, **kwargs):
  30         self.update_sql_functions_called = False
  31         self.finalize_import_called = False
  32         self.update_statistics_called = False
  33         self.update_word_tokens_called = False
  34
  35     def update_sql_functions(self, *args, **kwargs):
  36         self.update_sql_functions_called = True
  37
  38     def finalize_import(self, *args, **kwargs):
  39         self.finalize_import_called = True
  40
  41     def update_statistics(self, *args, **kwargs):
  42         self.update_statistics_called = True
  43
  44     def update_word_tokens(self, *args, **kwargs):
  45         self.update_word_tokens_called = True
  46
  47
  48 @pytest.fixture
  49 def cli_call():
  50     """ Call the nominatim main function with the correct paths set.
  51         Returns a function that can be called with the desired CLI arguments.
  52     """
  53     def _call_nominatim(*args):
  54         return nominatim_db.cli.nominatim(module_dir='MODULE NOT AVAILABLE',
  55                                           osm2pgsql_path='OSM2PGSQL NOT AVAILABLE',
  56                                           cli_args=args)
  57
  58     return _call_nominatim
  59
  60
  61 @pytest.fixture
  62 def mock_func_factory(monkeypatch):
  63     def get_mock(module, func):
  64         mock = MockParamCapture()
  65         mock.func_name = func
  66         monkeypatch.setattr(module, func, mock)
  67         return mock
  68
  69     return get_mock
  70
  71
  72 @pytest.fixture
  73 def cli_tokenizer_mock(monkeypatch):
  74     tok = DummyTokenizer()
  75     monkeypatch.setattr(nominatim_db.tokenizer.factory, 'get_tokenizer_for_db',
  76                         lambda *args: tok)
  77     monkeypatch.setattr(nominatim_db.tokenizer.factory, 'create_tokenizer',
  78                         lambda *args: tok)
  79
  80     return tok