celery/celerytest

Name: celerytest

Owner: Celery

Description: Run monitored Celery workers for your integration tests

Created: 2015-11-17 10:00:30.0

Updated: 2018-03-31 00:15:34.0

Pushed: 2015-05-18 08:37:09.0

Homepage: null

Size: 337

Language: Python

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

celerytest - Integration testing with Celery

Writing (integration) tests that depend on Celery tasks is problematic. When you manually run a Celery worker together with your tests, it runs in a separate process and there's no clean way to address objects targeted by Celery from your tests. When you use a separate test database (as with Django for example), you'll have to duplicate configuration code so your Celery worker accesses the same database.

celerytest provides the ability to run a Celery worker in the background from your tests. It also allows your tests to monitor the worker and pause until Celery tasks are completed.

Using celerytest

To start a Celery worker in a separate thread, use:

= Celery() # your Celery app
er = start_celery_worker(app) # configure the app for our celery worker

To wait for the worker to finish executing tasks, use:

lt = some_celery_task.delay()
er.idle.wait() # optionally specify time-out

Django

To use this with your django app through django-celery, get your app as such:

 djcelery.app import app
er = start_celery_worker(app)

TestCase

If you want to use this in a unittest TestCase, you can use CeleryTestCaseMixin. If you're writing unit tests that depend on a celery worker, though, you're doing it wrong. For unit tests, you'll want to mock your Celery methods and test them separately. You could use CeleryTestCaseMixin to write integration tests with Celery tasks, though.

 unittest import TestCase
 celerytest.testcase import CeleryTestCaseMixin, setup_celery_worker
rt time

= Celery()
p_celery_worker(app) # need to setup worker outside

s SomeTestCase(CeleryTestCaseMixin, TestCase):
celery_app = app
celery_concurrency = 4

def test_something(self):
    result = multiply.delay(2,3)
    self.worker.idle.wait()
    self.assertEqual(result.get(), 6)

Lettuce

To automatically launch a worker in the background while running a Lettuce integration test suite, add to terrain.py:

_celery_app.py
= Celery('my_celery_app', broker='amqp://')

rrain.py
 lettuce import *
 celerytest import start_celery_worker

place this with an import of your actual app
 my_celery_app import app

ore.harvest
initial_setup(server):
# memory transport may not work here
world.celery = start_celery_worker(app, config="amqp")

er.harvest
cleanup(server):
world.celery.stop()

er.each_step
after_step(step):
# make sure we've received any scheduled tasks
world.celery.active.wait(.05) 
# allow tasks to complete
world.celery.idle.wait(5)

Installation

Install the latest version of celerytest from PyPI:

$ pip install celerytest

Or, clone the latest version of celerytest from GitHub and run setup:

$ git clone git://github.com/RentMethod/celerytest.git
$ cd celerytest
$ ./setup.py install # as root