modify context data before upcall to the parent get_context_data. Only create action item if user has change perms

Author: erikvw

edc_locator/tests/test_view_mixins.py

@@ -1,12 +1,17 @@
 from unittest.case import skip
 
+from django.conf import settings
+from django.contrib.auth import get_user_model
+from django.contrib.auth.models import Permission
 from django.contrib.messages.storage.fallback import FallbackStorage
 from django.http.request import HttpRequest
 from django.test import TestCase
 from django.views.generic.base import ContextMixin
 from edc_action_item import site_action_items
 from edc_action_item.models import ActionItem
 from edc_registration.models import RegisteredSubject
+from edc_sites.utils import get_site_model_cls
+from edc_sites.view_mixins import SiteViewMixin
 
 from ..action_items import SUBJECT_LOCATOR_ACTION
 from ..view_mixins import SubjectLocatorViewMixin, SubjectLocatorViewMixinError
@@ -21,62 +26,76 @@ class TestViewMixins(TestCase):
     def setUp(self):
         self.subject_identifier = "12345"
         RegisteredSubject.objects.create(subject_identifier=self.subject_identifier)
+        self.user = get_user_model().objects.create_superuser(
+            "user_login", "[email protected]", "pass"
+        )
+        self.user.is_active = True
+        self.user.is_staff = True
+        self.user.save()
+        self.user.refresh_from_db()
+        self.user.userprofile.sites.add(get_site_model_cls().objects.get(id=settings.SITE_ID))
+        self.user.user_permissions.add(
+            Permission.objects.get(
+                codename="view_appointment", content_type__app_label="edc_appointment"
+            )
+        )
+
+    def get_request_object(self) -> HttpRequest:
+        request = HttpRequest()
+        setattr(request, "session", "session")
+        messages = FallbackStorage(request)
+        setattr(request, "_messages", messages)
+        setattr(request, "user", self.user)
+        setattr(request, "site", get_site_model_cls().objects.get(id=settings.SITE_ID))
+        return request
 
     def test_subject_locator_raises_on_bad_model(self):
-        class MySubjectLocatorViewMixin(SubjectLocatorViewMixin, ContextMixin):
+        class MySubjectLocatorViewMixin(SiteViewMixin, SubjectLocatorViewMixin, ContextMixin):
             subject_locator_model_wrapper_cls = DummyModelWrapper
             subject_locator_model = "blah.blahblah"
 
         mixin = MySubjectLocatorViewMixin()
+        mixin.kwargs = {"subject_identifier": self.subject_identifier}
+        mixin.request = self.get_request_object()
         self.assertRaises(SubjectLocatorViewMixinError, mixin.get_context_data)
 
     def test_subject_locator_raisesmissing_wrapper_cls(self):
-        class MySubjectLocatorViewMixin(SubjectLocatorViewMixin, ContextMixin):
+        class MySubjectLocatorViewMixin(SiteViewMixin, SubjectLocatorViewMixin, ContextMixin):
             subject_locator_model = "edc_locator.subjectlocator"
 
         self.assertRaises(SubjectLocatorViewMixinError, MySubjectLocatorViewMixin)
 
     @skip("problems emulating message framework")
     def test_mixin_messages(self):
-        class MySubjectLocatorViewMixin(SubjectLocatorViewMixin, ContextMixin):
+        class MySubjectLocatorViewMixin(SiteViewMixin, SubjectLocatorViewMixin, ContextMixin):
             subject_locator_model_wrapper_cls = DummyModelWrapper
             subject_locator_model = "edc_locator.subjectlocator"
 
         mixin = MySubjectLocatorViewMixin()
         mixin.kwargs = {"subject_identifier": self.subject_identifier}
-        mixin.request = HttpRequest()
-        setattr(mixin.request, "session", "session")
-        messages = FallbackStorage(mixin.request)
-        setattr(mixin.request, "_messages", messages)
+        mixin.request = self.get_request_object()
         self.assertGreater(len(mixin.request._messages._queued_messages), 0)
 
     def test_subject_locator_view_ok(self):
-        class MySubjectLocatorViewMixin(SubjectLocatorViewMixin, ContextMixin):
+        class MySubjectLocatorViewMixin(SiteViewMixin, SubjectLocatorViewMixin, ContextMixin):
             subject_locator_model_wrapper_cls = DummyModelWrapper
             subject_locator_model = "edc_locator.subjectlocator"
 
         mixin = MySubjectLocatorViewMixin()
-        mixin.request = HttpRequest()
-        setattr(mixin.request, "session", "session")
-        messages = FallbackStorage(mixin.request)
-        setattr(mixin.request, "_messages", messages)
-        # add this manually
+        mixin.request = self.get_request_object()
         mixin.kwargs = {"subject_identifier": self.subject_identifier}
         try:
             mixin.get_context_data()
         except SubjectLocatorViewMixinError as e:
             self.fail(e)
 
     def test_subject_locator_self_corrects_if_multiple_actionitems(self):
-        class MySubjectLocatorViewMixin(SubjectLocatorViewMixin, ContextMixin):
+        class MySubjectLocatorViewMixin(SiteViewMixin, SubjectLocatorViewMixin, ContextMixin):
             subject_locator_model_wrapper_cls = DummyModelWrapper
             subject_locator_model = "edc_locator.subjectlocator"
 
         mixin = MySubjectLocatorViewMixin()
-        mixin.request = HttpRequest()
-        setattr(mixin.request, "session", "session")
-        messages = FallbackStorage(mixin.request)
-        setattr(mixin.request, "_messages", messages)
+        mixin.request = self.get_request_object()
         mixin.kwargs = {"subject_identifier": self.subject_identifier}
         try:
             mixin.get_context_data()

edc_locator/view_mixins.py

@@ -1,9 +1,19 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Type
+
 from django.apps import apps as django_apps
 from django.core.exceptions import MultipleObjectsReturned, ObjectDoesNotExist
 from edc_action_item.site_action_items import site_action_items
+from edc_sites.utils import get_user_codenames_or_raise
 
 from .action_items import SUBJECT_LOCATOR_ACTION
 
+if TYPE_CHECKING:
+    from edc_model_wrapper import ModelWrapper
+
+    from .models import SubjectLocator
+
 
 class SubjectLocatorViewMixinError(Exception):
     pass
@@ -16,8 +26,8 @@ class SubjectLocatorViewMixin:
     Declare with SubjectIdentifierViewMixin.
     """
 
-    subject_locator_model_wrapper_cls = None
-    subject_locator_model = None
+    subject_locator_model_wrapper_cls: Type[ModelWrapper] = None
+    subject_locator_model: int = None
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
@@ -31,19 +41,23 @@ def __init__(self, **kwargs):
             )
 
     def get_context_data(self, **kwargs):
-        context = super().get_context_data(**kwargs)
+        self.create_subject_locator_action_if_required()
         wrapper = self.subject_locator_model_wrapper_cls(model_obj=self.subject_locator)
-        context.update(subject_locator=wrapper)
-        self.get_subject_locator_or_message()
-        return context
+        kwargs.update(subject_locator=wrapper)
+        return super().get_context_data(**kwargs)
+
+    def create_subject_locator_action_if_required(self) -> None:
+        """Create a subject locator action if the subject locator
+        does not exist.
 
-    def get_subject_locator_or_message(self):
-        obj = None
+        Only check if user has change permissions.
+        """
+
+        # kwargs `subject_identifier` updated by RegisteredSubject
+        # view mixin get()
         subject_identifier = self.kwargs.get("subject_identifier")
         try:
-            obj = self.subject_locator_model_cls.objects.get(
-                subject_identifier=subject_identifier
-            )
+            self.subject_locator_model_cls.objects.get(subject_identifier=subject_identifier)
         except ObjectDoesNotExist:
             action_cls = site_action_items.get(SUBJECT_LOCATOR_ACTION)
             action_item_model_cls = action_cls.action_item_model_cls()
@@ -53,18 +67,20 @@ def get_subject_locator_or_message(self):
                     action_type__name=SUBJECT_LOCATOR_ACTION,
                 )
             except ObjectDoesNotExist:
-                action_cls(subject_identifier=subject_identifier)
+                # only create missing action item if user has change perms
+                _, model_name = self.subject_locator_model.split(".")
+                if f"change_{model_name}" in get_user_codenames_or_raise(self.request.user):
+                    action_cls(subject_identifier=subject_identifier)
             except MultipleObjectsReturned:
                 # if condition exists, correct here
                 action_item_model_cls.objects.filter(
                     subject_identifier=subject_identifier,
                     action_type__name=SUBJECT_LOCATOR_ACTION,
                 ).delete()
                 action_cls(subject_identifier=subject_identifier)
-        return obj
 
     @property
-    def subject_locator_model_cls(self):
+    def subject_locator_model_cls(self) -> Type[SubjectLocator]:
         try:
             model_cls = django_apps.get_model(self.subject_locator_model)
         except LookupError as e:
@@ -75,10 +91,10 @@ def subject_locator_model_cls(self):
         return model_cls
 
     @property
-    def subject_locator(self):
+    def subject_locator(self) -> SubjectLocator:
         """Returns a model instance either saved or unsaved.
 
-        If a save instance does not exits, returns a new unsaved instance.
+        If a saved instance does not exist, returns a new unsaved instance.
         """
         model_cls = self.subject_locator_model_cls
         try:

runtests.py

@@ -14,6 +14,7 @@
     APP_NAME=app_name,
     ETC_DIR=str(base_dir / app_name / "tests" / "etc"),
     SUBJECT_VISIT_MODEL="edc_visit_tracking.subjectvisit",
+    EDC_SITES_REGISTER_DEFAULT=True,
     INSTALLED_APPS=[
         "django.contrib.admin",
         "django.contrib.auth",
@@ -26,6 +27,7 @@
         "django_crypto_fields.apps.AppConfig",
         "edc_appointment.apps.AppConfig",
         "edc_action_item.apps.AppConfig",
+        "edc_auth.apps.AppConfig",
         "edc_crf.apps.AppConfig",
         "edc_consent.apps.AppConfig",
         "edc_randomization.apps.AppConfig",