From eae25754852f05a074ba365781373b787097c572 Mon Sep 17 00:00:00 2001 From: seunghan Kim Date: Fri, 17 Apr 2026 16:05:18 +0900 Subject: [PATCH] test: HWPX SVG snapshot regression harness (closes #173) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Adds a pure-Rust integration test that renders pages via `HwpDocument::render_page_svg_native` and diffs the output against committed golden SVGs. Runs under the existing `cargo test` job in ci.yml, so no new workflow is required and the check is active on every PR without any Hancom-Office / Windows dependency. ## Highlights - `tests/svg_snapshot.rs` — harness with `UPDATE_GOLDEN=1` regeneration (same pattern used in the MDM project's `golden_hwpx.rs`). - First golden: `form-002.hwpx` page 0 — the smallest committed sample (~130KB input → ~263KB SVG). More goldens can be added file-by-file without harness changes. - Determinism probe: `render_is_deterministic_within_process` renders the same page twice in a single process and asserts byte equality, so any future non-determinism bug surfaces loudly instead of masquerading as a golden mismatch. ## Verification - Byte-identical across two separate CLI invocations: `rhwp export-svg samples/hwpx/form-002.hwpx -o /tmp/a -p 0` vs `... -o /tmp/b -p 0` → `diff -q /tmp/a /tmp/b` returns empty. - `cargo test --test svg_snapshot` passes locally. ## Follow-up (not in this PR) - Expand golden corpus to the 2024/2025 investment samples once the first run is green on CI. - Consider gzip-encoding large goldens if the corpus grows past a few MB. For now, raw SVG plays nicely with git diff and PR review. --- tests/golden_svg/form-002/page-0.svg | 1095 ++++++++++++++++++++++++++ tests/svg_snapshot.rs | 103 +++ 2 files changed, 1198 insertions(+) create mode 100644 tests/golden_svg/form-002/page-0.svg create mode 100644 tests/svg_snapshot.rs diff --git a/tests/golden_svg/form-002/page-0.svg b/tests/golden_svg/form-002/page-0.svg new file mode 100644 index 00000000..9a020a21 --- /dev/null +++ b/tests/golden_svg/form-002/page-0.svg @@ -0,0 +1,1095 @@ + + + + + + + + + + + + + + + + + + + +품 +목 +번 +호 +2 +0 +2 +6 +- +1 +차 +- +바 +이 +오 +산 +업 +기 +술 +- +맞 +춤 +형 +진 +단 +치 +료 +- +품 +목 +- +일 +반 +- +0 +1 + +산 +업 +기 +술 +분 +류 + +중 +분 +류 +Ⅰ + +중 +분 +류 +Ⅱ + +개 +발 +형 +태 + +원천기술형 + + +혁신제품형 +의 +약 +바 +이 +오 + +혁 +신 +도 +전 +형 + +세계최초 + +세계최고 + + +해당없음 + +A +I +연 +계 + +AI 응용 및 활용 + +AI 기반 + +기타 AI 연계 기술 + + +해당없음 + +지 +역 +( +비 +수 +도 +권 +) +연 +계 + +지역 산업 연계 + +지역 기업 성장 + +지역 인재 및 일자리 + + +해당없음 + +초 +격 +차 +프 +로 +젝 +트 +( +해 +당 +) + +분 +야 +첨 +단 +바 +이 +오 + +미 +션 +글 +로 +벌 +제 +약 +ㆍ +바 +이 +오 +생 +산 +기 +지 +구 +축 + +프 +로 +젝 +트 +고 +품 +질 +, +고 +기 +능 +성 +, +고 +생 +산 +성 +첨 +단 +의 +약 +품 +ㆍ +의 +료 +제 +품 +디 +지 +털 +팩 +토 +리 +제 +조 +공 +정 +혁 +신 + +제 +품 +· +기 +술 +고 +생 +산 +성 +첨 +단 +의 +약 +품 +제 +형 +화 +및 +제 +조 +기 +술 +개 +발 + +세 +부 +기 +술 +고 +기 +능 +성 +혁 +신 +형 +의 +약 +품 +고 +도 +화 +기 +술 + +연 +계 +유 +형 + +IP R&&D연계 + +표준연계 + +적합성인증연계 + + +해당없음 + +특 +성 +분 +류 + +경쟁형과제 + +복수형과제 + +국가핵심기술 + +국제공동 + +대형통합형 + +민간투자연계형 + +서비스형 + +안전관리형 + +원스톱형 + +유연 컨소시엄 + +초고난도 과제 + +탄소중립 + +보안과제 + +E +S +G + +E + +S + + +G + +해당없음 + +R +D +자 +율 +성 +트 +랙 + + +R&&D 자율성트랙(일반) + +R&&D 자율성트랙(지정) + +품 +목 +명 +암 +조 +직 +저 +산 +소 +내 +성 +한 +계 +극 +복 +나 +노 +산 +소 +운 +반 +체 +기 +반 +항 +암 +제 +병 +용 +치 +료 +증 +강 +제 +개 +발 +( +T +R +L +: +[ +시 +작 +] +4 +단 +계 +〜 +[ +종 +료 +] +7 +단 +계 +) + +1 +. +개 +념 +및 +개 +발 +내 +용 +□ +개 +념 +ㅇ +혈 +액 +보 +다 +산 +소 +용 +해 +도 +가 +높 +은 +나 +노 +산 +소 +운 +반 +체 +를 +활 +용 +하 +여 +암 +조 +직 +에 +직 +접 +산 +소 +를 +전 +달 +하 +여 +암 +조 +직 +저 +산 +소 +( +H +y +p +o +x +i +a +) +내 +성 +한 +계 +극 +복 +을 +통 +해 +암 +세 +포 +사 +멸 +효 +과 +를 +증 +대 +시 +킬 +수 +있 +는 +암 +표 +적 +지 +향 +형 +나 +노 +산 +소 +운 +반 +체 +기 +반 +항 +암 +화 +학 +요 +법 +병 +용 +치 +료 +증 +강 +제 +및 +이 +의 +제 +조 +공 +정 +기 +술 +개 +발 +* +나 +노 +산 +소 +운 +반 +체 +는 +암 +세 +포 +방 +어 +막 +( +저 +산 +소 +환 +경 +) +의 +물 +리 +적 +무 +력 +화 +를 +통 +해 +, +기 +존 +항 +암 +제 +가 +저 +산 +소 +내 +성 +을 +극 +복 +하 +여 +효 +과 +를 +발 +휘 +하 +도 +록 +암 +세 +포 +를 +' +리 +셋 +( +R +e +s +e +t +) +' +시 +키 +는 +항 +암 +치 +료 +증 +강 +제 +역 +할 +을 +함 +- +항 +암 +효 +과 +의 +저 +해 +및 +치 +료 +실 +패 +의 +주 +원 +인 +되 +는 +고 +형 +암 +의 +' +저 +산 +소 +환 +경 +' +으 +로 +인 +한 +내 +성 +문 +제 +를 +가 +진 +기 +존 +항 +암 +제 +와 +의 +병 +용 +투 +여 +를 +통 +해 +항 +암 +제 +내 +성 +을 +극 +복 +하 +여 +암 +치 +료 +효 +과 +를 +극 +대 +화 +할 +수 +있 +는 +암 +표 +적 +지 +향 +형 +나 +노 +산 +소 +운 +반 +체 +기 +반 +신 +개 +념 +항 +암 +치 +료 +증 +강 +제 +의 +개 +발 +이 +필 +요 +함 + +※ +핵 +심 +목 +표 +: +항 +암 +제 +내 +성 +극 +복 +병 +용 +치 +료 +증 +강 +나 +노 +의 +약 +품 +기 +술 +자 +립 +화 + + + + + +□ +개 +발 +내 +용 +ㅇ +나 +노 +산 +소 +운 +반 +체 +기 +반 +화 +학 +항 +암 +요 +법 +병 +용 +투 +여 +용 +제 +형 +화 +기 +술 +개 +발 +- +과 +불 +화 +탄 +소 +( +P +F +C +) +기 +반 +코 +어 +- +쉘 +구 +조 +의 +나 +노 +산 +소 +운 +반 +체 +최 +적 +조 +성 +/ +제 +조 +기 +술 +개 +발 +* +입 +자 +사 +이 +즈 +2 +0 +0 +n +m +이 +하 +, +I +n +v +i +t +r +o +산 +소 +봉 +입 +농 +도 +1 +5 +p +p +m +이 +상 +, +산 +소 +누 +출 +최 +소 +화 +능 +력 +등 +- +나 +노 +산 +소 +운 +반 +체 +의 +수 +동 +· +능 +동 +암 +표 +적 +지 +향 +형 +전 +달 +플 +랫 +폼 +기 +술 +개 +발 +- +암 +표 +적 +지 +향 +형 +나 +노 +산 +소 +운 +반 +체 +의 +화 +학 +항 +암 +요 +법 +병 +용 +투 +여 +용 +주 +사 +제 +형 +화 +기 +술 +개 +발 + +연 +구 +개 +발 +계 +획 +서 +제 +출 +시 +다 +음 +의 +항 +목 +의 +정 +량 +적 +목 +표 +치 +및 +상 +용 +화 +수 +준 +제 +시 +필 +수 +산 +소 +탑 +재 +효 +율 +( +농 +도 +) +, +입 +자 +크 +기 +( +n +m +) +, +입 +도 +분 +포 +균 +일 +성 +( +P +D +I +) +, +암 +표 +적 +지 +향 +기 +술 +( +건 +) +, +원 +료 +D +M +F +취 +득 +( +건 +) +, +G +M +P +생 +산 +실 +증 +( +건 +) +, +제 +품 +표 +준 +서 +( +건 +) +, +비 +임 +상 +보 +고 +서 +( +건 +) +, +I +N +D +신 +청 +( +건 +) +등 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +- +1 +- + diff --git a/tests/svg_snapshot.rs b/tests/svg_snapshot.rs new file mode 100644 index 00000000..a75d3b2d --- /dev/null +++ b/tests/svg_snapshot.rs @@ -0,0 +1,103 @@ +//! SVG snapshot regression tests for HWPX rendering. +//! +//! Pure-Rust replacement for `tools/verify_hwpx.py`, which requires Windows +//! + Hancom Office + pyhwpx and cannot run in CI. This harness invokes +//! `rhwp::wasm_api::HwpDocument::render_page_svg_native()` directly so the +//! same SVG the CLI produces is diffed against committed golden files. +//! +//! # Updating goldens +//! +//! When rhwp's rendering intentionally changes, regenerate goldens: +//! +//! ```sh +//! UPDATE_GOLDEN=1 cargo test --test svg_snapshot +//! ``` +//! +//! Commit the resulting `tests/golden_svg/**/*.svg` files alongside the +//! source change and mention the intentional diff in the PR body. +//! +//! # Determinism +//! +//! These tests assume: +//! - `render_page_svg_native` output is deterministic for a fixed input +//! (no timestamps, no random IDs, no host-font-dependent glyph IDs). +//! - Font embedding is OFF (`FontEmbedMode::None` via the native entry +//! point) so host system fonts cannot leak into the snapshot. +//! +//! If a flake is observed, the first debugging step is to diff two +//! back-to-back runs on the same machine. Host-specific variance +//! indicates a real determinism bug — worth its own issue. + +use std::fs; +use std::path::{Path, PathBuf}; + +/// Generate an SVG for a specific page and compare against the committed +/// golden. Set `UPDATE_GOLDEN=1` to regenerate. +fn check_snapshot(hwpx_relpath: &str, page: u32, golden_name: &str) { + let repo_root = env!("CARGO_MANIFEST_DIR"); + let hwpx_path = Path::new(repo_root).join(hwpx_relpath); + let bytes = fs::read(&hwpx_path) + .unwrap_or_else(|e| panic!("read {}: {}", hwpx_path.display(), e)); + + let doc = rhwp::wasm_api::HwpDocument::from_bytes(&bytes) + .unwrap_or_else(|e| panic!("parse {}: {}", hwpx_relpath, e)); + + let actual = doc + .render_page_svg_native(page) + .unwrap_or_else(|e| panic!("render {} p.{}: {}", hwpx_relpath, page, e)); + + let golden_path = PathBuf::from(repo_root) + .join("tests/golden_svg") + .join(format!("{golden_name}.svg")); + + if std::env::var("UPDATE_GOLDEN").as_deref() == Ok("1") { + if let Some(parent) = golden_path.parent() { + fs::create_dir_all(parent).unwrap(); + } + fs::write(&golden_path, &actual).unwrap(); + eprintln!("UPDATED {}", golden_path.display()); + return; + } + + let expected = fs::read_to_string(&golden_path).unwrap_or_else(|e| { + panic!( + "missing golden {}: {}. Run `UPDATE_GOLDEN=1 cargo test --test svg_snapshot` to create.", + golden_path.display(), + e + ) + }); + + if actual != expected { + // Write the actual output next to the golden for local inspection + // without polluting the committed tree. + let actual_path = golden_path.with_extension("actual.svg"); + let _ = fs::write(&actual_path, &actual); + panic!( + "SVG snapshot mismatch for {}.\n expected: {}\n actual: {}\n\ + Inspect the diff; if intentional, rerun with UPDATE_GOLDEN=1.", + golden_name, + golden_path.display(), + actual_path.display() + ); + } +} + +#[test] +fn form_002_page_0() { + check_snapshot("samples/hwpx/form-002.hwpx", 0, "form-002/page-0"); +} + +/// Determinism probe: render the same page twice in one process and assert +/// byte-for-byte equality. If this ever fails, the snapshot tests above +/// are unreliable regardless of golden correctness. +#[test] +fn render_is_deterministic_within_process() { + let repo_root = env!("CARGO_MANIFEST_DIR"); + let bytes = fs::read(Path::new(repo_root).join("samples/hwpx/form-002.hwpx")) + .expect("sample present"); + + let doc = rhwp::wasm_api::HwpDocument::from_bytes(&bytes).expect("parse"); + let a = doc.render_page_svg_native(0).expect("render #1"); + let b = doc.render_page_svg_native(0).expect("render #2"); + assert_eq!(a, b, "render_page_svg_native must be deterministic"); +}