Merge pull request #2228 from AntoJvlt/import-special-phrases-porting-python

Import special phrases porting python

test/python/conftest.py

@@ -5,6 +5,7 @@ from pathlib import Path
 import psycopg2
 import psycopg2.extras
 import pytest
+import tempfile
 
 SRC_DIR = Path(__file__) / '..' / '..' / '..'
 
@@ -133,6 +134,13 @@ def def_config():
 def src_dir():
     return SRC_DIR.resolve()
 
+@pytest.fixture
+def tmp_phplib_dir():
+    with tempfile.TemporaryDirectory() as phpdir:
+        (Path(phpdir) / 'admin').mkdir()
+
+        yield Path(phpdir)
+
 @pytest.fixture
 def status_table(temp_db_conn):
     """ Create an empty version of the status table and

test/python/test_cli.py

@@ -64,7 +64,6 @@ def test_cli_help(capsys):
 
 
 @pytest.mark.parametrize("command,script", [
-                         (('special-phrases',), 'specialphrases'),
                          (('add-data', '--file', 'foo.osm'), 'update'),
                          (('export',), 'export')
                          ])
@@ -172,6 +171,12 @@ def test_index_command(mock_func_factory, temp_db_cursor, params, do_bnds, do_ra
     assert bnd_mock.called == do_bnds
     assert rank_mock.called == do_ranks
 
+def test_special_phrases_command(temp_db, mock_func_factory):
+    func = mock_func_factory(nominatim.clicmd.special_phrases.SpecialPhrasesImporter, 'import_from_wiki')
+
+    call_nominatim('special-phrases', '--import-from-wiki')
+
+    assert func.called == 1
 
 @pytest.mark.parametrize("command,func", [
                          ('postcodes', 'update_postcodes'),

test/python/test_tools_exec_utils.py

@@ -9,13 +9,6 @@ import pytest
 
 import nominatim.tools.exec_utils as exec_utils
 
-@pytest.fixture
-def tmp_phplib_dir():
-    with tempfile.TemporaryDirectory() as phpdir:
-        (Path(phpdir) / 'admin').mkdir()
-
-        yield Path(phpdir)
-
 @pytest.fixture
 def nominatim_env(tmp_phplib_dir, def_config):
     class _NominatimEnv:

test/python/test_tools_import_special_phrases.py

@@ -0,0 +1,346 @@
+"""
+    Tests for import special phrases methods
+    of the class SpecialPhrasesImporter.
+"""
+from nominatim.errors import UsageError
+from pathlib import Path
+import tempfile
+from shutil import copyfile
+import pytest
+from nominatim.tools.special_phrases import SpecialPhrasesImporter
+
+TEST_BASE_DIR = Path(__file__) / '..' / '..'
+
+def test_check_sanity_class(special_phrases_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.
+    """
+    with pytest.raises(UsageError) as wrong_class:
+        special_phrases_importer._check_sanity('en', '', 'type')
+    
+    with pytest.raises(UsageError) as wrong_type:
+        special_phrases_importer._check_sanity('en', 'class', '')
+
+    special_phrases_importer._check_sanity('en', 'class', 'type')
+
+    assert wrong_class and wrong_type
+
+def test_load_white_and_black_lists(special_phrases_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 = special_phrases_importer._load_white_and_black_lists()
+
+    assert isinstance(black_list, dict) and isinstance(white_list, dict)
+
+def test_convert_php_settings(special_phrases_importer):
+    """
+        Test that _convert_php_settings_if_needed() convert the given
+        php file to a json file.
+    """
+    php_file = (TEST_BASE_DIR / 'testfiles' / 'phrase_settings.php').resolve()
+
+    with tempfile.TemporaryDirectory() as temp_dir:
+        temp_settings = (Path(temp_dir) / 'phrase_settings.php').resolve()
+        copyfile(php_file, temp_settings)
+        special_phrases_importer._convert_php_settings_if_needed(temp_settings)
+
+        assert (Path(temp_dir) / 'phrase_settings.json').is_file()
+
+def test_convert_settings_wrong_file(special_phrases_importer):
+    """
+        Test that _convert_php_settings_if_needed() raise an exception
+        if the given file is not a valid file.
+    """
+
+    with pytest.raises(UsageError) as exceptioninfos:
+        special_phrases_importer._convert_php_settings_if_needed('random_file')
+
+    assert str(exceptioninfos.value) == 'random_file is not a valid file.'
+
+def test_convert_settings_json_already_exist(special_phrases_importer):
+    """
+        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 = (TEST_BASE_DIR / 'testfiles' / 'phrase_settings.php').resolve()
+    json_file = (TEST_BASE_DIR / 'testfiles' / 'phrase_settings.json').resolve()
+
+    returned = special_phrases_importer._convert_php_settings_if_needed(php_file)
+
+    assert returned == json_file
+
+def test_convert_settings_giving_json(special_phrases_importer):
+    """
+        Test that if we give to '_convert_php_settings_if_needed' a json file path
+        the same path is directly returned
+    """
+    json_file = (TEST_BASE_DIR / 'testfiles' / 'phrase-settings.json').resolve()
+    
+    returned = special_phrases_importer._convert_php_settings_if_needed(json_file)
+
+    assert returned == json_file
+
+def test_process_amenity_with_operator(special_phrases_importer, getorcreate_amenityoperator_funcs,
+                                       word_table, temp_db_conn):
+    """
+        Test that _process_amenity() execute well the 
+        getorcreate_amenityoperator() SQL function and that
+        the 2 differents operators are well handled.
+    """
+    special_phrases_importer._process_amenity('', '', '', '', 'near')
+    special_phrases_importer._process_amenity('', '', '', '', 'in')
+
+    with temp_db_conn.cursor() as temp_db_cursor:
+        temp_db_cursor.execute("SELECT * FROM temp_with_operator WHERE op='near' OR op='in'")
+        results = temp_db_cursor.fetchall()
+
+    assert len(results) == 2
+
+def test_process_amenity_without_operator(special_phrases_importer, getorcreate_amenity_funcs,
+                                          temp_db_conn):
+    """
+        Test that _process_amenity() execute well the
+        getorcreate_amenity() SQL function.
+    """
+    special_phrases_importer._process_amenity('', '', '', '', '')
+
+    with temp_db_conn.cursor() as temp_db_cursor:
+        temp_db_cursor.execute("SELECT * FROM temp_without_operator WHERE op='no_operator'")
+        result = temp_db_cursor.fetchone()
+
+    assert result
+
+def test_create_place_classtype_indexes(temp_db_conn, special_phrases_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)
+
+    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)
+
+    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):
+    """
+        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)
+
+    assert check_table_exist(temp_db_conn, phrase_class, phrase_type)
+
+def test_grant_access_to_web_user(temp_db_conn, def_config, special_phrases_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))
+
+    special_phrases_importer._grant_access_to_webuser(phrase_class, phrase_type)
+
+    assert check_grant_access(temp_db_conn, def_config.DATABASE_WEBUSER, phrase_class, phrase_type)
+
+def test_create_place_classtype_table_and_indexes(
+        temp_db_conn, def_config, placex_table, getorcreate_amenity_funcs,
+        getorcreate_amenityoperator_funcs, special_phrases_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)
+
+    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 test_process_xml_content(temp_db_conn, def_config, special_phrases_importer, 
+                             getorcreate_amenity_funcs, getorcreate_amenityoperator_funcs):
+    """
+        Test that _process_xml_content() process the given xml content right
+        by executing the right SQL functions for amenities and 
+        by returning the right set of pairs.
+    """
+    class_test = 'aerialway'
+    type_test = 'zip_line'
+
+    #Converted output set to a dict for easy assert further.
+    results = dict(special_phrases_importer._process_xml_content(get_test_xml_wiki_content(), 'en'))
+
+    assert check_amenities_with_op(temp_db_conn)
+    assert check_amenities_without_op(temp_db_conn)
+    assert results[class_test] and type_test in results.values()
+
+def test_import_from_wiki(monkeypatch, temp_db_conn, def_config, special_phrases_importer, placex_table, 
+                          getorcreate_amenity_funcs, getorcreate_amenityoperator_funcs):
+    """
+        Check that the main import_from_wiki() 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.
+    """
+    monkeypatch.setattr('nominatim.tools.special_phrases.SpecialPhrasesImporter._get_wiki_content', mock_get_wiki_content)
+    special_phrases_importer.import_from_wiki(['en'])
+
+    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_amenities_with_op(temp_db_conn)
+    assert check_amenities_without_op(temp_db_conn)
+
+def mock_get_wiki_content(lang):
+    """
+        Mock the _get_wiki_content() method to return
+        static xml test file content.
+    """
+    return get_test_xml_wiki_content()
+
+def get_test_xml_wiki_content():
+    """
+        return the content of the static xml test file.
+    """
+    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()
+
+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.
+    """
+    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.tables
+            WHERE table_type='BASE TABLE'
+            AND table_name='{}'""".format(table_name))
+        return temp_db_cursor.fetchone()
+
+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')
+    )
+
+def check_amenities_with_op(temp_db_conn):
+    """
+        Check that the test table for the SQL function getorcreate_amenityoperator()
+        contains more than one value (so that the SQL function was call more than one time).
+    """
+    with temp_db_conn.cursor() as temp_db_cursor:
+        temp_db_cursor.execute("SELECT * FROM temp_with_operator")
+        return len(temp_db_cursor.fetchall()) > 1
+
+def check_amenities_without_op(temp_db_conn):
+    """
+        Check that the test table for the SQL function getorcreate_amenity()
+        contains more than one value (so that the SQL function was call more than one time).
+    """
+    with temp_db_conn.cursor() as temp_db_cursor:
+        temp_db_cursor.execute("SELECT * FROM temp_without_operator")
+        return len(temp_db_cursor.fetchall()) > 1
+
+@pytest.fixture
+def special_phrases_importer(temp_db_conn, def_config, temp_phplib_dir_with_migration):
+    """
+        Return an instance of SpecialPhrasesImporter.
+    """
+    return SpecialPhrasesImporter(def_config, temp_phplib_dir_with_migration, temp_db_conn)
+
+@pytest.fixture
+def temp_phplib_dir_with_migration():
+    """
+        Return temporary phpdir with migration subdirectory and
+        PhraseSettingsToJson.php script inside.
+    """
+    migration_file = (TEST_BASE_DIR / '..' / 'lib-php' / 'migration'
+                      / 'PhraseSettingsToJson.php').resolve()
+    with tempfile.TemporaryDirectory() as phpdir:
+        (Path(phpdir) / 'migration').mkdir()
+        migration_dest_path = (Path(phpdir) / 'migration' / 'PhraseSettingsToJson.php').resolve()
+        copyfile(migration_file, migration_dest_path)
+
+        yield Path(phpdir)
+
+@pytest.fixture
+def make_strandard_name_func(temp_db_cursor):
+    temp_db_cursor.execute("""
+        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("""
+        CREATE TABLE temp_without_operator(op TEXT);
+    
+        CREATE OR REPLACE FUNCTION getorcreate_amenity(lookup_word TEXT, normalized_word TEXT,
+                                                    lookup_class text, lookup_type text)
+        RETURNS void as $$
+        BEGIN
+            INSERT INTO temp_without_operator VALUES('no_operator');
+        END;
+        $$ LANGUAGE plpgsql""")
+
+@pytest.fixture
+def getorcreate_amenityoperator_funcs(temp_db_cursor, make_strandard_name_func):
+    temp_db_cursor.execute("""
+        CREATE TABLE temp_with_operator(op TEXT);
+
+        CREATE OR REPLACE FUNCTION getorcreate_amenityoperator(lookup_word TEXT, normalized_word TEXT,
+                                                    lookup_class text, lookup_type text, op text)
+        RETURNS void as $$
+        BEGIN 
+            INSERT INTO temp_with_operator VALUES(op);
+        END;
+        $$ LANGUAGE plpgsql""")

test/testdata/special_phrases_test_content.txt

@@ -0,0 +1,78 @@
+<mediawiki xsi:schemaLocation="http://www.mediawiki.org/xml/export-0.11/ http://www.mediawiki.org/xml/export-0.11.xsd" version="0.11" xml:lang="en">
+<siteinfo>
+<sitename>OpenStreetMap Wiki</sitename>
+<dbname>wiki</dbname>
+<base>https://wiki.openstreetmap.org/wiki/Main_Page</base>
+<generator>MediaWiki 1.35.1</generator>
+<case>first-letter</case>
+<namespaces>
+<namespace key="-2" case="first-letter">Media</namespace>
+<namespace key="-1" case="first-letter">Special</namespace>
+<namespace key="0" case="first-letter"/>
+<namespace key="1" case="first-letter">Talk</namespace>
+<namespace key="2" case="first-letter">User</namespace>
+<namespace key="3" case="first-letter">User talk</namespace>
+<namespace key="4" case="first-letter">Wiki</namespace>
+<namespace key="5" case="first-letter">Wiki talk</namespace>
+<namespace key="6" case="first-letter">File</namespace>
+<namespace key="7" case="first-letter">File talk</namespace>
+<namespace key="8" case="first-letter">MediaWiki</namespace>
+<namespace key="9" case="first-letter">MediaWiki talk</namespace>
+<namespace key="10" case="first-letter">Template</namespace>
+<namespace key="11" case="first-letter">Template talk</namespace>
+<namespace key="12" case="first-letter">Help</namespace>
+<namespace key="13" case="first-letter">Help talk</namespace>
+<namespace key="14" case="first-letter">Category</namespace>
+<namespace key="15" case="first-letter">Category talk</namespace>
+<namespace key="120" case="first-letter">Item</namespace>
+<namespace key="121" case="first-letter">Item talk</namespace>
+<namespace key="122" case="first-letter">Property</namespace>
+<namespace key="123" case="first-letter">Property talk</namespace>
+<namespace key="200" case="first-letter">DE</namespace>
+<namespace key="201" case="first-letter">DE talk</namespace>
+<namespace key="202" case="first-letter">FR</namespace>
+<namespace key="203" case="first-letter">FR talk</namespace>
+<namespace key="204" case="first-letter">ES</namespace>
+<namespace key="205" case="first-letter">ES talk</namespace>
+<namespace key="206" case="first-letter">IT</namespace>
+<namespace key="207" case="first-letter">IT talk</namespace>
+<namespace key="208" case="first-letter">NL</namespace>
+<namespace key="209" case="first-letter">NL talk</namespace>
+<namespace key="210" case="first-letter">RU</namespace>
+<namespace key="211" case="first-letter">RU talk</namespace>
+<namespace key="212" case="first-letter">JA</namespace>
+<namespace key="213" case="first-letter">JA talk</namespace>
+<namespace key="710" case="first-letter">TimedText</namespace>
+<namespace key="711" case="first-letter">TimedText talk</namespace>
+<namespace key="828" case="first-letter">Module</namespace>
+<namespace key="829" case="first-letter">Module talk</namespace>
+<namespace key="2300" case="first-letter">Gadget</namespace>
+<namespace key="2301" case="first-letter">Gadget talk</namespace>
+<namespace key="2302" case="case-sensitive">Gadget definition</namespace>
+<namespace key="2303" case="case-sensitive">Gadget definition talk</namespace>
+</namespaces>
+</siteinfo>
+<page>
+<title>Nominatim/Special Phrases/EN</title>
+<ns>0</ns>
+<id>67365</id>
+<revision>
+<id>2100424</id>
+<parentid>2100422</parentid>
+<timestamp>2021-01-27T20:29:53Z</timestamp>
+<contributor>
+<username>Violaine Do</username>
+<id>88152</id>
+</contributor>
+<minor/>
+<comment>/* en */ add coworking amenity</comment>
+<origin>2100424</origin>
+<model>wikitext</model>
+<format>text/x-wiki</format>
+<text bytes="158218" sha1="cst5x7tt58izti1pxzgljf27tx8qjcj" xml:space="preserve">
+== en == {| class="wikitable sortable" |- ! Word / Phrase !! Key !! Value !! Operator !! Plural |- | Zip Line || aerialway || zip_line || - || N |- | Zip Lines || aerialway || zip_line || - || Y |- | Zip Line in || aerialway || zip_line || in || N |- | Zip Lines in || aerialway || zip_line || in || Y |- | Zip Line near || aerialway || zip_line || near || N |- | Zip Lines near || aerialway || zip_line || near || Y |- | Zip Wire || aerialway || zip_line || - || N |- | Zip Wires || aerialway || zip_line || - || Y |- | Zip Wire in || aerialway || zip_line || in || N |- | Zip Wires in || aerialway || zip_line || in || Y |- | Zip Wire near || aerialway || zip_line || near || N |} [[Category:Word list]]
+</text>
+<sha1>cst5x7tt58izti1pxzgljf27tx8qjcj</sha1>
+</revision>
+</page>
+</mediawiki>

test/testfiles/phrase_settings.php

@@ -0,0 +1,20 @@
+<?php
+
+// These settings control the import of special phrases from the wiki.
+
+// class/type combinations to exclude
+$aTagsBlacklist
+ = array(
+    'boundary' => array('administrative'),
+    'place' => array('house', 'houses'),
+   );
+
+// If a class is in the white list then all types will
+// be ignored except the ones given in the list.
+// Also use this list to exclude an entire class from
+// special phrases.
+$aTagsWhitelist
+ = array(
+    'highway' => array('bus_stop', 'rest_area', 'raceway'),
+    'building' => array(),
+   );