test/python/test_tokenizer_icu.py

   1 """
   2 Tests for Legacy ICU tokenizer.
   3 """
   4 import shutil
   5 import yaml
   6
   7 import pytest
   8
   9 from nominatim.tokenizer import icu_tokenizer
  10 from nominatim.tokenizer.icu_rule_loader import ICURuleLoader
  11 from nominatim.db import properties
  12 from nominatim.db.sql_preprocessor import SQLPreprocessor
  13 from nominatim.indexer.place_info import PlaceInfo
  14
  15 from mock_icu_word_table import MockIcuWordTable
  16
  17 @pytest.fixture
  18 def word_table(temp_db_conn):
  19     return MockIcuWordTable(temp_db_conn)
  20
  21
  22 @pytest.fixture
  23 def test_config(def_config, tmp_path):
  24     def_config.project_dir = tmp_path / 'project'
  25     def_config.project_dir.mkdir()
  26
  27     sqldir = tmp_path / 'sql'
  28     sqldir.mkdir()
  29     (sqldir / 'tokenizer').mkdir()
  30     (sqldir / 'tokenizer' / 'icu_tokenizer.sql').write_text("SELECT 'a'")
  31     shutil.copy(str(def_config.lib_dir.sql / 'tokenizer' / 'icu_tokenizer_tables.sql'),
  32                 str(sqldir / 'tokenizer' / 'icu_tokenizer_tables.sql'))
  33
  34     def_config.lib_dir.sql = sqldir
  35
  36     return def_config
  37
  38
  39 @pytest.fixture
  40 def tokenizer_factory(dsn, tmp_path, property_table,
  41                       sql_preprocessor, place_table, word_table):
  42     (tmp_path / 'tokenizer').mkdir()
  43
  44     def _maker():
  45         return icu_tokenizer.create(dsn, tmp_path / 'tokenizer')
  46
  47     return _maker
  48
  49
  50 @pytest.fixture
  51 def db_prop(temp_db_conn):
  52     def _get_db_property(name):
  53         return properties.get_property(temp_db_conn, name)
  54
  55     return _get_db_property
  56
  57
  58 @pytest.fixture
  59 def analyzer(tokenizer_factory, test_config, monkeypatch,
  60              temp_db_with_extensions, tmp_path):
  61     sql = tmp_path / 'sql' / 'tokenizer' / 'icu_tokenizer.sql'
  62     sql.write_text("SELECT 'a';")
  63
  64     monkeypatch.setenv('NOMINATIM_TERM_NORMALIZATION', ':: lower();')
  65     tok = tokenizer_factory()
  66     tok.init_new_db(test_config)
  67     monkeypatch.undo()
  68
  69     def _mk_analyser(norm=("[[:Punctuation:][:Space:]]+ > ' '",), trans=(':: upper()',),
  70                      variants=('~gasse -> gasse', 'street => st', ),
  71                      sanitizers=[]):
  72         cfgstr = {'normalization': list(norm),
  73                   'sanitizers': sanitizers,
  74                   'transliteration': list(trans),
  75                   'token-analysis': [{'analyzer': 'generic',
  76                                       'variants': [{'words': list(variants)}]}]}
  77         (test_config.project_dir / 'icu_tokenizer.yaml').write_text(yaml.dump(cfgstr))
  78         tok.loader = ICURuleLoader(test_config)
  79
  80         return tok.name_analyzer()
  81
  82     return _mk_analyser
  83
  84 @pytest.fixture
  85 def sql_functions(temp_db_conn, def_config, src_dir):
  86     orig_sql = def_config.lib_dir.sql
  87     def_config.lib_dir.sql = src_dir / 'lib-sql'
  88     sqlproc = SQLPreprocessor(temp_db_conn, def_config)
  89     sqlproc.run_sql_file(temp_db_conn, 'functions/utils.sql')
  90     sqlproc.run_sql_file(temp_db_conn, 'tokenizer/icu_tokenizer.sql')
  91     def_config.lib_dir.sql = orig_sql
  92
  93
  94 @pytest.fixture
  95 def getorcreate_full_word(temp_db_cursor):
  96     temp_db_cursor.execute("""CREATE OR REPLACE FUNCTION getorcreate_full_word(
  97                                                  norm_term TEXT, lookup_terms TEXT[],
  98                                                  OUT full_token INT,
  99                                                  OUT partial_tokens INT[])
 100   AS $$
 101 DECLARE
 102   partial_terms TEXT[] = '{}'::TEXT[];
 103   term TEXT;
 104   term_id INTEGER;
 105   term_count INTEGER;
 106 BEGIN
 107   SELECT min(word_id) INTO full_token
 108     FROM word WHERE info->>'word' = norm_term and type = 'W';
 109
 110   IF full_token IS NULL THEN
 111     full_token := nextval('seq_word');
 112     INSERT INTO word (word_id, word_token, type, info)
 113       SELECT full_token, lookup_term, 'W',
 114              json_build_object('word', norm_term, 'count', 0)
 115         FROM unnest(lookup_terms) as lookup_term;
 116   END IF;
 117
 118   FOR term IN SELECT unnest(string_to_array(unnest(lookup_terms), ' ')) LOOP
 119     term := trim(term);
 120     IF NOT (ARRAY[term] <@ partial_terms) THEN
 121       partial_terms := partial_terms || term;
 122     END IF;
 123   END LOOP;
 124
 125   partial_tokens := '{}'::INT[];
 126   FOR term IN SELECT unnest(partial_terms) LOOP
 127     SELECT min(word_id), max(info->>'count') INTO term_id, term_count
 128       FROM word WHERE word_token = term and type = 'w';
 129
 130     IF term_id IS NULL THEN
 131       term_id := nextval('seq_word');
 132       term_count := 0;
 133       INSERT INTO word (word_id, word_token, type, info)
 134         VALUES (term_id, term, 'w', json_build_object('count', term_count));
 135     END IF;
 136
 137     IF NOT (ARRAY[term_id] <@ partial_tokens) THEN
 138       partial_tokens := partial_tokens || term_id;
 139     END IF;
 140   END LOOP;
 141 END;
 142 $$
 143 LANGUAGE plpgsql;
 144                               """)
 145
 146
 147 @pytest.fixture
 148 def getorcreate_hnr_id(temp_db_cursor):
 149     temp_db_cursor.execute("""CREATE OR REPLACE FUNCTION getorcreate_hnr_id(lookup_term TEXT)
 150                               RETURNS INTEGER AS $$
 151                                 SELECT -nextval('seq_word')::INTEGER; $$ LANGUAGE SQL""")
 152
 153
 154 def test_init_new(tokenizer_factory, test_config, monkeypatch, db_prop):
 155     monkeypatch.setenv('NOMINATIM_TERM_NORMALIZATION', ':: lower();')
 156
 157     tok = tokenizer_factory()
 158     tok.init_new_db(test_config)
 159
 160     assert db_prop(icu_tokenizer.DBCFG_TERM_NORMALIZATION) == ':: lower();'
 161
 162
 163 def test_init_word_table(tokenizer_factory, test_config, place_row, word_table):
 164     place_row(names={'name' : 'Test Area', 'ref' : '52'})
 165     place_row(names={'name' : 'No Area'})
 166     place_row(names={'name' : 'Holzstrasse'})
 167
 168     tok = tokenizer_factory()
 169     tok.init_new_db(test_config)
 170
 171     assert word_table.get_partial_words() == {('test', 1),
 172                                               ('no', 1), ('area', 2)}
 173
 174
 175 def test_init_from_project(monkeypatch, test_config, tokenizer_factory):
 176     monkeypatch.setenv('NOMINATIM_TERM_NORMALIZATION', ':: lower();')
 177     tok = tokenizer_factory()
 178     tok.init_new_db(test_config)
 179     monkeypatch.undo()
 180
 181     tok = tokenizer_factory()
 182     tok.init_from_project(test_config)
 183
 184     assert tok.loader is not None
 185     assert tok.term_normalization == ':: lower();'
 186
 187
 188 def test_update_sql_functions(db_prop, temp_db_cursor,
 189                               tokenizer_factory, test_config, table_factory,
 190                               monkeypatch):
 191     tok = tokenizer_factory()
 192     tok.init_new_db(test_config)
 193
 194     table_factory('test', 'txt TEXT')
 195
 196     func_file = test_config.lib_dir.sql / 'tokenizer' / 'icu_tokenizer.sql'
 197     func_file.write_text("""INSERT INTO test VALUES (1133)""")
 198
 199     tok.update_sql_functions(test_config)
 200
 201     test_content = temp_db_cursor.row_set('SELECT * FROM test')
 202     assert test_content == set((('1133', ), ))
 203
 204
 205 def test_normalize_postcode(analyzer):
 206     with analyzer() as anl:
 207         anl.normalize_postcode('123') == '123'
 208         anl.normalize_postcode('ab-34 ') == 'AB-34'
 209         anl.normalize_postcode('38 Б') == '38 Б'
 210
 211
 212 def test_update_postcodes_from_db_empty(analyzer, table_factory, word_table):
 213     table_factory('location_postcode', 'postcode TEXT',
 214                   content=(('1234',), ('12 34',), ('AB23',), ('1234',)))
 215
 216     with analyzer() as anl:
 217         anl.update_postcodes_from_db()
 218
 219     assert word_table.count() == 3
 220     assert word_table.get_postcodes() == {'1234', '12 34', 'AB23'}
 221
 222
 223 def test_update_postcodes_from_db_add_and_remove(analyzer, table_factory, word_table):
 224     table_factory('location_postcode', 'postcode TEXT',
 225                   content=(('1234',), ('45BC', ), ('XX45', )))
 226     word_table.add_postcode(' 1234', '1234')
 227     word_table.add_postcode(' 5678', '5678')
 228
 229     with analyzer() as anl:
 230         anl.update_postcodes_from_db()
 231
 232     assert word_table.count() == 3
 233     assert word_table.get_postcodes() == {'1234', '45BC', 'XX45'}
 234
 235
 236 def test_update_special_phrase_empty_table(analyzer, word_table):
 237     with analyzer() as anl:
 238         anl.update_special_phrases([
 239             ("König  bei", "amenity", "royal", "near"),
 240             ("Könige ", "amenity", "royal", "-"),
 241             ("street", "highway", "primary", "in")
 242         ], True)
 243
 244     assert word_table.get_special() \
 245                == {('KÖNIG BEI', 'König bei', 'amenity', 'royal', 'near'),
 246                    ('KÖNIGE', 'Könige', 'amenity', 'royal', None),
 247                    ('STREET', 'street', 'highway', 'primary', 'in')}
 248
 249
 250 def test_update_special_phrase_delete_all(analyzer, word_table):
 251     word_table.add_special('FOO', 'foo', 'amenity', 'prison', 'in')
 252     word_table.add_special('BAR', 'bar', 'highway', 'road', None)
 253
 254     assert word_table.count_special() == 2
 255
 256     with analyzer() as anl:
 257         anl.update_special_phrases([], True)
 258
 259     assert word_table.count_special() == 0
 260
 261
 262 def test_update_special_phrases_no_replace(analyzer, word_table):
 263     word_table.add_special('FOO', 'foo', 'amenity', 'prison', 'in')
 264     word_table.add_special('BAR', 'bar', 'highway', 'road', None)
 265
 266     assert word_table.count_special() == 2
 267
 268     with analyzer() as anl:
 269         anl.update_special_phrases([], False)
 270
 271     assert word_table.count_special() == 2
 272
 273
 274 def test_update_special_phrase_modify(analyzer, word_table):
 275     word_table.add_special('FOO', 'foo', 'amenity', 'prison', 'in')
 276     word_table.add_special('BAR', 'bar', 'highway', 'road', None)
 277
 278     assert word_table.count_special() == 2
 279
 280     with analyzer() as anl:
 281         anl.update_special_phrases([
 282             ('prison', 'amenity', 'prison', 'in'),
 283             ('bar', 'highway', 'road', '-'),
 284             ('garden', 'leisure', 'garden', 'near')
 285         ], True)
 286
 287     assert word_table.get_special() \
 288                == {('PRISON', 'prison', 'amenity', 'prison', 'in'),
 289                    ('BAR', 'bar', 'highway', 'road', None),
 290                    ('GARDEN', 'garden', 'leisure', 'garden', 'near')}
 291
 292
 293 def test_add_country_names_new(analyzer, word_table):
 294     with analyzer() as anl:
 295         anl.add_country_names('es', {'name': 'Espagña', 'name:en': 'Spain'})
 296
 297     assert word_table.get_country() == {('es', 'ESPAGÑA'), ('es', 'SPAIN')}
 298
 299
 300 def test_add_country_names_extend(analyzer, word_table):
 301     word_table.add_country('ch', 'SCHWEIZ')
 302
 303     with analyzer() as anl:
 304         anl.add_country_names('ch', {'name': 'Schweiz', 'name:fr': 'Suisse'})
 305
 306     assert word_table.get_country() == {('ch', 'SCHWEIZ'), ('ch', 'SUISSE')}
 307
 308
 309 class TestPlaceNames:
 310
 311     @pytest.fixture(autouse=True)
 312     def setup(self, analyzer, sql_functions):
 313         sanitizers = [{'step': 'split-name-list'},
 314                       {'step': 'strip-brace-terms'}]
 315         with analyzer(sanitizers=sanitizers) as anl:
 316             self.analyzer = anl
 317             yield anl
 318
 319
 320     def expect_name_terms(self, info, *expected_terms):
 321         tokens = self.analyzer.get_word_token_info(expected_terms)
 322         for token in tokens:
 323             assert token[2] is not None, "No token for {0}".format(token)
 324
 325         assert eval(info['names']) == set((t[2] for t in tokens))
 326
 327
 328     def process_named_place(self, names):
 329         return self.analyzer.process_place(PlaceInfo({'name': names}))
 330
 331
 332     def test_simple_names(self):
 333         info = self.process_named_place({'name': 'Soft bAr', 'ref': '34'})
 334
 335         self.expect_name_terms(info, '#Soft bAr', '#34', 'Soft', 'bAr', '34')
 336
 337
 338     @pytest.mark.parametrize('sep', [',' , ';'])
 339     def test_names_with_separator(self, sep):
 340         info = self.process_named_place({'name': sep.join(('New York', 'Big Apple'))})
 341
 342         self.expect_name_terms(info, '#New York', '#Big Apple',
 343                                      'new', 'york', 'big', 'apple')
 344
 345
 346     def test_full_names_with_bracket(self):
 347         info = self.process_named_place({'name': 'Houseboat (left)'})
 348
 349         self.expect_name_terms(info, '#Houseboat (left)', '#Houseboat',
 350                                      'houseboat', 'left')
 351
 352
 353     def test_country_name(self, word_table):
 354         place = PlaceInfo({'name' : {'name': 'Norge'},
 355                            'country_code': 'no',
 356                            'rank_address': 4,
 357                            'class': 'boundary',
 358                            'type': 'administrative'})
 359
 360         info = self.analyzer.process_place(place)
 361
 362         self.expect_name_terms(info, '#norge', 'norge')
 363         assert word_table.get_country() == {('no', 'NORGE')}
 364
 365
 366 class TestPlaceAddress:
 367
 368     @pytest.fixture(autouse=True)
 369     def setup(self, analyzer, sql_functions):
 370         with analyzer(trans=(":: upper()", "'🜵' > ' '")) as anl:
 371             self.analyzer = anl
 372             yield anl
 373
 374
 375     def process_address(self, **kwargs):
 376         return self.analyzer.process_place(PlaceInfo({'address': kwargs}))
 377
 378
 379     def name_token_set(self, *expected_terms):
 380         tokens = self.analyzer.get_word_token_info(expected_terms)
 381         for token in tokens:
 382             assert token[2] is not None, "No token for {0}".format(token)
 383
 384         return set((t[2] for t in tokens))
 385
 386
 387     @pytest.mark.parametrize('pcode', ['12345', 'AB 123', '34-345'])
 388     def test_process_place_postcode(self, word_table, pcode):
 389         self.process_address(postcode=pcode)
 390
 391         assert word_table.get_postcodes() == {pcode, }
 392
 393
 394     @pytest.mark.parametrize('pcode', ['12:23', 'ab;cd;f', '123;836'])
 395     def test_process_place_bad_postcode(self, word_table, pcode):
 396         self.process_address(postcode=pcode)
 397
 398         assert not word_table.get_postcodes()
 399
 400
 401     @pytest.mark.parametrize('hnr', ['123a', '1', '101'])
 402     def test_process_place_housenumbers_simple(self, hnr, getorcreate_hnr_id):
 403         info = self.process_address(housenumber=hnr)
 404
 405         assert info['hnr'] == hnr.upper()
 406         assert info['hnr_tokens'] == "{-1}"
 407
 408
 409     def test_process_place_housenumbers_lists(self, getorcreate_hnr_id):
 410         info = self.process_address(conscriptionnumber='1; 2;3')
 411
 412         assert set(info['hnr'].split(';')) == set(('1', '2', '3'))
 413         assert info['hnr_tokens'] == "{-1,-2,-3}"
 414
 415
 416     def test_process_place_housenumbers_duplicates(self, getorcreate_hnr_id):
 417         info = self.process_address(housenumber='134',
 418                                     conscriptionnumber='134',
 419                                     streetnumber='99a')
 420
 421         assert set(info['hnr'].split(';')) == set(('134', '99A'))
 422         assert info['hnr_tokens'] == "{-1,-2}"
 423
 424
 425     def test_process_place_housenumbers_cached(self, getorcreate_hnr_id):
 426         info = self.process_address(housenumber="45")
 427         assert info['hnr_tokens'] == "{-1}"
 428
 429         info = self.process_address(housenumber="46")
 430         assert info['hnr_tokens'] == "{-2}"
 431
 432         info = self.process_address(housenumber="41;45")
 433         assert eval(info['hnr_tokens']) == {-1, -3}
 434
 435         info = self.process_address(housenumber="41")
 436         assert eval(info['hnr_tokens']) == {-3}
 437
 438
 439     def test_process_place_street(self):
 440         info = self.process_address(street='Grand Road')
 441
 442         assert eval(info['street']) == self.name_token_set('GRAND', 'ROAD')
 443
 444
 445     def test_process_place_street_empty(self):
 446         info = self.process_address(street='🜵')
 447
 448         assert 'street' not in info
 449
 450
 451     def test_process_place_place(self):
 452         info = self.process_address(place='Honu Lulu')
 453
 454         assert eval(info['place']) == self.name_token_set('HONU', 'LULU')
 455
 456
 457     def test_process_place_place_empty(self):
 458         info = self.process_address(place='🜵')
 459
 460         assert 'place' not in info
 461
 462
 463     def test_process_place_address_terms(self):
 464         info = self.process_address(country='de', city='Zwickau', state='Sachsen',
 465                                     suburb='Zwickau', street='Hauptstr',
 466                                     full='right behind the church')
 467
 468         city = self.name_token_set('ZWICKAU')
 469         state = self.name_token_set('SACHSEN')
 470
 471         result = {k: eval(v) for k,v in info['addr'].items()}
 472
 473         assert result == {'city': city, 'suburb': city, 'state': state}
 474
 475
 476     def test_process_place_address_terms_empty(self):
 477         info = self.process_address(country='de', city=' ', street='Hauptstr',
 478                                     full='right behind the church')
 479
 480         assert 'addr' not in info
 481