test/python/conftest.py

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