test/python/conftest.py

   1 import itertools
   2 import sys
   3 from pathlib import Path
   4
   5 import psycopg2
   6 import psycopg2.extras
   7 import pytest
   8
   9 SRC_DIR = Path(__file__) / '..' / '..' / '..'
  10
  11 # always test against the source
  12 sys.path.insert(0, str(SRC_DIR.resolve()))
  13
  14 from nominatim.config import Configuration
  15 from nominatim.db import connection
  16
  17 class _TestingCursor(psycopg2.extras.DictCursor):
  18     """ Extension to the DictCursor class that provides execution
  19         short-cuts that simplify writing assertions.
  20     """
  21
  22     def scalar(self, sql, params=None):
  23         """ Execute a query with a single return value and return this value.
  24             Raises an assertion when not exactly one row is returned.
  25         """
  26         self.execute(sql, params)
  27         assert self.rowcount == 1
  28         return self.fetchone()[0]
  29
  30     def row_set(self, sql, params=None):
  31         """ Execute a query and return the result as a set of tuples.
  32         """
  33         self.execute(sql, params)
  34         if self.rowcount == 1:
  35             return set(tuple(self.fetchone()))
  36
  37         return set((tuple(row) for row in self))
  38
  39     def table_exists(self, table):
  40         """ Check that a table with the given name exists in the database.
  41         """
  42         num = self.scalar("""SELECT count(*) FROM pg_tables
  43                              WHERE tablename = %s""", (table, ))
  44         return num == 1
  45
  46
  47 @pytest.fixture
  48 def temp_db(monkeypatch):
  49     """ Create an empty database for the test. The database name is also
  50         exported into NOMINATIM_DATABASE_DSN.
  51     """
  52     name = 'test_nominatim_python_unittest'
  53     conn = psycopg2.connect(database='postgres')
  54
  55     conn.set_isolation_level(0)
  56     with conn.cursor() as cur:
  57         cur.execute('DROP DATABASE IF EXISTS {}'.format(name))
  58         cur.execute('CREATE DATABASE {}'.format(name))
  59
  60     conn.close()
  61
  62     monkeypatch.setenv('NOMINATIM_DATABASE_DSN' , 'dbname=' + name)
  63
  64     yield name
  65
  66     conn = psycopg2.connect(database='postgres')
  67
  68     conn.set_isolation_level(0)
  69     with conn.cursor() as cur:
  70         cur.execute('DROP DATABASE IF EXISTS {}'.format(name))
  71
  72     conn.close()
  73
  74 @pytest.fixture
  75 def temp_db_with_extensions(temp_db):
  76     conn = psycopg2.connect(database=temp_db)
  77     with conn.cursor() as cur:
  78         cur.execute('CREATE EXTENSION hstore; CREATE EXTENSION postgis;')
  79     conn.commit()
  80     conn.close()
  81
  82     return temp_db
  83
  84 @pytest.fixture
  85 def temp_db_conn(temp_db):
  86     """ Connection to the test database.
  87     """
  88     with connection.connect('dbname=' + temp_db) as 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     conn = psycopg2.connect('dbname=' + temp_db)
  98     conn.set_isolation_level(0)
  99     with conn.cursor(cursor_factory=_TestingCursor) as cur:
 100         yield cur
 101     conn.close()
 102
 103
 104 @pytest.fixture
 105 def def_config():
 106     return Configuration(None, SRC_DIR.resolve() / 'settings')
 107
 108 @pytest.fixture
 109 def src_dir():
 110     return SRC_DIR.resolve()
 111
 112 @pytest.fixture
 113 def status_table(temp_db_conn):
 114     """ Create an empty version of the status table and
 115         the status logging table.
 116     """
 117     with temp_db_conn.cursor() as cur:
 118         cur.execute("""CREATE TABLE import_status (
 119                            lastimportdate timestamp with time zone NOT NULL,
 120                            sequence_id integer,
 121                            indexed boolean
 122                        )""")
 123         cur.execute("""CREATE TABLE import_osmosis_log (
 124                            batchend timestamp,
 125                            batchseq integer,
 126                            batchsize bigint,
 127                            starttime timestamp,
 128                            endtime timestamp,
 129                            event text
 130                            )""")
 131     temp_db_conn.commit()
 132
 133
 134 @pytest.fixture
 135 def place_table(temp_db_with_extensions, temp_db_conn):
 136     """ Create an empty version of the place table.
 137     """
 138     with temp_db_conn.cursor() as cur:
 139         cur.execute("""CREATE TABLE place (
 140                            osm_id int8 NOT NULL,
 141                            osm_type char(1) NOT NULL,
 142                            class text NOT NULL,
 143                            type text NOT NULL,
 144                            name hstore,
 145                            admin_level smallint,
 146                            address hstore,
 147                            extratags hstore,
 148                            geometry Geometry(Geometry,4326) NOT NULL)""")
 149     temp_db_conn.commit()
 150
 151
 152 @pytest.fixture
 153 def place_row(place_table, temp_db_cursor):
 154     """ A factory for rows in the place table. The table is created as a
 155         prerequisite to the fixture.
 156     """
 157     idseq = itertools.count(1001)
 158     def _insert(osm_type='N', osm_id=None, cls='amenity', typ='cafe', names=None,
 159                 admin_level=None, address=None, extratags=None, geom=None):
 160         temp_db_cursor.execute("INSERT INTO place VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s)",
 161                                (osm_id or next(idseq), osm_type, cls, typ, names,
 162                                 admin_level, address, extratags,
 163                                 geom or 'SRID=4326;POINT(0 0 )'))
 164
 165     return _insert
 166
 167 @pytest.fixture
 168 def placex_table(temp_db_with_extensions, temp_db_conn):
 169     """ Create an empty version of the place table.
 170     """
 171     with temp_db_conn.cursor() as cur:
 172         cur.execute("""CREATE TABLE placex (
 173                            place_id BIGINT NOT NULL,
 174                            parent_place_id BIGINT,
 175                            linked_place_id BIGINT,
 176                            importance FLOAT,
 177                            indexed_date TIMESTAMP,
 178                            geometry_sector INTEGER,
 179                            rank_address SMALLINT,
 180                            rank_search SMALLINT,
 181                            partition SMALLINT,
 182                            indexed_status SMALLINT,
 183                            osm_id int8,
 184                            osm_type char(1),
 185                            class text,
 186                            type text,
 187                            name hstore,
 188                            admin_level smallint,
 189                            address hstore,
 190                            extratags hstore,
 191                            geometry Geometry(Geometry,4326),
 192                            wikipedia TEXT,
 193                            country_code varchar(2),
 194                            housenumber TEXT,
 195                            postcode TEXT,
 196                            centroid GEOMETRY(Geometry, 4326))
 197                            """)
 198     temp_db_conn.commit()
 199
 200
 201 @pytest.fixture
 202 def osm2pgsql_options(temp_db):
 203     return dict(osm2pgsql='echo',
 204                 osm2pgsql_cache=10,
 205                 osm2pgsql_style='style.file',
 206                 threads=1,
 207                 dsn='dbname=' + temp_db,
 208                 flatnode_file='',
 209                 tablespaces=dict(slim_data='', slim_index='',
 210                                  main_data='', main_index=''))