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 from nose.tools import * # for assert functions
   9 from sys import version_info as python_version
  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     'TEST_SETTINGS_FILE' : '/tmp/nominatim_settings.php',
  25     'SERVER_MODULE_PATH' : None,
  26     'PHPCOV' : False, # set to output directory to enable code coverage
  27 }
  28
  29 use_step_matcher("re")
  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.local_settings_file = config['TEST_SETTINGS_FILE']
  47         self.reuse_template = not config['REMOVE_TEMPLATE']
  48         self.keep_scenario_db = config['KEEP_TEST_DB']
  49         self.code_coverage_path = config['PHPCOV']
  50         self.code_coverage_id = 1
  51         self.test_env = None
  52         os.environ['NOMINATIM_SETTINGS'] = self.local_settings_file
  53
  54         self.template_db_done = False
  55
  56     def connect_database(self, dbname):
  57         dbargs = {'database': dbname}
  58         if self.db_host:
  59             dbargs['host'] = self.db_host
  60         if self.db_port:
  61             dbargs['port'] = self.db_port
  62         if self.db_user:
  63             dbargs['user'] = self.db_user
  64         if self.db_pass:
  65             dbargs['password'] = self.db_pass
  66         conn = psycopg2.connect(**dbargs)
  67         return conn
  68
  69     def next_code_coverage_file(self):
  70         fn = os.path.join(self.code_coverage_path, "%06d.cov" % self.code_coverage_id)
  71         self.code_coverage_id += 1
  72
  73         return fn
  74
  75     def write_nominatim_config(self, dbname):
  76         self.test_env = os.environ
  77         self.test_env['NOMINATIM_DATABASE_DSN'] = 'pgsql:dbname={}{}{}{}{}'.format(
  78                 dbname,
  79                  (';host=' + self.db_host) if self.db_host else '',
  80                  (';port=' + self.db_port) if self.db_port else '',
  81                  (';user=' + self.db_user) if self.db_user else '',
  82                  (';password=' + self.db_pass) if self.db_pass else ''
  83                  )
  84         self.test_env['NOMINATIM_FLATNODE_FILE'] = ''
  85         self.test_env['NOMINATIM_IMPORT_STYLE'] = 'full'
  86         self.test_env['NOMINATIM_USE_US_TIGER_DATA'] = 'yes'
  87
  88     def cleanup(self):
  89         try:
  90             os.remove(self.local_settings_file)
  91         except OSError:
  92             pass # ignore missing file
  93
  94     def db_drop_database(self, name):
  95         conn = self.connect_database('postgres')
  96         conn.set_isolation_level(0)
  97         cur = conn.cursor()
  98         cur.execute('DROP DATABASE IF EXISTS %s' % (name, ))
  99         conn.close()
 100
 101     def setup_template_db(self):
 102         if self.template_db_done:
 103             return
 104
 105         self.template_db_done = True
 106
 107         if self.reuse_template:
 108             # check that the template is there
 109             conn = self.connect_database('postgres')
 110             cur = conn.cursor()
 111             cur.execute('select count(*) from pg_database where datname = %s',
 112                         (self.template_db,))
 113             if cur.fetchone()[0] == 1:
 114                 return
 115             conn.close()
 116         else:
 117             # just in case... make sure a previous table has been dropped
 118             self.db_drop_database(self.template_db)
 119
 120         try:
 121             # call the first part of database setup
 122             self.write_nominatim_config(self.template_db)
 123             self.run_setup_script('create-db', 'setup-db')
 124             # remove external data to speed up indexing for tests
 125             conn = self.connect_database(self.template_db)
 126             cur = conn.cursor()
 127             cur.execute("""select tablename from pg_tables
 128                            where tablename in ('gb_postcode', 'us_postcode')""")
 129             for t in cur:
 130                 conn.cursor().execute('TRUNCATE TABLE %s' % (t[0],))
 131             conn.commit()
 132             conn.close()
 133
 134             # execute osm2pgsql import on an empty file to get the right tables
 135             with tempfile.NamedTemporaryFile(dir='/tmp', suffix='.xml') as fd:
 136                 fd.write(b'<osm version="0.6"></osm>')
 137                 fd.flush()
 138                 self.run_setup_script('import-data',
 139                                       'ignore-errors',
 140                                       'create-functions',
 141                                       'create-tables',
 142                                       'create-partition-tables',
 143                                       'create-partition-functions',
 144                                       'load-data',
 145                                       'create-search-indices',
 146                                       osm_file=fd.name,
 147                                       osm2pgsql_cache='200')
 148         except:
 149             self.db_drop_database(self.template_db)
 150             raise
 151
 152
 153     def setup_api_db(self, context):
 154         f = open(self.local_settings_file, 'w')
 155         # https://secure.php.net/manual/en/ref.pdo-pgsql.connection.php
 156         f.write("<?php\n  @define('CONST_Database_DSN', 'pgsql:dbname=%s%s%s%s%s');\n" %
 157                 (self.api_test_db,
 158                  (';host=' + self.db_host) if self.db_host else '',
 159                  (';port=' + self.db_port) if self.db_port else '',
 160                  (';user=' + self.db_user) if self.db_user else '',
 161                  (';password=' + self.db_pass) if self.db_pass else ''
 162                  ))
 163         f.write("@define('CONST_Osm2pgsql_Flatnode_File', null);\n")
 164         f.write("@define('CONST_Import_Style', CONST_DataDir.'/settings/import-full.style');\n")
 165         f.write("@define('CONST_Use_US_Tiger_Data', true);\n")
 166         f.close()
 167
 168     def setup_unknown_db(self, context):
 169         self.write_nominatim_config('UNKNOWN_DATABASE_NAME')
 170
 171     def setup_db(self, context):
 172         self.setup_template_db()
 173         self.write_nominatim_config(self.test_db)
 174         conn = self.connect_database(self.template_db)
 175         conn.set_isolation_level(0)
 176         cur = conn.cursor()
 177         cur.execute('DROP DATABASE IF EXISTS %s' % (self.test_db, ))
 178         cur.execute('CREATE DATABASE %s TEMPLATE = %s' % (self.test_db, self.template_db))
 179         conn.close()
 180         context.db = self.connect_database(self.test_db)
 181         if python_version[0] < 3:
 182             psycopg2.extras.register_hstore(context.db, globally=False, unicode=True)
 183         else:
 184             psycopg2.extras.register_hstore(context.db, globally=False)
 185
 186     def teardown_db(self, context):
 187         if 'db' in context:
 188             context.db.close()
 189
 190         if not self.keep_scenario_db:
 191             self.db_drop_database(self.test_db)
 192
 193     def run_setup_script(self, *args, **kwargs):
 194         if self.server_module_path:
 195             kwargs = dict(kwargs)
 196             kwargs['module_path'] = self.server_module_path
 197         self.run_nominatim_script('setup', *args, **kwargs)
 198
 199     def run_update_script(self, *args, **kwargs):
 200         self.run_nominatim_script('update', *args, **kwargs)
 201
 202     def run_nominatim_script(self, script, *args, **kwargs):
 203         cmd = ['/usr/bin/env', 'php', '-Cq']
 204         cmd.append(os.path.join(self.build_dir, 'utils', '%s.php' % script))
 205         cmd.extend(['--%s' % x for x in args])
 206         for k, v in kwargs.items():
 207             cmd.extend(('--' + k.replace('_', '-'), str(v)))
 208         proc = subprocess.Popen(cmd, cwd=self.build_dir, env=self.test_env,
 209                                 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 210         (outp, outerr) = proc.communicate()
 211         outerr = outerr.decode('utf-8').replace('\\n', '\n')
 212         logger.debug("run_nominatim_script: %s\n%s\n%s" % (cmd, outp, outerr))
 213         assert (proc.returncode == 0), "Script '%s' failed:\n%s\n%s\n" % (script, outp, outerr)
 214
 215
 216 class OSMDataFactory(object):
 217
 218     def __init__(self):
 219         scriptpath = os.path.dirname(os.path.abspath(__file__))
 220         self.scene_path = os.environ.get('SCENE_PATH',
 221                            os.path.join(scriptpath, '..', 'scenes', 'data'))
 222         self.scene_cache = {}
 223         self.clear_grid()
 224
 225     def parse_geometry(self, geom, scene):
 226         if geom.find(':') >= 0:
 227             return "ST_SetSRID(%s, 4326)" % self.get_scene_geometry(scene, geom)
 228
 229         if geom.find(',') < 0:
 230             out = "POINT(%s)" % self.mk_wkt_point(geom)
 231         elif geom.find('(') < 0:
 232             line = ','.join([self.mk_wkt_point(x) for x in geom.split(',')])
 233             out = "LINESTRING(%s)" % line
 234         else:
 235             inner = geom.strip('() ')
 236             line = ','.join([self.mk_wkt_point(x) for x in inner.split(',')])
 237             out = "POLYGON((%s))" % line
 238
 239         return "ST_SetSRID('%s'::geometry, 4326)" % out
 240
 241     def mk_wkt_point(self, point):
 242         geom = point.strip()
 243         if geom.find(' ') >= 0:
 244             return geom
 245         else:
 246             pt = self.grid_node(int(geom))
 247             assert_is_not_none(pt, "Point not found in grid")
 248             return "%f %f" % pt
 249
 250     def get_scene_geometry(self, default_scene, name):
 251         geoms = []
 252         for obj in name.split('+'):
 253             oname = obj.strip()
 254             if oname.startswith(':'):
 255                 assert_is_not_none(default_scene, "You need to set a scene")
 256                 defscene = self.load_scene(default_scene)
 257                 wkt = defscene[oname[1:]]
 258             else:
 259                 scene, obj = oname.split(':', 2)
 260                 scene_geoms = self.load_scene(scene)
 261                 wkt = scene_geoms[obj]
 262
 263             geoms.append("'%s'::geometry" % wkt)
 264
 265         if len(geoms) == 1:
 266             return geoms[0]
 267         else:
 268             return 'ST_LineMerge(ST_Collect(ARRAY[%s]))' % ','.join(geoms)
 269
 270     def load_scene(self, name):
 271         if name in self.scene_cache:
 272             return self.scene_cache[name]
 273
 274         scene = {}
 275         with open(os.path.join(self.scene_path, "%s.wkt" % name), 'r') as fd:
 276             for line in fd:
 277                 if line.strip():
 278                     obj, wkt = line.split('|', 2)
 279                     scene[obj.strip()] = wkt.strip()
 280             self.scene_cache[name] = scene
 281
 282         return scene
 283
 284     def clear_grid(self):
 285         self.grid = {}
 286
 287     def add_grid_node(self, nodeid, x, y):
 288         self.grid[nodeid] = (x, y)
 289
 290     def grid_node(self, nodeid):
 291         return self.grid.get(nodeid)
 292
 293
 294 def before_all(context):
 295     # logging setup
 296     context.config.setup_logging()
 297     # set up -D options
 298     for k,v in userconfig.items():
 299         context.config.userdata.setdefault(k, v)
 300     logging.debug('User config: %s' %(str(context.config.userdata)))
 301     # Nominatim test setup
 302     context.nominatim = NominatimEnvironment(context.config.userdata)
 303     context.osm = OSMDataFactory()
 304
 305 def after_all(context):
 306     context.nominatim.cleanup()
 307
 308
 309 def before_scenario(context, scenario):
 310     if 'DB' in context.tags:
 311         context.nominatim.setup_db(context)
 312     elif 'APIDB' in context.tags:
 313         context.nominatim.setup_api_db(context)
 314     elif 'UNKNOWNDB' in context.tags:
 315         context.nominatim.setup_unknown_db(context)
 316     context.scene = None
 317
 318 def after_scenario(context, scenario):
 319     if 'DB' in context.tags:
 320         context.nominatim.teardown_db(context)