131 lines
3.2 KiB
Python
131 lines
3.2 KiB
Python
import time
|
|
from contextlib import contextmanager
|
|
from unittest.mock import patch
|
|
|
|
from rq import Queue
|
|
|
|
import frappe
|
|
from frappe.core.doctype.rq_job.rq_job import remove_failed_jobs
|
|
from frappe.tests.utils import FrappeTestCase
|
|
from frappe.utils.background_jobs import (
|
|
RQ_JOB_FAILURE_TTL,
|
|
RQ_RESULTS_TTL,
|
|
execute_job,
|
|
generate_qname,
|
|
get_redis_conn,
|
|
)
|
|
|
|
|
|
class TestBackgroundJobs(FrappeTestCase):
|
|
def test_remove_failed_jobs(self):
|
|
frappe.enqueue(method="frappe.tests.test_background_jobs.fail_function", queue="short")
|
|
# wait for enqueued job to execute
|
|
time.sleep(2)
|
|
conn = get_redis_conn()
|
|
queues = Queue.all(conn)
|
|
|
|
for queue in queues:
|
|
if queue.name == generate_qname("short"):
|
|
fail_registry = queue.failed_job_registry
|
|
self.assertGreater(fail_registry.count, 0)
|
|
|
|
remove_failed_jobs()
|
|
|
|
for queue in queues:
|
|
if queue.name == generate_qname("short"):
|
|
fail_registry = queue.failed_job_registry
|
|
self.assertEqual(fail_registry.count, 0)
|
|
|
|
def test_enqueue_at_front(self):
|
|
kwargs = {
|
|
"method": "frappe.handler.ping",
|
|
"queue": "short",
|
|
}
|
|
|
|
# give worker something to work on first so that get_position doesn't return None
|
|
frappe.enqueue(**kwargs)
|
|
|
|
# test enqueue with at_front=True
|
|
low_priority_job = frappe.enqueue(**kwargs)
|
|
high_priority_job = frappe.enqueue(**kwargs, at_front=True)
|
|
|
|
# lesser is earlier
|
|
self.assertTrue(high_priority_job.get_position() < low_priority_job.get_position())
|
|
|
|
def test_enqueue_call(self):
|
|
with patch.object(Queue, "enqueue_call") as mock_enqueue_call:
|
|
frappe.enqueue(
|
|
"frappe.handler.ping",
|
|
queue="short",
|
|
timeout=300,
|
|
kwargs={"site": frappe.local.site},
|
|
)
|
|
|
|
mock_enqueue_call.assert_called_once_with(
|
|
execute_job,
|
|
on_success=None,
|
|
on_failure=None,
|
|
timeout=300,
|
|
kwargs={
|
|
"site": frappe.local.site,
|
|
"user": "Administrator",
|
|
"method": "frappe.handler.ping",
|
|
"event": None,
|
|
"job_name": "frappe.handler.ping",
|
|
"is_async": True,
|
|
"kwargs": {"kwargs": {"site": frappe.local.site}},
|
|
},
|
|
at_front=False,
|
|
failure_ttl=RQ_JOB_FAILURE_TTL,
|
|
result_ttl=RQ_RESULTS_TTL,
|
|
job_id=None,
|
|
)
|
|
|
|
def test_job_hooks(self):
|
|
self.addCleanup(lambda: _test_JOB_HOOK.clear())
|
|
with freeze_local() as locals, frappe.init_site(locals.site), patch(
|
|
"frappe.get_hooks", patch_job_hooks
|
|
):
|
|
frappe.connect()
|
|
self.assertIsNone(_test_JOB_HOOK.get("before_job"))
|
|
r = execute_job(
|
|
site=frappe.local.site,
|
|
user="Administrator",
|
|
method="frappe.handler.ping",
|
|
event=None,
|
|
job_name="frappe.handler.ping",
|
|
is_async=True,
|
|
kwargs={},
|
|
)
|
|
self.assertEqual(r, "pong")
|
|
self.assertLess(_test_JOB_HOOK.get("before_job"), _test_JOB_HOOK.get("after_job"))
|
|
|
|
|
|
def fail_function():
|
|
return 1 / 0
|
|
|
|
|
|
_test_JOB_HOOK = {}
|
|
|
|
|
|
def before_job(*args, **kwargs):
|
|
_test_JOB_HOOK["before_job"] = time.time()
|
|
|
|
|
|
def after_job(*args, **kwargs):
|
|
_test_JOB_HOOK["after_job"] = time.time()
|
|
|
|
|
|
@contextmanager
|
|
def freeze_local():
|
|
locals = frappe.local
|
|
frappe.local = frappe.Local()
|
|
yield locals
|
|
frappe.local = locals
|
|
|
|
|
|
def patch_job_hooks(event: str):
|
|
return {
|
|
"before_job": ["frappe.tests.test_background_jobs.before_job"],
|
|
"after_job": ["frappe.tests.test_background_jobs.after_job"],
|
|
}[event]
|