add ! mixin for sync in admin

Author: vitali-yanushchyk-valor

src/country_workspace/admin/base.py

@@ -1,3 +1,4 @@
+from typing import TypedDict
 from admin_extra_buttons.mixins import ExtraButtonsMixin
 from adminfilters.mixin import AdminAutoCompleteSearchMixin, AdminFiltersMixin
 from django.contrib import admin, messages
@@ -12,15 +13,19 @@ class BaseModelAdmin(ExtraButtonsMixin, AdminAutoCompleteSearchMixin, AdminFilte
     pass
 
 
+class SyncConfig(TypedDict):
+    model: type[Model]
+    step: SyncStep
+
+
 class SyncAdminMixin:
-    sync_step: SyncStep = None
-    sync_model: type[Model] = None
+    sync_config: SyncConfig
 
     @button()
     def sync(self, request: HttpRequest) -> None:
-        totals = sync_context_programs(step=self.sync_step)
+        totals = sync_context_programs(step=self.sync_config["step"])
         if errors := totals.get("errors"):
             self.message_user(request, "; ".join(errors), level=messages.ERROR)
         else:
-            info = totals[self.sync_model._meta.model_name]
+            info = totals[self.sync_config["model"]._meta.model_name]
             self.message_user(request, f"{info['add']} created - {info['upd']} updated", level=messages.SUCCESS)

src/country_workspace/admin/office.py

@@ -5,7 +5,7 @@
 from country_workspace.contrib.hope.sync.context_programs import SyncStep
 
 from ..models import Office
-from .base import BaseModelAdmin, SyncAdminMixin
+from .base import BaseModelAdmin, SyncAdminMixin, SyncConfig
 
 
 @admin.register(Office)
@@ -15,8 +15,7 @@ class OfficeAdmin(SyncAdminMixin, BaseModelAdmin):
     list_filter = ("active",)
     readonly_fields = ("hope_id", "slug")
     ordering = ("name",)
-    sync_step = SyncStep.OFFICES
-    sync_model = Office
+    sync_config = SyncConfig(model=Office, step=SyncStep.OFFICES)
 
     @link(change_list=False)
     def programmes(self, btn: LinkButton) -> None:

src/country_workspace/admin/program.py

@@ -9,7 +9,7 @@
 from ..cache.manager import cache_manager
 from ..compat.admin_extra_buttons import confirm_action
 from ..models import Program
-from .base import BaseModelAdmin, SyncAdminMixin
+from .base import BaseModelAdmin, SyncAdminMixin, SyncConfig
 from country_workspace.contrib.hope.sync.context_programs import SyncStep
 
 if TYPE_CHECKING:
@@ -41,9 +41,7 @@ class ProgramAdmin(SyncAdminMixin, BaseModelAdmin):
     )
     ordering = ("name",)
     autocomplete_fields = ("country_office",)
-
-    sync_step = SyncStep.PROGRAMS
-    sync_model = Program
+    sync_config = SyncConfig(model=Program, step=SyncStep.PROGRAMS)
 
     @button()
     def invalidate_cache(self, request: HttpRequest, pk: str) -> None:

tests/admin/test_admin_sync.py

@@ -7,58 +7,47 @@
 
 from country_workspace.contrib.hope.sync.context_programs import SyncStep
 from country_workspace.models import Office, Program
+from country_workspace.admin.base import SyncConfig
 
 if TYPE_CHECKING:
     from django_webtest.pytest_plugin import MixinWithInstanceVariables
     from testutils.types import CWTestApp
-
     from country_workspace.models import User
 
 
 @pytest.fixture
-def app(
-    django_app_factory: "MixinWithInstanceVariables",
-    admin_user: "User",
-) -> "CWTestApp":
+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.mark.parametrize(
-    ("admin_class", "model_name", "step", "url_name", "sync_result", "message", "level"),
+    ("sync_config", "url_name", "sync_result", "message", "level"),
     [
         (
-            "admin.OfficeAdmin",
-            Office._meta.model_name,
-            SyncStep.OFFICES,
+            SyncConfig(model=Office, step=SyncStep.OFFICES),
             "country_workspace_office_sync",
             {Office._meta.model_name: {"add": 1, "upd": 2}},
             "1 created - 2 updated",
             messages.SUCCESS,
         ),
         (
-            "admin.OfficeAdmin",
-            Office._meta.model_name,
-            SyncStep.OFFICES,
+            SyncConfig(model=Office, step=SyncStep.OFFICES),
             "country_workspace_office_sync",
             {"errors": ["Error 1", "Error 2"], Office._meta.model_name: {"add": 0, "upd": 0}},
             "Error 1; Error 2",
             messages.ERROR,
         ),
         (
-            "admin.ProgramAdmin",
-            Program._meta.model_name,
-            SyncStep.PROGRAMS,
+            SyncConfig(model=Program, step=SyncStep.PROGRAMS),
             "country_workspace_program_sync",
             {Program._meta.model_name: {"add": 1, "upd": 2}},
             "1 created - 2 updated",
             messages.SUCCESS,
         ),
         (
-            "admin.ProgramAdmin",
-            Program._meta.model_name,
-            SyncStep.PROGRAMS,
+            SyncConfig(model=Program, step=SyncStep.PROGRAMS),
             "country_workspace_program_sync",
             {"errors": ["Error 3", "Error 4"], Program._meta.model_name: {"add": 0, "upd": 0}},
             "Error 3; Error 4",
@@ -68,11 +57,14 @@ def app(
     ids=["office_success", "office_errors", "program_success", "program_errors"],
 )
 @pytest.mark.xdist_group("remote")
-def test_admin_sync(app, mocker: MockerFixture, admin_class, model_name, step, url_name, sync_result, message, level):
-    mocker.patch(
-        "country_workspace.contrib.hope.sync.context_programs.sync_context_programs",
+def test_admin_sync(app, mocker: MockerFixture, sync_config, url_name, sync_result, message, level):
+    mock_sync_context_programs = mocker.patch(
+        "country_workspace.admin.base.sync_context_programs",
         return_value=sync_result,
     )
-    mock_message_user = mocker.patch(f"country_workspace.{admin_class}.message_user")
+    mock_message_user = mocker.patch("country_workspace.admin.base.BaseModelAdmin.message_user")
+
     app.get(reverse(f"admin:{url_name}"))
+
+    mock_sync_context_programs.assert_called_once_with(step=sync_config["step"])
     mock_message_user.assert_called_once_with(mocker.ANY, message, level=level)