add tests

saxix · saxix · commit 5c3038fd8c9a · 2025-04-02T12:14:07.000+02:00
diff --git a/src/country_workspace/models/household.py b/src/country_workspace/models/household.py
@@ -16,9 +16,7 @@
     from .program import Program
 
 
-@pghistory.track(
-    pghistory.UpdateEvent("updates", condition=pghistory.AnyChange("flex_fields", "flex_files", "removed"))
-)
+@pghistory.track(pghistory.UpdateEvent(condition=pghistory.AnyChange("flex_fields", "flex_files", "removed")))
 class Household(Validable, BaseModel):
     system_fields = models.JSONField(default=dict, blank=True)
     members: "QuerySet[Individual]"
diff --git a/src/country_workspace/models/individual.py b/src/country_workspace/models/individual.py
@@ -11,9 +11,7 @@
     from hope_flex_fields.models import DataChecker
 
 
-@pghistory.track(
-    pghistory.UpdateEvent("updates", condition=pghistory.AnyChange("flex_fields", "flex_files", "removed"))
-)
+@pghistory.track(pghistory.UpdateEvent(condition=pghistory.AnyChange("flex_fields", "flex_files", "removed")))
 class Individual(Validable, BaseModel):
     household = models.ForeignKey(Household, on_delete=models.CASCADE, null=True, blank=True, related_name="members")
     system_fields = models.JSONField(default=dict, blank=True)
diff --git a/src/country_workspace/workspaces/admin/hh_ind.py b/src/country_workspace/workspaces/admin/hh_ind.py
@@ -234,29 +234,30 @@ def history_view(
         self, request: HttpRequest, object_id: str, extra_context: dict[str, Any] | None = None
     ) -> TemplateResponse:
         obj = self.get_object(request, unquote(object_id))
-        etag = cache_manager.build_key_from_request(request, "history", obj.last_modified)
-        if response := cache_manager.retrieve(etag):
-            return response
-        history = []
-        prev = {}
-        field_names = [f.name for __, f in obj.checker.get_fields()]
-        for entry in obj.events.select_related("pgh_context").all():
-            changes = {}
-            for field_name in field_names:
-                old_value = prev.get(field_name, "")
-                new_value = entry.flex_fields.get(field_name, "")
-                if old_value != new_value:
-                    changes[field_name] = {"from": old_value, "to": new_value}
-            history.append(
-                {
-                    "changes": changes,
-                    "date": entry.pgh_created_at,
-                    "pgh_label": entry.pgh_label,
-                    "user": entry.pgh_context.metadata["user"],
-                }
-            )
-            prev = entry.flex_fields
-        history.reverse()
+        key = cache_manager.build_key_from_request(request, "history", obj.pk, obj.version)
+        if not (history := cache_manager.retrieve(key)):
+            history = []
+            prev = {}
+            field_names = [f.name for __, f in obj.checker.get_fields()]
+            for entry in obj.events.select_related("pgh_context").all():
+                changes = {}
+                for field_name in field_names:
+                    old_value = prev.get(field_name, "")
+                    new_value = entry.flex_fields.get(field_name, "")
+                    if old_value != new_value:
+                        changes[field_name] = {"from": old_value, "to": new_value}
+                history.append(
+                    {
+                        "changes": changes,
+                        "date": entry.pgh_created_at,
+                        "pgh_label": entry.pgh_label,
+                        "user": entry.pgh_context.metadata["user"],
+                    }
+                )
+                prev = entry.flex_fields
+            history.reverse()
+            cache_manager.store(key, history)
+
         context = {
             **self.admin_site.each_context(request),
             "modeladmin": self,
@@ -273,9 +274,5 @@ def history_view(
             "preserved_filters": self.get_preserved_filters(request),
             **(extra_context or {}),
         }
-        return TemplateResponse(
-            request,
-            self.object_history_template,
-            context,
-            headers={"Etag": etag},
-        )
+
+        return TemplateResponse(request, self.object_history_template, context)
diff --git a/tests/cache/test_cache_base.py b/tests/cache/test_cache_base.py
@@ -3,7 +3,6 @@
 import pytest
 from django.core.cache import cache
 from django.urls import reverse
-
 from testutils.perms import user_grant_permissions
 from testutils.utils import select_office
 
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -6,9 +6,8 @@
 import factory
 import pytest
 import responses
-
-from django.core.files.storage.base import Storage
 from django.core.files.base import ContentFile
+from django.core.files.storage.base import Storage
 
 if TYPE_CHECKING:
     from country_workspace.models import User
@@ -62,6 +61,7 @@ def mock_storage():
 @pytest.fixture(autouse=True)
 def patch_asyncjob(mock_storage):
     from django.db import models
+
     from country_workspace.models.jobs import AsyncJob
 
     AsyncJob._meta.get_field("file").storage = mock_storage
diff --git a/tests/contrib/aurora/test_aurora_client.py b/tests/contrib/aurora/test_aurora_client.py
@@ -1,7 +1,6 @@
 import re
 from collections.abc import Callable
 
-
 import pytest
 import requests
 import responses
diff --git a/tests/contrib/hope/test_hope_client.py b/tests/contrib/hope/test_hope_client.py
@@ -2,19 +2,19 @@
 import re
 from collections.abc import Callable
 from unittest.mock import Mock
-from constance.test import override_config
 
 import pytest
 import requests
 import responses
+from constance.test import override_config
 
 from country_workspace.contrib.hope.client import HopeClient
 from country_workspace.exceptions import RemoteError
 
 
 @pytest.fixture
 def mock_signals():
-    from country_workspace.contrib.hope.client import hope_request_start, hope_request_end
+    from country_workspace.contrib.hope.client import hope_request_end, hope_request_start
 
     start_mock = Mock()
     end_mock = Mock()
diff --git a/tests/contrib/hope/test_push_to_hope_core.py b/tests/contrib/hope/test_push_to_hope_core.py
@@ -1,16 +1,15 @@
-import pytest
+from json import JSONDecodeError
 
-from pytest_mock import MockerFixture
+import pytest
 from django.db import DatabaseError
+from pytest_mock import MockerFixture
+from requests.exceptions import RequestException
 
+from country_workspace.contrib.hope.push import PushProcessor, map_fields, push_to_hope_core
+from country_workspace.exceptions import RemoteError
+from country_workspace.models import Household, Individual
 from country_workspace.state import state
-from country_workspace.contrib.hope.push import PushProcessor, push_to_hope_core, map_fields
-from country_workspace.models import Individual, Household
-
 from country_workspace.workspaces.models import CountryHousehold
-from requests.exceptions import RequestException
-from json import JSONDecodeError
-from country_workspace.exceptions import RemoteError
 
 
 @pytest.fixture
diff --git a/tests/datasources/test_rdi.py b/tests/datasources/test_rdi.py
@@ -5,20 +5,20 @@
 from pytest_mock import MockerFixture
 
 from country_workspace.datasources.rdi import (
-    normalize_row,
-    get_value,
     ColumnConfigurationError,
-    SheetProcessingError,
-    MissingHouseholdError,
+    Config,
     HouseholdValidationError,
+    MissingHouseholdError,
+    Row,
+    Sheet,
+    SheetProcessingError,
     filter_rows_with_household_pk,
+    get_value,
+    import_from_rdi,
+    normalize_row,
     process_households,
     process_individuals,
     validate_households,
-    import_from_rdi,
-    Config,
-    Sheet,
-    Row,
 )
 from country_workspace.models import Household
 
diff --git a/tests/extras/testutils/factories/program.py b/tests/extras/testutils/factories/program.py
@@ -1,6 +1,6 @@
 import factory
 
-from country_workspace.models import Program, BeneficiaryGroup
+from country_workspace.models import BeneficiaryGroup, Program
 from country_workspace.workspaces.models import CountryProgram
 
 from .base import AutoRegisterModelFactory
diff --git a/tests/models/test_m_history.py b/tests/models/test_m_history.py
@@ -1,6 +1,6 @@
 import pytest
 
-from country_workspace.models import Household
+from country_workspace.models import Household, Individual
 from country_workspace.state import state
 
 
@@ -36,19 +36,49 @@ def household(program):
     )
 
 
-def test_history_update(household):
-    assert household.events.count() == 1
+@pytest.fixture
+def individual(household):
+    from testutils.factories import CountryIndividualFactory
+
+    return CountryIndividualFactory(
+        batch=household.batch,
+        flex_fields={"first_name": "name", "last_name": "family name"},
+    )
+
+
+def test_history_household(household):
+    start = household.events.count()
 
     household.system_fields = {"a": 1}
     household.save()
-    assert household.events.count() == 1
+    assert household.events.count() == start
 
     Household.objects.filter(pk=household.pk).update(system_fields={"a": 1})
-    assert household.events.count() == 1
+    assert household.events.count() == start
 
     Household.objects.filter(pk=household.pk).update(flex_fields={"first_name": "First Name"})
-    assert household.events.count() == 2
+    assert household.events.count() == start + 1
 
     household.flex_fields = {"a": 1}
     household.save()
-    assert household.events.count() == 3
+    assert household.events.count() == start + 2
+
+
+def test_history_individual(individual):
+    start = individual.events.count()
+
+    individual.system_fields = {"a": 1}
+    individual.save()
+    assert individual.events.count() == start
+
+    Individual.objects.filter(pk=individual.pk).update(system_fields={"a": 1})
+    assert individual.events.count() == start
+
+    Individual.objects.filter(pk=individual.pk).update(
+        flex_fields={"first_name": "First Name", "last_name": "Family Name"}
+    )
+    assert individual.events.count() == start + 1
+
+    individual.flex_fields = {"a": 1}
+    individual.save()
+    assert individual.events.count() == start + 2
diff --git a/tests/models/test_m_household.py b/tests/models/test_m_household.py
@@ -4,10 +4,9 @@
 
 import pytest
 
-
 if TYPE_CHECKING:
-    from country_workspace.workspaces.models import CountryHousehold, CountryIndividual
     from country_workspace.models import Household
+    from country_workspace.workspaces.models import CountryHousehold, CountryIndividual
 
 
 @pytest.fixture
diff --git a/tests/test_sync.py b/tests/test_sync.py
@@ -3,7 +3,7 @@
 import pytest
 from django import forms
 
-from country_workspace.contrib.hope.sync.office import sync_all, sync_offices, sync_programs, sync_beneficiary_groups
+from country_workspace.contrib.hope.sync.office import sync_all, sync_beneficiary_groups, sync_offices, sync_programs
 
 
 @pytest.fixture(autouse=True)
diff --git a/tests/workspace/actions/test_ws_bulk.py b/tests/workspace/actions/test_ws_bulk.py
@@ -9,12 +9,11 @@
 from django.urls import reverse
 from testutils.factories import FlexFieldFactory
 from testutils.utils import select_office
+from webtest import Upload
 
 from country_workspace.state import state
 from country_workspace.workspaces.admin.cleaners.bulk_update import TYPES, create_xls_importer
 from tests.workspace.actions import stub
-from webtest import Upload
-
 
 if TYPE_CHECKING:
     from django_webtest import DjangoTestApp
diff --git a/tests/workspace/test_ws_history.py b/tests/workspace/test_ws_history.py
@@ -0,0 +1,61 @@
+from typing import TYPE_CHECKING
+
+import pghistory
+import pytest
+from django.urls import reverse
+from pyquery import PyQuery
+from testutils.utils import select_office
+
+
+if TYPE_CHECKING:
+    from django_webtest.pytest_plugin import MixinWithInstanceVariables
+    from testutils.types import CWTestApp
+
+    from country_workspace.models import User
+    from country_workspace.workspaces.models import CountryIndividual
+
+
+@pytest.fixture
+def app(django_app_factory: "MixinWithInstanceVariables", admin_user: "User") -> "CWTestApp":
+    django_app = django_app_factory(csrf_checks=False)
+    django_app.set_user(admin_user)
+    return django_app
+
+
+@pytest.fixture
+def program():
+    from testutils.factories import CountryProgramFactory
+
+    return CountryProgramFactory()
+
+
+@pytest.fixture
+def individual():
+    from testutils.factories import CountryIndividualFactory
+
+    individual = CountryIndividualFactory(household__batch__program__individual_checker__fields=["first_name"])
+    with pghistory.context(user={"email": "<EMAIL>", "username": "user #1"}):
+        individual.flex_fields = {"first_name": "Name 1"}
+        individual.save()
+        individual.flex_fields = {"first_name": "Name 2"}
+        individual.save()
+
+    return individual
+
+
+def test_individual_history(app, individual: "CountryIndividual"):
+    url = reverse("workspace:workspaces_countryindividual_history", args=[individual.pk])
+    with select_office(app, individual.country_office, individual.program):
+        res = app.get(url)
+        etag = res.headers["Etag"]
+
+        assert res.status_code == 200
+        pq = PyQuery(res.content)
+        assert pq("table.history tbody tr td div.old_value")[0].text == "Name 1"
+        assert pq("table.history tbody tr td div.new_value")[0].text == "Name 2"
+
+        assert pq("table.history tbody tr td div.old_value")[1].text is None
+        assert pq("table.history tbody tr td div.new_value")[1].text == "Name 1"
+
+        res = app.get(url, headers={"etag": etag})
+        assert res.status_code == 304
diff --git a/tests/workspace/test_ws_import.py b/tests/workspace/test_ws_import.py
@@ -1,11 +1,11 @@
 import re
+from pathlib import Path
 from typing import TYPE_CHECKING, Any
 
 import pytest
 import responses
 from constance import config
 from django.urls import reverse
-from pathlib import Path
 from webtest import Upload
 
 from country_workspace.state import state
@@ -15,7 +15,7 @@
     from django_webtest import DjangoTestApp
     from django_webtest.pytest_plugin import MixinWithInstanceVariables
 
-    from country_workspace.workspaces.models import CountryProgram, CountryHousehold
+    from country_workspace.workspaces.models import CountryHousehold, CountryProgram
 
 
 @pytest.fixture
