def test_djangohuey_configure_does_not_raise_error_when_both_settings_are_defined(
self, ):
DJANGO_HUEY = {
"queues": {
"queuename": {
"name": "test",
"immediate": True,
}
}
}
config = DjangoHueySettingsReader(DJANGO_HUEY)
config.configure()
def test_djangohuey_with_backend_class(self, *args):
DJANGO_HUEY = {
"queues": {
"first": {
"backend_class": "huey.RedisHuey",
}
}
}
config = DjangoHueySettingsReader(DJANGO_HUEY)
config.configure()
self.assertTrue(isinstance(config.get_queue("first"), RedisHuey))
def test_djangohuey_configure_when_django_huey_setting_is_defined(
self, *args):
DJANGO_HUEY = {
"queues": {
"first": {
"huey_class":
"huey.RedisHuey", # Huey implementation to use.
"name": "testname", # Use db name for huey.
},
"mails": {
"huey_class":
"huey.MemoryHuey", # Huey implementation to use.
"name": "testnamememory", # Use db name for huey.
},
}
}
config = DjangoHueySettingsReader(DJANGO_HUEY)
config.configure()
self.assertTrue(isinstance(config.get_queue("first"), RedisHuey))
self.assertEqual(config.get_queue("first").name, "testname")
self.assertTrue(isinstance(config.get_queue("mails"), MemoryHuey))
self.assertEqual(config.get_queue("mails").name, "testnamememory")
def test_djangohuey_config_with_no_settings(self):
with self.assertRaises(ConfigurationError) as cm:
DjangoHueySettingsReader(None)
self.assertEqual("Error: DJANGO_HUEY must be a dictionary",
str(cm.exception))
def test_djangohuey_get_queue_when_queue_is_included_from_module(self):
DJANGO_HUEY = {
"queues": {
**include("tests.queuesvalid"),
"mails": {
"huey_class": "huey.MemoryHuey",
"name": "first",
},
},
}
config = DjangoHueySettingsReader(DJANGO_HUEY)
config.configure()
queue = config.get_queue("test")
self.assertEqual(queue.name, "test")
def test_djangohuey_invalid_backend_class(self, *args):
DJANGO_HUEY = {
"queues": {
"first": {
"backend_class": "huey.RedisHuey2",
}
}
}
with self.assertRaises(ConfigurationError) as cm:
config = DjangoHueySettingsReader(DJANGO_HUEY)
config.configure()
self.assertEqual(
"Error: could not import Huey backend: huey.RedisHuey2",
str(cm.exception))
def test_djangohuey_get_queue_when_queue_is_none_and_default_queue_is_defined(
self):
DJANGO_HUEY = {
"default": "queuename",
"queues": {
"queuename": {
"name": "queue-default",
"immediate": True,
}
},
}
config = DjangoHueySettingsReader(DJANGO_HUEY)
config.configure()
queue = config.get_queue(None)
self.assertEqual(queue.name, "queue-default")
def test_djangohuey_configure_when_django_huey_setting_is_an_object_raises_error(
self, *args):
DJANGO_HUEY = object()
with self.assertRaises(ConfigurationError) as cm:
DjangoHueySettingsReader(DJANGO_HUEY)
self.assertEqual("Error: DJANGO_HUEY must be a dictionary",
str(cm.exception))
def test_djangohuey_get_queue_when_queue_is_none(self):
DJANGO_HUEY = {
"queues": {
"queuename": {
"name": "test",
"immediate": True,
}
}
}
config = DjangoHueySettingsReader(DJANGO_HUEY)
config.configure()
with self.assertRaises(ConfigurationError) as cm:
config.get_queue(None)
self.assertEqual(
"""
Command djangohuey must receive a --queue parameter or define a default queue in DJANGO_HUEY setting.
i.e.:
python manage.py djangohuey --queue first
or in settings file:
DJANGO_HUEY = {
'default': 'your-default-queue-name',
'queues': {
#Your queues here
}
}
""",
str(cm.exception),
)
def test_djangohuey_configure_when_there_are_two_queues_with_the_same_name(
self, *args):
DJANGO_HUEY = {
"queues": {
"first": {
"huey_class": "huey.RedisHuey",
"name": "first",
},
"mails": {
"huey_class": "huey.MemoryHuey",
"name": "first",
},
}
}
config = DjangoHueySettingsReader(DJANGO_HUEY)
with self.assertRaises(ConfigurationError) as cm:
config.configure()
self.assertEqual(
"There are more than one queue with the name 'first'. Check DJANGO_HUEY in your settings file.",
str(cm.exception),
)
def test_djangohuey_invalid_default_queue(self):
DJANGO_HUEY = {
"default": "invalid-queue",
"queues": {
"queuename": {
"name": "queue-default",
"immediate": True,
}
},
}
with self.assertRaises(ConfigurationError) as cm:
DjangoHueySettingsReader(DJANGO_HUEY)
self.assertEqual(
"Queue defined as default: invalid-queue, is not configured in DJANGO_HUEY.",
str(cm.exception),
)
def test_djangohuey_if_name_is_not_defined_queue_name_is_default(
self, *args):
DJANGO_HUEY = {
"queues": {
"first": {
"huey_class":
"huey.RedisHuey", # Huey implementation to use.
},
"mails": {
"huey_class":
"huey.MemoryHuey", # Huey implementation to use.
},
}
}
config = DjangoHueySettingsReader(DJANGO_HUEY)
config.configure()
self.assertEqual(config.get_queue("first").name, "first")
self.assertEqual(config.get_queue("mails").name, "mails")
from functools import wraps
from django.conf import settings
from django.db import close_old_connections
from django_huey.config import DjangoHueySettingsReader
DJANGO_HUEY = getattr(settings, "DJANGO_HUEY", None)
config = DjangoHueySettingsReader(DJANGO_HUEY)
config.configure()
def get_close_db_for_queue(queue):
def close_db(fn):
"""Decorator to be used with tasks that may operate on the database."""
@wraps(fn)
def inner(*args, **kwargs):
instance = get_queue(queue)
if not instance.immediate:
close_old_connections()
try:
return fn(*args, **kwargs)
finally:
if not instance.immediate:
close_old_connections()
return inner
return close_db