Celery文档提到了在Django中测试Celery,但没有解释如果不使用Django,如何测试Celery任务。你怎么做到这一点?
Celery文档提到了在Django中测试Celery,但没有解释如果不使用Django,如何测试Celery任务。你怎么做到这一点?
Answers:
可以使用任何unittest库同步测试任务。在处理芹菜任务时,我通常会进行2次不同的测试。第一个(如我所建议的,下面是波纹管)是完全同步的,应该确保算法执行应做的工作。第二部分使用整个系统(包括代理),并确保我没有序列化问题或任何其他分发,通信问题。
所以:
from celery import Celery
celery = Celery()
@celery.task
def add(x, y):
return x + y
和您的测试:
from nose.tools import eq_
def test_add_task():
rst = add.apply(args=(4, 4)).get()
eq_(rst, 8)
希望有帮助!
我用这个:
with mock.patch('celeryconfig.CELERY_ALWAYS_EAGER', True, create=True):
...
文件:http : //docs.celeryproject.org/en/3.1/configuration.html#celery-always-eager
CELERY_ALWAYS_EAGER使您可以同步运行任务,并且不需要芹菜服务器。
ImportError: No module named celeryconfig
。
celeryconfig.py
位于自己的包装中。参见docs.celeryproject.org/en/latest/getting-started/…。
add
从TestCase
班级中的OP问题中启动任务?
CELERY_TASK_ALWAYS_EAGER
用于单元测试。
取决于您要测试的内容。
import unittest
from myproject.myapp import celeryapp
class TestMyCeleryWorker(unittest.TestCase):
def setUp(self):
celeryapp.conf.update(CELERY_ALWAYS_EAGER=True)
# conftest.py
from myproject.myapp import celeryapp
@pytest.fixture(scope='module')
def celery_app(request):
celeryapp.conf.update(CELERY_ALWAYS_EAGER=True)
return celeryapp
# test_tasks.py
def test_some_task(celery_app):
...
from celery import current_app
def send_task(name, args=(), kwargs={}, **opts):
# https://github.com/celery/celery/issues/581
task = current_app.tasks[name]
return task.apply(args, kwargs, **opts)
current_app.send_task = send_task
对于Celery 4上的用户:
@override_settings(CELERY_TASK_ALWAYS_EAGER=True)
由于设置名称已更改,如果您选择升级,则需要更新,请参见
从Celery 3.0开始,CELERY_ALWAYS_EAGER
在Django中进行设置的一种方法是:
from django.test import TestCase, override_settings
from .foo import foo_celery_task
class MyTest(TestCase):
@override_settings(CELERY_ALWAYS_EAGER=True)
def test_foo(self):
self.assertTrue(foo_celery_task.delay())
从Celery v4.0开始,提供了py.test固定装置来启动celery工人只是为了进行测试,并在完成后将其关闭:
def test_myfunc_is_executed(celery_session_worker):
# celery_session_worker: <Worker: gen93553@gnpill.local (running)>
assert myfunc.delay().wait(3)
在http://docs.celeryproject.org/en/latest/userguide/testing.html#py-test中描述的其他灯具中,您可以通过celery_config
以下方式重新定义灯具来更改celery的默认选项:
@pytest.fixture(scope='session')
def celery_config():
return {
'accept_content': ['json', 'pickle'],
'result_serializer': 'pickle',
}
默认情况下,测试人员使用内存中的代理和结果后端。如果不测试特定功能,则无需使用本地Redis或RabbitMQ。
使用pytest 参考。
def test_add(celery_worker):
mytask.delay()
如果您使用烧瓶,请设置应用配置
CELERY_BROKER_URL = 'memory://'
CELERY_RESULT_BACKEND = 'cache+memory://'
和在 conftest.py
@pytest.fixture
def app():
yield app # Your actual Flask application
@pytest.fixture
def celery_app(app):
from celery.contrib.testing import tasks # need it
yield celery_app # Your actual Flask-Celery application
就我而言(我假设还有很多其他人),我想要做的就是使用pytest测试任务的内部逻辑。
TL; DR; 最终嘲笑了一切(选项2)
示例用例:
proj/tasks.py
@shared_task(bind=True)
def add_task(self, a, b):
return a+b;
tests/test_tasks.py
from proj import add_task
def test_add():
assert add_task(1, 2) == 3, '1 + 2 should equal 3'
但是,由于shared_task
装饰器执行了许多芹菜内部逻辑操作,因此它实际上不是单元测试。
因此,对我来说,有2种选择:
选项1:独立的内部逻辑
proj/tasks_logic.py
def internal_add(a, b):
return a + b;
proj/tasks.py
from .tasks_logic import internal_add
@shared_task(bind=True)
def add_task(self, a, b):
return internal_add(a, b);
这看起来很奇怪,除了使可读性降低之外,它还需要手动提取并传递属于请求的属性,例如task_id
在您需要的情况下,这会使逻辑不那么纯净。
选项2:模拟
嘲笑芹菜内部
tests/__init__.py
# noinspection PyUnresolvedReferences
from celery import shared_task
from mock import patch
def mock_signature(**kwargs):
return {}
def mocked_shared_task(*decorator_args, **decorator_kwargs):
def mocked_shared_decorator(func):
func.signature = func.si = func.s = mock_signature
return func
return mocked_shared_decorator
patch('celery.shared_task', mocked_shared_task).start()
然后,它允许我模拟请求对象(同样,如果您需要请求中的内容,例如ID或重试计数器)。
tests/test_tasks.py
from proj import add_task
class MockedRequest:
def __init__(self, id=None):
self.id = id or 1
class MockedTask:
def __init__(self, id=None):
self.request = MockedRequest(id=id)
def test_add():
mocked_task = MockedTask(id=3)
assert add_task(mocked_task, 1, 2) == 3, '1 + 2 should equal 3'
该解决方案更加手动,但是,它为我提供了实际进行单元测试所需的控制,而无需重复自己,也不会丢失芹菜范围。