add documentation for sanitizer interface

[nominatim.git] / test / python / conftest.py

diff --git a/test/python/conftest.py b/test/python/conftest.py
index c25449486546fa318e918b4000efbc8f9dec81e1..405262950b78319d2924274ad497f933b03490f2 100644 (file)
--- a/test/python/conftest.py
+++ b/test/python/conftest.py
@@ -1,3 +1,9 @@
+# SPDX-License-Identifier: GPL-2.0-only
+#
+# This file is part of Nominatim. (https://nominatim.org)
+#
+# Copyright (C) 2022 by the Nominatim developer community.
+# For a full list of authors see the git log.

 import itertools
 import sys
 from pathlib import Path
 import itertools
 import sys
 from pathlib import Path


@@ -5,23 +11,25 @@ from pathlib import Path
 import psycopg2
 import pytest
 
 import psycopg2
 import pytest
 

-SRC_DIR = Path(__file__) / '..' / '..' / '..'
-

 # always test against the source
 # always test against the source

-sys.path.insert(0, str(SRC_DIR.resolve()))
+SRC_DIR = (Path(__file__) / '..' / '..' / '..').resolve()
+sys.path.insert(0, str(SRC_DIR))

 
 from nominatim.config import Configuration
 from nominatim.db import connection
 from nominatim.db.sql_preprocessor import SQLPreprocessor
 
 from nominatim.config import Configuration
 from nominatim.db import connection
 from nominatim.db.sql_preprocessor import SQLPreprocessor

-from nominatim.db import properties

 import nominatim.tokenizer.factory
 import nominatim.tokenizer.factory

-import nominatim.cli

 
 import dummy_tokenizer
 import mocks
 from cursor import CursorForTesting
 
 
 
 import dummy_tokenizer
 import mocks
 from cursor import CursorForTesting
 
 

+@pytest.fixture
+def src_dir():
+    return SRC_DIR
+
+

 @pytest.fixture
 def temp_db(monkeypatch):
     """ Create an empty database for the test. The database name is also
 @pytest.fixture
 def temp_db(monkeypatch):
     """ Create an empty database for the test. The database name is also


@@ -99,79 +107,66 @@ def table_factory(temp_db_cursor):
 
 
 @pytest.fixture
 
 
 @pytest.fixture

-def def_config():
-    cfg = Configuration(None, SRC_DIR.resolve() / 'settings')
+def def_config(src_dir):
+    cfg = Configuration(None, src_dir / 'settings')

     cfg.set_libdirs(module='.', osm2pgsql='.',
     cfg.set_libdirs(module='.', osm2pgsql='.',

-                    php=SRC_DIR / 'lib-php',
-                    sql=SRC_DIR / 'lib-sql',
-                    data=SRC_DIR / 'data')
+                    php=src_dir / 'lib-php',
+                    sql=src_dir / 'lib-sql',
+                    data=src_dir / 'data')

     return cfg
 
 
 @pytest.fixture
     return cfg
 
 
 @pytest.fixture

-def src_dir():
-    return SRC_DIR.resolve()
-
-
-@pytest.fixture
-def cli_call():
-    def _call_nominatim(*args):
-        return nominatim.cli.nominatim(
-                   module_dir='MODULE NOT AVAILABLE',
-                   osm2pgsql_path='OSM2PGSQL NOT AVAILABLE',
-                   phplib_dir=str(SRC_DIR / 'lib-php'),
-                   data_dir=str(SRC_DIR / 'data'),
-                   phpcgi_path='/usr/bin/php-cgi',
-                   sqllib_dir=str(SRC_DIR / 'lib-sql'),
-                   config_dir=str(SRC_DIR / 'settings'),
-                   cli_args=args)
-
-    return _call_nominatim
+def project_env(src_dir, tmp_path):
+    projdir = tmp_path / 'project'
+    projdir.mkdir()
+    cfg = Configuration(projdir, src_dir / 'settings')
+    cfg.set_libdirs(module='.', osm2pgsql='.',
+                    php=src_dir / 'lib-php',
+                    sql=src_dir / 'lib-sql',
+                    data=src_dir / 'data')
+    return cfg

 
 
 @pytest.fixture
 
 
 @pytest.fixture

-def property_table(table_factory):
+def property_table(table_factory, temp_db_conn):

     table_factory('nominatim_properties', 'property TEXT, value TEXT')
 
     table_factory('nominatim_properties', 'property TEXT, value TEXT')
 

+    return mocks.MockPropertyTable(temp_db_conn)
+

 
 @pytest.fixture
 
 @pytest.fixture

-def status_table(temp_db_conn):
+def status_table(table_factory):

     """ Create an empty version of the status table and
         the status logging table.
     """
     """ Create an empty version of the status table and
         the status logging table.
     """

-    with temp_db_conn.cursor() as cur:
-        cur.execute("""CREATE TABLE import_status (
-                           lastimportdate timestamp with time zone NOT NULL,
-                           sequence_id integer,
-                           indexed boolean
-                       )""")
-        cur.execute("""CREATE TABLE import_osmosis_log (
-                           batchend timestamp,
-                           batchseq integer,
-                           batchsize bigint,
-                           starttime timestamp,
-                           endtime timestamp,
-                           event text
-                           )""")
-    temp_db_conn.commit()
+    table_factory('import_status',
+                  """lastimportdate timestamp with time zone NOT NULL,
+                     sequence_id integer,
+                     indexed boolean""")
+    table_factory('import_osmosis_log',
+                  """batchend timestamp,
+                     batchseq integer,
+                     batchsize bigint,
+                     starttime timestamp,
+                     endtime timestamp,
+                     event text""")

 
 
 @pytest.fixture
 
 
 @pytest.fixture

-def place_table(temp_db_with_extensions, temp_db_conn):
+def place_table(temp_db_with_extensions, table_factory):

     """ Create an empty version of the place table.
     """
     """ Create an empty version of the place table.
     """

-    with temp_db_conn.cursor() as cur:
-        cur.execute("""CREATE TABLE place (
-                           osm_id int8 NOT NULL,
-                           osm_type char(1) NOT NULL,
-                           class text NOT NULL,
-                           type text NOT NULL,
-                           name hstore,
-                           admin_level smallint,
-                           address hstore,
-                           extratags hstore,
-                           geometry Geometry(Geometry,4326) NOT NULL)""")
-    temp_db_conn.commit()
+    table_factory('place',
+                  """osm_id int8 NOT NULL,
+                     osm_type char(1) NOT NULL,
+                     class text NOT NULL,
+                     type text NOT NULL,
+                     name hstore,
+                     admin_level smallint,
+                     address hstore,
+                     extratags hstore,
+                     geometry Geometry(Geometry,4326) NOT NULL""")

 
 
 @pytest.fixture
 
 
 @pytest.fixture


@@ -179,6 +174,7 @@ def place_row(place_table, temp_db_cursor):
     """ A factory for rows in the place table. The table is created as a
         prerequisite to the fixture.
     """
     """ A factory for rows in the place table. The table is created as a
         prerequisite to the fixture.
     """

+    psycopg2.extras.register_hstore(temp_db_cursor)

     idseq = itertools.count(1001)
     def _insert(osm_type='N', osm_id=None, cls='amenity', typ='cafe', names=None,
                 admin_level=None, address=None, extratags=None, geom=None):
     idseq = itertools.count(1001)
     def _insert(osm_type='N', osm_id=None, cls='amenity', typ='cafe', names=None,
                 admin_level=None, address=None, extratags=None, geom=None):


@@ -197,65 +193,51 @@ def placex_table(temp_db_with_extensions, temp_db_conn):
 
 
 @pytest.fixture
 
 
 @pytest.fixture

-def osmline_table(temp_db_with_extensions, temp_db_conn):
-    with temp_db_conn.cursor() as cur:
-        cur.execute("""CREATE TABLE location_property_osmline (
-                           place_id BIGINT,
-                           osm_id BIGINT,
-                           parent_place_id BIGINT,
-                           geometry_sector INTEGER,
-                           indexed_date TIMESTAMP,
-                           startnumber INTEGER,
-                           endnumber INTEGER,
-                           partition SMALLINT,
-                           indexed_status SMALLINT,
-                           linegeo GEOMETRY,
-                           interpolationtype TEXT,
-                           address HSTORE,
-                           postcode TEXT,
-                           country_code VARCHAR(2))""")
-    temp_db_conn.commit()
-
-
-@pytest.fixture
-def word_table(temp_db_conn):
-    return mocks.MockWordTable(temp_db_conn)
+def osmline_table(temp_db_with_extensions, table_factory):
+    table_factory('location_property_osmline',
+                  """place_id BIGINT,
+                     osm_id BIGINT,
+                     parent_place_id BIGINT,
+                     geometry_sector INTEGER,
+                     indexed_date TIMESTAMP,
+                     startnumber INTEGER,
+                     endnumber INTEGER,
+                     partition SMALLINT,
+                     indexed_status SMALLINT,
+                     linegeo GEOMETRY,
+                     interpolationtype TEXT,
+                     address HSTORE,
+                     postcode TEXT,
+                     country_code VARCHAR(2)""")

 
 
 @pytest.fixture
 
 
 @pytest.fixture

-def osm2pgsql_options(temp_db):
-    return dict(osm2pgsql='echo',
-                osm2pgsql_cache=10,
-                osm2pgsql_style='style.file',
-                threads=1,
-                dsn='dbname=' + temp_db,
-                flatnode_file='',
-                tablespaces=dict(slim_data='', slim_index='',
-                                 main_data='', main_index=''))
-
-@pytest.fixture
-def sql_preprocessor(temp_db_conn, tmp_path, monkeypatch, table_factory):
+def sql_preprocessor_cfg(tmp_path, table_factory, temp_db_with_extensions):

     table_factory('country_name', 'partition INT', ((0, ), (1, ), (2, )))
     cfg = Configuration(None, SRC_DIR.resolve() / 'settings')
     cfg.set_libdirs(module='.', osm2pgsql='.', php=SRC_DIR / 'lib-php',
                     sql=tmp_path, data=SRC_DIR / 'data')
     table_factory('country_name', 'partition INT', ((0, ), (1, ), (2, )))
     cfg = Configuration(None, SRC_DIR.resolve() / 'settings')
     cfg.set_libdirs(module='.', osm2pgsql='.', php=SRC_DIR / 'lib-php',
                     sql=tmp_path, data=SRC_DIR / 'data')

+    return cfg

 
 

-    return SQLPreprocessor(temp_db_conn, cfg)
+
+@pytest.fixture
+def sql_preprocessor(sql_preprocessor_cfg, temp_db_conn):
+    return SQLPreprocessor(temp_db_conn, sql_preprocessor_cfg)

 
 
 @pytest.fixture
 
 
 @pytest.fixture

-def tokenizer_mock(monkeypatch, property_table, temp_db_conn, tmp_path):
+def tokenizer_mock(monkeypatch, property_table):

     """ Sets up the configuration so that the test dummy tokenizer will be
         loaded when the tokenizer factory is used. Also returns a factory
         with which a new dummy tokenizer may be created.
     """
     monkeypatch.setenv('NOMINATIM_TOKENIZER', 'dummy')
 
     """ Sets up the configuration so that the test dummy tokenizer will be
         loaded when the tokenizer factory is used. Also returns a factory
         with which a new dummy tokenizer may be created.
     """
     monkeypatch.setenv('NOMINATIM_TOKENIZER', 'dummy')
 

-    def _import_dummy(module, *args, **kwargs):
+    def _import_dummy(*args, **kwargs):

         return dummy_tokenizer
 
     monkeypatch.setattr(nominatim.tokenizer.factory, "_import_tokenizer", _import_dummy)
         return dummy_tokenizer
 
     monkeypatch.setattr(nominatim.tokenizer.factory, "_import_tokenizer", _import_dummy)

-    properties.set_property(temp_db_conn, 'tokenizer', 'dummy')
+    property_table.set('tokenizer', 'dummy')

 
     def _create_tokenizer():
         return dummy_tokenizer.DummyTokenizer(None, None)
 
     def _create_tokenizer():
         return dummy_tokenizer.DummyTokenizer(None, None)