## Summary Three defects a live twenty-page run surfaced, each of which cost whole pages. `PageBox` said in its own docstring that it reads the same as `ppt_layout.Box`, and `Box` answers to `.x` and `.y` as well as `.w` and `.h`. `PageBox` answered to two of the four. A build helper read `round(b.y, 3)` once, in the one place it used for every page, and all twenty pages failed to draw with `'PageBox' object has no attribute 'y'`. `Box` was given the same pair after the same crash; the promise was the part that did not travel. `_check_cut_out` asked its argument for `.name`, and the spelling the skill documents is `replace_picture(shape_at(slide, n), str(FIGURES / image), fit)`. Every other branch takes that string -- the ones that open the file hand it to PIL, which does -- so the only thing that refused it was the warning that exists to explain a mistake. It raised `'str' object has no attribute 'name'` over the top of the explanation and took the page with it. Rasterising now has a gate of its own, and it is one. `pdf()` spends its time in a LibreOffice subprocess with a profile of its own, so width there costs nothing and buys wall clock; `pages_of` spends its time in pypdfium2, in a worker thread of this process, against a library that keeps state per process rather than per document. One gate for both put them under the same number and let the second run concurrently with itself: over a nine-template reference set, six of the nine PDFs failed to open with `PDFium: Data format error` while every one of the nine opened when read one at a time, and an earlier run on the same path took SIGSEGV. `pages_of` answers a failed read with an empty dict, so the cost was a reference sheet quietly short of two thirds of its pages rather than anything that looked like an error. ## Type - [x] Fix - [ ] Feature - [ ] Docs - [ ] CI / tooling - [ ] Refactor - [ ] Other ## Verification - [x] Relevant tests pass locally - [x] Relevant lint / type checks pass locally - [ ] User-facing docs or screenshots are updated when needed Commands run on this branch, rebased onto main: ``` uv run --frozen pytest tests/ -k ppt -q uv run --frozen pytest tests/test_ppt_engine_template.py -q \ -k "page_box_answers or cut_out_warning_survives or rasterising_runs_one_at_a_time" uv run --frozen ruff check plugins-dist/ppt-engine/raven_ppt/services/template/compose.py \ plugins-dist/ppt-engine/raven_ppt/stages/_views.py ``` The three added tests were each confirmed to fail without the source change. The concurrency one asserts on how many rasterisations are in flight -- the property -- rather than on the width of a semaphore, which is one way to get it, and its stub renderer carries the real signatures on purpose: a stub that shapes itself to the caller agrees with a call the engine cannot make. ## Risk - [x] Security impact considered - [x] Backward compatibility considered - [x] Rollback path is clear for risky changes Two added properties and one widened type annotation are additive. The third change narrows rasterising to one at a time while leaving conversion as wide as it was, so a deck whose pages are read after conversion takes slightly longer in exchange for reading all of them; reverting the commit restores the shared gate. ## Related Issues N/A
260 lines
8.4 KiB
Python
260 lines
8.4 KiB
Python
"""Unit tests for rendering path containment and bundle publication."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import asyncio
|
|
import json
|
|
from dataclasses import asdict
|
|
from pathlib import Path
|
|
from types import SimpleNamespace
|
|
|
|
import pytest
|
|
|
|
from raven_design.rendering.backend import (
|
|
BoxLiteRenderBackend,
|
|
_copy_asset_tree,
|
|
_outcome_from_wire,
|
|
_posix_locale,
|
|
)
|
|
from raven_design.rendering.bundle import validate_published_bundle
|
|
from raven_design.rendering.models import RenderConfig, RenderError, RenderRequest
|
|
from raven_design.rendering.paths import RenderPathPolicy
|
|
from raven_design.rendering.worker import _read_request
|
|
|
|
|
|
def _policy(tmp_path: Path) -> RenderPathPolicy:
|
|
workspace = tmp_path / "workspace"
|
|
media = tmp_path / "media"
|
|
runtime = tmp_path / "runtime"
|
|
workspace.mkdir()
|
|
media.mkdir()
|
|
runtime.mkdir()
|
|
return RenderPathPolicy(
|
|
workspace=workspace,
|
|
media_root=media,
|
|
runtime_root=runtime,
|
|
restrict_to_workspace=True,
|
|
)
|
|
|
|
|
|
def test_relative_paths_resolve_inside_workspace(tmp_path: Path) -> None:
|
|
policy = _policy(tmp_path)
|
|
source = policy.workspace / "page.html"
|
|
source.write_text("<html/>", encoding="utf-8")
|
|
|
|
assert policy.resolve_source("page.html") == source
|
|
assert policy.resolve_output_dir("output") == policy.workspace / "output"
|
|
|
|
|
|
def test_browser_locale_is_normalized_for_worker_processes() -> None:
|
|
assert _posix_locale("en-US") == "en_US.UTF-8"
|
|
assert _posix_locale("C.UTF-8") == "C.UTF-8"
|
|
|
|
|
|
def test_symlink_escape_is_rejected(tmp_path: Path) -> None:
|
|
policy = _policy(tmp_path)
|
|
outside = tmp_path / "outside.html"
|
|
outside.write_text("<html/>", encoding="utf-8")
|
|
link = policy.workspace / "escape.html"
|
|
link.symlink_to(outside)
|
|
|
|
with pytest.raises(RenderError) as raised:
|
|
policy.resolve_source(link)
|
|
|
|
assert raised.value.code == "path_not_allowed"
|
|
|
|
|
|
def test_external_output_and_broad_asset_root_are_rejected(tmp_path: Path) -> None:
|
|
policy = _policy(tmp_path)
|
|
|
|
with pytest.raises(RenderError, match="outside") as output_error:
|
|
policy.resolve_output_dir(tmp_path / "external")
|
|
with pytest.raises(RenderError, match="too broad") as asset_error:
|
|
policy.resolve_asset_root(Path("/"))
|
|
|
|
assert output_error.value.code == "path_not_allowed"
|
|
assert asset_error.value.code == "path_not_allowed"
|
|
|
|
|
|
def test_internal_preview_output_may_use_runtime_root(tmp_path: Path) -> None:
|
|
policy = _policy(tmp_path)
|
|
|
|
output = policy.resolve_output_dir(policy.runtime_root / "preview", internal=True)
|
|
|
|
assert output == policy.runtime_root / "preview"
|
|
|
|
|
|
def test_published_bundle_rejects_extra_entries_and_symlinks(tmp_path: Path) -> None:
|
|
bundle = tmp_path / "bundle"
|
|
(bundle / "pages").mkdir(parents=True)
|
|
(bundle / "preview").mkdir()
|
|
(bundle / "document.pdf").write_bytes(b"%PDF-test")
|
|
(bundle / "manifest.json").write_text("{}", encoding="utf-8")
|
|
|
|
with pytest.raises(RenderError) as extra:
|
|
validate_published_bundle(bundle, 1024)
|
|
assert extra.value.code == "invalid_output"
|
|
|
|
(bundle / "manifest.json").unlink()
|
|
(bundle / "preview" / "link.png").symlink_to(bundle / "document.pdf")
|
|
with pytest.raises(RenderError) as symlink:
|
|
validate_published_bundle(bundle, 1024)
|
|
assert symlink.value.code == "invalid_output"
|
|
|
|
|
|
def test_published_bundle_rejects_invalid_file_signatures(tmp_path: Path) -> None:
|
|
bundle = tmp_path / "bundle"
|
|
(bundle / "pages").mkdir(parents=True)
|
|
(bundle / "preview").mkdir()
|
|
(bundle / "document.pdf").write_bytes(b"%PDF-1.7")
|
|
(bundle / "pages" / "page.png").write_bytes(b"\x89PNG\r\n\x1a\n")
|
|
(bundle / "preview" / "preview.png").write_bytes(b"not-a-png")
|
|
|
|
with pytest.raises(RenderError) as raised:
|
|
validate_published_bundle(bundle, 1024)
|
|
|
|
assert raised.value.code == "invalid_output"
|
|
|
|
|
|
def test_worker_asset_staging_rejects_filesystem_root(tmp_path: Path) -> None:
|
|
source = tmp_path / "page.html"
|
|
source.write_text("<html/>", encoding="utf-8")
|
|
|
|
with pytest.raises(RenderError) as raised:
|
|
_copy_asset_tree(Path("/"), source, tmp_path / "target", 1024)
|
|
|
|
assert raised.value.code == "path_not_allowed"
|
|
|
|
|
|
def test_worker_metadata_cannot_escape_published_bundle(tmp_path: Path) -> None:
|
|
bundle = tmp_path / "bundle"
|
|
(bundle / "pages").mkdir(parents=True)
|
|
(bundle / "preview").mkdir()
|
|
(bundle / "document.pdf").write_bytes(b"%PDF-test")
|
|
(bundle / "pages" / "page.png").write_bytes(b"page")
|
|
(bundle / "preview" / "preview.png").write_bytes(b"preview")
|
|
response = {
|
|
"detection": {
|
|
"format": "docx",
|
|
"family": "office",
|
|
"mime": "application/octet-stream",
|
|
"declared_extension": ".docx",
|
|
"support_level": "guaranteed",
|
|
"metadata": {},
|
|
"motion_signals": [],
|
|
},
|
|
"page_records": [{"path": "pages/page.png"}],
|
|
"preview_records": [{"path": "../outside.png"}],
|
|
"preview_candidate_count": 1,
|
|
"warnings": [],
|
|
}
|
|
|
|
with pytest.raises(RenderError) as raised:
|
|
_outcome_from_wire(bundle, response)
|
|
|
|
assert raised.value.code == "invalid_output"
|
|
|
|
|
|
def test_worker_request_schema_rejects_unknown_config_fields(tmp_path: Path) -> None:
|
|
payload = {
|
|
"version": 1,
|
|
"source": "/workspace/input/page.html",
|
|
"output_dir": "/workspace/output",
|
|
"asset_root": None,
|
|
"preview_limit": 1,
|
|
"options": {
|
|
"motion_mode": "static",
|
|
"capture_duration_seconds": 0.25,
|
|
"capture_at_seconds": 0,
|
|
"page_range": None,
|
|
"viewport_width": 640,
|
|
"viewport_height": 360,
|
|
"actions": None,
|
|
},
|
|
"config": asdict(RenderConfig(chrome_path=None, libreoffice_path=None)),
|
|
}
|
|
request = tmp_path / "request.json"
|
|
request.write_text(json.dumps(payload), encoding="utf-8")
|
|
assert _read_request(request)["version"] == 1
|
|
payload["config"]["unexpected"] = True
|
|
request.write_text(json.dumps(payload), encoding="utf-8")
|
|
|
|
with pytest.raises(RenderError) as raised:
|
|
_read_request(request)
|
|
|
|
assert raised.value.code == "invalid_parameters"
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_cancelling_boxlite_job_stops_vm_and_removes_staging(
|
|
tmp_path: Path,
|
|
monkeypatch: pytest.MonkeyPatch,
|
|
) -> None:
|
|
policy = _policy(tmp_path)
|
|
source = policy.workspace / "page.html"
|
|
source.write_text("<html/>", encoding="utf-8")
|
|
started = asyncio.Event()
|
|
stopped = asyncio.Event()
|
|
|
|
class Executor:
|
|
async def start(self):
|
|
return None
|
|
|
|
async def exec(self, *args, **kwargs):
|
|
started.set()
|
|
await asyncio.Event().wait()
|
|
return SimpleNamespace(exit_code=0, stdout="", stderr="")
|
|
|
|
async def stop(self):
|
|
stopped.set()
|
|
|
|
backend = BoxLiteRenderBackend(
|
|
RenderConfig(chrome_path=None, libreoffice_path=None),
|
|
policy,
|
|
image="renderer:test",
|
|
cpus=1,
|
|
memory_mib=512,
|
|
create_timeout_seconds=1,
|
|
)
|
|
monkeypatch.setattr(backend, "_executor", lambda job_root: Executor())
|
|
task = asyncio.create_task(
|
|
backend.run(
|
|
RenderRequest(
|
|
path=source,
|
|
output_dir=policy.workspace / "output",
|
|
motion_mode="static",
|
|
capture_duration_seconds=0.25,
|
|
),
|
|
preview_limit=1,
|
|
)
|
|
)
|
|
await started.wait()
|
|
task.cancel()
|
|
|
|
with pytest.raises(asyncio.CancelledError):
|
|
await task
|
|
assert stopped.is_set()
|
|
assert list(policy.runtime_root.iterdir()) == []
|
|
|
|
|
|
def test_the_boxlite_backend_can_build_the_executor_it_asks_raven_for(tmp_path: Path) -> None:
|
|
"""The constructor call crosses the raven/design-engine seam, so a new
|
|
required argument on raven's side fails here synchronously, before any VM.
|
|
The cancellation test above replaces ``_executor``, so it cannot see that."""
|
|
from raven.config.paths import get_sandbox_dir
|
|
from raven.sandbox.boxlite_executor import BoxliteExecutor
|
|
|
|
backend = BoxLiteRenderBackend(
|
|
RenderConfig(chrome_path=None, libreoffice_path=None),
|
|
_policy(tmp_path),
|
|
image="renderer:test",
|
|
cpus=1,
|
|
memory_mib=512,
|
|
create_timeout_seconds=1,
|
|
)
|
|
|
|
executor = backend._executor(tmp_path / "job")
|
|
|
|
assert isinstance(executor, BoxliteExecutor)
|
|
assert executor._sandbox_home == get_sandbox_dir("boxlite")
|