test/python/api/test_api_status.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) 2025 by the Nominatim developer community.
   6 # For a full list of authors see the git log.
   7 """
   8 Tests for the status API call.
   9 """
  10 import asyncio
  11 import datetime as dt
  12
  13 import pytest
  14
  15 from nominatim_api.version import NOMINATIM_API_VERSION
  16 import nominatim_api as napi
  17
  18
  19 def test_status_no_extra_info(apiobj, frontend):
  20     api = frontend(apiobj)
  21     result = api.status()
  22
  23     assert result.status == 0
  24     assert result.message == 'OK'
  25     assert result.software_version == NOMINATIM_API_VERSION
  26     assert result.database_version is None
  27     assert result.data_updated is None
  28
  29
  30 def test_status_full(apiobj, frontend):
  31     import_date = dt.datetime(2022, 12, 7, 14, 14, 46, 0, tzinfo=dt.timezone.utc)
  32     apiobj.add_data('import_status',
  33                     [{'lastimportdate': import_date}])
  34     apiobj.add_data('properties',
  35                     [{'property': 'database_version', 'value': '99.5.4-2'}])
  36
  37     api = frontend(apiobj)
  38     result = api.status()
  39
  40     assert result.status == 0
  41     assert result.message == 'OK'
  42     assert result.software_version == NOMINATIM_API_VERSION
  43     assert result.database_version == '99.5.4-2'
  44     assert result.data_updated == import_date
  45
  46
  47 def test_status_database_not_found(monkeypatch):
  48     monkeypatch.setenv('NOMINATIM_DATABASE_DSN', 'dbname=rgjdfkgjedkrgdfkngdfkg')
  49
  50     api = napi.NominatimAPI()
  51
  52     result = api.status()
  53
  54     assert result.status == 700
  55     assert result.message == 'Database connection failed'
  56     assert result.software_version == NOMINATIM_API_VERSION
  57     assert result.database_version is None
  58     assert result.data_updated is None
  59
  60
  61 @pytest.mark.asyncio
  62 async def test_status_connection_timeout_single_pool(status_table, property_table, monkeypatch):
  63     monkeypatch.setenv('NOMINATIM_API_POOL_SIZE', '1')
  64     monkeypatch.setenv('NOMINATIM_REQUEST_TIMEOUT', '1')
  65
  66     async with napi.NominatimAPIAsync() as api:
  67         async with api.begin():
  68             with pytest.raises((TimeoutError, asyncio.TimeoutError)):
  69                 await api.status()
  70
  71         await api.status()
  72
  73
  74 @pytest.mark.asyncio
  75 async def test_status_connection_timeout_multi_pool(status_table, property_table, monkeypatch):
  76     monkeypatch.setenv('NOMINATIM_API_POOL_SIZE', '2')
  77     monkeypatch.setenv('NOMINATIM_REQUEST_TIMEOUT', '1')
  78
  79     async with napi.NominatimAPIAsync() as api:
  80         async with api.begin(), api.begin():
  81             with pytest.raises((TimeoutError, asyncio.TimeoutError)):
  82                 await api.status()
  83
  84         await api.status()