test/python/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) 2026 by the Nominatim developer community.
   6 # For a full list of authors see the git log.
   7 import itertools
   8 import sys
   9 import asyncio
  10 from pathlib import Path
  11
  12 if sys.platform == 'win32':
  13     asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
  14
  15 import psycopg
  16 from psycopg import sql as pysql
  17 import pytest
  18
  19 # always test against the source
  20 SRC_DIR = (Path(__file__) / '..' / '..' / '..').resolve()
  21 sys.path.insert(0, str(SRC_DIR / 'src'))
  22
  23 from nominatim_db.config import Configuration
  24 from nominatim_db.db import connection, properties
  25 from nominatim_db.db.sql_preprocessor import SQLPreprocessor
  26 import nominatim_db.tokenizer.factory
  27
  28 import dummy_tokenizer
  29 from cursor import CursorForTesting
  30
  31
  32 def _with_srid(geom, default=None):
  33     if geom is None:
  34         return None if default is None else f"SRID=4326;{default}"
  35
  36     return f"SRID=4326;{geom}"
  37
  38
  39 @pytest.fixture
  40 def src_dir():
  41     return SRC_DIR
  42
  43
  44 @pytest.fixture
  45 def temp_db(monkeypatch):
  46     """ Create an empty database for the test. The database name is also
  47         exported into NOMINATIM_DATABASE_DSN.
  48     """
  49     name = 'test_nominatim_python_unittest'
  50
  51     with psycopg.connect(dbname='postgres', autocommit=True) as conn:
  52         with conn.cursor() as cur:
  53             cur.execute(pysql.SQL('DROP DATABASE IF EXISTS') + pysql.Identifier(name))
  54             cur.execute(pysql.SQL('CREATE DATABASE') + pysql.Identifier(name))
  55
  56     monkeypatch.setenv('NOMINATIM_DATABASE_DSN', 'dbname=' + name)
  57
  58     with psycopg.connect(dbname=name) as conn:
  59         with conn.cursor() as cur:
  60             cur.execute('CREATE EXTENSION hstore')
  61
  62     yield name
  63
  64     with psycopg.connect(dbname='postgres', autocommit=True) as conn:
  65         with conn.cursor() as cur:
  66             cur.execute(pysql.SQL('DROP DATABASE IF EXISTS') + pysql.Identifier(name))
  67
  68
  69 @pytest.fixture
  70 def dsn(temp_db):
  71     return 'dbname=' + temp_db
  72
  73
  74 @pytest.fixture
  75 def temp_db_with_extensions(temp_db):
  76     with psycopg.connect(dbname=temp_db) as conn:
  77         with conn.cursor() as cur:
  78             cur.execute('CREATE EXTENSION postgis')
  79
  80     return temp_db
  81
  82
  83 @pytest.fixture
  84 def temp_db_conn(temp_db):
  85     """ Connection to the test database.
  86     """
  87     with connection.connect('', autocommit=True, dbname=temp_db) as conn:
  88         connection.register_hstore(conn)
  89         yield conn
  90
  91
  92 @pytest.fixture
  93 def temp_db_cursor(temp_db):
  94     """ Connection and cursor towards the test database. The connection will
  95         be in auto-commit mode.
  96     """
  97     with psycopg.connect(dbname=temp_db, autocommit=True, cursor_factory=CursorForTesting) as conn:
  98         connection.register_hstore(conn)
  99         with conn.cursor() as cur:
 100             yield cur
 101
 102
 103 @pytest.fixture
 104 def table_factory(temp_db_conn):
 105     """ A fixture that creates new SQL tables, potentially filled with
 106         content.
 107     """
 108     def mk_table(name, definition='id INT', content=None):
 109         with psycopg.ClientCursor(temp_db_conn) as cur:
 110             cur.execute(pysql.SQL("CREATE TABLE {} ({})")
 111                              .format(pysql.Identifier(name),
 112                                      pysql.SQL(definition)))
 113             if content:
 114                 sql = pysql.SQL("INSERT INTO {} VALUES ({})")\
 115                            .format(pysql.Identifier(name),
 116                                    pysql.SQL(',').join([pysql.Placeholder()
 117                                                         for _ in range(len(content[0]))]))
 118                 cur.executemany(sql, content)
 119
 120     return mk_table
 121
 122
 123 @pytest.fixture
 124 def def_config():
 125     cfg = Configuration(None)
 126     return cfg
 127
 128
 129 @pytest.fixture
 130 def project_env(tmp_path):
 131     projdir = tmp_path / 'project'
 132     projdir.mkdir()
 133     cfg = Configuration(projdir)
 134     return cfg
 135
 136
 137 @pytest.fixture
 138 def country_table(table_factory):
 139     table_factory('country_name', 'partition INT, country_code varchar(2), name hstore')
 140
 141
 142 @pytest.fixture
 143 def country_row(country_table, temp_db_cursor):
 144     def _add(partition=None, country=None, names=None):
 145         temp_db_cursor.insert_row('country_name', partition=partition,
 146                                   country_code=country, name=names)
 147
 148     return _add
 149
 150
 151 @pytest.fixture
 152 def load_sql(temp_db_conn, country_table):
 153     conf = Configuration(None)
 154
 155     def _run(*filename, **kwargs):
 156         for fn in filename:
 157             SQLPreprocessor(temp_db_conn, conf).run_sql_file(temp_db_conn, fn, **kwargs)
 158
 159     return _run
 160
 161
 162 @pytest.fixture
 163 def property_table(load_sql, temp_db_conn):
 164     load_sql('tables/nominatim_properties.sql')
 165
 166     class _PropTable:
 167         def set(self, name, value):
 168             properties.set_property(temp_db_conn, name, value)
 169
 170         def get(self, name):
 171             return properties.get_property(temp_db_conn, name)
 172
 173     return _PropTable()
 174
 175
 176 @pytest.fixture
 177 def status_table(load_sql):
 178     """ Create an empty version of the status table and
 179         the status logging table.
 180     """
 181     load_sql('tables/status.sql')
 182
 183
 184 @pytest.fixture
 185 def place_table(temp_db_with_extensions, table_factory):
 186     """ Create an empty version of the place table.
 187     """
 188     table_factory('place',
 189                   """osm_id int8 NOT NULL,
 190                      osm_type char(1) NOT NULL,
 191                      class text NOT NULL,
 192                      type text NOT NULL,
 193                      name hstore,
 194                      admin_level smallint,
 195                      address hstore,
 196                      extratags hstore,
 197                      geometry Geometry(Geometry,4326) NOT NULL""")
 198
 199
 200 @pytest.fixture
 201 def place_row(place_table, temp_db_cursor):
 202     """ A factory for rows in the place table. The table is created as a
 203         prerequisite to the fixture.
 204     """
 205     idseq = itertools.count(1001)
 206
 207     def _insert(osm_type='N', osm_id=None, cls='amenity', typ='cafe', names=None,
 208                 admin_level=None, address=None, extratags=None, geom='POINT(0 0)'):
 209         args = {'osm_type': osm_type, 'osm_id': osm_id or next(idseq),
 210                 'class': cls, 'type': typ, 'name': names, 'admin_level': admin_level,
 211                 'address': address, 'extratags': extratags,
 212                 'geometry': _with_srid(geom)}
 213         temp_db_cursor.insert_row('place', **args)
 214
 215     return _insert
 216
 217
 218 @pytest.fixture
 219 def place_postcode_table(temp_db_with_extensions, table_factory):
 220     """ Create an empty version of the place_postcode table.
 221     """
 222     table_factory('place_postcode',
 223                   """osm_type char(1) NOT NULL,
 224                      osm_id bigint NOT NULL,
 225                      postcode text NOT NULL,
 226                      country_code text,
 227                      centroid Geometry(Point, 4326) NOT NULL,
 228                      geometry Geometry(Geometry, 4326)""")
 229
 230
 231 @pytest.fixture
 232 def place_postcode_row(place_postcode_table, temp_db_cursor):
 233     """ A factory for rows in the place_postcode table. The table is created as a
 234         prerequisite to the fixture.
 235     """
 236     idseq = itertools.count(5001)
 237
 238     def _insert(osm_type='N', osm_id=None, postcode=None, country=None,
 239                 centroid='POINT(12.0 4.0)', geom=None):
 240         temp_db_cursor.insert_row('place_postcode',
 241                                   osm_type=osm_type, osm_id=osm_id or next(idseq),
 242                                   postcode=postcode, country_code=country,
 243                                   centroid=_with_srid(centroid),
 244                                   geometry=_with_srid(geom))
 245
 246     return _insert
 247
 248
 249 @pytest.fixture
 250 def placex_table(temp_db_with_extensions, temp_db_conn, load_sql, place_table):
 251     """ Create an empty version of the placex table.
 252     """
 253     load_sql('tables/placex.sql')
 254     temp_db_conn.execute("CREATE SEQUENCE IF NOT EXISTS seq_place START 1")
 255
 256
 257 @pytest.fixture
 258 def placex_row(placex_table, temp_db_cursor):
 259     """ A factory for rows in the placex table. The table is created as a
 260         prerequisite to the fixture.
 261     """
 262     idseq = itertools.count(1001)
 263
 264     def _add(osm_type='N', osm_id=None, cls='amenity', typ='cafe', names=None,
 265              admin_level=None, address=None, extratags=None, geom='POINT(10 4)',
 266              country=None, housenumber=None, rank_search=30, rank_address=30,
 267              centroid='POINT(10 4)', indexed_status=0, indexed_date=None):
 268         args = {'place_id': pysql.SQL("nextval('seq_place')"),
 269                 'osm_type': osm_type, 'osm_id': osm_id or next(idseq),
 270                 'class': cls, 'type': typ, 'name': names, 'admin_level': admin_level,
 271                 'address': address, 'housenumber': housenumber,
 272                 'rank_search': rank_search, 'rank_address': rank_address,
 273                 'extratags': extratags,
 274                 'centroid': _with_srid(centroid), 'geometry': _with_srid(geom),
 275                 'country_code': country,
 276                 'indexed_status': indexed_status, 'indexed_date': indexed_date,
 277                 'partition': pysql.Literal(0), 'geometry_sector': pysql.Literal(1)}
 278         return temp_db_cursor.insert_row('placex', **args)
 279
 280     return _add
 281
 282
 283 @pytest.fixture
 284 def osmline_table(temp_db_with_extensions, load_sql):
 285     load_sql('tables/interpolation.sql')
 286
 287
 288 @pytest.fixture
 289 def osmline_row(osmline_table, temp_db_cursor):
 290     idseq = itertools.count(20001)
 291
 292     def _add(osm_id=None, geom='LINESTRING(12.0 11.0, 12.003 11.0)'):
 293         return temp_db_cursor.insert_row(
 294             'location_property_osmline',
 295             place_id=pysql.SQL("nextval('seq_place')"),
 296             osm_id=osm_id or next(idseq),
 297             geometry_sector=pysql.Literal(20),
 298             partition=pysql.Literal(0),
 299             indexed_status=1,
 300             linegeo=_with_srid(geom))
 301
 302     return _add
 303
 304
 305 @pytest.fixture
 306 def postcode_table(temp_db_with_extensions, load_sql):
 307     load_sql('tables/postcodes.sql')
 308
 309
 310 @pytest.fixture
 311 def postcode_row(postcode_table, temp_db_cursor):
 312     def _add(country, postcode, x=34.5, y=-9.33):
 313         geom = _with_srid(f"POINT({x} {y})")
 314         return temp_db_cursor.insert_row(
 315             'location_postcodes',
 316             place_id=pysql.SQL("nextval('seq_place')"),
 317             indexed_status=pysql.Literal(1),
 318             country_code=country, postcode=postcode,
 319             centroid=geom,
 320             rank_search=pysql.Literal(16),
 321             geometry=('ST_Expand(%s::geometry, 0.005)', geom))
 322
 323     return _add
 324
 325
 326 @pytest.fixture
 327 def sql_preprocessor_cfg(tmp_path, table_factory, temp_db_with_extensions, country_row):
 328     for part in range(3):
 329         country_row(partition=part)
 330
 331     cfg = Configuration(None)
 332     cfg.set_libdirs(sql=tmp_path)
 333     return cfg
 334
 335
 336 @pytest.fixture
 337 def sql_preprocessor(sql_preprocessor_cfg, temp_db_conn):
 338     return SQLPreprocessor(temp_db_conn, sql_preprocessor_cfg)
 339
 340
 341 @pytest.fixture
 342 def tokenizer_mock(monkeypatch, property_table):
 343     """ Sets up the configuration so that the test dummy tokenizer will be
 344         loaded when the tokenizer factory is used. Also returns a factory
 345         with which a new dummy tokenizer may be created.
 346     """
 347     monkeypatch.setenv('NOMINATIM_TOKENIZER', 'dummy')
 348
 349     def _import_dummy(*args, **kwargs):
 350         return dummy_tokenizer
 351
 352     monkeypatch.setattr(nominatim_db.tokenizer.factory,
 353                         "_import_tokenizer", _import_dummy)
 354     property_table.set('tokenizer', 'dummy')
 355
 356     def _create_tokenizer():
 357         return dummy_tokenizer.DummyTokenizer(None)
 358
 359     return _create_tokenizer