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' : 15}
  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         elif key.startswith('addr+'):
  24             self.add_hstore('address', key[5:], value)
  25         elif key in ('name', 'address', 'extratags'):
  26             self.columns[key] = eval('{' + value + '}')
  27         else:
  28             assert_in(key, ('class', 'type'))
  29             self.columns[key] = None if value == '' else value
  30
  31     def set_key_name(self, value):
  32         self.add_hstore('name', 'name', value)
  33
  34     def set_key_osm(self, value):
  35         assert_in(value[0], 'NRW')
  36         ok_(value[1:].isdigit())
  37
  38         self.columns['osm_type'] = value[0]
  39         self.columns['osm_id'] = int(value[1:])
  40
  41     def set_key_admin(self, value):
  42         self.columns['admin_level'] = int(value)
  43
  44     def set_key_housenr(self, value):
  45         if value:
  46             self.add_hstore('address', 'housenumber', value)
  47
  48     def set_key_postcode(self, value):
  49         if value:
  50             self.add_hstore('address', 'postcode', value)
  51
  52     def set_key_street(self, value):
  53         if value:
  54             self.add_hstore('address', 'street', value)
  55
  56     def set_key_addr_place(self, value):
  57         if value:
  58             self.add_hstore('address', 'place', value)
  59
  60     def set_key_country(self, value):
  61         if value:
  62             self.add_hstore('address', 'country', value)
  63
  64     def set_key_geometry(self, value):
  65         self.geometry = self.context.osm.parse_geometry(value, self.context.scene)
  66         assert_is_not_none(self.geometry)
  67
  68     def add_hstore(self, column, key, value):
  69         if column in self.columns:
  70             self.columns[column][key] = value
  71         else:
  72             self.columns[column] = { key : value }
  73
  74     def db_insert(self, cursor):
  75         assert_in('osm_type', self.columns)
  76         if self.force_name and 'name' not in self.columns:
  77             self.add_hstore('name', 'name', ''.join(random.choice(string.printable)
  78                                            for _ in range(int(random.random()*30))))
  79
  80         if self.columns['osm_type'] == 'N' and self.geometry is None:
  81             pt = self.context.osm.grid_node(self.columns['osm_id'])
  82             if pt is None:
  83                 pt = (random.random()*360 - 180, random.random()*180 - 90)
  84
  85             self.geometry = "ST_SetSRID(ST_Point(%f, %f), 4326)" % pt
  86         else:
  87             assert_is_not_none(self.geometry, "Geometry missing")
  88         query = 'INSERT INTO place (%s, geometry) values(%s, %s)' % (
  89                      ','.join(self.columns.keys()),
  90                      ','.join(['%s' for x in range(len(self.columns))]),
  91                      self.geometry)
  92         cursor.execute(query, list(self.columns.values()))
  93
  94 class LazyFmt(object):
  95
  96     def __init__(self, fmtstr, *args):
  97         self.fmt = fmtstr
  98         self.args = args
  99
 100     def __str__(self):
 101         return self.fmt % self.args
 102
 103 class PlaceObjName(object):
 104
 105     def __init__(self, placeid, conn):
 106         self.pid = placeid
 107         self.conn = conn
 108
 109     def __str__(self):
 110         if self.pid is None:
 111             return "<null>"
 112
 113         cur = self.conn.cursor()
 114         cur.execute("""SELECT osm_type, osm_id, class
 115                        FROM placex WHERE place_id = %s""",
 116                     (self.pid, ))
 117         eq_(1, cur.rowcount, "No entry found for place id %s" % self.pid)
 118
 119         return "%s%s:%s" % cur.fetchone()
 120
 121 def compare_place_id(expected, result, column, context):
 122     if expected == '0':
 123         eq_(0, result,
 124             LazyFmt("Bad place id in column %s. Expected: 0, got: %s.",
 125                     column, PlaceObjName(result, context.db)))
 126     elif expected == '-':
 127         assert_is_none(result,
 128                 LazyFmt("bad place id in column %s: %s.",
 129                         column, PlaceObjName(result, context.db)))
 130     else:
 131         eq_(NominatimID(expected).get_place_id(context.db.cursor()), result,
 132             LazyFmt("Bad place id in column %s. Expected: %s, got: %s.",
 133                     column, expected, PlaceObjName(result, context.db)))
 134
 135 class NominatimID:
 136     """ Splits a unique identifier for places into its components.
 137         As place_ids cannot be used for testing, we use a unique
 138         identifier instead that is of the form <osmtype><osmid>[:<class>].
 139     """
 140
 141     id_regex = re.compile(r"(?P<tp>[NRW])(?P<id>\d+)(:(?P<cls>\w+))?")
 142
 143     def __init__(self, oid):
 144         self.typ = self.oid = self.cls = None
 145
 146         if oid is not None:
 147             m = self.id_regex.fullmatch(oid)
 148             assert_is_not_none(m, "ID '%s' not of form <osmtype><osmid>[:<class>]" % oid)
 149
 150             self.typ = m.group('tp')
 151             self.oid = m.group('id')
 152             self.cls = m.group('cls')
 153
 154     def __str__(self):
 155         if self.cls is None:
 156             return self.typ + self.oid
 157
 158         return '%s%d:%s' % (self.typ, self.oid, self.cls)
 159
 160     def table_select(self):
 161         """ Return where clause and parameter list to select the object
 162             from a Nominatim table.
 163         """
 164         where = 'osm_type = %s and osm_id = %s'
 165         params = [self.typ, self. oid]
 166
 167         if self.cls is not None:
 168             where += ' and class = %s'
 169             params.append(self.cls)
 170
 171         return where, params
 172
 173     def get_place_id(self, cur):
 174         where, params = self.table_select()
 175         cur.execute("SELECT place_id FROM placex WHERE %s" % where, params)
 176         eq_(1, cur.rowcount,
 177             "Expected exactly 1 entry in placex for %s found %s"
 178               % (str(self), cur.rowcount))
 179
 180         return cur.fetchone()[0]
 181
 182
 183 def assert_db_column(row, column, value, context):
 184     if column == 'object':
 185         return
 186
 187     if column.startswith('centroid'):
 188         fac = float(column[9:]) if column.startswith('centroid*') else 1.0
 189         x, y = value.split(' ')
 190         assert_almost_equal(float(x) * fac, row['cx'], "Bad x coordinate")
 191         assert_almost_equal(float(y) * fac, row['cy'], "Bad y coordinate")
 192     elif column == 'geometry':
 193         geom = context.osm.parse_geometry(value, context.scene)
 194         cur = context.db.cursor()
 195         query = "SELECT ST_Equals(ST_SnapToGrid(%s, 0.00001, 0.00001), ST_SnapToGrid(ST_SetSRID('%s'::geometry, 4326), 0.00001, 0.00001))" % (
 196                  geom, row['geomtxt'],)
 197         cur.execute(query)
 198         eq_(cur.fetchone()[0], True, "(Row %s failed: %s)" % (column, query))
 199     elif value == '-':
 200         assert_is_none(row[column], "Row %s" % column)
 201     else:
 202         eq_(value, str(row[column]),
 203             "Row '%s': expected: %s, got: %s"
 204             % (column, value, str(row[column])))
 205
 206
 207 ################################ STEPS ##################################
 208
 209 @given(u'the scene (?P<scene>.+)')
 210 def set_default_scene(context, scene):
 211     context.scene = scene
 212
 213 @given("the (?P<named>named )?places")
 214 def add_data_to_place_table(context, named):
 215     cur = context.db.cursor()
 216     cur.execute('ALTER TABLE place DISABLE TRIGGER place_before_insert')
 217     for r in context.table:
 218         col = PlaceColumn(context, named is not None)
 219
 220         for h in r.headings:
 221             col.add(h, r[h])
 222
 223         col.db_insert(cur)
 224     cur.execute('ALTER TABLE place ENABLE TRIGGER place_before_insert')
 225     cur.close()
 226     context.db.commit()
 227
 228 @given("the relations")
 229 def add_data_to_planet_relations(context):
 230     cur = context.db.cursor()
 231     for r in context.table:
 232         last_node = 0
 233         last_way = 0
 234         parts = []
 235         if r['members']:
 236             members = []
 237             for m in r['members'].split(','):
 238                 mid = NominatimID(m)
 239                 if mid.typ == 'N':
 240                     parts.insert(last_node, int(mid.oid))
 241                     last_node += 1
 242                     last_way += 1
 243                 elif mid.typ == 'W':
 244                     parts.insert(last_way, int(mid.oid))
 245                     last_way += 1
 246                 else:
 247                     parts.append(int(mid.oid))
 248
 249                 members.extend((mid.typ.lower() + mid.oid, mid.cls or ''))
 250         else:
 251             members = None
 252
 253         tags = []
 254         for h in r.headings:
 255             if h.startswith("tags+"):
 256                 tags.extend((h[5:], r[h]))
 257
 258         cur.execute("""INSERT INTO planet_osm_rels (id, way_off, rel_off, parts, members, tags)
 259                        VALUES (%s, %s, %s, %s, %s, %s)""",
 260                     (r['id'], last_node, last_way, parts, members, tags))
 261     context.db.commit()
 262
 263 @given("the ways")
 264 def add_data_to_planet_ways(context):
 265     cur = context.db.cursor()
 266     for r in context.table:
 267         tags = []
 268         for h in r.headings:
 269             if h.startswith("tags+"):
 270                 tags.extend((h[5:], r[h]))
 271
 272         nodes = [ int(x.strip()) for x in r['nodes'].split(',') ]
 273
 274         cur.execute("INSERT INTO planet_osm_ways (id, nodes, tags) VALUES (%s, %s, %s)",
 275                     (r['id'], nodes, tags))
 276     context.db.commit()
 277
 278 @when("importing")
 279 def import_and_index_data_from_place_table(context):
 280     context.nominatim.run_setup_script('create-functions', 'create-partition-functions')
 281     cur = context.db.cursor()
 282     cur.execute(
 283         """insert into placex (osm_type, osm_id, class, type, name, admin_level, address, extratags, geometry)
 284            select              osm_type, osm_id, class, type, name, admin_level, address, extratags, geometry
 285            from place where not (class='place' and type='houses' and osm_type='W')""")
 286     cur.execute(
 287             """insert into location_property_osmline (osm_id, address, linegeo)
 288              SELECT osm_id, address, geometry from place
 289               WHERE class='place' and type='houses' and osm_type='W'
 290                     and ST_GeometryType(geometry) = 'ST_LineString'""")
 291     context.db.commit()
 292     context.nominatim.run_setup_script('calculate-postcodes', 'index', 'index-noanalyse')
 293
 294 @when("updating places")
 295 def update_place_table(context):
 296     context.nominatim.run_setup_script(
 297         'create-functions', 'create-partition-functions', 'enable-diff-updates')
 298     cur = context.db.cursor()
 299     for r in context.table:
 300         col = PlaceColumn(context, False)
 301
 302         for h in r.headings:
 303             col.add(h, r[h])
 304
 305         col.db_insert(cur)
 306
 307     context.db.commit()
 308
 309     while True:
 310         context.nominatim.run_update_script('index')
 311
 312         cur = context.db.cursor()
 313         cur.execute("SELECT 'a' FROM placex WHERE indexed_status != 0 LIMIT 1")
 314         if cur.rowcount == 0:
 315             break
 316
 317 @when("marking for delete (?P<oids>.*)")
 318 def delete_places(context, oids):
 319     context.nominatim.run_setup_script(
 320         'create-functions', 'create-partition-functions', 'enable-diff-updates')
 321     cur = context.db.cursor()
 322     for oid in oids.split(','):
 323         where, params = NominatimID(oid).table_select()
 324         cur.execute("DELETE FROM place WHERE " + where, params)
 325     context.db.commit()
 326
 327     while True:
 328         context.nominatim.run_update_script('index')
 329
 330         cur = context.db.cursor()
 331         cur.execute("SELECT 'a' FROM placex WHERE indexed_status != 0 LIMIT 1")
 332         if cur.rowcount == 0:
 333             break
 334
 335 @then("placex contains(?P<exact> exactly)?")
 336 def check_placex_contents(context, exact):
 337     cur = context.db.cursor(cursor_factory=psycopg2.extras.DictCursor)
 338
 339     expected_content = set()
 340     for row in context.table:
 341         nid = NominatimID(row['object'])
 342         where, params = nid.table_select()
 343         cur.execute("""SELECT *, ST_AsText(geometry) as geomtxt,
 344                        ST_X(centroid) as cx, ST_Y(centroid) as cy
 345                        FROM placex where %s""" % where,
 346                     params)
 347         assert_less(0, cur.rowcount, "No rows found for " + row['object'])
 348
 349         for res in cur:
 350             if exact:
 351                 expected_content.add((res['osm_type'], res['osm_id'], res['class']))
 352             for h in row.headings:
 353                 if h in ('extratags', 'address'):
 354                     if row[h] == '-':
 355                         assert_is_none(res[h])
 356                     else:
 357                         vdict = eval('{' + row[h] + '}')
 358                         assert_equals(vdict, res[h])
 359                 elif h.startswith('name'):
 360                     name = h[5:] if h.startswith('name+') else 'name'
 361                     assert_in(name, res['name'])
 362                     eq_(res['name'][name], row[h])
 363                 elif h.startswith('extratags+'):
 364                     eq_(res['extratags'][h[10:]], row[h])
 365                 elif h.startswith('addr+'):
 366                     if row[h] == '-':
 367                         if res['address'] is not None:
 368                             assert_not_in(h[5:], res['address'])
 369                     else:
 370                         assert_in(h[5:], res['address'], "column " + h)
 371                         assert_equals(res['address'][h[5:]], row[h],
 372                                       "column %s" % h)
 373                 elif h in ('linked_place_id', 'parent_place_id'):
 374                     compare_place_id(row[h], res[h], h, context)
 375                 else:
 376                     assert_db_column(res, h, row[h], context)
 377
 378     if exact:
 379         cur.execute('SELECT osm_type, osm_id, class from placex')
 380         eq_(expected_content, set([(r[0], r[1], r[2]) for r in cur]))
 381
 382     context.db.commit()
 383
 384 @then("place contains(?P<exact> exactly)?")
 385 def check_placex_contents(context, exact):
 386     cur = context.db.cursor(cursor_factory=psycopg2.extras.DictCursor)
 387
 388     expected_content = set()
 389     for row in context.table:
 390         nid = NominatimID(row['object'])
 391         where, params = nid.table_select()
 392         cur.execute("""SELECT *, ST_AsText(geometry) as geomtxt,
 393                        ST_GeometryType(geometry) as geometrytype
 394                        FROM place where %s""" % where,
 395                     params)
 396         assert_less(0, cur.rowcount, "No rows found for " + row['object'])
 397
 398         for res in cur:
 399             if exact:
 400                 expected_content.add((res['osm_type'], res['osm_id'], res['class']))
 401             for h in row.headings:
 402                 msg = "%s: %s" % (row['object'], h)
 403                 if h in ('name', 'extratags', 'address'):
 404                     if row[h] == '-':
 405                         assert_is_none(res[h], msg)
 406                     else:
 407                         vdict = eval('{' + row[h] + '}')
 408                         assert_equals(vdict, res[h], msg)
 409                 elif h.startswith('name+'):
 410                     assert_equals(res['name'][h[5:]], row[h], msg)
 411                 elif h.startswith('extratags+'):
 412                     assert_equals(res['extratags'][h[10:]], row[h], msg)
 413                 elif h.startswith('addr+'):
 414                     if row[h] == '-':
 415                         if res['address']  is not None:
 416                             assert_not_in(h[5:], res['address'])
 417                     else:
 418                         assert_equals(res['address'][h[5:]], row[h], msg)
 419                 elif h in ('linked_place_id', 'parent_place_id'):
 420                     compare_place_id(row[h], res[h], h, context)
 421                 else:
 422                     assert_db_column(res, h, row[h], context)
 423
 424     if exact:
 425         cur.execute('SELECT osm_type, osm_id, class from place')
 426         eq_(expected_content, set([(r[0], r[1], r[2]) for r in cur]))
 427
 428     context.db.commit()
 429
 430 @then("search_name contains(?P<exclude> not)?")
 431 def check_search_name_contents(context, exclude):
 432     cur = context.db.cursor(cursor_factory=psycopg2.extras.DictCursor)
 433
 434     for row in context.table:
 435         pid = NominatimID(row['object']).get_place_id(cur)
 436         cur.execute("""SELECT *, ST_X(centroid) as cx, ST_Y(centroid) as cy
 437                        FROM search_name WHERE place_id = %s""", (pid, ))
 438         assert_less(0, cur.rowcount, "No rows found for " + row['object'])
 439
 440         for res in cur:
 441             for h in row.headings:
 442                 if h in ('name_vector', 'nameaddress_vector'):
 443                     terms = [x.strip().replace('#', ' ') for x in row[h].split(',')]
 444                     subcur = context.db.cursor()
 445                     subcur.execute("""SELECT word_id, word_token
 446                                       FROM word, (SELECT unnest(%s) as term) t
 447                                       WHERE word_token = make_standard_name(t.term)""",
 448                                    (terms,))
 449                     if not exclude:
 450                         ok_(subcur.rowcount >= len(terms),
 451                             "No word entry found for " + row[h])
 452                     for wid in subcur:
 453                         if exclude:
 454                             assert_not_in(wid[0], res[h],
 455                                           "Found term for %s/%s: %s" % (pid, h, wid[1]))
 456                         else:
 457                             assert_in(wid[0], res[h],
 458                                       "Missing term for %s/%s: %s" % (pid, h, wid[1]))
 459                 else:
 460                     assert_db_column(res, h, row[h], context)
 461
 462
 463     context.db.commit()
 464
 465 @then("place_addressline contains")
 466 def check_place_addressline(context):
 467     cur = context.db.cursor(cursor_factory=psycopg2.extras.DictCursor)
 468
 469     for row in context.table:
 470         pid = NominatimID(row['object']).get_place_id(cur)
 471         apid = NominatimID(row['address']).get_place_id(cur)
 472         cur.execute(""" SELECT * FROM place_addressline
 473                         WHERE place_id = %s AND address_place_id = %s""",
 474                     (pid, apid))
 475         assert_less(0, cur.rowcount,
 476                     "No rows found for place %s and address %s"
 477                       % (row['object'], row['address']))
 478
 479         for res in cur:
 480             for h in row.headings:
 481                 if h not in ('address', 'object'):
 482                     assert_db_column(res, h, row[h], context)
 483
 484     context.db.commit()
 485
 486 @then("(?P<oid>\w+) expands to(?P<neg> no)? interpolation")
 487 def check_location_property_osmline(context, oid, neg):
 488     cur = context.db.cursor(cursor_factory=psycopg2.extras.DictCursor)
 489     nid = NominatimID(oid)
 490
 491     eq_('W', nid.typ, "interpolation must be a way")
 492
 493     cur.execute("""SELECT *, ST_AsText(linegeo) as geomtxt
 494                    FROM location_property_osmline
 495                    WHERE osm_id = %s AND startnumber IS NOT NULL""",
 496                 (nid.oid, ))
 497
 498     if neg:
 499         eq_(0, cur.rowcount)
 500         return
 501
 502     todo = list(range(len(list(context.table))))
 503     for res in cur:
 504         for i in todo:
 505             row = context.table[i]
 506             if (int(row['start']) == res['startnumber']
 507                 and int(row['end']) == res['endnumber']):
 508                 todo.remove(i)
 509                 break
 510         else:
 511             assert False, "Unexpected row %s" % (str(res))
 512
 513         for h in row.headings:
 514             if h in ('start', 'end'):
 515                 continue
 516             elif h == 'parent_place_id':
 517                 compare_place_id(row[h], res[h], h, context)
 518             else:
 519                 assert_db_column(res, h, row[h], context)
 520
 521     eq_(todo, [])
 522
 523
 524 @then("(?P<table>placex|place) has no entry for (?P<oid>.*)")
 525 def check_placex_has_entry(context, table, oid):
 526     cur = context.db.cursor(cursor_factory=psycopg2.extras.DictCursor)
 527     nid = NominatimID(oid)
 528     where, params = nid.table_select()
 529     cur.execute("SELECT * FROM %s where %s" % (table, where), params)
 530     eq_(0, cur.rowcount)
 531     context.db.commit()
 532
 533 @then("search_name has no entry for (?P<oid>.*)")
 534 def check_search_name_has_entry(context, oid):
 535     cur = context.db.cursor(cursor_factory=psycopg2.extras.DictCursor)
 536     pid = NominatimID(oid).get_place_id(cur)
 537     cur.execute("SELECT * FROM search_name WHERE place_id = %s", (pid, ))
 538     eq_(0, cur.rowcount)
 539     context.db.commit()