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) 2024 by the Nominatim developer community.
   6 # For a full list of authors see the git log.
   7 import itertools
   8 import sys
   9 from pathlib import Path
  10
  11 import psycopg2
  12 import pytest
  13
  14 # always test against the source
  15 SRC_DIR = (Path(__file__) / '..' / '..' / '..').resolve()
  16 sys.path.insert(0, str(SRC_DIR / 'src'))
  17
  18 from nominatim_db.config import Configuration
  19 from nominatim_db.db import connection
  20 from nominatim_db.db.sql_preprocessor import SQLPreprocessor
  21 import nominatim_db.tokenizer.factory
  22
  23 import dummy_tokenizer
  24 import mocks
  25 from cursor import CursorForTesting
  26
  27
  28 @pytest.fixture
  29 def src_dir():
  30     return SRC_DIR
  31
  32
  33 @pytest.fixture
  34 def temp_db(monkeypatch):
  35     """ Create an empty database for the test. The database name is also
  36         exported into NOMINATIM_DATABASE_DSN.
  37     """
  38     name = 'test_nominatim_python_unittest'
  39     conn = psycopg2.connect(database='postgres')
  40
  41     conn.set_isolation_level(0)
  42     with conn.cursor() as cur:
  43         cur.execute('DROP DATABASE IF EXISTS {}'.format(name))
  44         cur.execute('CREATE DATABASE {}'.format(name))
  45
  46     conn.close()
  47
  48     monkeypatch.setenv('NOMINATIM_DATABASE_DSN', 'dbname=' + name)
  49
  50     yield name
  51
  52     conn = psycopg2.connect(database='postgres')
  53
  54     conn.set_isolation_level(0)
  55     with conn.cursor() as cur:
  56         cur.execute('DROP DATABASE IF EXISTS {}'.format(name))
  57
  58     conn.close()
  59
  60
  61 @pytest.fixture
  62 def dsn(temp_db):
  63     return 'dbname=' + temp_db
  64
  65
  66 @pytest.fixture
  67 def temp_db_with_extensions(temp_db):
  68     conn = psycopg2.connect(database=temp_db)
  69     with conn.cursor() as cur:
  70         cur.execute('CREATE EXTENSION hstore; CREATE EXTENSION postgis;')
  71     conn.commit()
  72     conn.close()
  73
  74     return temp_db
  75
  76 @pytest.fixture
  77 def temp_db_conn(temp_db):
  78     """ Connection to the test database.
  79     """
  80     with connection.connect('dbname=' + temp_db) as conn:
  81         yield conn
  82
  83
  84 @pytest.fixture
  85 def temp_db_cursor(temp_db):
  86     """ Connection and cursor towards the test database. The connection will
  87         be in auto-commit mode.
  88     """
  89     conn = psycopg2.connect('dbname=' + temp_db)
  90     conn.set_isolation_level(0)
  91     with conn.cursor(cursor_factory=CursorForTesting) as cur:
  92         yield cur
  93     conn.close()
  94
  95
  96 @pytest.fixture
  97 def table_factory(temp_db_cursor):
  98     """ A fixture that creates new SQL tables, potentially filled with
  99         content.
 100     """
 101     def mk_table(name, definition='id INT', content=None):
 102         temp_db_cursor.execute('CREATE TABLE {} ({})'.format(name, definition))
 103         if content is not None:
 104             temp_db_cursor.execute_values("INSERT INTO {} VALUES %s".format(name), content)
 105
 106     return mk_table
 107
 108
 109 @pytest.fixture
 110 def def_config():
 111     cfg = Configuration(None)
 112     cfg.set_libdirs(module='.', osm2pgsql='.')
 113     return cfg
 114
 115
 116 @pytest.fixture
 117 def project_env(tmp_path):
 118     projdir = tmp_path / 'project'
 119     projdir.mkdir()
 120     cfg = Configuration(projdir)
 121     cfg.set_libdirs(module='.', osm2pgsql='.')
 122     return cfg
 123
 124
 125 @pytest.fixture
 126 def property_table(table_factory, temp_db_conn):
 127     table_factory('nominatim_properties', 'property TEXT, value TEXT')
 128
 129     return mocks.MockPropertyTable(temp_db_conn)
 130
 131
 132 @pytest.fixture
 133 def status_table(table_factory):
 134     """ Create an empty version of the status table and
 135         the status logging table.
 136     """
 137     table_factory('import_status',
 138                   """lastimportdate timestamp with time zone NOT NULL,
 139                      sequence_id integer,
 140                      indexed boolean""")
 141     table_factory('import_osmosis_log',
 142                   """batchend timestamp,
 143                      batchseq integer,
 144                      batchsize bigint,
 145                      starttime timestamp,
 146                      endtime timestamp,
 147                      event text""")
 148
 149
 150 @pytest.fixture
 151 def place_table(temp_db_with_extensions, table_factory):
 152     """ Create an empty version of the place table.
 153     """
 154     table_factory('place',
 155                   """osm_id int8 NOT NULL,
 156                      osm_type char(1) NOT NULL,
 157                      class text NOT NULL,
 158                      type text NOT NULL,
 159                      name hstore,
 160                      admin_level smallint,
 161                      address hstore,
 162                      extratags hstore,
 163                      geometry Geometry(Geometry,4326) NOT NULL""")
 164
 165
 166 @pytest.fixture
 167 def place_row(place_table, temp_db_cursor):
 168     """ A factory for rows in the place table. The table is created as a
 169         prerequisite to the fixture.
 170     """
 171     psycopg2.extras.register_hstore(temp_db_cursor)
 172     idseq = itertools.count(1001)
 173     def _insert(osm_type='N', osm_id=None, cls='amenity', typ='cafe', names=None,
 174                 admin_level=None, address=None, extratags=None, geom=None):
 175         temp_db_cursor.execute("INSERT INTO place VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s)",
 176                                (osm_id or next(idseq), osm_type, cls, typ, names,
 177                                 admin_level, address, extratags,
 178                                 geom or 'SRID=4326;POINT(0 0)'))
 179
 180     return _insert
 181
 182 @pytest.fixture
 183 def placex_table(temp_db_with_extensions, temp_db_conn):
 184     """ Create an empty version of the place table.
 185     """
 186     return mocks.MockPlacexTable(temp_db_conn)
 187
 188
 189 @pytest.fixture
 190 def osmline_table(temp_db_with_extensions, table_factory):
 191     table_factory('location_property_osmline',
 192                   """place_id BIGINT,
 193                      osm_id BIGINT,
 194                      parent_place_id BIGINT,
 195                      geometry_sector INTEGER,
 196                      indexed_date TIMESTAMP,
 197                      startnumber INTEGER,
 198                      endnumber INTEGER,
 199                      partition SMALLINT,
 200                      indexed_status SMALLINT,
 201                      linegeo GEOMETRY,
 202                      interpolationtype TEXT,
 203                      address HSTORE,
 204                      postcode TEXT,
 205                      country_code VARCHAR(2)""")
 206
 207
 208 @pytest.fixture
 209 def sql_preprocessor_cfg(tmp_path, table_factory, temp_db_with_extensions):
 210     table_factory('country_name', 'partition INT', ((0, ), (1, ), (2, )))
 211     cfg = Configuration(None)
 212     cfg.set_libdirs(module='.', osm2pgsql='.', sql=tmp_path)
 213     return cfg
 214
 215
 216 @pytest.fixture
 217 def sql_preprocessor(sql_preprocessor_cfg, temp_db_conn):
 218     return SQLPreprocessor(temp_db_conn, sql_preprocessor_cfg)
 219
 220
 221 @pytest.fixture
 222 def tokenizer_mock(monkeypatch, property_table):
 223     """ Sets up the configuration so that the test dummy tokenizer will be
 224         loaded when the tokenizer factory is used. Also returns a factory
 225         with which a new dummy tokenizer may be created.
 226     """
 227     monkeypatch.setenv('NOMINATIM_TOKENIZER', 'dummy')
 228
 229     def _import_dummy(*args, **kwargs):
 230         return dummy_tokenizer
 231
 232     monkeypatch.setattr(nominatim_db.tokenizer.factory,
 233                         "_import_tokenizer", _import_dummy)
 234     property_table.set('tokenizer', 'dummy')
 235
 236     def _create_tokenizer():
 237         return dummy_tokenizer.DummyTokenizer(None, None)
 238
 239     return _create_tokenizer