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
 109 @pytest.fixture
 110 def status_table(temp_db_conn):
 111     """ Create an empty version of the status table and
 112         the status logging table.
 113     """
 114     with temp_db_conn.cursor() as cur:
 115         cur.execute("""CREATE TABLE import_status (
 116                            lastimportdate timestamp with time zone NOT NULL,
 117                            sequence_id integer,
 118                            indexed boolean
 119                        )""")
 120         cur.execute("""CREATE TABLE import_osmosis_log (
 121                            batchend timestamp,
 122                            batchseq integer,
 123                            batchsize bigint,
 124                            starttime timestamp,
 125                            endtime timestamp,
 126                            event text
 127                            )""")
 128     temp_db_conn.commit()
 129
 130
 131 @pytest.fixture
 132 def place_table(temp_db_with_extensions, temp_db_conn):
 133     """ Create an empty version of the place table.
 134     """
 135     with temp_db_conn.cursor() as cur:
 136         cur.execute("""CREATE TABLE place (
 137                            osm_id int8 NOT NULL,
 138                            osm_type char(1) NOT NULL,
 139                            class text NOT NULL,
 140                            type text NOT NULL,
 141                            name hstore,
 142                            admin_level smallint,
 143                            address hstore,
 144                            extratags hstore,
 145                            geometry Geometry(Geometry,4326) NOT NULL)""")
 146     temp_db_conn.commit()
 147
 148
 149 @pytest.fixture
 150 def place_row(place_table, temp_db_cursor):
 151     """ A factory for rows in the place table. The table is created as a
 152         prerequisite to the fixture.
 153     """
 154     idseq = itertools.count(1001)
 155     def _insert(osm_type='N', osm_id=None, cls='amenity', typ='cafe', names=None,
 156                 admin_level=None, address=None, extratags=None, geom=None):
 157         temp_db_cursor.execute("INSERT INTO place VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s)",
 158                                (osm_id or next(idseq), osm_type, cls, typ, names,
 159                                 admin_level, address, extratags,
 160                                 geom or 'SRID=4326;POINT(0 0 )'))
 161
 162     return _insert
 163
 164 @pytest.fixture
 165 def placex_table(temp_db_with_extensions, temp_db_conn):
 166     """ Create an empty version of the place table.
 167     """
 168     with temp_db_conn.cursor() as cur:
 169         cur.execute("""CREATE TABLE placex (
 170                            place_id BIGINT NOT NULL,
 171                            parent_place_id BIGINT,
 172                            linked_place_id BIGINT,
 173                            importance FLOAT,
 174                            indexed_date TIMESTAMP,
 175                            geometry_sector INTEGER,
 176                            rank_address SMALLINT,
 177                            rank_search SMALLINT,
 178                            partition SMALLINT,
 179                            indexed_status SMALLINT,
 180                            osm_id int8,
 181                            osm_type char(1),
 182                            class text,
 183                            type text,
 184                            name hstore,
 185                            admin_level smallint,
 186                            address hstore,
 187                            extratags hstore,
 188                            geometry Geometry(Geometry,4326),
 189                            wikipedia TEXT,
 190                            country_code varchar(2),
 191                            housenumber TEXT,
 192                            postcode TEXT,
 193                            centroid GEOMETRY(Geometry, 4326))
 194                            """)
 195     temp_db_conn.commit()
 196
 197
 198