用Django芹菜进行单元测试？

Question

我正试图为我们的django-celery项目提出一种测试方法。我读过documentation中的注释，但它并没有给我一个好主意，告诉我该怎么做。我不担心在实际的守护进程中测试任务，只担心我的代码的功能。我主要想知道：

1. 在测试期间，我们如何绕过task.delay()（我试着设置CELERY_ALWAYS_EAGER = True，但没有区别）？
2. 我们如何使用推荐的测试设置（如果这是最好的方法），而不实际更改我们的设置.py？
3. 我们还可以使用manage.py test还是必须使用自定义运行程序？

总的来说，任何提示或芹菜测试技巧都会非常有用。

Answer 1

这是我的测试基类的一个摘录，它去掉了apply_async方法，并记录了对它的调用（包括Task.delay），这有点恶心，但它满足了我过去几个月的使用需求。

from django.test import TestCase
from celery.task.base import Task
# For recent versions, Task has been moved to celery.task.app:
# from celery.app.task import Task
# See http://docs.celeryproject.org/en/latest/reference/celery.app.task.html

class CeleryTestCaseBase(TestCase):

    def setUp(self):
        super(CeleryTestCaseBase, self).setUp()
        self.applied_tasks = []

        self.task_apply_async_orig = Task.apply_async

        @classmethod
        def new_apply_async(task_class, args=None, kwargs=None, **options):
            self.handle_apply_async(task_class, args, kwargs, **options)

        # monkey patch the regular apply_sync with our method
        Task.apply_async = new_apply_async

    def tearDown(self):
        super(CeleryTestCaseBase, self).tearDown()

        # Reset the monkey patch to the original method
        Task.apply_async = self.task_apply_async_orig

    def handle_apply_async(self, task_class, args=None, kwargs=None, **options):
        self.applied_tasks.append((task_class, tuple(args), kwargs))

    def assert_task_sent(self, task_class, *args, **kwargs):
        was_sent = any(task_class == task[0] and args == task[1] and kwargs == task[2]
                       for task in self.applied_tasks)
        self.assertTrue(was_sent, 'Task not called w/class %s and args %s' % (task_class, args))

    def assert_task_not_sent(self, task_class):
        was_sent = any(task_class == task[0] for task in self.applied_tasks)
        self.assertFalse(was_sent, 'Task was not expected to be called, but was.  Applied tasks: %s' %                 self.applied_tasks)

下面是一个“从头开始”的例子，说明如何在测试用例中使用它：

mymodule.py

from my_tasks import SomeTask

def run_some_task(should_run):
    if should_run:
        SomeTask.delay(1, some_kwarg=2)

test_mymodule.py

class RunSomeTaskTest(CeleryTestCaseBase):
    def test_should_run(self):
        run_some_task(should_run=True)
        self.assert_task_sent(SomeTask, 1, some_kwarg=2)

    def test_should_not_run(self):
        run_some_task(should_run=False)
        self.assert_task_not_sent(SomeTask)

Answer 2

尝试设置：

BROKER_BACKEND = 'memory'

（感谢asksol的评论。）

Answer 3

我喜欢在需要芹菜结果才能完成的测试上使用override_settings装饰符。

from django.test import TestCase
from django.test.utils import override_settings
from myapp.tasks import mytask

class AddTestCase(TestCase):

    @override_settings(CELERY_EAGER_PROPAGATES_EXCEPTIONS=True,
                       CELERY_ALWAYS_EAGER=True,
                       BROKER_BACKEND='memory')
    def test_mytask(self):
        result = mytask.delay()
        self.assertTrue(result.successful())

如果要将此应用于所有测试，可以使用http://docs.celeryproject.org/en/2.5/django/unit-testing.html中描述的芹菜测试运行器，它基本上设置了除（BROKER_BACKEND = 'memory'）之外的相同设置。

在“设置”中：

TEST_RUNNER = 'djcelery.contrib.test_runner.CeleryTestSuiteRunner'

看看芹菜SuiteRunner的来源，很清楚发生了什么。