test/python/tools/test_admin.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) 2026 by the Nominatim developer community.
   6 # For a full list of authors see the git log.
   7 """
   8 Tests for maintenance and analysis functions.
   9 """
  10 import pytest
  11
  12 from nominatim_db.errors import UsageError
  13 from nominatim_db.tools import admin
  14 from nominatim_db.tokenizer import factory
  15 from nominatim_db.db.sql_preprocessor import SQLPreprocessor
  16
  17
  18 @pytest.fixture(autouse=True)
  19 def create_placex_table(project_env, tokenizer_mock, temp_db_cursor, placex_table):
  20     """ All tests in this module require the placex table to be set up.
  21     """
  22     temp_db_cursor.execute("DROP TYPE IF EXISTS prepare_update_info CASCADE")
  23     temp_db_cursor.execute("""CREATE TYPE prepare_update_info AS (
  24                              name HSTORE,
  25                              address HSTORE,
  26                              rank_address SMALLINT,
  27                              country_code TEXT,
  28                              class TEXT,
  29                              type TEXT,
  30                              linked_place_id BIGINT
  31                            )""")
  32     temp_db_cursor.execute("""CREATE OR REPLACE FUNCTION placex_indexing_prepare(p placex,
  33                                                      OUT result prepare_update_info)
  34                            AS $$
  35                            BEGIN
  36                              result.address := p.address;
  37                              result.name := p.name;
  38                              result.class := p.class;
  39                              result.type := p.type;
  40                              result.country_code := p.country_code;
  41                              result.rank_address := p.rank_address;
  42                            END;
  43                            $$ LANGUAGE plpgsql STABLE;
  44                         """)
  45     factory.create_tokenizer(project_env)
  46
  47
  48 def test_analyse_indexing_no_objects(project_env):
  49     with pytest.raises(UsageError):
  50         admin.analyse_indexing(project_env)
  51
  52
  53 @pytest.mark.parametrize("oid", ['1234', 'N123a', 'X123'])
  54 def test_analyse_indexing_bad_osmid(project_env, oid):
  55     with pytest.raises(UsageError):
  56         admin.analyse_indexing(project_env, osm_id=oid)
  57
  58
  59 def test_analyse_indexing_unknown_osmid(project_env):
  60     with pytest.raises(UsageError):
  61         admin.analyse_indexing(project_env, osm_id='W12345674')
  62
  63
  64 def test_analyse_indexing_with_place_id(project_env, temp_db_cursor):
  65     temp_db_cursor.execute("INSERT INTO placex (place_id) VALUES(12345)")
  66
  67     admin.analyse_indexing(project_env, place_id=12345)
  68
  69
  70 def test_analyse_indexing_with_osm_id(project_env, temp_db_cursor):
  71     temp_db_cursor.execute("""INSERT INTO placex (place_id, osm_type, osm_id)
  72                               VALUES(9988, 'N', 10000)""")
  73
  74     admin.analyse_indexing(project_env, osm_id='N10000')
  75
  76
  77 class TestAdminCleanDeleted:
  78
  79     @pytest.fixture(autouse=True)
  80     def setup_polygon_delete(self, project_env, table_factory, country_table, place_table,
  81                              osmline_table, temp_db_cursor, temp_db_conn, def_config, src_dir):
  82         """ Set up place_force_delete function and related tables
  83         """
  84         self.project_env = project_env
  85         self.temp_db_cursor = temp_db_cursor
  86         table_factory('import_polygon_delete',
  87                       """osm_id BIGINT,
  88                       osm_type CHAR(1),
  89                       class TEXT NOT NULL,
  90                       type TEXT NOT NULL""",
  91                       ((100, 'N', 'boundary', 'administrative'),
  92                        (145, 'N', 'boundary', 'administrative'),
  93                        (175, 'R', 'landcover', 'grass')))
  94         temp_db_cursor.execute("""
  95             INSERT INTO placex (place_id, osm_id, osm_type, class, type,
  96                                 indexed_date, indexed_status)
  97             VALUES(1, 100, 'N', 'boundary', 'administrative', current_date - INTERVAL '1 month', 1),
  98                   (2, 145, 'N', 'boundary', 'administrative', current_date - INTERVAL '3 month', 1),
  99                   (3, 175, 'R', 'landcover', 'grass', current_date - INTERVAL '3 months', 1)""")
 100         # set up tables and triggers for utils function
 101         table_factory('place_to_be_deleted',
 102                       """osm_id BIGINT,
 103                       osm_type CHAR(1),
 104                       class TEXT NOT NULL,
 105                       type TEXT NOT NULL,
 106                       deferred BOOLEAN""")
 107         table_factory('import_polygon_error', """osm_id BIGINT,
 108                       osm_type CHAR(1),
 109                       class TEXT NOT NULL,
 110                       type TEXT NOT NULL""")
 111         temp_db_cursor.execute("""CREATE OR REPLACE FUNCTION place_delete()
 112                                RETURNS TRIGGER AS $$
 113                                BEGIN RETURN NULL; END;
 114                                $$ LANGUAGE plpgsql;""")
 115         temp_db_cursor.execute("""CREATE TRIGGER place_before_delete BEFORE DELETE ON place
 116                                FOR EACH ROW EXECUTE PROCEDURE place_delete();""")
 117         orig_sql = def_config.lib_dir.sql
 118         def_config.lib_dir.sql = src_dir / 'lib-sql'
 119         sqlproc = SQLPreprocessor(temp_db_conn, def_config)
 120         sqlproc.run_sql_file(temp_db_conn, 'functions/utils.sql')
 121         def_config.lib_dir.sql = orig_sql
 122
 123     def test_admin_clean_deleted_no_records(self):
 124         admin.clean_deleted_relations(self.project_env, age='1 year')
 125
 126         rowset = self.temp_db_cursor.row_set(
 127             'SELECT osm_id, osm_type, class, type, indexed_status FROM placex')
 128
 129         assert rowset == {(100, 'N', 'boundary', 'administrative', 1),
 130                           (145, 'N', 'boundary', 'administrative', 1),
 131                           (175, 'R', 'landcover', 'grass', 1)}
 132         assert self.temp_db_cursor.table_rows('import_polygon_delete') == 3
 133
 134     @pytest.mark.parametrize('test_age', ['T week', '1 welk', 'P1E'])
 135     def test_admin_clean_deleted_bad_age(self, test_age):
 136         with pytest.raises(UsageError):
 137             admin.clean_deleted_relations(self.project_env, age=test_age)
 138
 139     def test_admin_clean_deleted_partial(self):
 140         admin.clean_deleted_relations(self.project_env, age='2 months')
 141
 142         rowset = self.temp_db_cursor.row_set(
 143             'SELECT osm_id, osm_type, class, type, indexed_status FROM placex')
 144
 145         assert rowset == {(100, 'N', 'boundary', 'administrative', 1),
 146                           (145, 'N', 'boundary', 'administrative', 100),
 147                           (175, 'R', 'landcover', 'grass', 100)}
 148         assert self.temp_db_cursor.table_rows('import_polygon_delete') == 1
 149
 150     @pytest.mark.parametrize('test_age', ['1 week', 'P3D', '5 hours'])
 151     def test_admin_clean_deleted(self, test_age):
 152         admin.clean_deleted_relations(self.project_env, age=test_age)
 153
 154         rowset = self.temp_db_cursor.row_set(
 155             'SELECT osm_id, osm_type, class, type, indexed_status FROM placex')
 156
 157         assert rowset == {(100, 'N', 'boundary', 'administrative', 100),
 158                           (145, 'N', 'boundary', 'administrative', 100),
 159                           (175, 'R', 'landcover', 'grass', 100)}
 160         assert self.temp_db_cursor.table_rows('import_polygon_delete') == 0