Sybren A. Stüvel
d25d409e35
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).
309 lines
11 KiB
Python
309 lines
11 KiB
Python
from pathlib import Path
|
|
import subprocess
|
|
import tempfile
|
|
from unittest import mock
|
|
|
|
from unittest.mock import patch
|
|
|
|
from tests.test_runner import AbstractCommandTest
|
|
|
|
|
|
class BlenderRenderTest(AbstractCommandTest):
|
|
thisfile = Path(__file__).as_posix()
|
|
|
|
def setUp(self):
|
|
super().setUp()
|
|
|
|
from flamenco_worker.commands import BlenderRenderCommand
|
|
|
|
self.cmd = BlenderRenderCommand(
|
|
worker=self.fworker,
|
|
task_id="12345",
|
|
command_idx=0,
|
|
)
|
|
self.cmd.proc = None
|
|
|
|
def test_re_time(self):
|
|
line = "| Time:00:04.17 |"
|
|
m = self.cmd.re_time.search(line)
|
|
|
|
self.assertEqual(
|
|
m.groupdict(),
|
|
{
|
|
"hours": None,
|
|
"minutes": "00",
|
|
"seconds": "04",
|
|
"hunds": "17",
|
|
},
|
|
)
|
|
|
|
def test_parse_render_line(self):
|
|
line = (
|
|
"Fra:10 Mem:17.52M (0.00M, Peak 33.47M) | Time:00:04.17 | Remaining:00:00.87 | "
|
|
"Mem:1.42M, Peak:1.42M | Scene, RenderLayer | Path Tracing Tile 110/135"
|
|
)
|
|
self.assertEqual(
|
|
self.cmd.parse_render_line(line),
|
|
{
|
|
"fra": 10,
|
|
"mem": "17.52M",
|
|
"peakmem": "33.47M",
|
|
"time_sec": 4.17,
|
|
"remaining_sec": 0.87,
|
|
"status": "Path Tracing Tile 110/135",
|
|
},
|
|
)
|
|
|
|
line = (
|
|
"Fra:003 Mem:17.52G (0.00M, Peak 33G) | Time:03:00:04.17 | Remaining:44:00:00.87 | "
|
|
"Mem:1.42M, Peak:1.42M | Séance, RenderLëør | Computing cosmic flöw 110/13005"
|
|
)
|
|
self.assertEqual(
|
|
self.cmd.parse_render_line(line),
|
|
{
|
|
"fra": 3,
|
|
"mem": "17.52G",
|
|
"peakmem": "33G",
|
|
"time_sec": 3 * 3600 + 4.17,
|
|
"remaining_sec": 44 * 3600 + 0.87,
|
|
"status": "Computing cosmic flöw 110/13005",
|
|
},
|
|
)
|
|
|
|
def test_output_produced(self):
|
|
line1 = "Saved: '/render/sprites/farm_output/shots/110_rextoria/110_0140_A/110_0140_A.lighting__intermediate-2021-07-12_082449/000113.exr'"
|
|
line2 = "Saved: '/render/sprites/farm_output/shots/110_rextoria/110_0140_A/110_0140_A.lighting__intermediate-2021-07-12_082449/000113.jpg'"
|
|
|
|
self.loop.run_until_complete(self.cmd.process_line(line1))
|
|
self.fworker.output_produced.assert_called_once_with(
|
|
"/render/sprites/farm_output/shots/110_rextoria/110_0140_A/110_0140_A.lighting__intermediate-2021-07-12_082449/000113.exr"
|
|
)
|
|
self.loop.run_until_complete(self.cmd.process_line(line2))
|
|
self.fworker.output_produced.assert_called_with(
|
|
"/render/sprites/farm_output/shots/110_rextoria/110_0140_A/110_0140_A.lighting__intermediate-2021-07-12_082449/000113.jpg"
|
|
)
|
|
|
|
def test_missing_files(self):
|
|
"""Missing files should not abort the render."""
|
|
|
|
line = "Warning: Unable to open op-je-hoofd"
|
|
self.cmd.proc = mock.Mock()
|
|
self.cmd.proc.pid = 47
|
|
self.loop.run_until_complete(self.cmd.process_line(line))
|
|
self.fworker.register_task_update.assert_called_once_with(activity=line)
|
|
|
|
self.fworker.register_task_update.reset_mock()
|
|
line = "Warning: Path 'op-je-hoofd' not found"
|
|
self.loop.run_until_complete(self.cmd.process_line(line))
|
|
self.fworker.register_task_update.assert_called_once_with(activity=line)
|
|
|
|
def test_cli_args(self):
|
|
"""Test that CLI arguments in the blender_cmd setting are handled properly."""
|
|
from tests.mock_responses import CoroMock
|
|
|
|
filepath = Path(__file__).parent.as_posix()
|
|
settings = {
|
|
# Point blender_cmd to this file so that we're sure it exists.
|
|
"blender_cmd": f'{self.thisfile!r} --with --cli="args for CLI"',
|
|
"chunk_size": 100,
|
|
"frames": "1..2",
|
|
"format": "JPEG",
|
|
"filepath": filepath,
|
|
}
|
|
|
|
cse = CoroMock(...)
|
|
cse.coro.return_value.wait = CoroMock(return_value=0)
|
|
cse.coro.return_value.pid = 47
|
|
with patch("asyncio.create_subprocess_exec", new=cse) as mock_cse:
|
|
self.loop.run_until_complete(self.cmd.run(settings))
|
|
|
|
mock_cse.assert_called_once_with(
|
|
self.thisfile,
|
|
"--with",
|
|
"--cli=args for CLI",
|
|
"--enable-autoexec",
|
|
"-noaudio",
|
|
"--background",
|
|
filepath,
|
|
"--render-format",
|
|
"JPEG",
|
|
"--render-frame",
|
|
"1..2",
|
|
stdin=subprocess.DEVNULL,
|
|
stdout=subprocess.PIPE,
|
|
stderr=subprocess.STDOUT,
|
|
env=mock.ANY,
|
|
)
|
|
|
|
def test_cli_openexr(self):
|
|
from tests.mock_responses import CoroMock
|
|
|
|
filepath = Path(__file__).parent.as_posix()
|
|
settings = {
|
|
# Point blender_cmd to this file so that we're sure it exists.
|
|
"blender_cmd": f'{self.thisfile!r} --with --cli="args for CLI"',
|
|
"chunk_size": 100,
|
|
"frames": "1..2",
|
|
"format": "OPEN_EXR",
|
|
"filepath": filepath,
|
|
}
|
|
|
|
cse = CoroMock(...)
|
|
cse.coro.return_value.wait = CoroMock(return_value=0)
|
|
cse.coro.return_value.pid = 47
|
|
with patch("asyncio.create_subprocess_exec", new=cse) as mock_cse:
|
|
self.loop.run_until_complete(self.cmd.run(settings))
|
|
|
|
mock_cse.assert_called_once_with(
|
|
self.thisfile,
|
|
"--with",
|
|
"--cli=args for CLI",
|
|
"--enable-autoexec",
|
|
"-noaudio",
|
|
"--background",
|
|
filepath,
|
|
"--render-format",
|
|
"EXR", # see https://developer.blender.org/D4502
|
|
"--render-frame",
|
|
"1..2",
|
|
stdin=subprocess.DEVNULL,
|
|
stdout=subprocess.PIPE,
|
|
stderr=subprocess.STDOUT,
|
|
env=mock.ANY,
|
|
)
|
|
|
|
def test_python_expr(self):
|
|
from tests.mock_responses import CoroMock
|
|
|
|
filepath = Path(__file__).parent.as_posix()
|
|
settings = {
|
|
# Point blender_cmd to this file so that we're sure it exists.
|
|
"blender_cmd": f'{self.thisfile!r} --with --cli="args for CLI"',
|
|
"python_expr": "print(\"yay in 'quotes'\")",
|
|
"chunk_size": 100,
|
|
"frames": "1..2",
|
|
"format": "JPEG",
|
|
"filepath": filepath,
|
|
}
|
|
|
|
cse = CoroMock(...)
|
|
cse.coro.return_value.wait = CoroMock(return_value=0)
|
|
cse.coro.return_value.pid = 47
|
|
with patch("asyncio.create_subprocess_exec", new=cse) as mock_cse:
|
|
self.loop.run_until_complete(self.cmd.run(settings))
|
|
|
|
mock_cse.assert_called_once_with(
|
|
self.thisfile,
|
|
"--with",
|
|
"--cli=args for CLI",
|
|
"--enable-autoexec",
|
|
"-noaudio",
|
|
"--background",
|
|
filepath,
|
|
"--python-expr",
|
|
"print(\"yay in 'quotes'\")",
|
|
"--render-format",
|
|
"JPEG",
|
|
"--render-frame",
|
|
"1..2",
|
|
stdin=subprocess.DEVNULL,
|
|
stdout=subprocess.PIPE,
|
|
stderr=subprocess.STDOUT,
|
|
env=mock.ANY,
|
|
)
|
|
|
|
def test_cli_args_override_file(self):
|
|
"""Test that an override file next to the blend file is recognised."""
|
|
from tests.mock_responses import CoroMock
|
|
|
|
with tempfile.TemporaryDirectory() as tempdir:
|
|
temppath = Path(tempdir)
|
|
|
|
blendpath = temppath / "thefile.blend"
|
|
blendpath.touch()
|
|
override = temppath / "thefile-overrides.py"
|
|
override.touch()
|
|
|
|
settings = {
|
|
# Point blender_cmd to this file so that we're sure it exists.
|
|
"blender_cmd": self.thisfile,
|
|
"chunk_size": 100,
|
|
"frames": "1..2",
|
|
"format": "JPEG",
|
|
"filepath": blendpath.as_posix(),
|
|
}
|
|
|
|
cse = CoroMock(...)
|
|
cse.coro.return_value.wait = CoroMock(return_value=0)
|
|
cse.coro.return_value.pid = 47
|
|
with patch("asyncio.create_subprocess_exec", new=cse) as mock_cse:
|
|
self.loop.run_until_complete(self.cmd.run(settings))
|
|
|
|
mock_cse.assert_called_once_with(
|
|
self.thisfile,
|
|
"--enable-autoexec",
|
|
"-noaudio",
|
|
"--background",
|
|
blendpath.as_posix(),
|
|
"--python-exit-code",
|
|
"42",
|
|
"--python",
|
|
override.as_posix(),
|
|
"--render-format",
|
|
"JPEG",
|
|
"--render-frame",
|
|
"1..2",
|
|
stdin=subprocess.DEVNULL,
|
|
stdout=subprocess.PIPE,
|
|
stderr=subprocess.STDOUT,
|
|
env=mock.ANY,
|
|
)
|
|
|
|
def test_cli_environment(self):
|
|
"""Test that LD_LIBRARY_PATH is removed from the environment."""
|
|
from tests.mock_responses import CoroMock
|
|
|
|
filepath = Path(__file__).parent.as_posix()
|
|
settings = {
|
|
# Point blender_cmd to this file so that we're sure it exists.
|
|
"blender_cmd": f'{self.thisfile!r} --with --cli="args for CLI"',
|
|
"chunk_size": 100,
|
|
"frames": "1..2",
|
|
"format": "JPEG",
|
|
"filepath": filepath,
|
|
}
|
|
|
|
cse = CoroMock(...)
|
|
cse.coro.return_value.wait = CoroMock(return_value=0)
|
|
cse.coro.return_value.pid = 47
|
|
|
|
mock_env = {
|
|
"PATH": "/path/a:/path/b",
|
|
"LD_LIBRARY_PATH": "/path/to/conflicting/libraries",
|
|
}
|
|
|
|
with patch("asyncio.create_subprocess_exec", new=cse) as mock_cse, patch(
|
|
"os.environ", new=mock_env
|
|
):
|
|
self.loop.run_until_complete(self.cmd.run(settings))
|
|
|
|
mock_cse.assert_called_once_with(
|
|
self.thisfile,
|
|
"--with",
|
|
"--cli=args for CLI",
|
|
"--enable-autoexec",
|
|
"-noaudio",
|
|
"--background",
|
|
filepath,
|
|
"--render-format",
|
|
"JPEG",
|
|
"--render-frame",
|
|
"1..2",
|
|
stdin=subprocess.DEVNULL,
|
|
stdout=subprocess.PIPE,
|
|
stderr=subprocess.STDOUT,
|
|
env={
|
|
"PATH": "/path/a:/path/b",
|
|
},
|
|
)
|