]> git.openstreetmap.org Git - nominatim.git/blob - test/python/test_tokenizer_legacy.py
add unit tests for legacy ICU tokenizer
[nominatim.git] / test / python / test_tokenizer_legacy.py
1 """
2 Test for legacy tokenizer.
3 """
4 import shutil
5
6 import pytest
7
8 from nominatim.tokenizer import legacy_tokenizer
9 from nominatim.db import properties
10 from nominatim.errors import UsageError
11
12 @pytest.fixture
13 def test_config(def_config, tmp_path):
14     def_config.project_dir = tmp_path / 'project'
15     def_config.project_dir.mkdir()
16
17     module_dir = tmp_path / 'module_src'
18     module_dir.mkdir()
19     (module_dir / 'nominatim.so').write_text('TEST nomiantim.so')
20
21     def_config.lib_dir.module = module_dir
22
23     sqldir = tmp_path / 'sql'
24     sqldir.mkdir()
25     (sqldir / 'tokenizer').mkdir()
26     (sqldir / 'tokenizer' / 'legacy_tokenizer.sql').write_text("SELECT 'a'")
27     (sqldir / 'words.sql').write_text("SELECT 'a'")
28     shutil.copy(str(def_config.lib_dir.sql / 'tokenizer' / 'legacy_tokenizer_tables.sql'),
29                 str(sqldir / 'tokenizer' / 'legacy_tokenizer_tables.sql'))
30
31     def_config.lib_dir.sql = sqldir
32     def_config.lib_dir.data = sqldir
33
34     return def_config
35
36
37 @pytest.fixture
38 def tokenizer_factory(dsn, tmp_path, property_table):
39     (tmp_path / 'tokenizer').mkdir()
40
41     def _maker():
42         return legacy_tokenizer.create(dsn, tmp_path / 'tokenizer')
43
44     return _maker
45
46
47 @pytest.fixture
48 def tokenizer_setup(tokenizer_factory, test_config, monkeypatch, sql_preprocessor):
49     monkeypatch.setattr(legacy_tokenizer, '_check_module' , lambda m, c: None)
50     tok = tokenizer_factory()
51     tok.init_new_db(test_config)
52
53
54 @pytest.fixture
55 def analyzer(tokenizer_factory, test_config, monkeypatch, sql_preprocessor,
56              word_table, temp_db_with_extensions, tmp_path):
57     sql = tmp_path / 'sql' / 'tokenizer' / 'legacy_tokenizer.sql'
58     sql.write_text("""
59         CREATE OR REPLACE FUNCTION getorcreate_housenumber_id(lookup_word TEXT)
60           RETURNS INTEGER AS $$ SELECT 342; $$ LANGUAGE SQL;
61         """)
62
63     monkeypatch.setattr(legacy_tokenizer, '_check_module' , lambda m, c: None)
64     monkeypatch.setenv('NOMINATIM_TERM_NORMALIZATION', ':: lower();')
65     tok = tokenizer_factory()
66     tok.init_new_db(test_config)
67     monkeypatch.undo()
68
69     with tok.name_analyzer() as analyzer:
70         yield analyzer
71
72
73 @pytest.fixture
74 def make_standard_name(temp_db_cursor):
75     temp_db_cursor.execute("""CREATE OR REPLACE FUNCTION make_standard_name(name TEXT)
76                               RETURNS TEXT AS $$ SELECT ' ' || name; $$ LANGUAGE SQL""")
77
78
79 @pytest.fixture
80 def create_postcode_id(table_factory, temp_db_cursor):
81     table_factory('out_postcode_table', 'postcode TEXT')
82
83     temp_db_cursor.execute("""CREATE OR REPLACE FUNCTION create_postcode_id(postcode TEXT)
84                               RETURNS BOOLEAN AS $$
85                               INSERT INTO out_postcode_table VALUES (postcode) RETURNING True;
86                               $$ LANGUAGE SQL""")
87
88
89 @pytest.fixture
90 def create_housenumbers(temp_db_cursor):
91     temp_db_cursor.execute("""CREATE OR REPLACE FUNCTION create_housenumbers(
92                                   housenumbers TEXT[],
93                                   OUT tokens TEXT, OUT normtext TEXT)
94                               AS $$
95                               SELECT housenumbers::TEXT, array_to_string(housenumbers, ';')
96                               $$ LANGUAGE SQL""")
97
98
99 @pytest.fixture
100 def make_keywords(temp_db_cursor, temp_db_with_extensions):
101     temp_db_cursor.execute(
102         """CREATE OR REPLACE FUNCTION make_keywords(names HSTORE)
103            RETURNS INTEGER[] AS $$ SELECT ARRAY[1, 2, 3] $$ LANGUAGE SQL""")
104
105 def test_init_new(tokenizer_factory, test_config, monkeypatch,
106                   temp_db_conn, sql_preprocessor):
107     monkeypatch.setenv('NOMINATIM_TERM_NORMALIZATION', 'xxvv')
108     monkeypatch.setattr(legacy_tokenizer, '_check_module' , lambda m, c: None)
109
110     tok = tokenizer_factory()
111     tok.init_new_db(test_config)
112
113     assert properties.get_property(temp_db_conn, legacy_tokenizer.DBCFG_NORMALIZATION) == 'xxvv'
114
115     outfile = test_config.project_dir / 'module' / 'nominatim.so'
116
117     assert outfile.exists()
118     assert outfile.read_text() == 'TEST nomiantim.so'
119     assert outfile.stat().st_mode == 33261
120
121
122 def test_init_module_load_failed(tokenizer_factory, test_config,
123                                  monkeypatch, temp_db_conn):
124     tok = tokenizer_factory()
125
126     with pytest.raises(UsageError):
127         tok.init_new_db(test_config)
128
129
130 def test_init_module_custom(tokenizer_factory, test_config,
131                             monkeypatch, tmp_path, sql_preprocessor):
132     module_dir = (tmp_path / 'custom').resolve()
133     module_dir.mkdir()
134     (module_dir/ 'nominatim.so').write_text('CUSTOM nomiantim.so')
135
136     monkeypatch.setenv('NOMINATIM_DATABASE_MODULE_PATH', str(module_dir))
137     monkeypatch.setattr(legacy_tokenizer, '_check_module' , lambda m, c: None)
138
139     tok = tokenizer_factory()
140     tok.init_new_db(test_config)
141
142     assert not (test_config.project_dir / 'module').exists()
143
144
145 def test_init_from_project(tokenizer_setup, tokenizer_factory):
146     tok = tokenizer_factory()
147
148     tok.init_from_project()
149
150     assert tok.normalization is not None
151
152
153 def test_update_sql_functions(sql_preprocessor, temp_db_conn,
154                               tokenizer_factory, test_config, table_factory,
155                               monkeypatch, temp_db_cursor):
156     monkeypatch.setenv('NOMINATIM_MAX_WORD_FREQUENCY', '1133')
157     monkeypatch.setattr(legacy_tokenizer, '_check_module' , lambda m, c: None)
158     tok = tokenizer_factory()
159     tok.init_new_db(test_config)
160     monkeypatch.undo()
161
162     assert properties.get_property(temp_db_conn, legacy_tokenizer.DBCFG_MAXWORDFREQ) == '1133'
163
164     table_factory('test', 'txt TEXT')
165
166     func_file = test_config.lib_dir.sql / 'tokenizer' / 'legacy_tokenizer.sql'
167     func_file.write_text("""INSERT INTO test VALUES ('{{max_word_freq}}'),
168                                                    ('{{modulepath}}')""")
169
170     tok.update_sql_functions(test_config)
171
172     test_content = temp_db_cursor.row_set('SELECT * FROM test')
173     assert test_content == set((('1133', ), (str(test_config.project_dir / 'module'), )))
174
175
176 def test_migrate_database(tokenizer_factory, test_config, temp_db_conn, monkeypatch):
177     monkeypatch.setattr(legacy_tokenizer, '_check_module' , lambda m, c: None)
178     tok = tokenizer_factory()
179     tok.migrate_database(test_config)
180
181     assert properties.get_property(temp_db_conn, legacy_tokenizer.DBCFG_MAXWORDFREQ) is not None
182     assert properties.get_property(temp_db_conn, legacy_tokenizer.DBCFG_NORMALIZATION) is not None
183
184     outfile = test_config.project_dir / 'module' / 'nominatim.so'
185
186     assert outfile.exists()
187     assert outfile.read_text() == 'TEST nomiantim.so'
188     assert outfile.stat().st_mode == 33261
189
190
191 def test_normalize(analyzer):
192     assert analyzer.normalize('TEsT') == 'test'
193
194
195 def test_add_postcodes_from_db(analyzer, table_factory, temp_db_cursor,
196                                create_postcode_id):
197     table_factory('location_postcode', 'postcode TEXT',
198                   content=(('1234',), ('12 34',), ('AB23',), ('1234',)))
199
200     analyzer.add_postcodes_from_db()
201
202     assert temp_db_cursor.row_set("SELECT * from out_postcode_table") \
203                == set((('1234', ), ('12 34', ), ('AB23',)))
204
205
206 def test_update_special_phrase_empty_table(analyzer, word_table, temp_db_cursor,
207                                            make_standard_name):
208     analyzer.update_special_phrases([
209         ("König bei", "amenity", "royal", "near"),
210         ("Könige", "amenity", "royal", "-"),
211         ("strasse", "highway", "primary", "in")
212     ])
213
214     assert temp_db_cursor.row_set("""SELECT word_token, word, class, type, operator
215                                      FROM word WHERE class != 'place'""") \
216                == set(((' könig bei', 'könig bei', 'amenity', 'royal', 'near'),
217                        (' könige', 'könige', 'amenity', 'royal', None),
218                        (' strasse', 'strasse', 'highway', 'primary', 'in')))
219
220
221 def test_update_special_phrase_delete_all(analyzer, word_table, temp_db_cursor,
222                                           make_standard_name):
223     temp_db_cursor.execute("""INSERT INTO word (word_token, word, class, type, operator)
224                               VALUES (' foo', 'foo', 'amenity', 'prison', 'in'),
225                                      (' bar', 'bar', 'highway', 'road', null)""")
226
227     assert 2 == temp_db_cursor.scalar("SELECT count(*) FROM word WHERE class != 'place'""")
228
229     analyzer.update_special_phrases([])
230
231     assert 0 == temp_db_cursor.scalar("SELECT count(*) FROM word WHERE class != 'place'""")
232
233
234 def test_update_special_phrase_modify(analyzer, word_table, temp_db_cursor,
235                                       make_standard_name):
236     temp_db_cursor.execute("""INSERT INTO word (word_token, word, class, type, operator)
237                               VALUES (' foo', 'foo', 'amenity', 'prison', 'in'),
238                                      (' bar', 'bar', 'highway', 'road', null)""")
239
240     assert 2 == temp_db_cursor.scalar("SELECT count(*) FROM word WHERE class != 'place'""")
241
242     analyzer.update_special_phrases([
243       ('prison', 'amenity', 'prison', 'in'),
244       ('bar', 'highway', 'road', '-'),
245       ('garden', 'leisure', 'garden', 'near')
246     ])
247
248     assert temp_db_cursor.row_set("""SELECT word_token, word, class, type, operator
249                                      FROM word WHERE class != 'place'""") \
250                == set(((' prison', 'prison', 'amenity', 'prison', 'in'),
251                        (' bar', 'bar', 'highway', 'road', None),
252                        (' garden', 'garden', 'leisure', 'garden', 'near')))
253
254
255 def test_process_place_names(analyzer, make_keywords):
256
257     info = analyzer.process_place({'name' : {'name' : 'Soft bAr', 'ref': '34'}})
258
259     assert info['names'] == '{1,2,3}'
260
261
262 @pytest.mark.parametrize('pc', ['12345', 'AB 123', '34-345'])
263 def test_process_place_postcode(analyzer, temp_db_cursor, create_postcode_id, pc):
264
265     info = analyzer.process_place({'address': {'postcode' : pc}})
266
267     assert temp_db_cursor.row_set("SELECT * from out_postcode_table") \
268                == set(((pc, ),))
269
270
271 @pytest.mark.parametrize('pc', ['12:23', 'ab;cd;f', '123;836'])
272 def test_process_place_bad_postcode(analyzer, temp_db_cursor, create_postcode_id,
273                                     pc):
274
275     info = analyzer.process_place({'address': {'postcode' : pc}})
276
277     assert 0 == temp_db_cursor.scalar("SELECT count(*) from out_postcode_table")
278
279
280 @pytest.mark.parametrize('hnr', ['123a', '1', '101'])
281 def test_process_place_housenumbers_simple(analyzer, create_housenumbers, hnr):
282     info = analyzer.process_place({'address': {'housenumber' : hnr}})
283
284     assert info['hnr'] == hnr
285     assert info['hnr_tokens'].startswith("{")
286
287
288 def test_process_place_housenumbers_lists(analyzer, create_housenumbers):
289     info = analyzer.process_place({'address': {'conscriptionnumber' : '1; 2;3'}})
290
291     assert set(info['hnr'].split(';')) == set(('1', '2', '3'))
292
293
294 def test_process_place_housenumbers_duplicates(analyzer, create_housenumbers):
295     info = analyzer.process_place({'address': {'housenumber' : '134',
296                                                'conscriptionnumber' : '134',
297                                                'streetnumber' : '99a'}})
298
299     assert set(info['hnr'].split(';')) == set(('134', '99a'))