test/bdd/steps/db_ops.py

   1 import base64
   2 import random
   3 import string
   4 import re
   5 from nose.tools import * # for assert functions
   6 import psycopg2.extras
   7
   8 class PlaceColumn:
   9
  10     def __init__(self, context, force_name):
  11         self.columns = { 'admin_level' : 100}
  12         self.force_name = force_name
  13         self.context = context
  14         self.geometry = None
  15
  16     def add(self, key, value):
  17         if hasattr(self, 'set_key_' + key):
  18             getattr(self, 'set_key_' + key)(value)
  19         elif key.startswith('name+'):
  20             self.add_hstore('name', key[5:], value)
  21         elif key.startswith('extra+'):
  22             self.add_hstore('extratags', key[6:], value)
  23         else:
  24             assert_in(key, ('class', 'type', 'street', 'addr_place',
  25                             'isin', 'postcode'))
  26             self.columns[key] = None if value == '' else value
  27
  28     def set_key_name(self, value):
  29         self.add_hstore('name', 'name', value)
  30
  31     def set_key_osm(self, value):
  32         assert_in(value[0], 'NRW')
  33         ok_(value[1:].isdigit())
  34
  35         self.columns['osm_type'] = value[0]
  36         self.columns['osm_id'] = int(value[1:])
  37
  38     def set_key_admin(self, value):
  39         self.columns['admin_level'] = int(value)
  40
  41     def set_key_housenr(self, value):
  42         self.columns['housenumber'] = None if value == '' else value
  43
  44     def set_key_country(self, value):
  45         self.columns['country_code'] = None if value == '' else value
  46
  47     def set_key_geometry(self, value):
  48         self.geometry = self.context.osm.parse_geometry(value, self.context.scene)
  49         assert_is_not_none(self.geometry)
  50
  51     def add_hstore(self, column, key, value):
  52         if column in self.columns:
  53             self.columns[column][key] = value
  54         else:
  55             self.columns[column] = { key : value }
  56
  57     def db_insert(self, cursor):
  58         assert_in('osm_type', self.columns)
  59         if self.force_name and 'name' not in self.columns:
  60             self.add_hstore('name', 'name', ''.join(random.choice(string.printable)
  61                                            for _ in range(int(random.random()*30))))
  62
  63         if self.columns['osm_type'] == 'N' and self.geometry is None:
  64             self.geometry = "ST_SetSRID(ST_Point(%f, %f), 4326)" % (
  65                             random.random()*360 - 180, random.random()*180 - 90)
  66         else:
  67             assert_is_not_none(self.geometry, "Geometry missing")
  68         query = 'INSERT INTO place (%s, geometry) values(%s, %s)' % (
  69                      ','.join(self.columns.keys()),
  70                      ','.join(['%s' for x in range(len(self.columns))]),
  71                      self.geometry)
  72         cursor.execute(query, list(self.columns.values()))
  73
  74 class NominatimID:
  75     """ Splits a unique identifier for places into its components.
  76         As place_ids cannot be used for testing, we use a unique
  77         identifier instead that is of the form <osmtype><osmid>[:<class>].
  78     """
  79
  80     id_regex = re.compile(r"(?P<tp>[NRW])(?P<id>\d+)(:(?P<cls>\w+))?")
  81
  82     def __init__(self, oid):
  83         self.typ = self.oid = self.cls = None
  84
  85         if oid is not None:
  86             m = self.id_regex.fullmatch(oid)
  87             assert_is_not_none(m, "ID '%s' not of form <osmtype><osmid>[:<class>]" % oid)
  88
  89             self.typ = m.group('tp')
  90             self.oid = m.group('id')
  91             self.cls = m.group('cls')
  92
  93     def table_select(self):
  94         """ Return where clause and parameter list to select the object
  95             from a Nominatim table.
  96         """
  97         where = 'osm_type = %s and osm_id = %s'
  98         params = [self.typ, self. oid]
  99
 100         if self.cls is not None:
 101             where += ' and class = %s'
 102             params.append(self.cls)
 103
 104         return where, params
 105
 106     def get_place_id(self, cur):
 107         where, params = self.table_select()
 108         cur.execute("SELECT place_id FROM placex WHERE %s" % where, params)
 109         eq_(1, cur.rowcount, "Expected exactly 1 entry in placex found %s" % cur.rowcount)
 110
 111         return cur.fetchone()[0]
 112
 113
 114 def assert_db_column(row, column, value, context):
 115     if column == 'object':
 116         return
 117
 118     if column.startswith('centroid'):
 119         fac = float(column[9:]) if column.startswith('centroid*') else 1.0
 120         x, y = value.split(' ')
 121         assert_almost_equal(float(x) * fac, row['cx'], "Bad x coordinate")
 122         assert_almost_equal(float(y) * fac, row['cy'], "Bad y coordinate")
 123     elif column == 'geometry':
 124         geom = context.osm.parse_geometry(value, context.scene)
 125         cur = context.db.cursor()
 126         query = "SELECT ST_Equals(ST_SnapToGrid(%s, 0.00001, 0.00001), ST_SnapToGrid(ST_SetSRID('%s'::geometry, 4326), 0.00001, 0.00001))" % (
 127                  geom, row['geomtxt'],)
 128         cur.execute(query)
 129         eq_(cur.fetchone()[0], True, "(Row %s failed: %s)" % (column, query))
 130     else:
 131         eq_(value, str(row[column]),
 132             "Row '%s': expected: %s, got: %s"
 133             % (column, value, str(row[column])))
 134
 135
 136 ################################ STEPS ##################################
 137
 138 @given(u'the scene (?P<scene>.+)')
 139 def set_default_scene(context, scene):
 140     context.scene = scene
 141
 142 @given("the (?P<named>named )?places")
 143 def add_data_to_place_table(context, named):
 144     cur = context.db.cursor()
 145     cur.execute('ALTER TABLE place DISABLE TRIGGER place_before_insert')
 146     for r in context.table:
 147         col = PlaceColumn(context, named is not None)
 148
 149         for h in r.headings:
 150             col.add(h, r[h])
 151
 152         col.db_insert(cur)
 153     cur.execute('ALTER TABLE place ENABLE TRIGGER place_before_insert')
 154     cur.close()
 155     context.db.commit()
 156
 157 @given("the relations")
 158 def add_data_to_planet_relations(context):
 159     cur = context.db.cursor()
 160     for r in context.table:
 161         last_node = 0
 162         last_way = 0
 163         parts = []
 164         if r['members']:
 165             members = []
 166             for m in r['members'].split(','):
 167                 mid = NominatimID(m)
 168                 if mid.typ == 'N':
 169                     parts.insert(last_node, int(mid.oid))
 170                     last_node += 1
 171                     last_way += 1
 172                 elif mid.typ == 'W':
 173                     parts.insert(last_way, int(mid.oid))
 174                     last_way += 1
 175                 else:
 176                     parts.append(int(mid.oid))
 177
 178                 members.extend((mid.typ.lower() + mid.oid, mid.cls or ''))
 179         else:
 180             members = None
 181
 182         tags = []
 183         for h in r.headings:
 184             if h.startswith("tags+"):
 185                 tags.extend((h[5:], r[h]))
 186
 187         cur.execute("""INSERT INTO planet_osm_rels (id, way_off, rel_off, parts, members, tags)
 188                        VALUES (%s, %s, %s, %s, %s, %s)""",
 189                     (r['id'], last_node, last_way, parts, members, tags))
 190     context.db.commit()
 191
 192 @given("the ways")
 193 def add_data_to_planet_ways(context):
 194     cur = context.db.cursor()
 195     for r in context.table:
 196         tags = []
 197         for h in r.headings:
 198             if h.startswith("tags+"):
 199                 tags.extend((h[5:], r[h]))
 200
 201         nodes = [ int(x.strip()) for x in r['nodes'].split(',') ]
 202
 203         cur.execute("INSERT INTO planet_osm_ways (id, nodes, tags) VALUES (%s, %s, %s)",
 204                     (r['id'], nodes, tags))
 205     context.db.commit()
 206
 207 @when("importing")
 208 def import_and_index_data_from_place_table(context):
 209     context.nominatim.run_setup_script('create-functions', 'create-partition-functions')
 210     cur = context.db.cursor()
 211     cur.execute(
 212         """insert into placex (osm_type, osm_id, class, type, name, admin_level,
 213            housenumber, street, addr_place, isin, postcode, country_code, extratags,
 214            geometry)
 215            select * from place where not (class='place' and type='houses' and osm_type='W')""")
 216     cur.execute(
 217         """select insert_osmline (osm_id, housenumber, street, addr_place,
 218            postcode, country_code, geometry)
 219            from place where class='place' and type='houses' and osm_type='W'""")
 220     context.db.commit()
 221     context.nominatim.run_setup_script('index', 'index-noanalyse')
 222
 223 @when("updating places")
 224 def update_place_table(context):
 225     context.nominatim.run_setup_script(
 226         'create-functions', 'create-partition-functions', 'enable-diff-updates')
 227     cur = context.db.cursor()
 228     for r in context.table:
 229         col = PlaceColumn(context, False)
 230
 231         for h in r.headings:
 232             col.add(h, r[h])
 233
 234         col.db_insert(cur)
 235
 236     context.db.commit()
 237     context.nominatim.run_update_script('index')
 238
 239 @when("marking for delete (?P<oids>.*)")
 240 def delete_places(context, oids):
 241     context.nominatim.run_setup_script(
 242         'create-functions', 'create-partition-functions', 'enable-diff-updates')
 243     cur = context.db.cursor()
 244     for oid in oids.split(','):
 245         where, params = NominatimID(oid).table_select()
 246         cur.execute("DELETE FROM place WHERE " + where, params)
 247     context.db.commit()
 248     context.nominatim.run_update_script('index')
 249
 250 @then("placex contains(?P<exact> exactly)?")
 251 def check_placex_contents(context, exact):
 252     cur = context.db.cursor(cursor_factory=psycopg2.extras.DictCursor)
 253
 254     expected_content = set()
 255     for row in context.table:
 256         nid = NominatimID(row['object'])
 257         where, params = nid.table_select()
 258         cur.execute("""SELECT *, ST_AsText(geometry) as geomtxt,
 259                        ST_X(centroid) as cx, ST_Y(centroid) as cy
 260                        FROM placex where %s""" % where,
 261                     params)
 262         assert_less(0, cur.rowcount, "No rows found for " + row['object'])
 263
 264         for res in cur:
 265             if exact:
 266                 expected_content.add((res['osm_type'], res['osm_id'], res['class']))
 267             for h in row.headings:
 268                 if h.startswith('name'):
 269                     name = h[5:] if h.startswith('name+') else 'name'
 270                     assert_in(name, res['name'])
 271                     eq_(res['name'][name], row[h])
 272                 elif h.startswith('extratags+'):
 273                     eq_(res['extratags'][h[10:]], row[h])
 274                 elif h in ('linked_place_id', 'parent_place_id'):
 275                     if row[h] == '0':
 276                         eq_(0, res[h])
 277                     elif row[h] == '-':
 278                         assert_is_none(res[h])
 279                     else:
 280                         eq_(NominatimID(row[h]).get_place_id(context.db.cursor()),
 281                             res[h])
 282                 else:
 283                     assert_db_column(res, h, row[h], context)
 284
 285     if exact:
 286         cur.execute('SELECT osm_type, osm_id, class from placex')
 287         eq_(expected_content, set([(r[0], r[1], r[2]) for r in cur]))
 288
 289     context.db.commit()
 290
 291 @then("place contains(?P<exact> exactly)?")
 292 def check_placex_contents(context, exact):
 293     cur = context.db.cursor(cursor_factory=psycopg2.extras.DictCursor)
 294
 295     expected_content = set()
 296     for row in context.table:
 297         nid = NominatimID(row['object'])
 298         where, params = nid.table_select()
 299         cur.execute("""SELECT *, ST_AsText(geometry) as geomtxt,
 300                        ST_GeometryType(geometry) as geometrytype
 301                        FROM place where %s""" % where,
 302                     params)
 303         assert_less(0, cur.rowcount, "No rows found for " + row['object'])
 304
 305         for res in cur:
 306             if exact:
 307                 expected_content.add((res['osm_type'], res['osm_id'], res['class']))
 308             for h in row.headings:
 309                 msg = "%s: %s" % (row['object'], h)
 310                 if h in ('name', 'extratags'):
 311                     vdict = eval('{' + row[h] + '}')
 312                     assert_equals(vdict, res[h], msg)
 313                 elif h.startswith('name+'):
 314                     assert_equals(res['name'][h[5:]], row[h], msg)
 315                 elif h.startswith('extratags+'):
 316                     assert_equals(res['extratags'][h[10:]], row[h], msg)
 317                 elif h in ('linked_place_id', 'parent_place_id'):
 318                     if row[h] == '0':
 319                         assert_equals(0, res[h], msg)
 320                     elif row[h] == '-':
 321                         assert_is_none(res[h], msg)
 322                     else:
 323                         assert_equals(NominatimID(row[h]).get_place_id(context.db.cursor()),
 324                                       res[h], msg)
 325                 else:
 326                     assert_db_column(res, h, row[h], context)
 327
 328     if exact:
 329         cur.execute('SELECT osm_type, osm_id, class from place')
 330         eq_(expected_content, set([(r[0], r[1], r[2]) for r in cur]))
 331
 332     context.db.commit()
 333
 334 @then("search_name contains")
 335 def check_search_name_contents(context):
 336     cur = context.db.cursor(cursor_factory=psycopg2.extras.DictCursor)
 337
 338     for row in context.table:
 339         pid = NominatimID(row['object']).get_place_id(cur)
 340         cur.execute("""SELECT *, ST_X(centroid) as cx, ST_Y(centroid) as cy
 341                        FROM search_name WHERE place_id = %s""", (pid, ))
 342         assert_less(0, cur.rowcount, "No rows found for " + row['object'])
 343
 344         for res in cur:
 345             for h in row.headings:
 346                 if h in ('name_vector', 'nameaddress_vector'):
 347                     terms = [x.strip().replace('#', ' ') for x in row[h].split(',')]
 348                     subcur = context.db.cursor()
 349                     subcur.execute("""SELECT word_id, word_token
 350                                       FROM word, (SELECT unnest(%s) as term) t
 351                                       WHERE word_token = make_standard_name(t.term)""",
 352                                    (terms,))
 353                     ok_(subcur.rowcount >= len(terms))
 354                     for wid in subcur:
 355                         assert_in(wid[0], res[h],
 356                                   "Missing term for %s/%s: %s" % (pid, h, wid[1]))
 357                 else:
 358                     assert_db_column(res, h, row[h], context)
 359
 360
 361     context.db.commit()
 362
 363 @then("(?P<oid>\w+) expands to(?P<neg> no)? interpolation")
 364 def check_location_property_osmline(context, oid, neg):
 365     cur = context.db.cursor(cursor_factory=psycopg2.extras.DictCursor)
 366     nid = NominatimID(oid)
 367
 368     eq_('W', nid.typ, "interpolation must be a way")
 369
 370     cur.execute("""SELECT *, ST_AsText(linegeo) as geomtxt
 371                    FROM location_property_osmline WHERE osm_id = %s""",
 372                 (nid.oid, ))
 373
 374     if neg:
 375         eq_(0, cur.rowcount)
 376         return
 377
 378     todo = list(range(len(list(context.table))))
 379     for res in cur:
 380         for i in todo:
 381             row = context.table[i]
 382             if (int(row['start']) == res['startnumber']
 383                 and int(row['end']) == res['endnumber']):
 384                 todo.remove(i)
 385                 break
 386         else:
 387             assert False, "Unexpected row %s" % (str(res))
 388
 389         for h in row.headings:
 390             if h in ('start', 'end'):
 391                 continue
 392             elif h == 'parent_place_id':
 393                 if row[h] == '0':
 394                     eq_(0, res[h])
 395                 elif row[h] == '-':
 396                     assert_is_none(res[h])
 397                 else:
 398                     eq_(NominatimID(row[h]).get_place_id(context.db.cursor()),
 399                         res[h])
 400             else:
 401                 assert_db_column(res, h, row[h], context)
 402
 403     eq_(todo, [])
 404
 405
 406 @then("placex has no entry for (?P<oid>.*)")
 407 def check_placex_has_entry(context, oid):
 408     cur = context.db.cursor(cursor_factory=psycopg2.extras.DictCursor)
 409     nid = NominatimID(oid)
 410     where, params = nid.table_select()
 411     cur.execute("SELECT * FROM placex where %s" % where, params)
 412     eq_(0, cur.rowcount)
 413     context.db.commit()
 414
 415 @then("search_name has no entry for (?P<oid>.*)")
 416 def check_search_name_has_entry(context, oid):
 417     cur = context.db.cursor(cursor_factory=psycopg2.extras.DictCursor)
 418     pid = NominatimID(oid).get_place_id(cur)
 419     cur.execute("SELECT * FROM search_name WHERE place_id = %s", (pid, ))
 420     eq_(0, cur.rowcount)
 421     context.db.commit()