|
| 1 | +######################################################################### |
| 2 | +# |
| 3 | +# Copyright (C) 2024 OSGeo |
| 4 | +# |
| 5 | +# This program is free software: you can redistribute it and/or modify |
| 6 | +# it under the terms of the GNU General Public License as published by |
| 7 | +# the Free Software Foundation, either version 3 of the License, or |
| 8 | +# (at your option) any later version. |
| 9 | +# |
| 10 | +# This program is distributed in the hope that it will be useful, |
| 11 | +# but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 | +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 13 | +# GNU General Public License for more details. |
| 14 | +# |
| 15 | +# You should have received a copy of the GNU General Public License |
| 16 | +# along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 17 | +# |
| 18 | +######################################################################### |
| 19 | + |
| 20 | +import os |
| 21 | +import logging |
| 22 | +from types import SimpleNamespace |
| 23 | + |
| 24 | +from unittest.mock import patch, MagicMock |
| 25 | + |
| 26 | +from django.test import override_settings |
| 27 | + |
| 28 | +from geonode.base.models import ResourceBase |
| 29 | +from geonode.metadata.handlers.multilang import MultiLangHandler |
| 30 | +from geonode.metadata.handlers.sparse import SparseHandler, SparseFieldRegistry |
| 31 | +from geonode.metadata.manager import MetadataManager |
| 32 | +from geonode.metadata.multilang import utils as multi |
| 33 | +from geonode.metadata.tests.handlers import FakeHandler, LoaderHandler |
| 34 | + |
| 35 | +from geonode.tests.base import GeoNodeBaseTestSupport |
| 36 | + |
| 37 | + |
| 38 | +logger = logging.getLogger(__name__) |
| 39 | + |
| 40 | + |
| 41 | +class MetadataMultilangTests(GeoNodeBaseTestSupport): |
| 42 | + |
| 43 | + def setUp(self): |
| 44 | + pass |
| 45 | + |
| 46 | + def tearDown(self): |
| 47 | + super().tearDown() |
| 48 | + |
| 49 | + def create_metadata_manager(self): |
| 50 | + sr = SparseFieldRegistry() |
| 51 | + mm = MetadataManager() |
| 52 | + mm.handlers = { |
| 53 | + # "base": BaseHandler(), |
| 54 | + "loader": LoaderHandler(schemafile=os.path.join(os.path.dirname(__file__), "data/minimal_schema.json")), |
| 55 | + "fake": FakeHandler(), |
| 56 | + "sparse": SparseHandler(registry=sr), |
| 57 | + "multilang": MultiLangHandler(registry=sr), |
| 58 | + } |
| 59 | + mm.post_init() |
| 60 | + return mm, sr |
| 61 | + |
| 62 | + def test_schema_add_language(self): |
| 63 | + """ |
| 64 | + The MultiLang handler should create one field for each language for each field declared as multilang |
| 65 | + """ |
| 66 | + |
| 67 | + with(override_settings( |
| 68 | + LANGUAGES=[("en", "English"), ("it", "Italiano")], |
| 69 | + MULTILANG_FIELDS=()) |
| 70 | + ): |
| 71 | + mm, sr = self.create_metadata_manager() |
| 72 | + schema = mm.build_schema() |
| 73 | + start_len = len(schema["properties"]) |
| 74 | + |
| 75 | + self.assertIn("title", schema["properties"]) |
| 76 | + self.assertEqual(0, len(sr.fields()), f"Unexpected sparse fields found: {sr.fields()}") |
| 77 | + |
| 78 | + with(override_settings( |
| 79 | + LANGUAGES=[("en", "English"), ("it", "Italiano")], |
| 80 | + MULTILANG_FIELDS=["title"]) |
| 81 | + ): |
| 82 | + mm, sr = self.create_metadata_manager() |
| 83 | + schema = mm.build_schema() |
| 84 | + |
| 85 | + self.assertEqual(2, len(sr.fields()), "Bad set of sparse fields found") |
| 86 | + self.assertEqual(start_len + 2, len(schema["properties"]), "Bad number of properties in schema") |
| 87 | + self.assertIn(multi.get_multilang_field_name("title", "en"), schema["properties"], "Multilang field not found") |
| 88 | + |
| 89 | + def test_bad_field(self): |
| 90 | + """ |
| 91 | + Only text fields should be declared as multilang |
| 92 | + """ |
| 93 | + with(override_settings( |
| 94 | + LANGUAGES=[("en", "English"), ("it", "Italiano")], |
| 95 | + MULTILANG_FIELDS=["license"]) |
| 96 | + ): |
| 97 | + try: |
| 98 | + mm, _ = self.create_metadata_manager() |
| 99 | + mm.build_schema() |
| 100 | + self.fail("Non multilang-able field not detected") |
| 101 | + except ValueError as e : |
| 102 | + logger.info(f"Bad multilang field properly caught: {e}") |
| 103 | + |
| 104 | + def test_unexisting_field(self): |
| 105 | + """ |
| 106 | + Test field existence on declaration of multilang field |
| 107 | + """ |
| 108 | + with(override_settings( |
| 109 | + LANGUAGES=[("en", "English"), ("it", "Italiano")], |
| 110 | + MULTILANG_FIELDS=["does_not_exists"]) |
| 111 | + ): |
| 112 | + try: |
| 113 | + mm, _ = self.create_metadata_manager() |
| 114 | + mm.build_schema() |
| 115 | + self.fail("Missing field not detected") |
| 116 | + except KeyError as e : |
| 117 | + logger.info(f"Missing field properly caught: {e}") |
| 118 | + |
| 119 | + def test_default_preserialization(self): |
| 120 | + """ |
| 121 | + Check that if a multilang field is not populated but the main field is, |
| 122 | + the main field value is copied into the multilang field of the default language |
| 123 | + """ |
| 124 | + with(override_settings( |
| 125 | + LANGUAGE_CODE="it", |
| 126 | + LANGUAGES=[("en", "English"), ("it", "Italiano")], |
| 127 | + MULTILANG_FIELDS=["title"]) |
| 128 | + ): |
| 129 | + mm, _ = self.create_metadata_manager() |
| 130 | + schema = mm.get_schema() |
| 131 | + instance = mm.build_schema_instance(None) |
| 132 | + # logger.info(f"INSTANCE {instance}") |
| 133 | + self.assertEqual("title_fake", instance["title"]) |
| 134 | + self.assertEqual("title_fake", instance["title_multilang_it"]) |
| 135 | + self.assertIsNone(instance["title_multilang_en"]) |
| 136 | + |
| 137 | + @patch("geonode.base.models.ResourceBase.get_real_instance_class") |
| 138 | + @patch("geonode.indexing.manager.TSVectorIndexManager.update_index") |
| 139 | + @patch("geonode.metadata.handlers.sparse.SparseHandler.update_resource") |
| 140 | + def test_default_base_value(self, mock_get_real_instance_class, mock_update_index, mock_sparse_update): |
| 141 | + """ |
| 142 | + The value in the default language of the multilang field should go in the base field whan saving |
| 143 | + """ |
| 144 | + with(override_settings( |
| 145 | + LANGUAGE_CODE="it", |
| 146 | + LANGUAGES=[("en", "English"), ("it", "Italiano")], |
| 147 | + MULTILANG_FIELDS=["title"]) |
| 148 | + ): |
| 149 | + mm, _ = self.create_metadata_manager() |
| 150 | + instance = { |
| 151 | + 'title': 'whatever', |
| 152 | + 'title_multilang_it': 'title_it', |
| 153 | + 'title_multilang_en': None, |
| 154 | + 'abstract': 'abstract_fake', |
| 155 | + 'license': 'license_fake' |
| 156 | + } |
| 157 | + |
| 158 | + resource = ResourceBase() |
| 159 | + fake_req = SimpleNamespace(data=instance, user=None) |
| 160 | + mm.update_schema_instance(resource, fake_req) |
| 161 | + logger.info(f"INSTANCE POST {instance}") |
| 162 | + |
| 163 | + self.assertEqual("title_it", instance["title"]) |
0 commit comments