mirror of
https://github.com/GSA/notifications-api.git
synced 2026-01-30 06:21:50 -05:00
Merge pull request #3373 from alphagov/centralise-celery-180213914
Use central NotifyCelery base class in utils
This commit is contained in:
Ben Thorner
@@ -1,166 +0,0 @@
|
||||
import uuid
|
||||
|
||||
import pytest
|
||||
from flask import g
|
||||
from freezegun import freeze_time
|
||||
|
||||
from app import notify_celery
|
||||
|
||||
|
||||
# requiring notify_api ensures notify_celery.init_app has been called
|
||||
@pytest.fixture(scope='session')
|
||||
def celery_task(notify_api):
|
||||
@notify_celery.task(name=uuid.uuid4(), base=notify_celery.task_cls)
|
||||
def test_task(delivery_info=None): pass
|
||||
return test_task
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def async_task(celery_task):
|
||||
celery_task.push_request(delivery_info={'routing_key': 'test-queue'})
|
||||
yield celery_task
|
||||
celery_task.pop_request()
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def request_id_task(celery_task):
|
||||
# Note that each header is a direct attribute of the
|
||||
# task context (aka "request").
|
||||
celery_task.push_request(notify_request_id='1234')
|
||||
yield celery_task
|
||||
celery_task.pop_request()
|
||||
|
||||
|
||||
def test_success_should_log_and_call_statsd(mocker, notify_api, async_task):
|
||||
statsd = mocker.patch.object(notify_api.statsd_client, 'timing')
|
||||
logger = mocker.patch.object(notify_api.logger, 'info')
|
||||
|
||||
with freeze_time() as frozen:
|
||||
async_task()
|
||||
frozen.tick(5)
|
||||
|
||||
async_task.on_success(
|
||||
retval=None, task_id=1234, args=[], kwargs={}
|
||||
)
|
||||
|
||||
statsd.assert_called_once_with(f'celery.test-queue.{async_task.name}.success', 5.0)
|
||||
logger.assert_called_once_with(f'Celery task {async_task.name} (queue: test-queue) took 5.0000')
|
||||
|
||||
|
||||
def test_success_queue_when_applied_synchronously(mocker, notify_api, celery_task):
|
||||
statsd = mocker.patch.object(notify_api.statsd_client, 'timing')
|
||||
logger = mocker.patch.object(notify_api.logger, 'info')
|
||||
|
||||
with freeze_time() as frozen:
|
||||
celery_task()
|
||||
frozen.tick(5)
|
||||
|
||||
celery_task.on_success(
|
||||
retval=None, task_id=1234, args=[], kwargs={}
|
||||
)
|
||||
|
||||
statsd.assert_called_once_with(f'celery.none.{celery_task.name}.success', 5.0)
|
||||
logger.assert_called_once_with(f'Celery task {celery_task.name} (queue: none) took 5.0000')
|
||||
|
||||
|
||||
def test_failure_should_log_and_call_statsd(mocker, notify_api, async_task):
|
||||
statsd = mocker.patch.object(notify_api.statsd_client, 'incr')
|
||||
logger = mocker.patch.object(notify_api.logger, 'exception')
|
||||
|
||||
async_task.on_failure(
|
||||
exc=Exception, task_id=1234, args=[], kwargs={}, einfo=None
|
||||
)
|
||||
|
||||
statsd.assert_called_once_with(f'celery.test-queue.{async_task.name}.failure')
|
||||
logger.assert_called_once_with(f'Celery task {async_task.name} (queue: test-queue) failed')
|
||||
|
||||
|
||||
def test_failure_queue_when_applied_synchronously(mocker, notify_api, celery_task):
|
||||
statsd = mocker.patch.object(notify_api.statsd_client, 'incr')
|
||||
logger = mocker.patch.object(notify_api.logger, 'exception')
|
||||
|
||||
celery_task.on_failure(
|
||||
exc=Exception, task_id=1234, args=[], kwargs={}, einfo=None
|
||||
)
|
||||
|
||||
statsd.assert_called_once_with(f'celery.none.{celery_task.name}.failure')
|
||||
logger.assert_called_once_with(f'Celery task {celery_task.name} (queue: none) failed')
|
||||
|
||||
|
||||
def test_call_exports_request_id_from_headers(mocker, request_id_task):
|
||||
g = mocker.patch('app.celery.celery.g')
|
||||
request_id_task()
|
||||
assert g.request_id == '1234'
|
||||
|
||||
|
||||
def test_call_copes_if_request_id_not_in_headers(mocker, celery_task):
|
||||
g = mocker.patch('app.celery.celery.g')
|
||||
celery_task()
|
||||
assert g.request_id is None
|
||||
|
||||
|
||||
def test_send_task_injects_global_request_id_into_headers(mocker, notify_api):
|
||||
super_apply = mocker.patch('celery.Celery.send_task')
|
||||
g.request_id = '1234'
|
||||
notify_celery.send_task('some-task')
|
||||
|
||||
super_apply.assert_called_with(
|
||||
'some-task', # name
|
||||
None, # args
|
||||
None, # kwargs
|
||||
headers={'notify_request_id': '1234'} # other kwargs
|
||||
)
|
||||
|
||||
|
||||
def test_send_task_injects_request_id_with_existing_headers(mocker, notify_api):
|
||||
super_apply = mocker.patch('celery.Celery.send_task')
|
||||
g.request_id = '1234'
|
||||
|
||||
notify_celery.send_task(
|
||||
'some-task',
|
||||
None, # args
|
||||
None, # kwargs
|
||||
headers={'something': 'else'} # other kwargs
|
||||
)
|
||||
|
||||
super_apply.assert_called_with(
|
||||
'some-task', # name
|
||||
None, # args
|
||||
None, # kwargs
|
||||
headers={'notify_request_id': '1234', 'something': 'else'} # other kwargs
|
||||
)
|
||||
|
||||
|
||||
def test_send_task_injects_request_id_with_none_headers(mocker, notify_api):
|
||||
super_apply = mocker.patch('celery.Celery.send_task')
|
||||
g.request_id = '1234'
|
||||
|
||||
notify_celery.send_task(
|
||||
'some-task',
|
||||
None, # args
|
||||
None, # kwargs
|
||||
headers=None, # other kwargs (task retry set headers to "None")
|
||||
)
|
||||
|
||||
super_apply.assert_called_with(
|
||||
'some-task', # name
|
||||
None, # args
|
||||
None, # kwargs
|
||||
headers={'notify_request_id': '1234'} # other kwargs
|
||||
)
|
||||
|
||||
|
||||
def test_send_task_injects_id_into_kwargs_from_request(mocker, notify_api):
|
||||
super_apply = mocker.patch('celery.Celery.send_task')
|
||||
request_id_header = notify_api.config['NOTIFY_TRACE_ID_HEADER']
|
||||
request_headers = {request_id_header: '1234'}
|
||||
|
||||
with notify_api.test_request_context(headers=request_headers):
|
||||
notify_celery.send_task('some-task')
|
||||
|
||||
super_apply.assert_called_with(
|
||||
'some-task', # name
|
||||
None, # args
|
||||
None, # kwargs
|
||||
headers={'notify_request_id': '1234'} # other kwargs
|
||||
)
|
||||
Reference in New Issue
Block a user