This repository has been archived on 2023-02-07. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
flamenco-worker/tests/test_worker.py
Sybren A. Stüvel d25d409e35 Report web-preview-friendly output when produced
When multiple versions of the same frame are generated (like EXR and
JPG), always report the most web-preview-friendly version.

In other words, when the frames are produces by Blender in the order
(`frame-001.jpg`, `frame-001.exr`), only the JPEG is reported. When the
JPEG follows the EXR, both will be reported as when the EXR is created
it is not yet know whether it will be followed by a JPEG or not.

Before this, the 2nd file would never be reported due to the Worker
throttling such reports to the Manager (to not swamp it when rendering
sequences of images, for example).
2021-07-12 13:11:52 +02:00

727 lines
26 KiB
Python

import concurrent.futures
import unittest
import unittest.mock
from unittest.mock import Mock, call
import asyncio
import requests
from tests.abstract_worker_test import AbstractWorkerTest
class AbstractFWorkerTest(AbstractWorkerTest):
def setUp(self):
from flamenco_worker.cli import construct_asyncio_loop
from flamenco_worker.upstream import FlamencoManager
from flamenco_worker.worker import FlamencoWorker
from flamenco_worker.runner import TaskRunner
from flamenco_worker.upstream_update_queue import TaskUpdateQueue
from tests.mock_responses import CoroMock
self.asyncio_loop = construct_asyncio_loop()
self.asyncio_loop.set_debug(True)
self.shutdown_future = self.asyncio_loop.create_future()
self.manager = Mock(spec=FlamencoManager)
self.manager.post = CoroMock()
self.trunner = Mock(spec=TaskRunner)
self.trunner.aggr_timing_info = {}
self.tuqueue = Mock(spec=TaskUpdateQueue)
self.tuqueue.flush_and_report = CoroMock()
self.tuqueue.queue_size.return_value = 0
self.trunner.execute = self.mock_task_execute
self.trunner.abort_current_task = CoroMock()
self.worker = FlamencoWorker(
manager=self.manager,
trunner=self.trunner,
tuqueue=self.tuqueue,
task_types=["sleep", "unittest"],
worker_id="1234",
worker_secret="jemoeder",
loop=self.asyncio_loop,
shutdown_future=self.shutdown_future,
)
# Prime the LRU cache to always return this hostname.
with unittest.mock.patch("socket.gethostname") as gethostname:
gethostname.return_value = "ws-unittest"
self.worker.hostname()
def tearDown(self):
if self.worker._push_act_to_manager is not None:
try:
self.asyncio_loop.run_until_complete(self.worker._push_act_to_manager)
except asyncio.CancelledError:
pass
if self.worker._push_log_to_manager is not None:
try:
self.asyncio_loop.run_until_complete(self.worker._push_log_to_manager)
except asyncio.CancelledError:
pass
self.shutdown_future.cancel()
self.worker.shutdown()
self.asyncio_loop.close()
async def mock_task_execute(self, task: dict, fworker):
"""Mock task execute function that does nothing but sleep a bit."""
await asyncio.sleep(1)
return True
class WorkerStartupTest(AbstractFWorkerTest):
# Mock merge_with_home_config() so that it doesn't overwrite actual config.
@unittest.mock.patch("flamenco_worker.config.merge_with_home_config")
def test_startup_already_registered(self, mock_merge_with_home_config):
from tests.mock_responses import EmptyResponse, CoroMock
self.manager.post = CoroMock(return_value=EmptyResponse())
self.asyncio_loop.run_until_complete(self.worker.startup(may_retry_loop=False))
mock_merge_with_home_config.assert_not_called() # Starting with known ID/secret
self.manager.post.assert_called_once_with(
"/sign-on",
json={
"supported_task_types": ["sleep", "unittest"],
"nickname": "ws-unittest",
},
loop=self.asyncio_loop,
)
self.tuqueue.queue.assert_not_called()
@unittest.mock.patch("flamenco_worker.config.merge_with_home_config")
def test_startup_registration(self, mock_merge_with_home_config):
from flamenco_worker.worker import detect_platform
from tests.mock_responses import JsonResponse, CoroMock
self.worker.worker_id = None
self.manager.post = CoroMock(
return_value=JsonResponse(
{
"_id": "5555",
}
)
)
self.asyncio_loop.run_until_complete(self.worker.startup(may_retry_loop=False))
mock_merge_with_home_config.assert_called_once_with(
{"worker_id": "5555", "worker_secret": self.worker.worker_secret}
)
assert isinstance(self.manager.post, unittest.mock.Mock)
self.manager.post.assert_called_once_with(
"/register-worker",
json={
"platform": detect_platform(),
"supported_task_types": ["sleep", "unittest"],
"secret": self.worker.worker_secret,
"nickname": "ws-unittest",
},
auth=None,
loop=self.asyncio_loop,
)
@unittest.mock.patch("socket.gethostname")
@unittest.mock.patch("flamenco_worker.config.merge_with_home_config")
def test_startup_registration_unhappy(
self, mock_merge_with_home_config, mock_gethostname
):
"""Test that startup is aborted when the worker can't register."""
from flamenco_worker.worker import detect_platform, UnableToRegisterError
from tests.mock_responses import JsonResponse, CoroMock
self.worker.worker_id = None
mock_gethostname.return_value = "ws-unittest"
self.manager.post = CoroMock(
return_value=JsonResponse(
{
"_id": "5555",
},
status_code=500,
)
)
# Mock merge_with_home_config() so that it doesn't overwrite actual config.
self.assertRaises(
UnableToRegisterError,
self.asyncio_loop.run_until_complete,
self.worker.startup(may_retry_loop=False),
)
mock_merge_with_home_config.assert_not_called()
assert isinstance(self.manager.post, unittest.mock.Mock)
self.manager.post.assert_called_once_with(
"/register-worker",
json={
"platform": detect_platform(),
"supported_task_types": ["sleep", "unittest"],
"secret": self.worker.worker_secret,
"nickname": "ws-unittest",
},
auth=None,
loop=self.asyncio_loop,
)
# Mock merge_with_home_config() so that it doesn't overwrite actual config.
@unittest.mock.patch("flamenco_worker.config.merge_with_home_config")
def test_reregister_if_forbidden(self, mock_merge_with_home_config):
from tests.mock_responses import (
CoroMock,
EmptyResponse,
JsonResponse,
TextResponse,
)
from flamenco_worker.worker import detect_platform
self.manager.post = CoroMock(
side_effect=[
# First sign-on fails:
requests.exceptions.HTTPError(
response=TextResponse(text="401 Unauthorized", status_code=401)
),
# Automatic re-register response:
JsonResponse({"_id": "47327"}),
# Subsequent sign-on is OK:
EmptyResponse(),
]
)
self.assertEqual(self.worker.worker_id, "1234")
old_worker_secret = self.worker.worker_secret
self.asyncio_loop.run_until_complete(self.worker.startup(may_retry_loop=False))
mock_merge_with_home_config.assert_called_once_with(
{"worker_id": "47327", "worker_secret": self.worker.worker_secret}
)
self.assertEqual(self.worker.worker_id, "47327")
self.assertNotEqual(old_worker_secret, self.worker.worker_secret)
self.assertEqual(("47327", self.worker.worker_secret), self.worker.manager.auth)
self.manager.post.assert_has_calls(
[
call(
"/sign-on",
json={
"supported_task_types": ["sleep", "unittest"],
"nickname": "ws-unittest",
},
loop=self.asyncio_loop,
),
call(
"/register-worker",
json={
"secret": self.worker.worker_secret,
"platform": detect_platform(),
"supported_task_types": ["sleep", "unittest"],
"nickname": "ws-unittest",
},
auth=None,
loop=self.asyncio_loop,
),
call(
"/sign-on",
json={
"supported_task_types": ["sleep", "unittest"],
"nickname": "ws-unittest",
},
loop=self.asyncio_loop,
),
]
)
self.tuqueue.queue.assert_not_called()
class TestWorkerTaskExecution(AbstractFWorkerTest):
def setUp(self):
super().setUp()
from flamenco_worker.cli import construct_asyncio_loop
self.loop = construct_asyncio_loop()
self.worker.loop = self.loop
def test_fetch_task_happy(self):
from unittest.mock import call
from tests.mock_responses import JsonResponse, CoroMock
self.manager.post = CoroMock()
# response when fetching a task
self.manager.post.coro.return_value = JsonResponse(
{
"_id": "58514d1e9837734f2e71b479",
"job": "58514d1e9837734f2e71b477",
"manager": "585a795698377345814d2f68",
"project": "",
"user": "580f8c66983773759afdb20e",
"name": "sleep-14-26",
"status": "processing",
"priority": 50,
"job_type": "unittest",
"task_type": "sleep",
"commands": [
{"name": "echo", "settings": {"message": "Preparing to sleep"}},
{"name": "sleep", "settings": {"time_in_seconds": 3}},
],
}
)
async def async_none():
return None
self.tuqueue.queue.side_effect = [
# Responses after status updates
None, # task becoming active
None, # task becoming complete
]
self.worker.schedule_fetch_task()
self.manager.post.assert_not_called()
interesting_task = self.worker.single_iteration_fut
self.loop.run_until_complete(self.worker.single_iteration_fut)
# Another fetch-task task should have been scheduled.
self.assertNotEqual(self.worker.single_iteration_fut, interesting_task)
self.manager.post.assert_called_once_with("/task", loop=self.asyncio_loop)
self.tuqueue.queue.assert_has_calls(
[
call(
"/tasks/58514d1e9837734f2e71b479/update",
{
"task_progress_percentage": 0,
"activity": "",
"command_progress_percentage": 0,
"task_status": "active",
"current_command_idx": 0,
},
),
call(
"/tasks/58514d1e9837734f2e71b479/update",
{
"task_progress_percentage": 0,
"activity": "Task completed",
"command_progress_percentage": 0,
"task_status": "completed",
"current_command_idx": 0,
},
),
]
)
self.assertEqual(self.tuqueue.queue.call_count, 2)
def test_stop_current_task(self):
"""Test that stopped tasks get status 'canceled'."""
from tests.mock_responses import JsonResponse, CoroMock, EmptyResponse
self.manager.post = CoroMock()
self.manager.post.coro.side_effect = [
# response when fetching a task
JsonResponse(
{
"_id": "58514d1e9837734f2e71b479",
"job": "58514d1e9837734f2e71b477",
"manager": "585a795698377345814d2f68",
"project": "",
"user": "580f8c66983773759afdb20e",
"name": "sleep-14-26",
"status": "processing",
"priority": 50,
"job_type": "unittest",
"task_type": "sleep",
"commands": [{"name": "sleep", "settings": {"time_in_seconds": 3}}],
}
),
EmptyResponse(), # stopping (and thus returning) a task.
EmptyResponse(), # signing off
]
self.worker.schedule_fetch_task()
stop_called = False
async def stop():
nonlocal stop_called
stop_called = True
await asyncio.sleep(0.2)
await self.worker.stop_current_task(self.worker.task_id)
asyncio.ensure_future(stop(), loop=self.loop)
self.loop.run_until_complete(self.worker.single_iteration_fut)
self.assertTrue(stop_called)
self.manager.post.assert_has_calls(
[
unittest.mock.call("/task", loop=self.asyncio_loop),
unittest.mock.call(
f"/tasks/{self.worker.task_id}/return", loop=self.asyncio_loop
),
]
)
self.tuqueue.queue.assert_any_call(
"/tasks/58514d1e9837734f2e71b479/update",
{
"task_progress_percentage": 0,
"activity": "",
"command_progress_percentage": 0,
"task_status": "active",
"current_command_idx": 0,
},
)
# A bit clunky because we don't know which timestamp is included in the log line.
last_args, last_kwargs = self.tuqueue.queue.call_args
self.assertEqual(last_args[0], "/tasks/58514d1e9837734f2e71b479/update")
self.assertEqual(last_kwargs, {})
self.assertIn("log", last_args[1])
self.assertIn(
"Worker 1234 (ws-unittest) stopped running this task, no longer "
"allowed to run by Manager",
last_args[1]["log"],
)
self.assertEqual(self.tuqueue.queue.call_count, 2)
def test_stop_current_task_mismatch(self):
from tests.mock_responses import JsonResponse, CoroMock
self.manager.post = CoroMock()
# response when fetching a task
self.manager.post.coro.return_value = JsonResponse(
{
"_id": "58514d1e9837734f2e71b479",
"job": "58514d1e9837734f2e71b477",
"manager": "585a795698377345814d2f68",
"project": "",
"user": "580f8c66983773759afdb20e",
"name": "sleep-14-26",
"status": "processing",
"priority": 50,
"job_type": "unittest",
"task_type": "sleep",
"commands": [{"name": "sleep", "settings": {"time_in_seconds": 3}}],
}
)
self.worker.schedule_fetch_task()
stop_called = False
async def stop():
nonlocal stop_called
stop_called = True
await asyncio.sleep(0.2)
await self.worker.stop_current_task("other-task-id")
asyncio.ensure_future(stop(), loop=self.loop)
self.loop.run_until_complete(self.worker.single_iteration_fut)
self.assertTrue(stop_called)
self.manager.post.assert_called_once_with("/task", loop=self.asyncio_loop)
self.tuqueue.queue.assert_any_call(
"/tasks/58514d1e9837734f2e71b479/update",
{
"task_progress_percentage": 0,
"activity": "",
"command_progress_percentage": 0,
"task_status": "active",
"current_command_idx": 0,
},
)
# The task shouldn't be stopped, because the wrong task ID was requested to stop.
last_args, last_kwargs = self.tuqueue.queue.call_args
self.assertEqual(last_args[0], "/tasks/58514d1e9837734f2e71b479/update")
self.assertEqual(last_kwargs, {})
self.assertIn("activity", last_args[1])
self.assertEqual(last_args[1]["activity"], "Task completed")
self.assertEqual(self.tuqueue.queue.call_count, 2)
def test_uncaught_exception(self):
from unittest.mock import call
from tests.mock_responses import JsonResponse, CoroMock
self.manager.post = CoroMock()
# response when fetching a task
self.manager.post.coro.return_value = JsonResponse(
{
"_id": "58514d1e9837734f2e71b479",
"job": "58514d1e9837734f2e71b477",
"manager": "585a795698377345814d2f68",
"project": "",
"user": "580f8c66983773759afdb20e",
"name": "sleep-14-26",
"status": "processing",
"priority": 50,
"job_type": "unittest",
"task_type": "sleep",
"commands": [
{"name": "echo", "settings": {"message": "Preparing to sleep"}},
{"name": "sleep", "settings": {"time_in_seconds": 3}},
],
}
)
self.tuqueue.queue.side_effect = None
self.worker.schedule_fetch_task()
interesting_task = self.worker.single_iteration_fut
with unittest.mock.patch("asyncio.sleep") as mock_sleep:
mock_sleep.side_effect = OSError("op-je-hoofd")
with self.assertRaises(OSError):
self.loop.run_until_complete(self.worker.single_iteration_fut)
# Another fetch-task task should have been scheduled.
self.assertNotEqual(self.worker.single_iteration_fut, interesting_task)
class WorkerPushToMasterTest(AbstractFWorkerTest):
def test_one_activity(self):
"""A single activity should be sent to manager within reasonable time."""
from datetime import timedelta
queue_pushed_future = asyncio.Future()
def queue_pushed(*args, **kwargs):
queue_pushed_future.set_result(True)
self.tuqueue.queue.side_effect = queue_pushed
self.worker.push_act_max_interval = timedelta(milliseconds=500)
asyncio.ensure_future(
self.worker.register_task_update(activity="test"), loop=self.asyncio_loop
)
self.asyncio_loop.run_until_complete(asyncio.wait_for(queue_pushed_future, 1))
# Queue push should only be done once
self.assertEqual(self.tuqueue.queue.call_count, 1)
def test_two_activities(self):
"""A single non-status-changing and then a status-changing act should push once."""
from datetime import timedelta
queue_pushed_future = asyncio.Future()
def queue_pushed(*args, **kwargs):
queue_pushed_future.set_result(True)
self.tuqueue.queue.side_effect = queue_pushed
self.worker.push_act_max_interval = timedelta(milliseconds=500)
# Non-status-changing
asyncio.ensure_future(
self.worker.register_task_update(activity="test"), loop=self.asyncio_loop
)
# Status-changing
asyncio.ensure_future(
self.worker.register_task_update(task_status="changed"),
loop=self.asyncio_loop,
)
self.asyncio_loop.run_until_complete(asyncio.wait_for(queue_pushed_future, 1))
# Queue push should only be done once
self.assertEqual(self.tuqueue.queue.call_count, 1)
# The scheduled task should be cancelled.
self.assertTrue(self.worker._push_act_to_manager.cancelled())
def test_one_log(self):
"""A single log should be sent to manager within reasonable time."""
from datetime import timedelta
queue_pushed_future = asyncio.Future()
def queue_pushed(*args, **kwargs):
queue_pushed_future.set_result(True)
self.tuqueue.queue.side_effect = queue_pushed
self.worker.push_log_max_interval = timedelta(milliseconds=500)
asyncio.ensure_future(
self.worker.register_log("unit tests are ünits"), loop=self.asyncio_loop
)
self.asyncio_loop.run_until_complete(asyncio.wait_for(queue_pushed_future, 1))
# Queue push should only be done once
self.assertEqual(self.tuqueue.queue.call_count, 1)
def test_two_logs(self):
"""Logging once and then again should push once."""
queue_pushed_future = asyncio.Future()
def queue_pushed(*args, **kwargs):
queue_pushed_future.set_result(True)
self.tuqueue.queue.side_effect = queue_pushed
self.worker.push_log_max_entries = 1 # max 1 queued, will push at 2
# Queued, will schedule push
asyncio.ensure_future(
self.worker.register_log("first line"), loop=self.asyncio_loop
)
# Max queued reached, will cause immediate push
asyncio.ensure_future(
self.worker.register_log("second line"), loop=self.asyncio_loop
)
self.asyncio_loop.run_until_complete(asyncio.wait_for(queue_pushed_future, 1))
# Queue push should only be done once
self.assertEqual(self.tuqueue.queue.call_count, 1)
# The scheduled task should be cancelled.
self.assertTrue(self.worker._push_log_to_manager.cancelled())
class OutputProducedTest(AbstractFWorkerTest):
def test_single_output(self):
self.worker.output_produced("/path/to/some/file.exr")
# Sleep for a bit to let the background tasks run.
self.asyncio_loop.run_until_complete(asyncio.sleep(0.25))
self.manager.post.assert_called_once()
def test_consecutive_frames(self):
self.worker.output_produced("/path/to/some/frame-001.exr")
self.worker.output_produced("/path/to/some/frame-002.exr")
# Sleep for a bit to let the background tasks run.
self.asyncio_loop.run_until_complete(asyncio.sleep(0.25))
# For consecutive frames, only the first should be reported.
self.manager.post.assert_called_once()
def test_versions_of_same_frame_exr_first(self):
self.worker.output_produced("/path/to/some/frame-001.exr")
self.worker.output_produced("/path/to/some/frame-001.jpg")
# Sleep for a bit to let the background tasks run.
self.asyncio_loop.run_until_complete(asyncio.sleep(0.25))
# Both versions should be reported.
self.manager.post.assert_has_calls(
[
unittest.mock.call(
"/output-produced",
json={"paths": ["/path/to/some/frame-001.exr"]},
loop=unittest.mock.ANY,
),
unittest.mock.call(
"/output-produced",
json={"paths": ["/path/to/some/frame-001.jpg"]},
loop=unittest.mock.ANY,
),
]
)
def test_versions_of_same_frame_jpg_first(self):
self.worker.output_produced("/path/to/some/frame-001.jpg")
self.worker.output_produced("/path/to/some/frame-001.exr")
# Sleep for a bit to let the background tasks run.
self.asyncio_loop.run_until_complete(asyncio.sleep(0.25))
# Only the JPEG version should be reported.
self.manager.post.assert_has_calls(
[
unittest.mock.call(
"/output-produced",
json={"paths": ["/path/to/some/frame-001.jpg"]},
loop=unittest.mock.ANY,
),
]
)
class WorkerShutdownTest(AbstractWorkerTest):
def setUp(self):
from flamenco_worker.cli import construct_asyncio_loop
from flamenco_worker.upstream import FlamencoManager
from flamenco_worker.worker import FlamencoWorker
from flamenco_worker.runner import TaskRunner
from flamenco_worker.upstream_update_queue import TaskUpdateQueue
from tests.mock_responses import CoroMock
self.asyncio_loop = construct_asyncio_loop()
self.asyncio_loop.set_debug(True)
self.shutdown_future = self.asyncio_loop.create_future()
self.manager = Mock(spec=FlamencoManager)
self.manager.post = CoroMock()
self.trunner = Mock(spec=TaskRunner)
self.tuqueue = Mock(spec=TaskUpdateQueue)
self.tuqueue.flush_and_report = CoroMock()
self.trunner.abort_current_task = CoroMock()
self.worker = FlamencoWorker(
manager=self.manager,
trunner=self.trunner,
tuqueue=self.tuqueue,
task_types=["sleep", "unittest"],
worker_id="1234",
worker_secret="jemoeder",
loop=self.asyncio_loop,
shutdown_future=self.shutdown_future,
)
def test_shutdown(self):
self.shutdown_future.cancel()
self.worker.shutdown()
self.manager.post.assert_called_once_with("/sign-off", loop=self.asyncio_loop)
def tearDown(self):
self.asyncio_loop.close()
class WorkerSleepingTest(AbstractFWorkerTest):
def setUp(self):
super().setUp()
from flamenco_worker.cli import construct_asyncio_loop
self.loop = construct_asyncio_loop()
self.worker.loop = self.loop
def test_stop_current_task_go_sleep(self):
from tests.mock_responses import JsonResponse, CoroMock
self.manager.post = CoroMock()
# response when fetching a task
self.manager.post.coro.return_value = JsonResponse(
{"status_requested": "sleep"}, status_code=423
)
self.worker.schedule_fetch_task()
with self.assertRaises(concurrent.futures.CancelledError):
self.loop.run_until_complete(self.worker.single_iteration_fut)
self.assertIsNotNone(self.worker.sleeping_fut)
self.assertFalse(self.worker.sleeping_fut.done())
self.assertTrue(self.worker.single_iteration_fut.done())