Add optional django-reversion support

Author: codingjoe

.travis.yml

@@ -20,6 +20,7 @@ env:
   - DJANGO=21
   - DJANGO=master
   - TOXENV=docs
+  - TOXENV=reversion
 matrix:
   fast_finish: true
   allow_failures:
@@ -29,6 +30,10 @@ matrix:
     env: TOXENV=docs
   - python: "3.7"
     env: TOXENV=docs
+  - python: "3.5"
+    env: TOXENV=reversion
+  - python: "3.6"
+    env: TOXENV=reversion
 before_script:
 - |
   if [[ -z $TOXENV ]]; then

galahad/__init__.py

@@ -1 +1,2 @@
 """The workflow automation framework for machines with heart."""
+default_app_config = 'galahad.apps.GalahadConfig'

galahad/admin.py

@@ -4,22 +4,31 @@
 from django.utils.translation import ugettext_lazy as t
 
 from . import models
+from .contrib.reversion import VersionAdmin
+
+
+__all__ = (
+    'ProcessAdmin',
+)
+
+
+def rerun(modeladmin, request, queryset):
+    succeeded = queryset.succeeded().count()
+    if succeeded:
+        messages.warning(request, "Only failed tasks can be retried. %s tasks have been skipped" % succeeded)
+    counter = 0
+    for obj in queryset.not_succeeded().iterator():
+        obj.enqueue()
+        counter += 1
+    messages.success(request, "%s tasks have been successfully queued" % counter)
+
+
+rerun.short_description = t('Rerun selected tasks')
+rerun.allowed_permissions = ('rerun',)
 
 
 @admin.register(models.Task)
-class TaskAdmin(admin.ModelAdmin):
-    @staticmethod
-    def rerun(modeladmin, request, queryset):
-        succeeded = queryset.succeeded().count()
-        if succeeded:
-            messages.warning(request, "Only failed tasks can be retried. %s tasks have been skipped" % succeeded)
-        counter = 0
-        for obj in queryset.not_succeeded().iterator():
-            obj.enqueue()
-            counter += 1
-        messages.success(request, "%s tasks have been successfully queued" % counter)
-    rerun.short_description = t('Rerun tasks')
-    rerun.allowed_permissions = ('rerun',)
+class TaskAdmin(VersionAdmin):
 
     def has_rerun_permission(self, request):
         opts = self.opts
@@ -28,13 +37,15 @@ def has_rerun_permission(self, request):
 
     def pretty_stacktrace(self, obj):
         return format_html('<pre class="readonly collapse">{}<pre>', obj.stacktrace)
+
     pretty_stacktrace.short_description = t('Traceback')
 
     def child_tasks(self, obj):
         return ", ".join(str(task) for task in obj.child_task_set.all().iterator())
+
     child_tasks.short_description = t('Child tasks')
 
-    actions = ('rerun',)
+    actions = (rerun,)
 
     list_display = (
         'node_name',
@@ -85,3 +96,15 @@ def child_tasks(self, obj):
             'fields': ('pretty_stacktrace',),
         }),
     )
+
+
+class ProcessAdmin(VersionAdmin):
+    readonly_fields = (
+        'modified',
+        'created',
+    )
+
+    list_filter = (
+        'modified',
+        'created',
+    )

galahad/apps.py

@@ -0,0 +1,11 @@
+from django.apps import AppConfig
+from django.utils.translation import ugettext_lazy as t
+
+
+class GalahadConfig(AppConfig):
+    name = 'galahad'
+    verbose_name = t('Galahad')
+
+    def ready(self):
+        from .contrib.reversion import register_processes
+        register_processes()

galahad/celery.py

@@ -5,6 +5,7 @@
 from django.apps import apps
 from django.db import transaction
 
+from galahad.contrib.reversion import with_reversion
 from . import locking
 
 logger = logging.getLogger('galahad')
@@ -34,10 +35,12 @@ def task_wrapper(self, task_pk, process_pk):
         try:
             logger.info("Executing %r", task)
             node = getattr(type(process), task.node_name)
-            if getattr(node, 'with_task', False):
-                result = node(process, task)
-            else:
-                result = node(process)
+            with_task = getattr(node, 'with_task', False)
+            kwargs = {}
+            if with_task:
+                kwargs['task'] = task
+            with with_reversion(task):
+                result = node(process, **kwargs)
         except:  # NoQA
             task.fail()
             logger.exception("Execution of %r failed", task)

galahad/contrib/__init__.py

@@ -0,0 +1,53 @@
+from contextlib import contextmanager
+
+from galahad import utils
+
+__all__ = (
+    'register_processes',
+    'RevisionMixin',
+    'with_reversion',
+    'VersionAdmin',
+)
+
+
+def register_processes():
+    try:
+        from reversion import revisions
+    except ImportError:
+        pass
+    else:
+        for model in utils.get_processes():
+            if not revisions.is_registered(model):
+                revisions.register(model)
+
+
+@contextmanager
+def with_reversion(task):
+    try:
+        import reversion
+    except ImportError:
+        yield
+    else:
+        with reversion.create_revision():
+            yield
+            reversion.set_comment(task.node_name)
+
+
+try:
+    import reversion
+    from reversion.views import RevisionMixin as _RevisionMixin
+
+    class RevisionMixin(_RevisionMixin):
+        def dispatch(self, request, *args, **kwargs):
+            if self.revision_request_creates_revision(request):
+                reversion.set_comment(self.node_name)
+            return super().dispatch(request, *args, **kwargs)
+
+except ImportError:
+    class RevisionMixin:
+        pass
+
+try:
+    from reversion.admin import VersionAdmin
+except ImportError:
+    from django.contrib.admin import ModelAdmin as VersionAdmin

galahad/contrib/reversion.py

@@ -11,7 +11,7 @@
 from django.utils.translation import ugettext_lazy as t
 from django.views.generic.edit import BaseCreateView
 
-from galahad import views, celery, tasks
+from galahad import views, celery, tasks, utils
 from .conf import settings
 
 logger = logging.getLogger(__name__)
@@ -282,8 +282,7 @@ def process_subclasses():
 
     apps.check_models_ready()
     query = models.Q()
-    for model in apps.get_models():
-        if issubclass(model, Process) and model is not Process:
+    for model in utils.get_processes():
             opts = model._meta
             query |= models.Q(app_label=opts.app_label, model=opts.model_name)
     return query
@@ -421,6 +420,8 @@ def node(self):
     def finish(self, user=None):
         self.completed = timezone.now()
         self.status = self.SUCCEEDED
+        if user and not user.is_authenticated:
+            user = None
         self.completed_by_user = user
         if self.pk:
             self.save(update_fields=[

galahad/models.py

@@ -0,0 +1,12 @@
+import types
+
+
+def get_processes() -> types.GeneratorType:
+    """Return all processes"""
+    from django.apps import apps
+    from .models import Process
+
+    apps.check_models_ready()
+    for model in apps.get_models():
+        if issubclass(model, Process) and model is not Process:
+            yield model

galahad/utils.py

@@ -6,6 +6,7 @@
 from django.views import generic
 
 from . import models
+from .contrib.reversion import RevisionMixin
 
 
 class ProcessTemplateNameViewMixin:
@@ -27,7 +28,7 @@ def get_template_names(self):
         return names
 
 
-class TaskViewMixin(ProcessTemplateNameViewMixin):
+class TaskViewMixin(ProcessTemplateNameViewMixin, RevisionMixin):
     node_name = None
 
     def __init__(self, **kwargs):
@@ -56,10 +57,7 @@ def post(self, request, *args, **kwargs):
         response = super().post(request, *args, **kwargs)
         task = self.get_task()
         task.process = self.object
-        if request.user.is_authenticated:
-            task.finish(request.user)
-        else:
-            task.finish()
+        task.finish(request.user)
         task.start_next_tasks()
         return response
 
@@ -68,7 +66,7 @@ class ProcessDetailView(ProcessTemplateNameViewMixin, generic.DetailView):
     pass
 
 
-class ManualOverrideView(PermissionRequiredMixin, ProcessTemplateNameViewMixin, generic.UpdateView):
+class ManualOverrideView(PermissionRequiredMixin, RevisionMixin, ProcessTemplateNameViewMixin, generic.UpdateView):
     permission_required = 'override'
     node_name = 'manual_override'
     fields = '__all__'