X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/2c19bd5ea38fb7474d0ca530fdab7ae76cee965b..02d357d29e40a8dfe5bc8eb4eac35c3ad3cc0958:/test/python/test_tools_import_special_phrases.py diff --git a/test/python/test_tools_import_special_phrases.py b/test/python/test_tools_import_special_phrases.py index 0adc2850..f0a34b08 100644 --- a/test/python/test_tools_import_special_phrases.py +++ b/test/python/test_tools_import_special_phrases.py @@ -1,121 +1,300 @@ """ - Tests for import special phrases functions + Tests for import special phrases methods + of the class SPImporter. """ -from pathlib import Path +from shutil import copyfile import pytest -from nominatim.tools.special_phrases import SpecialPhrasesImporter +from nominatim.tools.special_phrases.sp_importer import SPImporter +from nominatim.tools.special_phrases.sp_wiki_loader import SPWikiLoader +from nominatim.tools.special_phrases.special_phrase import SpecialPhrase +from nominatim.errors import UsageError -TEST_BASE_DIR = Path(__file__) / '..' / '..' +from cursor import CursorForTesting -def test_process_amenity_with_operator(special_phrases_importer, getorcreate_amenityoperator_funcs): - special_phrases_importer._process_amenity('', '', '', '', 'near') - special_phrases_importer._process_amenity('', '', '', '', 'in') +@pytest.fixture +def testfile_dir(src_dir): + return src_dir / 'test' / 'testfiles' + + +@pytest.fixture +def sp_importer(temp_db_conn, def_config, temp_phplib_dir_with_migration): + """ + Return an instance of SPImporter. + """ + loader = SPWikiLoader(def_config, ['en']) + return SPImporter(def_config, temp_phplib_dir_with_migration, temp_db_conn, loader) + + +@pytest.fixture +def temp_phplib_dir_with_migration(src_dir, tmp_path): + """ + Return temporary phpdir with migration subdirectory and + PhraseSettingsToJson.php script inside. + """ + migration_file = (src_dir / 'lib-php' / 'migration' / 'PhraseSettingsToJson.php').resolve() + + phpdir = tmp_path / 'tempphp' + phpdir.mkdir() + + (phpdir / 'migration').mkdir() + migration_dest_path = (phpdir / 'migration' / 'PhraseSettingsToJson.php').resolve() + copyfile(str(migration_file), str(migration_dest_path)) + + return phpdir + + +@pytest.fixture +def xml_wiki_content(src_dir): + """ + return the content of the static xml test file. + """ + xml_test_content = src_dir / 'test' / 'testdata' / 'special_phrases_test_content.txt' + return xml_test_content.read_text() + + +@pytest.fixture +def default_phrases(table_factory): + table_factory('place_classtype_testclasstypetable_to_delete') + table_factory('place_classtype_testclasstypetable_to_keep') + + +def test_fetch_existing_place_classtype_tables(sp_importer, table_factory): + """ + Check for the fetch_existing_place_classtype_tables() method. + It should return the table just created. + """ + table_factory('place_classtype_testclasstypetable') + + sp_importer._fetch_existing_place_classtype_tables() + contained_table = sp_importer.table_phrases_to_delete.pop() + assert contained_table == 'place_classtype_testclasstypetable' + +def test_check_sanity_class(sp_importer): + """ + Check for _check_sanity() method. + If a wrong class or type is given, an UsageError should raise. + If a good class and type are given, nothing special happens. + """ + + assert not sp_importer._check_sanity(SpecialPhrase('en', '', 'type', '')) + assert not sp_importer._check_sanity(SpecialPhrase('en', 'class', '', '')) + + assert sp_importer._check_sanity(SpecialPhrase('en', 'class', 'type', '')) + +def test_load_white_and_black_lists(sp_importer): + """ + Test that _load_white_and_black_lists() well return + black list and white list and that they are of dict type. + """ + black_list, white_list = sp_importer._load_white_and_black_lists() + + assert isinstance(black_list, dict) and isinstance(white_list, dict) + +def test_convert_php_settings(sp_importer, testfile_dir, tmp_path): + """ + Test that _convert_php_settings_if_needed() convert the given + php file to a json file. + """ + php_file = (testfile_dir / 'phrase_settings.php').resolve() + + temp_settings = (tmp_path / 'phrase_settings.php').resolve() + copyfile(php_file, temp_settings) + sp_importer._convert_php_settings_if_needed(temp_settings) + + assert (tmp_path / 'phrase_settings.json').is_file() + +def test_convert_settings_wrong_file(sp_importer): + """ + Test that _convert_php_settings_if_needed() raise an exception + if the given file is not a valid file. + """ + with pytest.raises(UsageError, match='random_file is not a valid file.'): + sp_importer._convert_php_settings_if_needed('random_file') + +def test_convert_settings_json_already_exist(sp_importer, testfile_dir): + """ + Test that if we give to '_convert_php_settings_if_needed' a php file path + and that a the corresponding json file already exists, it is returned. + """ + php_file = (testfile_dir / 'phrase_settings.php').resolve() + json_file = (testfile_dir / 'phrase_settings.json').resolve() + + returned = sp_importer._convert_php_settings_if_needed(php_file) + + assert returned == json_file + +def test_convert_settings_giving_json(sp_importer, testfile_dir): + """ + Test that if we give to '_convert_php_settings_if_needed' a json file path + the same path is directly returned + """ + json_file = (testfile_dir / 'phrase_settings.json').resolve() -def test_process_amenity_without_operator(special_phrases_importer, getorcreate_amenity_funcs): - special_phrases_importer._process_amenity('', '', '', '', '') + returned = sp_importer._convert_php_settings_if_needed(json_file) -def test_create_place_classtype_indexes(temp_db_conn, special_phrases_importer): + assert returned == json_file + +def test_create_place_classtype_indexes(temp_db_with_extensions, temp_db_conn, + table_factory, sp_importer): + """ + Test that _create_place_classtype_indexes() create the + place_id index and centroid index on the right place_class_type table. + """ phrase_class = 'class' phrase_type = 'type' table_name = 'place_classtype_{}_{}'.format(phrase_class, phrase_type) - index_prefix = 'idx_place_classtype_{}_{}_'.format(phrase_class, phrase_type) - - with temp_db_conn.cursor() as temp_db_cursor: - temp_db_cursor.execute("CREATE EXTENSION postgis;") - temp_db_cursor.execute('CREATE TABLE {}(place_id BIGINT, centroid GEOMETRY)'.format(table_name)) - special_phrases_importer._create_place_classtype_indexes('', phrase_class, phrase_type) + table_factory(table_name, 'place_id BIGINT, centroid GEOMETRY') - centroid_index_exists = temp_db_conn.index_exists(index_prefix + 'centroid') - place_id_index_exists = temp_db_conn.index_exists(index_prefix + 'place_id') + sp_importer._create_place_classtype_indexes('', phrase_class, phrase_type) - assert centroid_index_exists and place_id_index_exists + assert check_placeid_and_centroid_indexes(temp_db_conn, phrase_class, phrase_type) -def test_create_place_classtype_table(temp_db_conn, placex_table, special_phrases_importer): +def test_create_place_classtype_table(temp_db_conn, placex_table, sp_importer): + """ + Test that _create_place_classtype_table() create + the right place_classtype table. + """ phrase_class = 'class' phrase_type = 'type' - special_phrases_importer._create_place_classtype_table('', phrase_class, phrase_type) + sp_importer._create_place_classtype_table('', phrase_class, phrase_type) - with temp_db_conn.cursor() as temp_db_cursor: - temp_db_cursor.execute(f""" - SELECT * - FROM information_schema.tables - WHERE table_type='BASE TABLE' - AND table_name='place_classtype_{phrase_class}_{phrase_type}'""") - result = temp_db_cursor.fetchone() - assert result - -def test_grant_access_to_web_user(temp_db_conn, def_config, special_phrases_importer): + assert check_table_exist(temp_db_conn, phrase_class, phrase_type) + +def test_grant_access_to_web_user(temp_db_conn, table_factory, def_config, sp_importer): + """ + Test that _grant_access_to_webuser() give + right access to the web user. + """ phrase_class = 'class' phrase_type = 'type' table_name = 'place_classtype_{}_{}'.format(phrase_class, phrase_type) - with temp_db_conn.cursor() as temp_db_cursor: - temp_db_cursor.execute('CREATE TABLE {}()'.format(table_name)) + table_factory(table_name) - special_phrases_importer._grant_access_to_webuser(phrase_class, phrase_type) + sp_importer._grant_access_to_webuser(phrase_class, phrase_type) - with temp_db_conn.cursor() as temp_db_cursor: - temp_db_cursor.execute(f""" - SELECT * FROM information_schema.role_table_grants - WHERE table_name='{table_name}' - AND grantee='{def_config.DATABASE_WEBUSER}' - AND privilege_type='SELECT'""") - result = temp_db_cursor.fetchone() - assert result + assert check_grant_access(temp_db_conn, def_config.DATABASE_WEBUSER, phrase_class, phrase_type) def test_create_place_classtype_table_and_indexes( - placex_table, getorcreate_amenity_funcs, - getorcreate_amenityoperator_funcs, special_phrases_importer): - pairs = {('class1', 'type1'), ('class2', 'type2')} + temp_db_conn, def_config, placex_table, + sp_importer): + """ + Test that _create_place_classtype_table_and_indexes() + create the right place_classtype tables and place_id indexes + and centroid indexes and grant access to the web user + for the given set of pairs. + """ + pairs = set([('class1', 'type1'), ('class2', 'type2')]) - special_phrases_importer._create_place_classtype_table_and_indexes(pairs) + sp_importer._create_place_classtype_table_and_indexes(pairs) -def test_process_xml_content(special_phrases_importer, getorcreate_amenity_funcs, - getorcreate_amenityoperator_funcs): - special_phrases_importer._process_xml_content(get_test_xml_wiki_content(), 'en') + for pair in pairs: + assert check_table_exist(temp_db_conn, pair[0], pair[1]) + assert check_placeid_and_centroid_indexes(temp_db_conn, pair[0], pair[1]) + assert check_grant_access(temp_db_conn, def_config.DATABASE_WEBUSER, pair[0], pair[1]) -def mock_get_wiki_content(lang): - return get_test_xml_wiki_content() +def test_remove_non_existent_tables_from_db(sp_importer, default_phrases, + temp_db_conn): + """ + Check for the remove_non_existent_phrases_from_db() method. -def test_import_from_wiki(monkeypatch, special_phrases_importer, placex_table, - getorcreate_amenity_funcs, getorcreate_amenityoperator_funcs): - #mocker.patch.object(special_phrases_importer, '_get_wiki_content', new=mock_get_wiki_content) - monkeypatch.setattr('nominatim.tools.special_phrases.SpecialPhrasesImporter._get_wiki_content', mock_get_wiki_content) - special_phrases_importer.import_from_wiki(['en']) + It should removed entries from the word table which are contained + in the words_phrases_to_delete set and not those also contained + in the words_phrases_still_exist set. -def get_test_xml_wiki_content(): - xml_test_content_path = (TEST_BASE_DIR / 'testdata' / 'special_phrases_test_content.txt').resolve() - with open(xml_test_content_path) as xml_content_reader: - return xml_content_reader.read() + place_classtype tables contained in table_phrases_to_delete should + be deleted. + """ + sp_importer.table_phrases_to_delete = { + 'place_classtype_testclasstypetable_to_delete' + } -@pytest.fixture -def special_phrases_importer(temp_db_conn, def_config, tmp_phplib_dir): - return SpecialPhrasesImporter(def_config, tmp_phplib_dir, temp_db_conn) + query_tables = """ + SELECT table_name + FROM information_schema.tables + WHERE table_schema='public' + AND table_name like 'place_classtype_%'; + """ -@pytest.fixture -def make_strandard_name_func(temp_db_cursor): - temp_db_cursor.execute(f""" - CREATE OR REPLACE FUNCTION make_standard_name(name TEXT) RETURNS TEXT AS $$ - BEGIN - RETURN trim(name); --Basically return only the trimed name for the tests - END; - $$ LANGUAGE plpgsql IMMUTABLE;""") - -@pytest.fixture -def getorcreate_amenity_funcs(temp_db_cursor, make_strandard_name_func): - temp_db_cursor.execute(f""" - CREATE OR REPLACE FUNCTION getorcreate_amenity(lookup_word TEXT, normalized_word TEXT, - lookup_class text, lookup_type text) - RETURNS void as $$ - BEGIN END; - $$ LANGUAGE plpgsql""") + sp_importer._remove_non_existent_tables_from_db() -@pytest.fixture -def getorcreate_amenityoperator_funcs(temp_db_cursor, make_strandard_name_func): - temp_db_cursor.execute(f""" - CREATE OR REPLACE FUNCTION getorcreate_amenityoperator(lookup_word TEXT, normalized_word TEXT, - lookup_class text, lookup_type text, op text) - RETURNS void as $$ - BEGIN END; - $$ LANGUAGE plpgsql""") \ No newline at end of file + # Changes are not committed yet. Use temp_db_conn for checking results. + with temp_db_conn.cursor(cursor_factory=CursorForTesting) as cur: + assert cur.row_set(query_tables) \ + == {('place_classtype_testclasstypetable_to_keep', )} + + +@pytest.mark.parametrize("should_replace", [(True), (False)]) +def test_import_phrases(monkeypatch, temp_db_conn, def_config, sp_importer, + placex_table, table_factory, tokenizer_mock, + xml_wiki_content, should_replace): + """ + Check that the main import_phrases() method is well executed. + It should create the place_classtype table, the place_id and centroid indexes, + grand access to the web user and executing the SQL functions for amenities. + It should also update the database well by deleting or preserving existing entries + of the database. + """ + #Add some data to the database before execution in order to test + #what is deleted and what is preserved. + table_factory('place_classtype_amenity_animal_shelter') + table_factory('place_classtype_wrongclass_wrongtype') + + monkeypatch.setattr('nominatim.tools.special_phrases.sp_wiki_loader.SPWikiLoader._get_wiki_content', + lambda self, lang: xml_wiki_content) + + tokenizer = tokenizer_mock() + sp_importer.import_phrases(tokenizer, should_replace) + + assert len(tokenizer.analyser_cache['special_phrases']) == 18 + + class_test = 'aerialway' + type_test = 'zip_line' + + assert check_table_exist(temp_db_conn, class_test, type_test) + assert check_placeid_and_centroid_indexes(temp_db_conn, class_test, type_test) + assert check_grant_access(temp_db_conn, def_config.DATABASE_WEBUSER, class_test, type_test) + assert check_table_exist(temp_db_conn, 'amenity', 'animal_shelter') + if should_replace: + assert not check_table_exist(temp_db_conn, 'wrong_class', 'wrong_type') + + assert temp_db_conn.table_exists('place_classtype_amenity_animal_shelter') + if should_replace: + assert not temp_db_conn.table_exists('place_classtype_wrongclass_wrongtype') + +def check_table_exist(temp_db_conn, phrase_class, phrase_type): + """ + Verify that the place_classtype table exists for the given + phrase_class and phrase_type. + """ + return temp_db_conn.table_exists('place_classtype_{}_{}'.format(phrase_class, phrase_type)) + + +def check_grant_access(temp_db_conn, user, phrase_class, phrase_type): + """ + Check that the web user has been granted right access to the + place_classtype table of the given phrase_class and phrase_type. + """ + table_name = 'place_classtype_{}_{}'.format(phrase_class, phrase_type) + + with temp_db_conn.cursor() as temp_db_cursor: + temp_db_cursor.execute(""" + SELECT * FROM information_schema.role_table_grants + WHERE table_name='{}' + AND grantee='{}' + AND privilege_type='SELECT'""".format(table_name, user)) + return temp_db_cursor.fetchone() + +def check_placeid_and_centroid_indexes(temp_db_conn, phrase_class, phrase_type): + """ + Check that the place_id index and centroid index exist for the + place_classtype table of the given phrase_class and phrase_type. + """ + index_prefix = 'idx_place_classtype_{}_{}_'.format(phrase_class, phrase_type) + + return ( + temp_db_conn.index_exists(index_prefix + 'centroid') + and + temp_db_conn.index_exists(index_prefix + 'place_id') + )