]> git.openstreetmap.org Git - nominatim.git/blob - test/bdd/environment.py
Merge branch 'patch-1' of https://github.com/ganeshkrishnan1/Nominatim into ganeshkri...
[nominatim.git] / 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         os.environ['NOMINATIM_SETTINGS'] = self.local_settings_file
52
53         self.template_db_done = False
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         f = open(self.local_settings_file, 'w')
76         # https://secure.php.net/manual/en/ref.pdo-pgsql.connection.php
77         f.write("<?php\n  @define('CONST_Database_DSN', 'pgsql:dbname=%s%s%s%s%s');\n" %
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         f.write("@define('CONST_Osm2pgsql_Flatnode_File', null);\n")
85         f.write("@define('CONST_Import_Style', CONST_BasePath.'/settings/import-full.style');\n")
86         f.close()
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         self.write_nominatim_config(self.api_test_db)
155
156     def setup_unknown_db(self, context):
157         self.write_nominatim_config('UNKNOWN_DATABASE_NAME')
158
159     def setup_db(self, context):
160         self.setup_template_db()
161         self.write_nominatim_config(self.test_db)
162         conn = self.connect_database(self.template_db)
163         conn.set_isolation_level(0)
164         cur = conn.cursor()
165         cur.execute('DROP DATABASE IF EXISTS %s' % (self.test_db, ))
166         cur.execute('CREATE DATABASE %s TEMPLATE = %s' % (self.test_db, self.template_db))
167         conn.close()
168         context.db = self.connect_database(self.test_db)
169         if python_version[0] < 3:
170             psycopg2.extras.register_hstore(context.db, globally=False, unicode=True)
171         else:
172             psycopg2.extras.register_hstore(context.db, globally=False)
173
174     def teardown_db(self, context):
175         if 'db' in context:
176             context.db.close()
177
178         if not self.keep_scenario_db:
179             self.db_drop_database(self.test_db)
180
181     def run_setup_script(self, *args, **kwargs):
182         if self.server_module_path:
183             kwargs = dict(kwargs)
184             kwargs['module_path'] = self.server_module_path
185         self.run_nominatim_script('setup', *args, **kwargs)
186
187     def run_update_script(self, *args, **kwargs):
188         self.run_nominatim_script('update', *args, **kwargs)
189
190     def run_nominatim_script(self, script, *args, **kwargs):
191         cmd = ['/usr/bin/env', 'php', '-Cq']
192         cmd.append(os.path.join(self.build_dir, 'utils', '%s.php' % script))
193         cmd.extend(['--%s' % x for x in args])
194         for k, v in kwargs.items():
195             cmd.extend(('--' + k.replace('_', '-'), str(v)))
196         proc = subprocess.Popen(cmd, cwd=self.build_dir,
197                                 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
198         (outp, outerr) = proc.communicate()
199         outerr = outerr.decode('utf-8').replace('\\n', '\n')
200         logger.debug("run_nominatim_script: %s\n%s\n%s" % (cmd, outp, outerr))
201         assert (proc.returncode == 0), "Script '%s' failed:\n%s\n%s\n" % (script, outp, outerr)
202
203
204 class OSMDataFactory(object):
205
206     def __init__(self):
207         scriptpath = os.path.dirname(os.path.abspath(__file__))
208         self.scene_path = os.environ.get('SCENE_PATH',
209                            os.path.join(scriptpath, '..', 'scenes', 'data'))
210         self.scene_cache = {}
211         self.clear_grid()
212
213     def parse_geometry(self, geom, scene):
214         if geom.find(':') >= 0:
215             return "ST_SetSRID(%s, 4326)" % self.get_scene_geometry(scene, geom)
216
217         if geom.find(',') < 0:
218             out = "POINT(%s)" % self.mk_wkt_point(geom)
219         elif geom.find('(') < 0:
220             line = ','.join([self.mk_wkt_point(x) for x in geom.split(',')])
221             out = "LINESTRING(%s)" % line
222         else:
223             inner = geom.strip('() ')
224             line = ','.join([self.mk_wkt_point(x) for x in inner.split(',')])
225             out = "POLYGON((%s))" % line
226
227         return "ST_SetSRID('%s'::geometry, 4326)" % out
228
229     def mk_wkt_point(self, point):
230         geom = point.strip()
231         if geom.find(' ') >= 0:
232             return geom
233         else:
234             pt = self.grid_node(int(geom))
235             assert_is_not_none(pt, "Point not found in grid")
236             return "%f %f" % pt
237
238     def get_scene_geometry(self, default_scene, name):
239         geoms = []
240         for obj in name.split('+'):
241             oname = obj.strip()
242             if oname.startswith(':'):
243                 assert_is_not_none(default_scene, "You need to set a scene")
244                 defscene = self.load_scene(default_scene)
245                 wkt = defscene[oname[1:]]
246             else:
247                 scene, obj = oname.split(':', 2)
248                 scene_geoms = self.load_scene(scene)
249                 wkt = scene_geoms[obj]
250
251             geoms.append("'%s'::geometry" % wkt)
252
253         if len(geoms) == 1:
254             return geoms[0]
255         else:
256             return 'ST_LineMerge(ST_Collect(ARRAY[%s]))' % ','.join(geoms)
257
258     def load_scene(self, name):
259         if name in self.scene_cache:
260             return self.scene_cache[name]
261
262         scene = {}
263         with open(os.path.join(self.scene_path, "%s.wkt" % name), 'r') as fd:
264             for line in fd:
265                 if line.strip():
266                     obj, wkt = line.split('|', 2)
267                     scene[obj.strip()] = wkt.strip()
268             self.scene_cache[name] = scene
269
270         return scene
271
272     def clear_grid(self):
273         self.grid = {}
274
275     def add_grid_node(self, nodeid, x, y):
276         self.grid[nodeid] = (x, y)
277
278     def grid_node(self, nodeid):
279         return self.grid.get(nodeid)
280
281
282 def before_all(context):
283     # logging setup
284     context.config.setup_logging()
285     # set up -D options
286     for k,v in userconfig.items():
287         context.config.userdata.setdefault(k, v)
288     logging.debug('User config: %s' %(str(context.config.userdata)))
289     # Nominatim test setup
290     context.nominatim = NominatimEnvironment(context.config.userdata)
291     context.osm = OSMDataFactory()
292
293 def after_all(context):
294     context.nominatim.cleanup()
295
296
297 def before_scenario(context, scenario):
298     if 'DB' in context.tags:
299         context.nominatim.setup_db(context)
300     elif 'APIDB' in context.tags:
301         context.nominatim.setup_api_db(context)
302     elif 'UNKNOWNDB' in context.tags:
303         context.nominatim.setup_unknown_db(context)
304     context.scene = None
305
306 def after_scenario(context, scenario):
307     if 'DB' in context.tags:
308         context.nominatim.teardown_db(context)