Skip to content

Add terminate selected tasks action in admin #449

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion django_celery_results/admin.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
"""Result Task Admin interface."""

from celery import current_app as celery_app
from django.conf import settings
from django.contrib import admin
from django.contrib import admin, messages
from django.utils.translation import gettext_lazy as _

try:
Expand Down Expand Up @@ -58,6 +59,7 @@ class TaskResultAdmin(admin.ModelAdmin):
'classes': ('extrapretty', 'wide')
}),
)
actions = ['terminate_task']

def get_readonly_fields(self, request, obj=None):
if ALLOW_EDITS:
Expand All @@ -67,6 +69,25 @@ def get_readonly_fields(self, request, obj=None):
field.name for field in self.opts.local_fields
})

def terminate_task(self, request, queryset):
"""Terminate selected tasks."""
task_ids = list(queryset.values_list('task_id', flat=True))
try:
celery_app.control.terminate(task_ids)
self.message_user(
request,
f"{len(task_ids)} Task was terminated successfully.",
messages.SUCCESS,
)
except Exception as e:
self.message_user(
request,
f"Error while terminating tasks: {e}",
messages.ERROR,
)

terminate_task.short_description = "Terminate selected tasks"


admin.site.register(TaskResult, TaskResultAdmin)

Expand Down
90 changes: 90 additions & 0 deletions t/unit/test_admin.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
from unittest.mock import MagicMock, patch

import pytest
from celery import uuid
from django.contrib.messages import constants, get_messages
from django.contrib.messages.middleware import MessageMiddleware
from django.contrib.sessions.middleware import SessionMiddleware
from django.test import RequestFactory, TestCase

from django_celery_results.admin import TaskResultAdmin
from django_celery_results.models import TaskResult


@pytest.mark.usefixtures('depends_on_current_app')
class test_Admin(TestCase):

def setUp(self):
self.task_admin = TaskResultAdmin(model=TaskResult, admin_site=None)
self.factory = RequestFactory()

def _apply_middleware(self, request):
SessionMiddleware(lambda req: None).process_request(request)
MessageMiddleware(lambda req: None).process_request(request)
request.session.save()

def create_task_result(self):
id = uuid()
taskmeta, created = TaskResult.objects.get_or_create(task_id=id)
return taskmeta

@patch('celery.current_app.control.terminate')
def test_terminate_task_success(self, mock_terminate):
# Create mock request
request = self.factory.post('/')
request.user = MagicMock()
self._apply_middleware(request)

# Create mock queryset
tr1 = self.create_task_result()
tr2 = self.create_task_result()
task_id_list = [tr1.task_id, tr2.task_id]

mock_queryset = MagicMock()
mock_queryset.values_list.return_value = task_id_list

# Call the terminate_task method
self.task_admin.terminate_task(request, mock_queryset)

# Verify terminate was called with the correct task IDs
mock_terminate.assert_called_once_with(task_id_list)

# Verify message_user was called with the success message
messages = list(get_messages(request))
self.assertEqual(len(messages), 1)
self.assertEqual(
str(messages[0]),
"2 Task was terminated successfully.")
self.assertEqual(messages[0].level, constants.SUCCESS)

@patch('celery.current_app.control.terminate')
def test_terminate_task_failure(self, mock_terminate):
# Create mock request
request = self.factory.post('/')
request.user = MagicMock()
self._apply_middleware(request)

# Create mock queryset
tr1 = self.create_task_result()
tr2 = self.create_task_result()
task_id_list = [tr1.task_id, tr2.task_id]

mock_queryset = MagicMock()
mock_queryset.values_list.return_value = task_id_list

# Simulate an exception in terminate
mock_terminate.side_effect = Exception("Termination failed")

# Call the terminate_task method
self.task_admin.terminate_task(request, mock_queryset)

# Verify terminate was called with the correct task IDs
mock_terminate.assert_called_once_with(task_id_list)

# Verify message_user was called with the error message
messages = list(get_messages(request))
self.assertEqual(len(messages), 1)
self.assertIn(
str(messages[0]),
"Error while terminating tasks: Termination failed")
self.assertEqual(messages[0].level, constants.ERROR)