Make it compatible with fsm-log

Author: pfouque

django_fsm/admin.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
+from functools import partial
 from typing import Any
 
 from django.conf import settings
@@ -15,6 +16,13 @@
 
 import django_fsm as fsm
 
+try:
+    import django_fsm_log  # noqa: F401
+except ModuleNotFoundError:
+    FSM_LOG_ENABLED = False
+else:
+    FSM_LOG_ENABLED = True
+
 
 @dataclass
 class FSMObjectTransition:
@@ -127,7 +135,20 @@ def response_change(self, request: HttpRequest, obj: Any) -> HttpResponse:
                 )
 
             try:
-                transition_func()
+                if FSM_LOG_ENABLED:
+                    for fn in [
+                        partial(transition_func, request=request, by=request.user),
+                        partial(transition_func, by=request.user),
+                        transition_func,
+                    ]:
+                        try:
+                            fn()
+                        except TypeError:  # noqa: PERF203
+                            pass
+                        else:
+                            break
+                else:
+                    transition_func()
             except fsm.TransitionNotAllowed:
                 self.message_user(
                     request=request,

tests/settings.py

@@ -43,6 +43,7 @@
     "django.contrib.sessions",
     "django.contrib.messages",
     "django.contrib.staticfiles",
+    "django_fsm_log",
     "guardian",
     *PROJECT_APPS,
 ]
@@ -135,3 +136,35 @@
 # https://docs.djangoproject.com/en/4.2/ref/settings/#default-auto-field
 
 DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
+
+
+# Django FSM-log settings
+DJANGO_FSM_LOG_IGNORED_MODELS = (
+    # "tests.testapp.models.AdminBlogPost",
+    "tests.testapp.models.Application",
+    "tests.testapp.models.BlogPost",
+    "tests.testapp.models.DbState",
+    "tests.testapp.models.FKApplication",
+    "tests.testapp.tests.SimpleBlogPost",
+    "tests.testapp.tests.test_abstract_inheritance.BaseAbstractModel",
+    "tests.testapp.tests.test_abstract_inheritance.InheritedFromAbstractModel",
+    "tests.testapp.tests.test_access_deferred_fsm_field.DeferrableModel",
+    "tests.testapp.tests.test_basic_transitions.SimpleBlogPost",
+    "tests.testapp.tests.test_conditions.BlogPostWithConditions",
+    "tests.testapp.tests.test_custom_data.BlogPostWithCustomData",
+    "tests.testapp.tests.test_exception_transitions.ExceptionalBlogPost",
+    "tests.testapp.tests.test_graph_transitions.VisualBlogPost",
+    "tests.testapp.tests.test_integer_field.BlogPostWithIntegerField",
+    "tests.testapp.tests.test_lock_mixin.ExtendedBlogPost",
+    "tests.testapp.tests.test_lock_mixin.LockedBlogPost",
+    "tests.testapp.tests.test_mixin_support.MixinSupportTestModel",
+    "tests.testapp.tests.test_multi_resultstate.MultiResultTest",
+    "tests.testapp.tests.test_multidecorators.TestModel",
+    "tests.testapp.tests.test_protected_field.ProtectedAccessModel",
+    "tests.testapp.tests.test_protected_fields.RefreshableProtectedAccessModel",
+    "tests.testapp.tests.test_proxy_inheritance.InheritedModel",
+    "tests.testapp.tests.test_state_transitions.Caterpillar",
+    "tests.testapp.tests.test_string_field_parameter.BlogPostWithStringField",
+    "tests.testapp.tests.test_transition_all_except_target.TestExceptTargetTransitionShortcut",
+    "tests.testapp.tests.test_key_field.FKBlogPost",
+)

tests/testapp/admin.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 from django.contrib import admin
+from django_fsm_log.admin import StateLogInline
 
 from django_fsm.admin import FSMAdminMixin
 
@@ -20,3 +21,5 @@ class AdminBlogPostAdmin(FSMAdminMixin, admin.ModelAdmin):
         "state",
         "step",
     ]
+
+    inlines = [StateLogInline]

tests/testapp/models.py

@@ -1,6 +1,8 @@
 from __future__ import annotations
 
 from django.db import models
+from django_fsm_log.decorators import fsm_log_by
+from django_fsm_log.decorators import fsm_log_description
 
 from django_fsm import FSMField
 from django_fsm import FSMKeyField
@@ -172,6 +174,8 @@ class AdminBlogPost(models.Model):
 
     # state transitions
 
+    @fsm_log_by
+    @fsm_log_description
     @transition(
         field=state,
         source="*",
@@ -180,17 +184,21 @@ class AdminBlogPost(models.Model):
             "admin": False,
         },
     )
-    def secret_transition(self):
+    def secret_transition(self, by=None, description=None):
         pass
 
+    @fsm_log_by
+    @fsm_log_description
     @transition(
         field=state,
         source=[AdminBlogPostState.CREATED],
         target=AdminBlogPostState.REVIEWED,
     )
-    def moderate(self):
+    def moderate(self, by=None, description=None):
         pass
 
+    @fsm_log_by
+    @fsm_log_description
     @transition(
         field=state,
         source=[
@@ -199,9 +207,11 @@ def moderate(self):
         ],
         target=AdminBlogPostState.PUBLISHED,
     )
-    def publish(self):
+    def publish(self, by=None, description=None):
         pass
 
+    @fsm_log_by
+    @fsm_log_description
     @transition(
         field=state,
         source=[
@@ -210,11 +220,13 @@ def publish(self):
         ],
         target=AdminBlogPostState.HIDDEN,
     )
-    def hide(self):
+    def hide(self, by=None, description=None):
         pass
 
     # step transitions
 
+    @fsm_log_by
+    @fsm_log_description
     @transition(
         field=step,
         source=[AdminBlogPostStep.STEP_1],
@@ -223,17 +235,21 @@ def hide(self):
             "label": "Go to Step 2",
         },
     )
-    def step_two(self):
+    def step_two(self, by=None, description=None):
         pass
 
+    @fsm_log_by
+    @fsm_log_description
     @transition(
         field=step,
         source=[AdminBlogPostStep.STEP_2],
         target=AdminBlogPostStep.STEP_3,
     )
-    def step_three(self):
+    def step_three(self, by=None, description=None):
         pass
 
+    @fsm_log_by
+    @fsm_log_description
     @transition(
         field=step,
         source=[
@@ -242,5 +258,5 @@ def step_three(self):
         ],
         target=AdminBlogPostStep.STEP_1,
     )
-    def step_reset(self):
+    def step_reset(self, by=None, description=None):
         pass

tests/testapp/tests/test_admin.py

@@ -1,12 +1,13 @@
 from __future__ import annotations
 
-from typing import Any
 from unittest.mock import patch
 
 from django.contrib import messages
 from django.contrib.admin.sites import AdminSite
+from django.contrib.auth import get_user_model
 from django.test import TestCase
 from django.test.client import RequestFactory
+from django_fsm_log.models import StateLog
 
 from django_fsm import ConcurrentTransition
 from django_fsm import FSMField
@@ -15,20 +16,6 @@
 from tests.testapp.models import AdminBlogPostState
 
 
-class MockRequest:
-    path = "/path"
-    user: Any
-
-
-class MockSuperUser:
-    def has_perm(self, perm, obj=None):
-        return True
-
-
-request = MockRequest()
-request.user = MockSuperUser()
-
-
 class ModelAdminTest(TestCase):
     @classmethod
     def setUpTestData(cls):
@@ -37,6 +24,9 @@ def setUpTestData(cls):
         blog_post.save()
         cls.blog_post = blog_post
 
+        cls.request = RequestFactory().get(path="/path")
+        cls.request.user = get_user_model().objects.create_user(username="jacob", password="password", is_staff=True)  # noqa: S106
+
     def setUp(self):
         self.model_admin = AdminBlogPostAdmin(AdminBlogPost, AdminSite())
 
@@ -47,13 +37,13 @@ def test_get_fsm_field_instance(self):
         assert isinstance(fsm_field, FSMField)
 
     def test_readonly_fields(self):
-        assert self.model_admin.get_readonly_fields(request=request) == ("state",)
+        assert self.model_admin.get_readonly_fields(request=self.request) == ("state",)
 
     def test_get_fsm_block_label(self):
         assert self.model_admin.get_fsm_block_label(fsm_field_name="MyField") == "Transition (MyField)"
 
     def test_get_fsm_object_transitions(self):
-        fsm_object_transitions = self.model_admin.get_fsm_object_transitions(request=request, obj=self.blog_post)
+        fsm_object_transitions = self.model_admin.get_fsm_object_transitions(request=self.request, obj=self.blog_post)
 
         assert len(fsm_object_transitions) == 2  # noqa: PLR2004
         state_transition, step_transition = fsm_object_transitions
@@ -70,7 +60,7 @@ def test_get_fsm_object_transitions(self):
         assert sorted([t.name for t in step_transition.available_transitions]) == ["step_two"]
 
     def test_get_fsm_redirect_url(self):
-        assert self.model_admin.get_fsm_redirect_url(request=request, obj=None) == "/path"
+        assert self.model_admin.get_fsm_redirect_url(request=self.request, obj=None) == "/path"
 
     @patch("django.contrib.admin.ModelAdmin.change_view")
     @patch("django_fsm.admin.FSMAdminMixin.get_fsm_object_transitions")
@@ -82,7 +72,7 @@ def test_change_view_context(
         mock_get_fsm_object_transitions.return_value = "object transitions"
 
         self.model_admin.change_view(
-            request=request,
+            request=self.request,
             form_url="/test",
             object_id=self.blog_post.pk,
             extra_context={
@@ -91,12 +81,12 @@ def test_change_view_context(
         )
 
         mock_get_fsm_object_transitions.assert_called_once_with(
-            request=request,
+            request=self.request,
             obj=self.blog_post,
         )
 
         mock_super_change_view.assert_called_once_with(
-            request=request,
+            request=self.request,
             object_id=self.blog_post.pk,
             form_url="/test",
             extra_context={
@@ -111,7 +101,12 @@ class ResponseChangeTest(TestCase):
     def setUp(self):
         self.model_admin = AdminBlogPostAdmin(AdminBlogPost, AdminSite())
 
+    @classmethod
+    def setUpTestData(cls):
+        cls.user = get_user_model().objects.create_user(username="jacob", password="password", is_staff=True)  # noqa: S106
+
     def test_unknown_transition(self, mock_message_user):
+        assert StateLog.objects.count() == 0
         request = RequestFactory().post(
             path="/",
             data={"_fsm_transition_to": "unknown_transition"},
@@ -133,12 +128,15 @@ def test_unknown_transition(self, mock_message_user):
 
         updated_blog_post = AdminBlogPost.objects.get(pk=blog_post.pk)
         assert updated_blog_post.state == AdminBlogPostState.CREATED
+        assert StateLog.objects.count() == 0
 
     def test_transition_applied(self, mock_message_user):
+        assert StateLog.objects.count() == 0
         request = RequestFactory().post(
             path="/",
             data={"_fsm_transition_to": "moderate"},
         )
+        request.user = self.user
 
         blog_post = AdminBlogPost.objects.create(title="Article name")
         assert blog_post.state == AdminBlogPostState.CREATED
@@ -156,12 +154,16 @@ def test_transition_applied(self, mock_message_user):
 
         updated_blog_post = AdminBlogPost.objects.get(pk=blog_post.pk)
         assert updated_blog_post.state == AdminBlogPostState.REVIEWED
+        assert StateLog.objects.count() == 1
+        assert StateLog.objects.get().by == self.user
 
     def test_transition_not_allowed_exception(self, mock_message_user):
+        assert StateLog.objects.count() == 0
         request = RequestFactory().post(
             path="/",
             data={"_fsm_transition_to": "publish"},
         )
+        request.user = self.user
 
         blog_post = AdminBlogPost.objects.create(title="Article name")
         assert blog_post.state == AdminBlogPostState.CREATED
@@ -179,12 +181,15 @@ def test_transition_not_allowed_exception(self, mock_message_user):
 
         updated_blog_post = AdminBlogPost.objects.get(pk=blog_post.pk)
         assert updated_blog_post.state == AdminBlogPostState.CREATED
+        assert StateLog.objects.count() == 0
 
     def test_concurrent_transition_exception(self, mock_message_user):
+        assert StateLog.objects.count() == 0
         request = RequestFactory().post(
             path="/",
             data={"_fsm_transition_to": "moderate"},
         )
+        request.user = self.user
 
         blog_post = AdminBlogPost.objects.create(title="Article name")
         assert blog_post.state == AdminBlogPostState.CREATED
@@ -206,3 +211,4 @@ def test_concurrent_transition_exception(self, mock_message_user):
 
         updated_blog_post = AdminBlogPost.objects.get(pk=blog_post.pk)
         assert updated_blog_post.state == AdminBlogPostState.CREATED
+        assert StateLog.objects.count() == 0

tests/testapp/tests/test_multidecorators.py

@@ -8,7 +8,7 @@
 from django_fsm.signals import post_transition
 
 
-class TestModel(models.Model):
+class MultiDecoratedModel(models.Model):
     counter = models.IntegerField(default=0)
     signal_counter = models.IntegerField(default=0)
     state = FSMField(default="SUBMITTED_BY_USER")
@@ -24,12 +24,12 @@ def count_calls(sender, instance, name, source, target, **kwargs):
     instance.signal_counter += 1
 
 
-post_transition.connect(count_calls, sender=TestModel)
+post_transition.connect(count_calls, sender=MultiDecoratedModel)
 
 
 class TestStateProxy(TestCase):
     def test_transition_method_called_once(self):
-        model = TestModel()
+        model = MultiDecoratedModel.objects.create()
         model.review()
         assert model.counter == 1
         assert model.signal_counter == 1

tests/wsgi.py

@@ -12,6 +12,6 @@
 
 from django.core.wsgi import get_wsgi_application
 
-os.environ.setdefault("DJANGO_SETTINGS_MODULE", "silvr.settings")
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "tests.settings")
 
 application = get_wsgi_application()