Bug Fix: Historical Entity Filtering Bug (#304)

* bug fix: updated period filtering logic

* updated test cases

* unit tests moved to the integration tests

Author: feba-rajan

application/data_access/entity_queries.py

@@ -331,7 +331,7 @@ def _apply_period_option_filter(query, params):
         )
     elif PeriodOption.historical in options:
         return query.filter(
-            or_(EntityOrm.end_date.is_not(None), EntityOrm.end_date < func.now())
+            and_(EntityOrm.end_date.is_not(None), EntityOrm.end_date < func.now())
         )
 
 

tests/integration/test_entity_queries.py

@@ -1,4 +1,7 @@
+from datetime import datetime
+import pytest
 from application.data_access.entity_queries import lookup_entity_link
+from application.data_access.entity_queries import _apply_period_option_filter
 from application.db.models import EntityOrm
 
 
@@ -39,3 +42,81 @@ def test__lookup_entity_link_returns_the_looked_up_entity_when_the_link_exists(
     assert linked_entity["typology"] == lookup_entity["typology"]
     assert linked_entity["name"] == lookup_entity["name"]
     assert linked_entity["reference"] == lookup_entity["reference"]
+
+
+@pytest.mark.parametrize("period", [["current"], ["historical"], ["all"]])
+def test_apply_period_option_filter(db_session, period):
+    entities = [
+        {
+            "entry_date": "2024-10-07",
+            "start_date": "2020-01-13",
+            "end_date": "2023-01-12",
+            "entity": 2300104,
+            "name": "Cooling Towers at the former Willington Power Station",
+            "dataset": "certificate-of-immunity",
+            "typology": "geography",
+            "reference": "1456996",
+            "prefix": "certificate-of-immunity",
+            "organisation_entity": "16",
+            "geometry": "MultiPolygon (((-0.3386878967285156 53.74426323597749, -0.337904691696167 53.743857158459996, -0.33673524856567383 53.744003093019586, -0.33637046813964844 53.74463124033804, -0.3365743160247803 53.74525937826645, -0.33737897872924805 53.74541799747043, -0.33875226974487305 53.74505000000031, -0.3386878967285156 53.74426323597749)))",  # noqa: E501
+            "point": "POINT (-0.33737897872924805 53.74541799747043)",
+        },
+        {
+            "entry_date": "2024-10-07",
+            "start_date": "2020-01-13",
+            "end_date": "2000-01-12",
+            "entity": 2300103,
+            "name": "Cooling Towers at the former Willington Power Station",
+            "dataset": "certificate-of-immunity",
+            "typology": "geography",
+            "reference": "1456995",
+            "prefix": "certificate-of-immunity",
+            "organisation_entity": "16",
+            "geometry": "MultiPolygon (((-0.3386878967285156 53.74426323597749, -0.337904691696167 53.743857158459996, -0.33673524856567383 53.744003093019586, -0.33637046813964844 53.74463124033804, -0.3365743160247803 53.74525937826645, -0.33737897872924805 53.74541799747043, -0.33875226974487305 53.74505000000031, -0.3386878967285156 53.74426323597749)))",  # noqa: E501
+            "point": "POINT (-0.33737897872924805 53.74541799747043)",
+        },
+        {
+            "entry_date": "2024-10-07",
+            "start_date": "2020-01-13",
+            "end_date": "2030-12-12",
+            "entity": 2300106,
+            "name": "Cooling Towers at the former Willington Power Station",
+            "dataset": "certificate-of-immunity",
+            "typology": "geography",
+            "reference": "1456997",
+            "prefix": "certificate-of-immunity",
+            "organisation_entity": "16",
+            "geometry": "MultiPolygon (((-0.3386878967285156 53.74426323597749, -0.337904691696167 53.743857158459996, -0.33673524856567383 53.744003093019586, -0.33637046813964844 53.74463124033804, -0.3365743160247803 53.74525937826645, -0.33737897872924805 53.74541799747043, -0.33875226974487305 53.74505000000031, -0.3386878967285156 53.74426323597749)))",  # noqa: E501
+            "point": "POINT (-0.33737897872924805 53.74541799747043)",
+        },
+        {
+            "entry_date": "2024-10-07",
+            "start_date": "2020-01-13",
+            "end_date": "2050-01-12",
+            "entity": 2300105,
+            "name": "Cooling Towers at the former Willington Power Station",
+            "dataset": "certificate-of-immunity",
+            "typology": "geography",
+            "reference": "1456999",
+            "prefix": "certificate-of-immunity",
+            "organisation_entity": "16",
+            "geometry": "MultiPolygon (((-0.3386878967285156 53.74426323597749, -0.337904691696167 53.743857158459996, -0.33673524856567383 53.744003093019586, -0.33637046813964844 53.74463124033804, -0.3365743160247803 53.74525937826645, -0.33737897872924805 53.74541799747043, -0.33875226974487305 53.74505000000031, -0.3386878967285156 53.74426323597749)))",  # noqa: E501
+            "point": "POINT (-0.33737897872924805 53.74541799747043)",
+        },
+    ]
+    for entity in entities:
+        db_session.add(EntityOrm(**entity))
+
+    db_session.flush()
+    query = db_session.query(EntityOrm)
+    result = _apply_period_option_filter(query, {"period": period}).all()
+
+    if period == ["current"]:
+        assert all(
+            entity.end_date is None or entity.end_date > datetime.now().date()
+            for entity in result
+        )
+    if period == ["historical"]:
+        assert all(entity.end_date < datetime.now().date() for entity in result)
+    if period == ["all"]:
+        assert len(result) == 4