test/bdd/environment.py

   1 from behave import *
   2 import logging
   3 import os
   4 import psycopg2
   5 import psycopg2.extras
   6 import subprocess
   7 import tempfile
   8
   9 from steps.geometry_factory import GeometryFactory
  10
  11 logger = logging.getLogger(__name__)
  12
  13 userconfig = {
  14     'BUILDDIR' : os.path.join(os.path.split(__file__)[0], "../../build"),
  15     'REMOVE_TEMPLATE' : False,
  16     'KEEP_TEST_DB' : False,
  17     'DB_HOST' : None,
  18     'DB_PORT' : None,
  19     'DB_USER' : None,
  20     'DB_PASS' : None,
  21     'TEMPLATE_DB' : 'test_template_nominatim',
  22     'TEST_DB' : 'test_nominatim',
  23     'API_TEST_DB' : 'test_api_nominatim',
  24     'SERVER_MODULE_PATH' : None,
  25     'PHPCOV' : False, # set to output directory to enable code coverage
  26 }
  27
  28 use_step_matcher("re")
  29
  30
  31 class NominatimEnvironment(object):
  32     """ Collects all functions for the execution of Nominatim functions.
  33     """
  34
  35     def __init__(self, config):
  36         self.build_dir = os.path.abspath(config['BUILDDIR'])
  37         self.src_dir = os.path.abspath(os.path.join(os.path.split(__file__)[0], "../.."))
  38         self.db_host = config['DB_HOST']
  39         self.db_port = config['DB_PORT']
  40         self.db_user = config['DB_USER']
  41         self.db_pass = config['DB_PASS']
  42         self.template_db = config['TEMPLATE_DB']
  43         self.test_db = config['TEST_DB']
  44         self.api_test_db = config['API_TEST_DB']
  45         self.server_module_path = config['SERVER_MODULE_PATH']
  46         self.reuse_template = not config['REMOVE_TEMPLATE']
  47         self.keep_scenario_db = config['KEEP_TEST_DB']
  48         self.code_coverage_path = config['PHPCOV']
  49         self.code_coverage_id = 1
  50         self.test_env = None
  51
  52         self.template_db_done = False
  53         self.website_dir = None
  54
  55     def connect_database(self, dbname):
  56         dbargs = {'database': dbname}
  57         if self.db_host:
  58             dbargs['host'] = self.db_host
  59         if self.db_port:
  60             dbargs['port'] = self.db_port
  61         if self.db_user:
  62             dbargs['user'] = self.db_user
  63         if self.db_pass:
  64             dbargs['password'] = self.db_pass
  65         conn = psycopg2.connect(**dbargs)
  66         return conn
  67
  68     def next_code_coverage_file(self):
  69         fn = os.path.join(self.code_coverage_path, "%06d.cov" % self.code_coverage_id)
  70         self.code_coverage_id += 1
  71
  72         return fn
  73
  74     def write_nominatim_config(self, dbname):
  75         dsn = 'pgsql:dbname={}{}{}{}{}'.format(
  76                 dbname,
  77                  (';host=' + self.db_host) if self.db_host else '',
  78                  (';port=' + self.db_port) if self.db_port else '',
  79                  (';user=' + self.db_user) if self.db_user else '',
  80                  (';password=' + self.db_pass) if self.db_pass else ''
  81                  )
  82
  83         if self.website_dir is not None \
  84            and self.test_env is not None \
  85            and dsn == self.test_env['NOMINATIM_DATABASE_DSN']:
  86             return # environment already set uo
  87
  88         self.test_env = os.environ
  89         self.test_env['NOMINATIM_DATABASE_DSN'] = dsn
  90         self.test_env['NOMINATIM_FLATNODE_FILE'] = ''
  91         self.test_env['NOMINATIM_IMPORT_STYLE'] = 'full'
  92         self.test_env['NOMINATIM_USE_US_TIGER_DATA'] = 'yes'
  93
  94         if self.website_dir is not None:
  95             self.website_dir.cleanup()
  96
  97         self.website_dir = tempfile.TemporaryDirectory()
  98         self.run_setup_script('setup-website')
  99
 100
 101     def db_drop_database(self, name):
 102         conn = self.connect_database('postgres')
 103         conn.set_isolation_level(0)
 104         cur = conn.cursor()
 105         cur.execute('DROP DATABASE IF EXISTS %s' % (name, ))
 106         conn.close()
 107
 108     def setup_template_db(self):
 109         if self.template_db_done:
 110             return
 111
 112         self.template_db_done = True
 113
 114         if self.reuse_template:
 115             # check that the template is there
 116             conn = self.connect_database('postgres')
 117             cur = conn.cursor()
 118             cur.execute('select count(*) from pg_database where datname = %s',
 119                         (self.template_db,))
 120             if cur.fetchone()[0] == 1:
 121                 return
 122             conn.close()
 123         else:
 124             # just in case... make sure a previous table has been dropped
 125             self.db_drop_database(self.template_db)
 126
 127         try:
 128             # call the first part of database setup
 129             self.write_nominatim_config(self.template_db)
 130             self.run_setup_script('create-db', 'setup-db')
 131             # remove external data to speed up indexing for tests
 132             conn = self.connect_database(self.template_db)
 133             cur = conn.cursor()
 134             cur.execute("""select tablename from pg_tables
 135                            where tablename in ('gb_postcode', 'us_postcode')""")
 136             for t in cur:
 137                 conn.cursor().execute('TRUNCATE TABLE %s' % (t[0],))
 138             conn.commit()
 139             conn.close()
 140
 141             # execute osm2pgsql import on an empty file to get the right tables
 142             with tempfile.NamedTemporaryFile(dir='/tmp', suffix='.xml') as fd:
 143                 fd.write(b'<osm version="0.6"></osm>')
 144                 fd.flush()
 145                 self.run_setup_script('import-data',
 146                                       'ignore-errors',
 147                                       'create-functions',
 148                                       'create-tables',
 149                                       'create-partition-tables',
 150                                       'create-partition-functions',
 151                                       'load-data',
 152                                       'create-search-indices',
 153                                       osm_file=fd.name,
 154                                       osm2pgsql_cache='200')
 155         except:
 156             self.db_drop_database(self.template_db)
 157             raise
 158
 159
 160     def setup_api_db(self, context):
 161         self.write_nominatim_config(self.api_test_db)
 162
 163     def setup_unknown_db(self, context):
 164         self.write_nominatim_config('UNKNOWN_DATABASE_NAME')
 165
 166     def setup_db(self, context):
 167         self.setup_template_db()
 168         self.write_nominatim_config(self.test_db)
 169         conn = self.connect_database(self.template_db)
 170         conn.set_isolation_level(0)
 171         cur = conn.cursor()
 172         cur.execute('DROP DATABASE IF EXISTS %s' % (self.test_db, ))
 173         cur.execute('CREATE DATABASE %s TEMPLATE = %s' % (self.test_db, self.template_db))
 174         conn.close()
 175         context.db = self.connect_database(self.test_db)
 176         psycopg2.extras.register_hstore(context.db, globally=False)
 177
 178     def teardown_db(self, context):
 179         if 'db' in context:
 180             context.db.close()
 181
 182         if not self.keep_scenario_db:
 183             self.db_drop_database(self.test_db)
 184
 185     def run_setup_script(self, *args, **kwargs):
 186         if self.server_module_path:
 187             kwargs = dict(kwargs)
 188             kwargs['module_path'] = self.server_module_path
 189         self.run_nominatim_script('setup', *args, **kwargs)
 190
 191     def run_update_script(self, *args, **kwargs):
 192         self.run_nominatim_script('update', *args, **kwargs)
 193
 194     def run_nominatim_script(self, script, *args, **kwargs):
 195         cmd = ['/usr/bin/env', 'php', '-Cq']
 196         cmd.append(os.path.join(self.build_dir, 'utils', '%s.php' % script))
 197         cmd.extend(['--%s' % x for x in args])
 198         for k, v in kwargs.items():
 199             cmd.extend(('--' + k.replace('_', '-'), str(v)))
 200
 201         if self.website_dir is not None:
 202             cwd = self.website_dir.name
 203         else:
 204             cwd = self.build_dir
 205
 206         proc = subprocess.Popen(cmd, cwd=cwd, env=self.test_env,
 207                                 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 208         (outp, outerr) = proc.communicate()
 209         outerr = outerr.decode('utf-8').replace('\\n', '\n')
 210         logger.debug("run_nominatim_script: %s\n%s\n%s" % (cmd, outp, outerr))
 211         assert (proc.returncode == 0), "Script '%s' failed:\n%s\n%s\n" % (script, outp, outerr)
 212
 213
 214
 215 def before_all(context):
 216     # logging setup
 217     context.config.setup_logging()
 218     # set up -D options
 219     for k,v in userconfig.items():
 220         context.config.userdata.setdefault(k, v)
 221     logging.debug('User config: %s' %(str(context.config.userdata)))
 222     # Nominatim test setup
 223     context.nominatim = NominatimEnvironment(context.config.userdata)
 224     context.osm = GeometryFactory()
 225
 226
 227 def before_scenario(context, scenario):
 228     if 'DB' in context.tags:
 229         context.nominatim.setup_db(context)
 230     elif 'APIDB' in context.tags:
 231         context.nominatim.setup_api_db(context)
 232     elif 'UNKNOWNDB' in context.tags:
 233         context.nominatim.setup_unknown_db(context)
 234     context.scene = None
 235
 236 def after_scenario(context, scenario):
 237     if 'DB' in context.tags:
 238         context.nominatim.teardown_db(context)