Add cancellation and migrations

codingjoe · codingjoe · commit f342ed4fd154 · 2018-11-29T16:10:59.000+01:00
diff --git a/galahad/admin.py b/galahad/admin.py
@@ -27,6 +27,18 @@ def rerun(modeladmin, request, queryset):
 rerun.allowed_permissions = ('rerun',)
 
 
+def cancel(modeladmin, request, queryset):
+    succeeded = queryset.succeeded().count()
+    if succeeded:
+        messages.warning(request, "Only failed tasks can be retried. %s tasks have been skipped" % succeeded)
+    queryset.not_succeeded().cancel(request.user)
+    messages.success(request, "Tasks have been successfully queued")
+
+
+cancel.short_description = t('Cancel selected tasks')
+cancel.allowed_permissions = ('cancel',)
+
+
 @admin.register(models.Task)
 class TaskAdmin(VersionAdmin):
 
diff --git a/galahad/migrations/0001_initial.py b/galahad/migrations/0001_initial.py
@@ -0,0 +1,52 @@
+# Generated by Django 2.1.3 on 2018-11-29 15:10
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+import galahad.models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('contenttypes', '0002_remove_content_type_name'),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Process',
+            fields=[
+                ('id', models.BigAutoField(editable=False, primary_key=True, serialize=False)),
+                ('created', models.DateTimeField(auto_now_add=True, db_index=True)),
+                ('modified', models.DateTimeField(auto_now=True, db_index=True)),
+            ],
+        ),
+        migrations.CreateModel(
+            name='Task',
+            fields=[
+                ('id', models.BigAutoField(editable=False, primary_key=True, serialize=False)),
+                ('node_name', models.TextField(db_index=True, editable=False)),
+                ('node_type', models.TextField(choices=[('human', 'human'), ('machine', 'machine')], db_index=True, editable=False)),
+                ('status', models.TextField(choices=[('failed', 'failed'), ('succeeded', 'succeeded'), ('scheduled', 'scheduled'), ('canceled', 'canceled')], db_index=True, default='scheduled', editable=False)),
+                ('created', models.DateTimeField(auto_now_add=True, db_index=True)),
+                ('modified', models.DateTimeField(auto_now=True, db_index=True)),
+                ('completed', models.DateTimeField(blank=True, db_index=True, editable=False, null=True)),
+                ('exception', models.TextField(blank=True)),
+                ('stacktrace', models.TextField(blank=True)),
+                ('_process', models.ForeignKey(db_column='process_id', editable=False, on_delete=django.db.models.deletion.CASCADE, to='galahad.Process')),
+                ('assignees', models.ManyToManyField(related_name='galahad_assignee_task_set', to=settings.AUTH_USER_MODEL, verbose_name='assignees')),
+                ('completed_by_user', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='galahad_completed_by_task_set', to=settings.AUTH_USER_MODEL, verbose_name='completed by')),
+                ('content_type', models.ForeignKey(editable=False, limit_choices_to=galahad.models.process_subclasses, on_delete=django.db.models.deletion.CASCADE, related_name='galahad_task_set', to='contenttypes.ContentType')),
+                ('parent_task_set', models.ManyToManyField(editable=False, related_name='child_task_set', to='galahad.Task')),
+            ],
+            options={
+                'get_latest_by': ('created',),
+                'permissions': (('rerun', 'Can rerun failed tasks.'), ('cancel', 'Can cancel failed tasks.'), ('override', 'Can override a process.')),
+                'ordering': ('-completed', '-created'),
+                'default_manager_name': 'objects',
+            },
+        ),
+    ]
diff --git a/galahad/migrations/__init__.py b/galahad/migrations/__init__.py
diff --git a/galahad/models.py b/galahad/models.py
@@ -5,6 +5,7 @@
 import graphviz as gv
 from django.contrib.contenttypes.fields import GenericForeignKey, GenericRelation
 from django.db import models, transaction
+from django.db.models.functions import Now
 from django.urls import path, reverse, NoReverseMatch
 from django.utils import timezone
 from django.utils.safestring import SafeString
@@ -89,6 +90,7 @@ class Process(models.Model, metaclass=BaseProcess):
     """
 
     manual_override = views.ManualOverrideView
+    detail_view = views.ProcessDetailView
 
     @classmethod
     def _wrap_view_instance(cls, name, view_instance):
@@ -134,9 +136,9 @@ def urls(cls):
                     route = '{name}/<pk>/'.format(name=name)
                 urls.append(path(route, cls._wrap_view_instance(name, node), name=name))
         urls.extend((
-            path('<pk>/', views.ProcessDetailView.as_view(model=cls),
+            path('<pk>/', cls.detail_view.as_view(model=cls),
                  name='detail'),
-            path('<pk>/override', views.ManualOverrideView.as_view(model=cls), name='override'),
+            path('<pk>/override', cls.manual_override.as_view(model=cls), name='override'),
         ))
         return urls, cls.get_url_namespace()
 
@@ -275,6 +277,9 @@ def save(self, **kwargs):
                 update_fields.append('modified')
         super().save(**kwargs)
 
+    def cancel(self, user=None):
+        self.task_set.cancel(user)
+
 
 def process_subclasses():
     from django.apps import apps
@@ -301,6 +306,18 @@ def not_succeeded(self):
     def failed(self):
         return self.filter(status=self.model.FAILED)
 
+    def canceled(self):
+        return self.filter(status=self.model.CANCELED)
+
+    def cancel(self, user=None):
+        if user and not user.is_authenticated:
+            user = None
+        return self.update(
+            status=self.model.CANCELED,
+            completed_by_user=user,
+            completed=Now(),
+        )
+
 
 class Task(models.Model):
     id = models.BigAutoField(primary_key=True, editable=False)
@@ -343,10 +360,12 @@ class Task(models.Model):
     FAILED = 'failed'
     SUCCEEDED = 'succeeded'
     SCHEDULED = 'scheduled'
+    CANCELED = 'canceled'
     _status_choices = (
         (FAILED, t(FAILED)),
         (SUCCEEDED, t(SUCCEEDED)),
         (SCHEDULED, t(SCHEDULED)),
+        (CANCELED, t(CANCELED)),
     )
     status = models.TextField(
         choices=_status_choices,
@@ -384,6 +403,7 @@ class Meta:
         get_latest_by = ('created',)
         permissions = (
             ('rerun', t('Can rerun failed tasks.')),
+            ('cancel', t('Can cancel failed tasks.')),
             ('override', t('Can override a process.')),
         )
         default_manager_name = 'objects'
@@ -431,6 +451,18 @@ def finish(self, user=None):
         else:
             self.save()
 
+    def cancel(self, user=None):
+        self.completed = timezone.now()
+        self.status = self.CANCELED
+        if user and not user.is_authenticated:
+            user = None
+        self.completed_by_user = user
+        self.save(update_fields=[
+            'status',
+            'completed',
+            'completed_by_user'
+        ])
+
     def fail(self):
         self.completed = timezone.now()
         self.status = self.FAILED
diff --git a/tests/testapp/migrations/0001_initial.py b/tests/testapp/migrations/0001_initial.py
@@ -0,0 +1,67 @@
+# Generated by Django 2.1.3 on 2018-11-29 15:10
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('galahad', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='GatewayProcess',
+            fields=[
+                ('process_ptr', models.OneToOneField(auto_created=True, on_delete=django.db.models.deletion.CASCADE, parent_link=True, primary_key=True, serialize=False, to='galahad.Process')),
+            ],
+            bases=('galahad.process',),
+        ),
+        migrations.CreateModel(
+            name='LoopProcess',
+            fields=[
+                ('process_ptr', models.OneToOneField(auto_created=True, on_delete=django.db.models.deletion.CASCADE, parent_link=True, primary_key=True, serialize=False, to='galahad.Process')),
+                ('counter', models.PositiveIntegerField(default=0)),
+            ],
+            bases=('galahad.process',),
+        ),
+        migrations.CreateModel(
+            name='SimpleProcess',
+            fields=[
+                ('process_ptr', models.OneToOneField(auto_created=True, on_delete=django.db.models.deletion.CASCADE, parent_link=True, primary_key=True, serialize=False, to='galahad.Process')),
+            ],
+            bases=('galahad.process',),
+        ),
+        migrations.CreateModel(
+            name='SplitJoinProcess',
+            fields=[
+                ('process_ptr', models.OneToOneField(auto_created=True, on_delete=django.db.models.deletion.CASCADE, parent_link=True, primary_key=True, serialize=False, to='galahad.Process')),
+                ('parallel_task_value', models.PositiveIntegerField(default=0)),
+            ],
+            bases=('galahad.process',),
+        ),
+        migrations.CreateModel(
+            name='WaitProcess',
+            fields=[
+                ('process_ptr', models.OneToOneField(auto_created=True, on_delete=django.db.models.deletion.CASCADE, parent_link=True, primary_key=True, serialize=False, to='galahad.Process')),
+                ('parallel_task_value', models.PositiveIntegerField(default=0)),
+            ],
+            bases=('galahad.process',),
+        ),
+        migrations.CreateModel(
+            name='WelcomeProcess',
+            fields=[
+                ('process_ptr', models.OneToOneField(auto_created=True, on_delete=django.db.models.deletion.CASCADE, parent_link=True, primary_key=True, serialize=False, to='galahad.Process')),
+                ('user', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)),
+            ],
+            options={
+                'abstract': False,
+            },
+            bases=('galahad.process', models.Model),
+        ),
+    ]
diff --git a/tests/testapp/migrations/__init__.py b/tests/testapp/migrations/__init__.py
