test/python/api/search/test_search_near.py

   1 # SPDX-License-Identifier: GPL-3.0-or-later
   2 #
   3 # This file is part of Nominatim. (https://nominatim.org)
   4 #
   5 # Copyright (C) 2023 by the Nominatim developer community.
   6 # For a full list of authors see the git log.
   7 """
   8 Tests for running the near searcher.
   9 """
  10 import pytest
  11
  12 import nominatim.api as napi
  13 from nominatim.api.types import SearchDetails
  14 from nominatim.api.search.db_searches import NearSearch, PlaceSearch
  15 from nominatim.api.search.db_search_fields import WeightedStrings, WeightedCategories,\
  16                                                   FieldLookup, FieldRanking, RankedTokens
  17 from nominatim.api.search.db_search_lookups import LookupAll
  18
  19
  20 def run_search(apiobj, global_penalty, cat, cat_penalty=None, ccodes=[],
  21                details=SearchDetails()):
  22
  23     class PlaceSearchData:
  24         penalty = 0.0
  25         postcodes = WeightedStrings([], [])
  26         countries = WeightedStrings(ccodes, [0.0] * len(ccodes))
  27         housenumbers = WeightedStrings([], [])
  28         qualifiers = WeightedStrings([], [])
  29         lookups = [FieldLookup('name_vector', [56], LookupAll)]
  30         rankings = []
  31
  32     if ccodes is not None:
  33         details.countries = ccodes
  34
  35     place_search = PlaceSearch(0.0, PlaceSearchData(), 2)
  36
  37     if cat_penalty is None:
  38         cat_penalty = [0.0] * len(cat)
  39
  40     near_search = NearSearch(0.1, WeightedCategories(cat, cat_penalty), place_search)
  41
  42     async def run():
  43         async with apiobj.api._async_api.begin() as conn:
  44             return await near_search.lookup(conn, details)
  45
  46     results = apiobj.async_to_sync(run())
  47     results.sort(key=lambda r: r.accuracy)
  48
  49     return results
  50
  51
  52 def test_no_results_inner_query(apiobj):
  53     assert not run_search(apiobj, 0.4, [('this', 'that')])
  54
  55
  56 def test_no_appropriate_results_inner_query(apiobj):
  57     apiobj.add_placex(place_id=100, country_code='us',
  58                       centroid=(5.6, 4.3),
  59                       geometry='POLYGON((0.0 0.0, 10.0 0.0, 10.0 2.0, 0.0 2.0, 0.0 0.0))')
  60     apiobj.add_search_name(100, names=[56], country_code='us',
  61                            centroid=(5.6, 4.3))
  62     apiobj.add_placex(place_id=22, class_='amenity', type='bank',
  63                       centroid=(5.6001, 4.2994))
  64
  65     assert not run_search(apiobj, 0.4, [('amenity', 'bank')])
  66
  67
  68 class TestNearSearch:
  69
  70     @pytest.fixture(autouse=True)
  71     def fill_database(self, apiobj):
  72         apiobj.add_placex(place_id=100, country_code='us',
  73                           centroid=(5.6, 4.3))
  74         apiobj.add_search_name(100, names=[56], country_code='us',
  75                                centroid=(5.6, 4.3))
  76         apiobj.add_placex(place_id=101, country_code='mx',
  77                           centroid=(-10.3, 56.9))
  78         apiobj.add_search_name(101, names=[56], country_code='mx',
  79                                centroid=(-10.3, 56.9))
  80
  81
  82     def test_near_in_placex(self, apiobj):
  83         apiobj.add_placex(place_id=22, class_='amenity', type='bank',
  84                           centroid=(5.6001, 4.2994))
  85         apiobj.add_placex(place_id=23, class_='amenity', type='bench',
  86                           centroid=(5.6001, 4.2994))
  87
  88         results = run_search(apiobj, 0.1, [('amenity', 'bank')])
  89
  90         assert [r.place_id for r in results] == [22]
  91
  92
  93     def test_multiple_types_near_in_placex(self, apiobj):
  94         apiobj.add_placex(place_id=22, class_='amenity', type='bank',
  95                           importance=0.002,
  96                           centroid=(5.6001, 4.2994))
  97         apiobj.add_placex(place_id=23, class_='amenity', type='bench',
  98                           importance=0.001,
  99                           centroid=(5.6001, 4.2994))
 100
 101         results = run_search(apiobj, 0.1, [('amenity', 'bank'),
 102                                            ('amenity', 'bench')])
 103
 104         assert [r.place_id for r in results] == [22, 23]
 105
 106
 107     def test_near_in_classtype(self, apiobj):
 108         apiobj.add_placex(place_id=22, class_='amenity', type='bank',
 109                           centroid=(5.6, 4.34))
 110         apiobj.add_placex(place_id=23, class_='amenity', type='bench',
 111                           centroid=(5.6, 4.34))
 112         apiobj.add_class_type_table('amenity', 'bank')
 113         apiobj.add_class_type_table('amenity', 'bench')
 114
 115         results = run_search(apiobj, 0.1, [('amenity', 'bank')])
 116
 117         assert [r.place_id for r in results] == [22]
 118
 119
 120     @pytest.mark.parametrize('cc,rid', [('us', 22), ('mx', 23)])
 121     def test_restrict_by_country(self, apiobj, cc, rid):
 122         apiobj.add_placex(place_id=22, class_='amenity', type='bank',
 123                           centroid=(5.6001, 4.2994),
 124                           country_code='us')
 125         apiobj.add_placex(place_id=122, class_='amenity', type='bank',
 126                           centroid=(5.6001, 4.2994),
 127                           country_code='mx')
 128         apiobj.add_placex(place_id=23, class_='amenity', type='bank',
 129                           centroid=(-10.3001, 56.9),
 130                           country_code='mx')
 131         apiobj.add_placex(place_id=123, class_='amenity', type='bank',
 132                           centroid=(-10.3001, 56.9),
 133                           country_code='us')
 134
 135         results = run_search(apiobj, 0.1, [('amenity', 'bank')], ccodes=[cc, 'fr'])
 136
 137         assert [r.place_id for r in results] == [rid]
 138
 139
 140     @pytest.mark.parametrize('excluded,rid', [(22, 122), (122, 22)])
 141     def test_exclude_place_by_id(self, apiobj, excluded, rid):
 142         apiobj.add_placex(place_id=22, class_='amenity', type='bank',
 143                           centroid=(5.6001, 4.2994),
 144                           country_code='us')
 145         apiobj.add_placex(place_id=122, class_='amenity', type='bank',
 146                           centroid=(5.6001, 4.2994),
 147                           country_code='us')
 148
 149
 150         results = run_search(apiobj, 0.1, [('amenity', 'bank')],
 151                              details=SearchDetails(excluded=[excluded]))
 152
 153         assert [r.place_id for r in results] == [rid]
 154
 155
 156     @pytest.mark.parametrize('layer,rids', [(napi.DataLayer.POI, [22]),
 157                                             (napi.DataLayer.MANMADE, [])])
 158     def test_with_layer(self, apiobj, layer, rids):
 159         apiobj.add_placex(place_id=22, class_='amenity', type='bank',
 160                           centroid=(5.6001, 4.2994),
 161                           country_code='us')
 162
 163         results = run_search(apiobj, 0.1, [('amenity', 'bank')],
 164                              details=SearchDetails(layers=layer))
 165
 166         assert [r.place_id for r in results] == rids