mirror of
https://github.com/django/django.git
synced 2025-06-09 13:39:13 +00:00
234 lines
8.1 KiB
Python
234 lines
8.1 KiB
Python
from typing import cast
|
|
|
|
from django.db import transaction
|
|
from django.tasks import ResultStatus, Task, default_task_backend, tasks
|
|
from django.tasks.backends.dummy import DummyBackend
|
|
from django.tasks.exceptions import ResultDoesNotExist
|
|
from django.test import SimpleTestCase, TransactionTestCase, override_settings
|
|
|
|
from . import tasks as test_tasks
|
|
|
|
|
|
@override_settings(
|
|
TASKS={"default": {"BACKEND": "django.tasks.backends.dummy.DummyBackend"}}
|
|
)
|
|
class DummyBackendTestCase(SimpleTestCase):
|
|
def setUp(self):
|
|
default_task_backend.clear() # type:ignore[attr-defined]
|
|
|
|
def test_using_correct_backend(self):
|
|
self.assertEqual(default_task_backend, tasks["default"])
|
|
self.assertIsInstance(tasks["default"], DummyBackend)
|
|
|
|
def test_enqueue_task(self):
|
|
for task in [test_tasks.noop_task, test_tasks.noop_task_async]:
|
|
with self.subTest(task):
|
|
result = cast(Task, task).enqueue(1, two=3)
|
|
|
|
self.assertEqual(result.status, ResultStatus.NEW)
|
|
self.assertIsNone(result.started_at)
|
|
self.assertIsNone(result.finished_at)
|
|
with self.assertRaisesMessage(ValueError, "Task has not finished yet"):
|
|
result.return_value # noqa:B018
|
|
self.assertEqual(result.task, task)
|
|
self.assertEqual(result.args, [1])
|
|
self.assertEqual(result.kwargs, {"two": 3})
|
|
|
|
self.assertIn(
|
|
result, default_task_backend.results
|
|
) # type:ignore[attr-defined]
|
|
|
|
async def test_enqueue_task_async(self):
|
|
for task in [test_tasks.noop_task, test_tasks.noop_task_async]:
|
|
with self.subTest(task):
|
|
result = await cast(Task, task).aenqueue()
|
|
|
|
self.assertEqual(result.status, ResultStatus.NEW)
|
|
self.assertIsNone(result.started_at)
|
|
self.assertIsNone(result.finished_at)
|
|
with self.assertRaisesMessage(ValueError, "Task has not finished yet"):
|
|
result.return_value # noqa:B018
|
|
self.assertEqual(result.task, task)
|
|
self.assertEqual(result.args, [])
|
|
self.assertEqual(result.kwargs, {})
|
|
|
|
self.assertIn(
|
|
result, default_task_backend.results
|
|
) # type:ignore[attr-defined]
|
|
|
|
def test_get_result(self):
|
|
result = default_task_backend.enqueue(test_tasks.noop_task, (), {})
|
|
|
|
new_result = default_task_backend.get_result(result.id)
|
|
|
|
self.assertEqual(result, new_result)
|
|
|
|
async def test_get_result_async(self):
|
|
result = await default_task_backend.aenqueue(test_tasks.noop_task, (), {})
|
|
|
|
new_result = await default_task_backend.aget_result(result.id)
|
|
|
|
self.assertEqual(result, new_result)
|
|
|
|
def test_refresh_result(self):
|
|
result = default_task_backend.enqueue(
|
|
test_tasks.calculate_meaning_of_life, (), {}
|
|
)
|
|
|
|
enqueued_result = default_task_backend.results[0] # type:ignore[attr-defined]
|
|
object.__setattr__(enqueued_result, "status", ResultStatus.COMPLETE)
|
|
|
|
self.assertEqual(result.status, ResultStatus.NEW)
|
|
result.refresh()
|
|
self.assertEqual(result.status, ResultStatus.COMPLETE)
|
|
|
|
async def test_refresh_result_async(self):
|
|
result = await default_task_backend.aenqueue(
|
|
test_tasks.calculate_meaning_of_life, (), {}
|
|
)
|
|
|
|
enqueued_result = default_task_backend.results[0] # type:ignore[attr-defined]
|
|
object.__setattr__(enqueued_result, "status", ResultStatus.COMPLETE)
|
|
|
|
self.assertEqual(result.status, ResultStatus.NEW)
|
|
await result.arefresh()
|
|
self.assertEqual(result.status, ResultStatus.COMPLETE)
|
|
|
|
async def test_get_missing_result(self):
|
|
with self.assertRaises(ResultDoesNotExist):
|
|
default_task_backend.get_result("123")
|
|
|
|
with self.assertRaises(ResultDoesNotExist):
|
|
await default_task_backend.aget_result("123")
|
|
|
|
def test_enqueue_on_commit(self):
|
|
self.assertFalse(
|
|
default_task_backend._get_enqueue_on_commit_for_task(
|
|
test_tasks.enqueue_on_commit_task
|
|
)
|
|
)
|
|
|
|
def test_enqueue_logs(self):
|
|
with self.assertLogs("django.tasks", level="DEBUG") as captured_logs:
|
|
result = test_tasks.noop_task.enqueue()
|
|
|
|
self.assertEqual(len(captured_logs.output), 1)
|
|
self.assertIn("enqueued", captured_logs.output[0])
|
|
self.assertIn(result.id, captured_logs.output[0])
|
|
|
|
|
|
class DummyBackendTransactionTestCase(TransactionTestCase):
|
|
@override_settings(
|
|
TASKS={
|
|
"default": {
|
|
"BACKEND": "django.tasks.backends.dummy.DummyBackend",
|
|
"ENQUEUE_ON_COMMIT": True,
|
|
}
|
|
}
|
|
)
|
|
def test_wait_until_transaction_commit(self):
|
|
self.assertTrue(default_task_backend.enqueue_on_commit)
|
|
self.assertTrue(
|
|
default_task_backend._get_enqueue_on_commit_for_task(test_tasks.noop_task)
|
|
)
|
|
|
|
with transaction.atomic():
|
|
test_tasks.noop_task.enqueue()
|
|
|
|
self.assertEqual(
|
|
len(default_task_backend.results), 0
|
|
) # type:ignore[attr-defined]
|
|
|
|
self.assertEqual(
|
|
len(default_task_backend.results), 1
|
|
) # type:ignore[attr-defined]
|
|
|
|
@override_settings(
|
|
TASKS={
|
|
"default": {
|
|
"BACKEND": "django.tasks.backends.dummy.DummyBackend",
|
|
"ENQUEUE_ON_COMMIT": False,
|
|
}
|
|
}
|
|
)
|
|
def test_doesnt_wait_until_transaction_commit(self):
|
|
self.assertFalse(default_task_backend.enqueue_on_commit)
|
|
self.assertFalse(
|
|
default_task_backend._get_enqueue_on_commit_for_task(test_tasks.noop_task)
|
|
)
|
|
|
|
with transaction.atomic():
|
|
result = test_tasks.noop_task.enqueue()
|
|
|
|
self.assertIsNotNone(result.enqueued_at)
|
|
|
|
self.assertEqual(
|
|
len(default_task_backend.results), 1
|
|
) # type:ignore[attr-defined]
|
|
|
|
self.assertEqual(
|
|
len(default_task_backend.results), 1
|
|
) # type:ignore[attr-defined]
|
|
|
|
@override_settings(
|
|
TASKS={
|
|
"default": {
|
|
"BACKEND": "django.tasks.backends.dummy.DummyBackend",
|
|
}
|
|
}
|
|
)
|
|
def test_wait_until_transaction_by_default(self):
|
|
self.assertTrue(default_task_backend.enqueue_on_commit)
|
|
self.assertTrue(
|
|
default_task_backend._get_enqueue_on_commit_for_task(test_tasks.noop_task)
|
|
)
|
|
|
|
with transaction.atomic():
|
|
result = test_tasks.noop_task.enqueue()
|
|
|
|
self.assertIsNone(result.enqueued_at)
|
|
|
|
self.assertEqual(
|
|
len(default_task_backend.results), 0
|
|
) # type:ignore[attr-defined]
|
|
|
|
self.assertEqual(
|
|
len(default_task_backend.results), 1
|
|
) # type:ignore[attr-defined]
|
|
self.assertIsNone(result.enqueued_at)
|
|
result.refresh()
|
|
self.assertIsNotNone(result.enqueued_at)
|
|
|
|
@override_settings(
|
|
TASKS={
|
|
"default": {
|
|
"BACKEND": "django.tasks.backends.dummy.DummyBackend",
|
|
"ENQUEUE_ON_COMMIT": False,
|
|
}
|
|
}
|
|
)
|
|
def test_task_specific_enqueue_on_commit(self):
|
|
self.assertFalse(default_task_backend.enqueue_on_commit)
|
|
self.assertTrue(test_tasks.enqueue_on_commit_task.enqueue_on_commit)
|
|
self.assertTrue(
|
|
default_task_backend._get_enqueue_on_commit_for_task(
|
|
test_tasks.enqueue_on_commit_task
|
|
)
|
|
)
|
|
|
|
with transaction.atomic():
|
|
result = test_tasks.enqueue_on_commit_task.enqueue()
|
|
|
|
self.assertIsNone(result.enqueued_at)
|
|
|
|
self.assertEqual(
|
|
len(default_task_backend.results), 0
|
|
) # type:ignore[attr-defined]
|
|
|
|
self.assertEqual(
|
|
len(default_task_backend.results), 1
|
|
) # type:ignore[attr-defined]
|
|
self.assertIsNone(result.enqueued_at)
|
|
result.refresh()
|
|
self.assertIsNotNone(result.enqueued_at)
|