Merge pull request #271 from amcmahon-rh/cancelled_by

Record user who cancelled a task [RHELDST-460]

Author: amcmahon-rh

kobo/hub/migrations/0005_add_task_canceller.py

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+from django.db import models, migrations
+from django.conf import settings
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('hub', '0004_alter_task_worker'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='task',
+            name='cancelled_by',
+            field=models.ForeignKey(settings.AUTH_USER_MODEL, null=True, blank=True, on_delete=models.CASCADE),
+        ),
+    ]

kobo/hub/models.py

@@ -578,6 +578,8 @@ class Task(models.Model):
     resubmitted_by      = models.ForeignKey(settings.AUTH_USER_MODEL, null=True, blank=True, related_name="resubmitted_by1", on_delete=models.CASCADE)
     resubmitted_from    = models.ForeignKey("self", null=True, blank=True, related_name="resubmitted_from1", on_delete=models.CASCADE)
 
+    cancelled_by        = models.ForeignKey(settings.AUTH_USER_MODEL, null=True, blank=True, on_delete=models.CASCADE)
+
     subtask_count       = models.PositiveIntegerField(default=0, help_text=_("Subtask count.<br />This is a generated field."))
 
     # override default *objects* Manager
@@ -895,12 +897,14 @@ def cancel_task(self, user=None, recursive=True):
 
         try:
             self.__lock(self.worker_id, new_state=TASK_STATES["CANCELED"], initial_states=(TASK_STATES["FREE"], TASK_STATES["ASSIGNED"], TASK_STATES["OPEN"], TASK_STATES["CREATED"]))
+            self.cancelled_by = user
+            self.save()
         except (MultipleObjectsReturned, ObjectDoesNotExist):
             raise Exception("Cannot cancel task %d, state is %s" % (self.id, self.get_state_display()))
 
         if recursive:
             for task in self.subtasks():
-                task.cancel_task(recursive=True)
+                task.cancel_task(user=user, recursive=True)
         self.logs.gzip_logs()
 
     def cancel_subtasks(self):

kobo/hub/templates/task/detail.html

@@ -27,6 +27,17 @@ <h3>{% trans 'Details' %}</h3>
     <td class="{{ task.get_state_display }}">{{ task.get_state_display }}</td>
   </tr>
 
+  {% if task.state == "CANCELED" %}
+  <tr>
+    <th>{% trans "Cancelled by" %}</th>
+    {% if task.cancelled_by %}
+      <td>{{ task.cancelled_by }}</td>
+    {% else %}
+      <td>Unavailable</td>
+    {% endif %}
+  </tr>
+{% endif %}
+
   <tr>
     <th>{% trans "Worker" %}</th>
     <td>{% if task.worker %}{{ task.worker }}{% endif %}</td>

tests/test_models.py

@@ -1243,10 +1243,11 @@ def test_cancel_task(self):
             state=TASK_STATES['FREE'],
         )
 
-        task.cancel_task()
+        task.cancel_task(self._user)
 
         task = Task.objects.get(id=task.id)
         self.assertEqual(task.state, TASK_STATES['CANCELED'])
+        self.assertEqual(task.cancelled_by, self._user)
 
     def test_interrupt_task(self):
         task = Task.objects.create(

tests/test_xmlrpc_client.py

@@ -187,7 +187,7 @@ def test_get_tasks_filter_by_state(self):
 
     def test_cancel_task(self):
         task_id = Task.create_task(self._user.username, 'task', 'method')
-        ret = client.cancel_task(_make_request(), task_id)
+        ret = client.cancel_task(_make_request(self._user), task_id)
         self.assertIsNone(ret)
 
         t = Task.objects.get(id=task_id)