raise issue if the found entity is retired

Author: kena-SL

digital_land/phase/lookup.py

@@ -212,7 +212,16 @@ def process(self, stream):
                                 organisation=row.get("organisation", ""),
                                 reference=row.get(linked_dataset, ""),
                             )
-                            if not find_entity:
+                            # raise issue if the found entity is retired in old-entity.csv
+                            if not find_entity or (
+                                str(find_entity) in self.redirect_lookups
+                                and int(
+                                    self.redirect_lookups[str(find_entity)].get(
+                                        "status", 0
+                                    )
+                                )
+                                == 410
+                            ):
                                 self.issues.log_issue(
                                     linked_dataset,
                                     "no associated documents found for this area",

tests/unit/phase/test_lookup.py

@@ -20,6 +20,22 @@ def get_input_stream():
     ]
 
 
+@pytest.fixture
+def get_input_stream_with_linked_field():
+    return [
+        {
+            "row": {
+                "prefix": "article-4-direction-area",
+                "reference": "1",
+                "organisation": "local-authority:ABC",
+                "article-4-direction": "a4d2",
+            },
+            "entry-number": 1,
+            "line-number": 2,
+        }
+    ]
+
+
 @pytest.fixture
 def get_lookup():
     return {",dataset,1,test": "1"}
@@ -124,19 +140,10 @@ def test_process_empty_prefix(self, get_lookup):
 
         assert output[0]["row"]["entity"] == "10"
 
-    def test_no_associated_documents_issue(self, mocker):
-        input_stream = [
-            {
-                "row": {
-                    "prefix": "article-4-direction-area",
-                    "reference": "1",
-                    "organisation": "local-authority:ABC",
-                    "article-4-direction": "a4d2",
-                },
-                "entry-number": 1,
-                "line-number": 2,
-            }
-        ]
+    def test_no_associated_documents_issue(
+        self, get_input_stream_with_linked_field, mocker
+    ):
+        input_stream = get_input_stream_with_linked_field
 
         lookups = {
             ",article-4-direction,a4d1,local-authorityabc": "1",
@@ -157,19 +164,10 @@ def test_no_associated_documents_issue(self, mocker):
         )
         assert issues.rows[0]["value"] == "a4d2"
 
-    def test_no_associated_documents_issue_for_missing_dataset(self, mocker):
-        input_stream = [
-            {
-                "row": {
-                    "prefix": "article-4-direction-area",
-                    "reference": "1",
-                    "organisation": "local-authority:ABC",
-                    "article-4-direction": "a4d2",
-                },
-                "entry-number": 1,
-                "line-number": 2,
-            }
-        ]
+    def test_no_associated_documents_issue_for_missing_dataset(
+        self, get_input_stream_with_linked_field, mocker
+    ):
+        input_stream = get_input_stream_with_linked_field
 
         lookups = {
             ",article-4-direction,a4d1,local-authorityabc": "1",
@@ -186,6 +184,33 @@ def test_no_associated_documents_issue_for_missing_dataset(self, mocker):
         assert output[0]["row"]["entity"] == "2"
         assert len(issues.rows) == 0
 
+    def test_no_associated_documents_issue_for_retired_entity(
+        self, get_input_stream_with_linked_field, mocker
+    ):
+        input_stream = get_input_stream_with_linked_field
+
+        lookups = {
+            ",article-4-direction,a4d2,local-authorityabc": "1",
+            ",article-4-direction-area,1,local-authorityabc": "2",
+        }
+        issues = IssueLog()
+        redirect_lookups = {"1": {"entity": "", "status": "410"}}
+
+        phase = LookupPhase(
+            lookups=lookups, redirect_lookups=redirect_lookups, issue_log=issues
+        )
+        phase.entity_field = "entity"
+        mock_df = pd.DataFrame({"organisation": ["local-authority:ABC"]})
+        mocker.patch("pandas.read_csv", return_value=mock_df)
+        output = [block for block in phase.process(input_stream)]
+
+        assert output[0]["row"]["entity"] == "2"
+        assert (
+            issues.rows[0]["issue-type"]
+            == "no associated documents found for this area"
+        )
+        assert issues.rows[0]["value"] == "a4d2"
+
 
 class TestPrintLookupPhase:
     def test_process_does_not_produce_new_lookup(self, get_input_stream, get_lookup):