small typos and wording in the API docs

[nominatim.git] / test / bdd / steps / db_ops.py

diff --git a/test/bdd/steps/db_ops.py b/test/bdd/steps/db_ops.py
index 201bf373db3ba2fff04067e5cb70e421a4cb6c90..b50f1d59baebb1c1556b0a60a8edae3f046bc31e 100644 (file)
--- a/test/bdd/steps/db_ops.py
+++ b/test/bdd/steps/db_ops.py
@@ -8,7 +8,7 @@ import psycopg2.extras
 class PlaceColumn:
 
     def __init__(self, context, force_name):
 class PlaceColumn:
 
     def __init__(self, context, force_name):

-        self.columns = { 'admin_level' : 100}
+        self.columns = { 'admin_level' : 15}

         self.force_name = force_name
         self.context = context
         self.geometry = None
         self.force_name = force_name
         self.context = context
         self.geometry = None


@@ -20,10 +20,13 @@ class PlaceColumn:
             self.add_hstore('name', key[5:], value)
         elif key.startswith('extra+'):
             self.add_hstore('extratags', key[6:], value)
             self.add_hstore('name', key[5:], value)
         elif key.startswith('extra+'):
             self.add_hstore('extratags', key[6:], value)

+        elif key.startswith('addr+'):
+            self.add_hstore('address', key[5:], value)
+        elif key in ('name', 'address', 'extratags'):
+            self.columns[key] = eval('{' + value + '}')

         else:
         else:

-            assert_in(key, ('class', 'type', 'street', 'addr_place',
-                            'isin', 'postcode'))
-            self.columns[key] = value
+            assert_in(key, ('class', 'type'))
+            self.columns[key] = None if value == '' else value

 
     def set_key_name(self, value):
         self.add_hstore('name', 'name', value)
 
     def set_key_name(self, value):
         self.add_hstore('name', 'name', value)


@@ -39,10 +42,24 @@ class PlaceColumn:
         self.columns['admin_level'] = int(value)
 
     def set_key_housenr(self, value):
         self.columns['admin_level'] = int(value)
 
     def set_key_housenr(self, value):

-        self.columns['housenumber'] = value
+        if value:
+            self.add_hstore('address', 'housenumber', value)
+
+    def set_key_postcode(self, value):
+        if value:
+            self.add_hstore('address', 'postcode', value)
+
+    def set_key_street(self, value):
+        if value:
+            self.add_hstore('address', 'street', value)
+
+    def set_key_addr_place(self, value):
+        if value:
+            self.add_hstore('address', 'place', value)

 
     def set_key_country(self, value):
 
     def set_key_country(self, value):

-        self.columns['country_code'] = value
+        if value:
+            self.add_hstore('address', 'country', value)

 
     def set_key_geometry(self, value):
         self.geometry = self.context.osm.parse_geometry(value, self.context.scene)
 
     def set_key_geometry(self, value):
         self.geometry = self.context.osm.parse_geometry(value, self.context.scene)


@@ -61,22 +78,79 @@ class PlaceColumn:
                                            for _ in range(int(random.random()*30))))
 
         if self.columns['osm_type'] == 'N' and self.geometry is None:
                                            for _ in range(int(random.random()*30))))
 
         if self.columns['osm_type'] == 'N' and self.geometry is None:

-            self.geometry = "ST_SetSRID(ST_Point(%f, %f), 4326)" % (
-                            random.random()*360 - 180, random.random()*180 - 90)
+            pt = self.context.osm.grid_node(self.columns['osm_id'])
+            if pt is None:
+                pt = (random.random()*360 - 180, random.random()*180 - 90)

 
 

+            self.geometry = "ST_SetSRID(ST_Point(%f, %f), 4326)" % pt
+        else:
+            assert_is_not_none(self.geometry, "Geometry missing")

         query = 'INSERT INTO place (%s, geometry) values(%s, %s)' % (
                      ','.join(self.columns.keys()),
                      ','.join(['%s' for x in range(len(self.columns))]),
                      self.geometry)
         cursor.execute(query, list(self.columns.values()))
 
         query = 'INSERT INTO place (%s, geometry) values(%s, %s)' % (
                      ','.join(self.columns.keys()),
                      ','.join(['%s' for x in range(len(self.columns))]),
                      self.geometry)
         cursor.execute(query, list(self.columns.values()))
 

+class LazyFmt(object):
+
+    def __init__(self, fmtstr, *args):
+        self.fmt = fmtstr
+        self.args = args
+
+    def __str__(self):
+        return self.fmt % self.args
+
+class PlaceObjName(object):
+
+    def __init__(self, placeid, conn):
+        self.pid = placeid
+        self.conn = conn
+
+    def __str__(self):
+        if self.pid is None:
+            return "<null>"
+
+        cur = self.conn.cursor()
+        cur.execute("""SELECT osm_type, osm_id, class
+                       FROM placex WHERE place_id = %s""",
+                    (self.pid, ))
+        eq_(1, cur.rowcount, "No entry found for place id %s" % self.pid)
+
+        return "%s%s:%s" % cur.fetchone()
+
+def compare_place_id(expected, result, column, context):
+    if expected == '0':
+        eq_(0, result,
+            LazyFmt("Bad place id in column %s. Expected: 0, got: %s.",
+                    column, PlaceObjName(result, context.db)))
+    elif expected == '-':
+        assert_is_none(result,
+                LazyFmt("bad place id in column %s: %s.",
+                        column, PlaceObjName(result, context.db)))
+    else:
+        eq_(NominatimID(expected).get_place_id(context.db.cursor()), result,
+            LazyFmt("Bad place id in column %s. Expected: %s, got: %s.",
+                    column, expected, PlaceObjName(result, context.db)))
+
+def check_database_integrity(context):
+    """ Check some generic constraints on the tables.
+    """
+    # place_addressline should not have duplicate (place_id, address_place_id)
+    cur = context.db.cursor()
+    cur.execute("""SELECT count(*) FROM
+                    (SELECT place_id, address_place_id, count(*) as c
+                     FROM place_addressline GROUP BY place_id, address_place_id) x
+                   WHERE c > 1""")
+    eq_(0, cur.fetchone()[0], "Duplicates found in place_addressline")
+
+

 class NominatimID:
     """ Splits a unique identifier for places into its components.
         As place_ids cannot be used for testing, we use a unique
         identifier instead that is of the form <osmtype><osmid>[:<class>].
     """
 
 class NominatimID:
     """ Splits a unique identifier for places into its components.
         As place_ids cannot be used for testing, we use a unique
         identifier instead that is of the form <osmtype><osmid>[:<class>].
     """
 

-    id_regex = re.compile(r"(?P<tp>[NRW])(?P<id>\d+)(?P<cls>:\w+)?")
+    id_regex = re.compile(r"(?P<tp>[NRW])(?P<id>\d+)(:(?P<cls>\w+))?")

 
     def __init__(self, oid):
         self.typ = self.oid = self.cls = None
 
     def __init__(self, oid):
         self.typ = self.oid = self.cls = None


@@ -89,6 +163,12 @@ class NominatimID:
             self.oid = m.group('id')
             self.cls = m.group('cls')
 
             self.oid = m.group('id')
             self.cls = m.group('cls')
 

+    def __str__(self):
+        if self.cls is None:
+            return self.typ + self.oid
+
+        return '%s%d:%s' % (self.typ, self.oid, self.cls)
+

     def table_select(self):
         """ Return where clause and parameter list to select the object
             from a Nominatim table.
     def table_select(self):
         """ Return where clause and parameter list to select the object
             from a Nominatim table.


@@ -97,11 +177,47 @@ class NominatimID:
         params = [self.typ, self. oid]
 
         if self.cls is not None:
         params = [self.typ, self. oid]
 
         if self.cls is not None:

-            where += ' class = %s'
+            where += ' and class = %s'

             params.append(self.cls)
 
         return where, params
 
             params.append(self.cls)
 
         return where, params
 

+    def get_place_id(self, cur):
+        where, params = self.table_select()
+        cur.execute("SELECT place_id FROM placex WHERE %s" % where, params)
+        eq_(1, cur.rowcount,
+            "Expected exactly 1 entry in placex for %s found %s"
+              % (str(self), cur.rowcount))
+
+        return cur.fetchone()[0]
+
+
+def assert_db_column(row, column, value, context):
+    if column == 'object':
+        return
+
+    if column.startswith('centroid'):
+        fac = float(column[9:]) if column.startswith('centroid*') else 1.0
+        x, y = value.split(' ')
+        assert_almost_equal(float(x) * fac, row['cx'], "Bad x coordinate")
+        assert_almost_equal(float(y) * fac, row['cy'], "Bad y coordinate")
+    elif column == 'geometry':
+        geom = context.osm.parse_geometry(value, context.scene)
+        cur = context.db.cursor()
+        query = "SELECT ST_Equals(ST_SnapToGrid(%s, 0.00001, 0.00001), ST_SnapToGrid(ST_SetSRID('%s'::geometry, 4326), 0.00001, 0.00001))" % (
+                 geom, row['geomtxt'],)
+        cur.execute(query)
+        eq_(cur.fetchone()[0], True, "(Row %s failed: %s)" % (column, query))
+    elif value == '-':
+        assert_is_none(row[column], "Row %s" % column)
+    else:
+        eq_(value, str(row[column]),
+            "Row '%s': expected: %s, got: %s"
+            % (column, value, str(row[column])))
+
+
+################################ STEPS ##################################
+

 @given(u'the scene (?P<scene>.+)')
 def set_default_scene(context, scene):
     context.scene = scene
 @given(u'the scene (?P<scene>.+)')
 def set_default_scene(context, scene):
     context.scene = scene


@@ -121,31 +237,121 @@ def add_data_to_place_table(context, named):
     cur.close()
     context.db.commit()
 
     cur.close()
     context.db.commit()
 

+@given("the relations")
+def add_data_to_planet_relations(context):
+    cur = context.db.cursor()
+    for r in context.table:
+        last_node = 0
+        last_way = 0
+        parts = []
+        if r['members']:
+            members = []
+            for m in r['members'].split(','):
+                mid = NominatimID(m)
+                if mid.typ == 'N':
+                    parts.insert(last_node, int(mid.oid))
+                    last_node += 1
+                    last_way += 1
+                elif mid.typ == 'W':
+                    parts.insert(last_way, int(mid.oid))
+                    last_way += 1
+                else:
+                    parts.append(int(mid.oid))
+
+                members.extend((mid.typ.lower() + mid.oid, mid.cls or ''))
+        else:
+            members = None
+
+        tags = []
+        for h in r.headings:
+            if h.startswith("tags+"):
+                tags.extend((h[5:], r[h]))
+
+        cur.execute("""INSERT INTO planet_osm_rels (id, way_off, rel_off, parts, members, tags)
+                       VALUES (%s, %s, %s, %s, %s, %s)""",
+                    (r['id'], last_node, last_way, parts, members, tags))
+    context.db.commit()
+
+@given("the ways")
+def add_data_to_planet_ways(context):
+    cur = context.db.cursor()
+    for r in context.table:
+        tags = []
+        for h in r.headings:
+            if h.startswith("tags+"):
+                tags.extend((h[5:], r[h]))
+
+        nodes = [ int(x.strip()) for x in r['nodes'].split(',') ]
+
+        cur.execute("INSERT INTO planet_osm_ways (id, nodes, tags) VALUES (%s, %s, %s)",
+                    (r['id'], nodes, tags))
+    context.db.commit()

 
 @when("importing")
 def import_and_index_data_from_place_table(context):
     context.nominatim.run_setup_script('create-functions', 'create-partition-functions')
     cur = context.db.cursor()
     cur.execute(
 
 @when("importing")
 def import_and_index_data_from_place_table(context):
     context.nominatim.run_setup_script('create-functions', 'create-partition-functions')
     cur = context.db.cursor()
     cur.execute(

-        """insert into placex (osm_type, osm_id, class, type, name, admin_level,
-           housenumber, street, addr_place, isin, postcode, country_code, extratags,
-           geometry)
-           select * from place where not (class='place' and type='houses' and osm_type='W')""")
+        """insert into placex (osm_type, osm_id, class, type, name, admin_level, address, extratags, geometry)
+           select              osm_type, osm_id, class, type, name, admin_level, address, extratags, geometry
+           from place where not (class='place' and type='houses' and osm_type='W')""")

     cur.execute(
     cur.execute(

-        """select insert_osmline (osm_id, housenumber, street, addr_place,
-           postcode, country_code, geometry)
-           from place where class='place' and type='houses' and osm_type='W'""")
+            """insert into location_property_osmline (osm_id, address, linegeo)
+             SELECT osm_id, address, geometry from place
+              WHERE class='place' and type='houses' and osm_type='W'
+                    and ST_GeometryType(geometry) = 'ST_LineString'""")

     context.db.commit()
     context.db.commit()

-    context.nominatim.run_setup_script('index', 'index-noanalyse')
+    context.nominatim.run_setup_script('calculate-postcodes', 'index', 'index-noanalyse')
+    check_database_integrity(context)

 
 

+@when("updating places")
+def update_place_table(context):
+    context.nominatim.run_setup_script(
+        'create-functions', 'create-partition-functions', 'enable-diff-updates')
+    cur = context.db.cursor()
+    for r in context.table:
+        col = PlaceColumn(context, False)
+
+        for h in r.headings:
+            col.add(h, r[h])
+
+        col.db_insert(cur)
+
+    context.db.commit()
+
+    while True:
+        context.nominatim.run_update_script('index')
+
+        cur = context.db.cursor()
+        cur.execute("SELECT 'a' FROM placex WHERE indexed_status != 0 LIMIT 1")
+        if cur.rowcount == 0:
+            break
+
+    check_database_integrity(context)
+
+@when("marking for delete (?P<oids>.*)")
+def delete_places(context, oids):
+    context.nominatim.run_setup_script(
+        'create-functions', 'create-partition-functions', 'enable-diff-updates')
+    cur = context.db.cursor()
+    for oid in oids.split(','):
+        where, params = NominatimID(oid).table_select()
+        cur.execute("DELETE FROM place WHERE " + where, params)
+    context.db.commit()
+
+    while True:
+        context.nominatim.run_update_script('index')
+
+        cur = context.db.cursor()
+        cur.execute("SELECT 'a' FROM placex WHERE indexed_status != 0 LIMIT 1")
+        if cur.rowcount == 0:
+            break

 
 @then("placex contains(?P<exact> exactly)?")
 def check_placex_contents(context, exact):
     cur = context.db.cursor(cursor_factory=psycopg2.extras.DictCursor)
 
 @then("placex contains(?P<exact> exactly)?")
 def check_placex_contents(context, exact):
     cur = context.db.cursor(cursor_factory=psycopg2.extras.DictCursor)

-    if exact:
-        cur.execute('SELECT osm_type, osm_id, class from placex')
-        to_match = [(r[0], r[1], r[2]) for r in cur]

 
 

+    expected_content = set()

     for row in context.table:
         nid = NominatimID(row['object'])
         where, params = nid.table_select()
     for row in context.table:
         nid = NominatimID(row['object'])
         where, params = nid.table_select()


@@ -153,35 +359,211 @@ def check_placex_contents(context, exact):
                        ST_X(centroid) as cx, ST_Y(centroid) as cy
                        FROM placex where %s""" % where,
                     params)
                        ST_X(centroid) as cx, ST_Y(centroid) as cy
                        FROM placex where %s""" % where,
                     params)

+        assert_less(0, cur.rowcount, "No rows found for " + row['object'])

 
         for res in cur:
 
         for res in cur:

+            if exact:
+                expected_content.add((res['osm_type'], res['osm_id'], res['class']))

             for h in row.headings:
             for h in row.headings:

-                if h == 'object':
-                    pass
+                if h in ('extratags', 'address'):
+                    if row[h] == '-':
+                        assert_is_none(res[h])
+                    else:
+                        vdict = eval('{' + row[h] + '}')
+                        assert_equals(vdict, res[h])

                 elif h.startswith('name'):
                     name = h[5:] if h.startswith('name+') else 'name'
                     assert_in(name, res['name'])
                     eq_(res['name'][name], row[h])
                 elif h.startswith('extratags+'):
                     eq_(res['extratags'][h[10:]], row[h])
                 elif h.startswith('name'):
                     name = h[5:] if h.startswith('name+') else 'name'
                     assert_in(name, res['name'])
                     eq_(res['name'][name], row[h])
                 elif h.startswith('extratags+'):
                     eq_(res['extratags'][h[10:]], row[h])

-                elif h.startswith('centroid'):
-                    fac = float(h[9:]) if h.startswith('centroid*') else 1.0
-                    x, y = row[h].split(' ')
-                    assert_almost_equal(float(x) * fac, res['cx'])
-                    assert_almost_equal(float(y) * fac, res['cy'])
+                elif h.startswith('addr+'):
+                    if row[h] == '-':
+                        if res['address'] is not None:
+                            assert_not_in(h[5:], res['address'])
+                    else:
+                        assert_in(h[5:], res['address'], "column " + h)
+                        assert_equals(res['address'][h[5:]], row[h],
+                                      "column %s" % h)
+                elif h in ('linked_place_id', 'parent_place_id'):
+                    compare_place_id(row[h], res[h], h, context)
+                else:
+                    assert_db_column(res, h, row[h], context)
+
+    if exact:
+        cur.execute('SELECT osm_type, osm_id, class from placex')
+        eq_(expected_content, set([(r[0], r[1], r[2]) for r in cur]))
+
+    context.db.commit()
+
+@then("place contains(?P<exact> exactly)?")
+def check_placex_contents(context, exact):
+    cur = context.db.cursor(cursor_factory=psycopg2.extras.DictCursor)
+
+    expected_content = set()
+    for row in context.table:
+        nid = NominatimID(row['object'])
+        where, params = nid.table_select()
+        cur.execute("""SELECT *, ST_AsText(geometry) as geomtxt,
+                       ST_GeometryType(geometry) as geometrytype
+                       FROM place where %s""" % where,
+                    params)
+        assert_less(0, cur.rowcount, "No rows found for " + row['object'])
+
+        for res in cur:
+            if exact:
+                expected_content.add((res['osm_type'], res['osm_id'], res['class']))
+            for h in row.headings:
+                msg = "%s: %s" % (row['object'], h)
+                if h in ('name', 'extratags', 'address'):
+                    if row[h] == '-':
+                        assert_is_none(res[h], msg)
+                    else:
+                        vdict = eval('{' + row[h] + '}')
+                        assert_equals(vdict, res[h], msg)
+                elif h.startswith('name+'):
+                    assert_equals(res['name'][h[5:]], row[h], msg)
+                elif h.startswith('extratags+'):
+                    assert_equals(res['extratags'][h[10:]], row[h], msg)
+                elif h.startswith('addr+'):
+                    if row[h] == '-':
+                        if res['address']  is not None:
+                            assert_not_in(h[5:], res['address'])
+                    else:
+                        assert_equals(res['address'][h[5:]], row[h], msg)
+                elif h in ('linked_place_id', 'parent_place_id'):
+                    compare_place_id(row[h], res[h], h, context)

                 else:
                 else:

-                    eq_(row[h], str(res[h]),
-                        "Row '%s': expected: %s, got: %s" % (h, row[h], str(res[h])))
+                    assert_db_column(res, h, row[h], context)
+
+    if exact:
+        cur.execute('SELECT osm_type, osm_id, class from place')
+        eq_(expected_content, set([(r[0], r[1], r[2]) for r in cur]))
+

     context.db.commit()
 
     context.db.commit()
 

-@then("placex has no entry for (?P<oid>.*)")
-def check_placex_has_entry(context, oid):
+@then("search_name contains(?P<exclude> not)?")
+def check_search_name_contents(context, exclude):
+    cur = context.db.cursor(cursor_factory=psycopg2.extras.DictCursor)
+
+    for row in context.table:
+        pid = NominatimID(row['object']).get_place_id(cur)
+        cur.execute("""SELECT *, ST_X(centroid) as cx, ST_Y(centroid) as cy
+                       FROM search_name WHERE place_id = %s""", (pid, ))
+        assert_less(0, cur.rowcount, "No rows found for " + row['object'])
+
+        for res in cur:
+            for h in row.headings:
+                if h in ('name_vector', 'nameaddress_vector'):
+                    terms = [x.strip().replace('#', ' ') for x in row[h].split(',')]
+                    subcur = context.db.cursor()
+                    subcur.execute("""SELECT word_id, word_token
+                                      FROM word, (SELECT unnest(%s) as term) t
+                                      WHERE word_token = make_standard_name(t.term)""",
+                                   (terms,))
+                    if not exclude:
+                        ok_(subcur.rowcount >= len(terms),
+                            "No word entry found for " + row[h])
+                    for wid in subcur:
+                        if exclude:
+                            assert_not_in(wid[0], res[h],
+                                          "Found term for %s/%s: %s" % (pid, h, wid[1]))
+                        else:
+                            assert_in(wid[0], res[h],
+                                      "Missing term for %s/%s: %s" % (pid, h, wid[1]))
+                else:
+                    assert_db_column(res, h, row[h], context)
+
+
+    context.db.commit()
+
+@then("place_addressline contains")
+def check_place_addressline(context):
+    cur = context.db.cursor(cursor_factory=psycopg2.extras.DictCursor)
+
+    for row in context.table:
+        pid = NominatimID(row['object']).get_place_id(cur)
+        apid = NominatimID(row['address']).get_place_id(cur)
+        cur.execute(""" SELECT * FROM place_addressline
+                        WHERE place_id = %s AND address_place_id = %s""",
+                    (pid, apid))
+        assert_less(0, cur.rowcount,
+                    "No rows found for place %s and address %s"
+                      % (row['object'], row['address']))
+
+        for res in cur:
+            for h in row.headings:
+                if h not in ('address', 'object'):
+                    assert_db_column(res, h, row[h], context)
+
+    context.db.commit()
+
+@then("place_addressline doesn't contain")
+def check_place_addressline_exclude(context):
+    cur = context.db.cursor(cursor_factory=psycopg2.extras.DictCursor)
+
+    for row in context.table:
+        pid = NominatimID(row['object']).get_place_id(cur)
+        apid = NominatimID(row['address']).get_place_id(cur)
+        cur.execute(""" SELECT * FROM place_addressline
+                        WHERE place_id = %s AND address_place_id = %s""",
+                    (pid, apid))
+        eq_(0, cur.rowcount,
+            "Row found for place %s and address %s" % (row['object'], row['address']))
+
+    context.db.commit()
+
+@then("(?P<oid>\w+) expands to(?P<neg> no)? interpolation")
+def check_location_property_osmline(context, oid, neg):
+    cur = context.db.cursor(cursor_factory=psycopg2.extras.DictCursor)
+    nid = NominatimID(oid)
+
+    eq_('W', nid.typ, "interpolation must be a way")
+
+    cur.execute("""SELECT *, ST_AsText(linegeo) as geomtxt
+                   FROM location_property_osmline
+                   WHERE osm_id = %s AND startnumber IS NOT NULL""",
+                (nid.oid, ))
+
+    if neg:
+        eq_(0, cur.rowcount)
+        return
+
+    todo = list(range(len(list(context.table))))
+    for res in cur:
+        for i in todo:
+            row = context.table[i]
+            if (int(row['start']) == res['startnumber']
+                and int(row['end']) == res['endnumber']):
+                todo.remove(i)
+                break
+        else:
+            assert False, "Unexpected row %s" % (str(res))
+
+        for h in row.headings:
+            if h in ('start', 'end'):
+                continue
+            elif h == 'parent_place_id':
+                compare_place_id(row[h], res[h], h, context)
+            else:
+                assert_db_column(res, h, row[h], context)
+
+    eq_(todo, [])
+
+
+@then("(?P<table>placex|place) has no entry for (?P<oid>.*)")
+def check_placex_has_entry(context, table, oid):

     cur = context.db.cursor(cursor_factory=psycopg2.extras.DictCursor)
     nid = NominatimID(oid)
     where, params = nid.table_select()
     cur = context.db.cursor(cursor_factory=psycopg2.extras.DictCursor)
     nid = NominatimID(oid)
     where, params = nid.table_select()

-    cur.execute("""SELECT *, ST_AsText(geometry) as geomtxt,
-                   ST_X(centroid) as cx, ST_Y(centroid) as cy
-                   FROM placex where %s""" % where,
-                params)
+    cur.execute("SELECT * FROM %s where %s" % (table, where), params)
+    eq_(0, cur.rowcount)
+    context.db.commit()
+
+@then("search_name has no entry for (?P<oid>.*)")
+def check_search_name_has_entry(context, oid):
+    cur = context.db.cursor(cursor_factory=psycopg2.extras.DictCursor)
+    pid = NominatimID(oid).get_place_id(cur)
+    cur.execute("SELECT * FROM search_name WHERE place_id = %s", (pid, ))

     eq_(0, cur.rowcount)
     context.db.commit()
     eq_(0, cur.rowcount)
     context.db.commit()