bdd: move NominatimEnvironment into separate file

Also cleans up and modernizes the code and adds documentation.

test/bdd/environment.py

@@ -1,17 +1,11 @@
 from behave import *
-import logging
+from pathlib import Path
-import os
-import psycopg2
-import psycopg2.extras
-import subprocess
-import tempfile
 
 from steps.geometry_factory import GeometryFactory
-
+from steps.nominatim_environment import NominatimEnvironment
-logger = logging.getLogger(__name__)
 
 userconfig = {
-    'BUILDDIR' : os.path.join(os.path.split(__file__)[0], "../../build"),
+    'BUILDDIR' : (Path(__file__) / '..' / '..' / '..' / 'build').resolve(),
     'REMOVE_TEMPLATE' : False,
     'KEEP_TEST_DB' : False,
     'DB_HOST' : None,
@@ -27,198 +21,12 @@ userconfig = {
 
 use_step_matcher("re")
 
-
-class NominatimEnvironment(object):
-    """ Collects all functions for the execution of Nominatim functions.
-    """
-
-    def __init__(self, config):
-        self.build_dir = os.path.abspath(config['BUILDDIR'])
-        self.src_dir = os.path.abspath(os.path.join(os.path.split(__file__)[0], "../.."))
-        self.db_host = config['DB_HOST']
-        self.db_port = config['DB_PORT']
-        self.db_user = config['DB_USER']
-        self.db_pass = config['DB_PASS']
-        self.template_db = config['TEMPLATE_DB']
-        self.test_db = config['TEST_DB']
-        self.api_test_db = config['API_TEST_DB']
-        self.server_module_path = config['SERVER_MODULE_PATH']
-        self.reuse_template = not config['REMOVE_TEMPLATE']
-        self.keep_scenario_db = config['KEEP_TEST_DB']
-        self.code_coverage_path = config['PHPCOV']
-        self.code_coverage_id = 1
-        self.test_env = None
-
-        self.template_db_done = False
-        self.website_dir = None
-
-    def connect_database(self, dbname):
-        dbargs = {'database': dbname}
-        if self.db_host:
-            dbargs['host'] = self.db_host
-        if self.db_port:
-            dbargs['port'] = self.db_port
-        if self.db_user:
-            dbargs['user'] = self.db_user
-        if self.db_pass:
-            dbargs['password'] = self.db_pass
-        conn = psycopg2.connect(**dbargs)
-        return conn
-
-    def next_code_coverage_file(self):
-        fn = os.path.join(self.code_coverage_path, "%06d.cov" % self.code_coverage_id)
-        self.code_coverage_id += 1
-
-        return fn
-
-    def write_nominatim_config(self, dbname):
-        dsn = 'pgsql:dbname={}{}{}{}{}'.format(
-                dbname,
-                 (';host=' + self.db_host) if self.db_host else '',
-                 (';port=' + self.db_port) if self.db_port else '',
-                 (';user=' + self.db_user) if self.db_user else '',
-                 (';password=' + self.db_pass) if self.db_pass else ''
-                 )
-
-        if self.website_dir is not None \
-           and self.test_env is not None \
-           and dsn == self.test_env['NOMINATIM_DATABASE_DSN']:
-            return # environment already set uo
-
-        self.test_env = os.environ
-        self.test_env['NOMINATIM_DATABASE_DSN'] = dsn
-        self.test_env['NOMINATIM_FLATNODE_FILE'] = ''
-        self.test_env['NOMINATIM_IMPORT_STYLE'] = 'full'
-        self.test_env['NOMINATIM_USE_US_TIGER_DATA'] = 'yes'
-
-        if self.website_dir is not None:
-            self.website_dir.cleanup()
-
-        self.website_dir = tempfile.TemporaryDirectory()
-        self.run_setup_script('setup-website')
-
-
-    def db_drop_database(self, name):
-        conn = self.connect_database('postgres')
-        conn.set_isolation_level(0)
-        cur = conn.cursor()
-        cur.execute('DROP DATABASE IF EXISTS %s' % (name, ))
-        conn.close()
-
-    def setup_template_db(self):
-        if self.template_db_done:
-            return
-
-        self.template_db_done = True
-
-        if self.reuse_template:
-            # check that the template is there
-            conn = self.connect_database('postgres')
-            cur = conn.cursor()
-            cur.execute('select count(*) from pg_database where datname = %s',
-                        (self.template_db,))
-            if cur.fetchone()[0] == 1:
-                return
-            conn.close()
-        else:
-            # just in case... make sure a previous table has been dropped
-            self.db_drop_database(self.template_db)
-
-        try:
-            # call the first part of database setup
-            self.write_nominatim_config(self.template_db)
-            self.run_setup_script('create-db', 'setup-db')
-            # remove external data to speed up indexing for tests
-            conn = self.connect_database(self.template_db)
-            cur = conn.cursor()
-            cur.execute("""select tablename from pg_tables
-                           where tablename in ('gb_postcode', 'us_postcode')""")
-            for t in cur:
-                conn.cursor().execute('TRUNCATE TABLE %s' % (t[0],))
-            conn.commit()
-            conn.close()
-
-            # execute osm2pgsql import on an empty file to get the right tables
-            with tempfile.NamedTemporaryFile(dir='/tmp', suffix='.xml') as fd:
-                fd.write(b'<osm version="0.6"></osm>')
-                fd.flush()
-                self.run_setup_script('import-data',
-                                      'ignore-errors',
-                                      'create-functions',
-                                      'create-tables',
-                                      'create-partition-tables',
-                                      'create-partition-functions',
-                                      'load-data',
-                                      'create-search-indices',
-                                      osm_file=fd.name,
-                                      osm2pgsql_cache='200')
-        except:
-            self.db_drop_database(self.template_db)
-            raise
-
-
-    def setup_api_db(self, context):
-        self.write_nominatim_config(self.api_test_db)
-
-    def setup_unknown_db(self, context):
-        self.write_nominatim_config('UNKNOWN_DATABASE_NAME')
-
-    def setup_db(self, context):
-        self.setup_template_db()
-        self.write_nominatim_config(self.test_db)
-        conn = self.connect_database(self.template_db)
-        conn.set_isolation_level(0)
-        cur = conn.cursor()
-        cur.execute('DROP DATABASE IF EXISTS %s' % (self.test_db, ))
-        cur.execute('CREATE DATABASE %s TEMPLATE = %s' % (self.test_db, self.template_db))
-        conn.close()
-        context.db = self.connect_database(self.test_db)
-        psycopg2.extras.register_hstore(context.db, globally=False)
-
-    def teardown_db(self, context):
-        if 'db' in context:
-            context.db.close()
-
-        if not self.keep_scenario_db:
-            self.db_drop_database(self.test_db)
-
-    def run_setup_script(self, *args, **kwargs):
-        if self.server_module_path:
-            kwargs = dict(kwargs)
-            kwargs['module_path'] = self.server_module_path
-        self.run_nominatim_script('setup', *args, **kwargs)
-
-    def run_update_script(self, *args, **kwargs):
-        self.run_nominatim_script('update', *args, **kwargs)
-
-    def run_nominatim_script(self, script, *args, **kwargs):
-        cmd = ['/usr/bin/env', 'php', '-Cq']
-        cmd.append(os.path.join(self.build_dir, 'utils', '%s.php' % script))
-        cmd.extend(['--%s' % x for x in args])
-        for k, v in kwargs.items():
-            cmd.extend(('--' + k.replace('_', '-'), str(v)))
-
-        if self.website_dir is not None:
-            cwd = self.website_dir.name
-        else:
-            cwd = self.build_dir
-
-        proc = subprocess.Popen(cmd, cwd=cwd, env=self.test_env,
-                                stdout=subprocess.PIPE, stderr=subprocess.PIPE)
-        (outp, outerr) = proc.communicate()
-        outerr = outerr.decode('utf-8').replace('\\n', '\n')
-        logger.debug("run_nominatim_script: %s\n%s\n%s" % (cmd, outp, outerr))
-        assert (proc.returncode == 0), "Script '%s' failed:\n%s\n%s\n" % (script, outp, outerr)
-
-
-
 def before_all(context):
     # logging setup
     context.config.setup_logging()
     # set up -D options
     for k,v in userconfig.items():
         context.config.userdata.setdefault(k, v)
-    logging.debug('User config: %s' %(str(context.config.userdata)))
     # Nominatim test setup
     context.nominatim = NominatimEnvironment(context.config.userdata)
     context.osm = GeometryFactory()
@@ -228,9 +36,9 @@ def before_scenario(context, scenario):
     if 'DB' in context.tags:
         context.nominatim.setup_db(context)
     elif 'APIDB' in context.tags:
-        context.nominatim.setup_api_db(context)
+        context.nominatim.setup_api_db()
     elif 'UNKNOWNDB' in context.tags:
-        context.nominatim.setup_unknown_db(context)
+        context.nominatim.setup_unknown_db()
     context.scene = None
 
 def after_scenario(context, scenario):

test/bdd/steps/nominatim_environment.py

@@ -0,0 +1,224 @@
+import logging
+import os
+from pathlib import Path
+import subprocess
+import tempfile
+
+import psycopg2
+import psycopg2.extras
+
+LOG = logging.getLogger(__name__)
+
+class NominatimEnvironment:
+    """ Collects all functions for the execution of Nominatim functions.
+    """
+
+    def __init__(self, config):
+        self.build_dir = Path(config['BUILDDIR']).resolve()
+        self.src_dir = (Path(__file__) / '..' / '..' / '..' / '..').resolve()
+        self.db_host = config['DB_HOST']
+        self.db_port = config['DB_PORT']
+        self.db_user = config['DB_USER']
+        self.db_pass = config['DB_PASS']
+        self.template_db = config['TEMPLATE_DB']
+        self.test_db = config['TEST_DB']
+        self.api_test_db = config['API_TEST_DB']
+        self.server_module_path = config['SERVER_MODULE_PATH']
+        self.reuse_template = not config['REMOVE_TEMPLATE']
+        self.keep_scenario_db = config['KEEP_TEST_DB']
+        self.code_coverage_path = config['PHPCOV']
+        self.code_coverage_id = 1
+        self.test_env = None
+
+        self.template_db_done = False
+        self.website_dir = None
+
+    def connect_database(self, dbname):
+        """ Return a connection to the database with the given name.
+            Uses configured host, user and port.
+        """
+        dbargs = {'database': dbname}
+        if self.db_host:
+            dbargs['host'] = self.db_host
+        if self.db_port:
+            dbargs['port'] = self.db_port
+        if self.db_user:
+            dbargs['user'] = self.db_user
+        if self.db_pass:
+            dbargs['password'] = self.db_pass
+        conn = psycopg2.connect(**dbargs)
+        return conn
+
+    def next_code_coverage_file(self):
+        """ Generate the next name for a coverage file.
+        """
+        fn = Path(self.code_coverage_path) / "{:06d}.cov".format(self.code_coverage_id)
+        self.code_coverage_id += 1
+
+        return fn.resolve()
+
+    def write_nominatim_config(self, dbname):
+        """ Set up a custom test configuration that connects to the given
+            database. This sets up the environment variables so that they can
+            be picked up by dotenv and creates a project directory with the
+            appropriate website scripts.
+        """
+        dsn = 'pgsql:dbname={}'.format(dbname)
+        if self.db_host:
+            dsn += ';host=' + self.db_host
+        if self.db_port:
+            dsn += ';port=' + self.db_port
+        if self.db_user:
+            dsn += ';user=' + self.db_user
+        if self.db_pass:
+            dsn += ';password=' + self.db_pass
+
+        if self.website_dir is not None \
+           and self.test_env is not None \
+           and dsn == self.test_env['NOMINATIM_DATABASE_DSN']:
+            return # environment already set uo
+
+        self.test_env = os.environ
+        self.test_env['NOMINATIM_DATABASE_DSN'] = dsn
+        self.test_env['NOMINATIM_FLATNODE_FILE'] = ''
+        self.test_env['NOMINATIM_IMPORT_STYLE'] = 'full'
+        self.test_env['NOMINATIM_USE_US_TIGER_DATA'] = 'yes'
+
+        if self.server_module_path:
+            self.test_env['NOMINATIM_DATABASE_MODULE_PATH'] = self.server_module_path
+
+        if self.website_dir is not None:
+            self.website_dir.cleanup()
+
+        self.website_dir = tempfile.TemporaryDirectory()
+        self.run_setup_script('setup-website')
+
+
+    def db_drop_database(self, name):
+        """ Drop the database with the given name.
+        """
+        conn = self.connect_database('postgres')
+        conn.set_isolation_level(0)
+        cur = conn.cursor()
+        cur.execute('DROP DATABASE IF EXISTS {}'.format(name))
+        conn.close()
+
+    def setup_template_db(self):
+        """ Setup a template database that already contains common test data.
+            Having a template database speeds up tests considerably but at
+            the price that the tests sometimes run with stale data.
+        """
+        if self.template_db_done:
+            return
+
+        self.template_db_done = True
+
+        if self.reuse_template:
+            # check that the template is there
+            conn = self.connect_database('postgres')
+            cur = conn.cursor()
+            cur.execute('select count(*) from pg_database where datname = %s',
+                        (self.template_db,))
+            if cur.fetchone()[0] == 1:
+                return
+            conn.close()
+        else:
+            # just in case... make sure a previous table has been dropped
+            self.db_drop_database(self.template_db)
+
+        try:
+            # call the first part of database setup
+            self.write_nominatim_config(self.template_db)
+            self.run_setup_script('create-db', 'setup-db')
+            # remove external data to speed up indexing for tests
+            conn = self.connect_database(self.template_db)
+            cur = conn.cursor()
+            cur.execute("""select tablename from pg_tables
+                           where tablename in ('gb_postcode', 'us_postcode')""")
+            for t in cur:
+                conn.cursor().execute('TRUNCATE TABLE {}'.format(t[0]))
+            conn.commit()
+            conn.close()
+
+            # execute osm2pgsql import on an empty file to get the right tables
+            with tempfile.NamedTemporaryFile(dir='/tmp', suffix='.xml') as fd:
+                fd.write(b'<osm version="0.6"></osm>')
+                fd.flush()
+                self.run_setup_script('import-data',
+                                      'ignore-errors',
+                                      'create-functions',
+                                      'create-tables',
+                                      'create-partition-tables',
+                                      'create-partition-functions',
+                                      'load-data',
+                                      'create-search-indices',
+                                      osm_file=fd.name,
+                                      osm2pgsql_cache='200')
+        except:
+            self.db_drop_database(self.template_db)
+            raise
+
+
+    def setup_api_db(self):
+        """ Setup a test against the API test database.
+        """
+        self.write_nominatim_config(self.api_test_db)
+
+    def setup_unknown_db(self):
+        """ Setup a test against a non-existing database.
+        """
+        self.write_nominatim_config('UNKNOWN_DATABASE_NAME')
+
+    def setup_db(self, context):
+        """ Setup a test against a fresh, empty test database.
+        """
+        self.setup_template_db()
+        self.write_nominatim_config(self.test_db)
+        conn = self.connect_database(self.template_db)
+        conn.set_isolation_level(0)
+        cur = conn.cursor()
+        cur.execute('DROP DATABASE IF EXISTS {}'.format(self.test_db))
+        cur.execute('CREATE DATABASE {} TEMPLATE = {}'.format(self.test_db, self.template_db))
+        conn.close()
+        context.db = self.connect_database(self.test_db)
+        psycopg2.extras.register_hstore(context.db, globally=False)
+
+    def teardown_db(self, context):
+        """ Remove the test database, if it exists.
+        """
+        if 'db' in context:
+            context.db.close()
+
+        if not self.keep_scenario_db:
+            self.db_drop_database(self.test_db)
+
+    def run_setup_script(self, *args, **kwargs):
+        """ Run the Nominatim setup script with the given arguments.
+        """
+        self.run_nominatim_script('setup', *args, **kwargs)
+
+    def run_update_script(self, *args, **kwargs):
+        """ Run the Nominatim update script with the given arguments.
+        """
+        self.run_nominatim_script('update', *args, **kwargs)
+
+    def run_nominatim_script(self, script, *args, **kwargs):
+        """ Run one of the Nominatim utility scripts with the given arguments.
+        """
+        cmd = ['/usr/bin/env', 'php', '-Cq']
+        cmd.append((Path(self.build_dir) / 'utils' / '{}.php'.format(script)).resolve())
+        cmd.extend(['--' + x for x in args])
+        for k, v in kwargs.items():
+            cmd.extend(('--' + k.replace('_', '-'), str(v)))
+
+        if self.website_dir is not None:
+            cwd = self.website_dir.name
+        else:
+            cwd = self.build_dir
+
+        proc = subprocess.Popen(cmd, cwd=cwd, env=self.test_env,
+                                stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        (outp, outerr) = proc.communicate()
+        outerr = outerr.decode('utf-8').replace('\\n', '\n')
+        LOG.debug("run_nominatim_script: %s\n%s\n%s", cmd, outp, outerr)
+        assert (proc.returncode == 0), "Script '%s' failed:\n%s\n%s\n" % (script, outp, outerr)