Skip to content

test(odf-core): skip LibreOffice-gated tests when soffice is present but unusable#438

Open
stevenobiajulu wants to merge 1 commit into
mainfrom
tweak-soffice-unusable-probe-skip
Open

test(odf-core): skip LibreOffice-gated tests when soffice is present but unusable#438
stevenobiajulu wants to merge 1 commit into
mainfrom
tweak-soffice-unusable-probe-skip

Conversation

@stevenobiajulu

Copy link
Copy Markdown
Member

Problem

resolveSoffice() proves the binary exists, not that it can launch. Under a restricted shell (observed: macOS Seatbelt via codex exec --sandbox workspace-write while implementing #411), soffice dies with SIGABRT during init. Four odf-core tests gate only on existence, so in that environment they fail after burning their 60–240 s oracle timeouts — misleading sandboxed agents into diagnosing the machine's LibreOffice as broken when only their shell is:

CONV-13 (convert/lo_convert_differential.test.ts) already solved this with an inline preflight probe.

Change

  • Extract the probe as probeSofficeUsable() next to resolveSoffice() in docx-core/src/integration/libreoffice-oracle.ts: a throwaway headless --convert-to with a fresh profile — the same first step the oracle itself performs — memoized per binary path. Re-exported from the docx-core index.
  • Apply it after the existing resolveSoffice() null-check in the three ungated tests; refactor CONV-13 onto the shared helper. The real oracle calls stay outside the probe, so genuine round-trip regressions still fail loudly — only launchability is skip-worthy.
  • ORTS-02's local resolveSoffice duplicate is replaced by the shared export (a superset: it also honors SAFE_DOCX_SOFFICE_BIN).

Verification

  • Real soffice (this machine, normal terminal): npm run test:run -w packages/odf-core → 19 files / 133 tests pass, oracle genuinely running (tests 35.8 s).
  • Simulated present-but-unusable: ODF_SOFFICE_BIN=/usr/bin/false … → same 133 green, all oracle work skipped (tests 1.0 s).
  • npm run test:run -w packages/docx-core → 1436 passed (suite's normal gated skips/xfails). Lint, check:spec-coverage, check:conformance-citations all pass.

Ref: #411 (provenance — found while Codex ran the root suite for that issue; this PR is the test-infrastructure fix, the stats work stays in #411)

…but unusable

resolveSoffice() proves the binary EXISTS, not that it can launch. Under a
restricted shell (observed: macOS Seatbelt via `codex exec --sandbox
workspace-write` while implementing #411) soffice dies with SIGABRT during
init, so the four existence-gated odf-core tests (ORTS-02, OCMPI-13, the
issue-#367 inline/paragraph round-trips) FAILED after burning their 60-240s
oracle timeouts instead of skipping — misleading sandboxed agents into
diagnosing the machine's LibreOffice as broken when only their shell is.

CONV-13 already solved this with an inline preflight probe. Extract it as
probeSofficeUsable() next to resolveSoffice() in docx-core (a throwaway
headless --convert-to with a fresh profile — the same first step the oracle
itself performs, memoized per binary path), apply it to the three ungated
tests, and refactor CONV-13 onto the shared helper. The real oracle calls
stay outside the probe so genuine round-trip regressions still fail loudly;
only launchability is skip-worthy. ORTS-02's local resolveSoffice duplicate
is replaced by the shared export (a superset: it also honors
SAFE_DOCX_SOFFICE_BIN).

Verified both paths: real soffice → 19 files / 133 tests pass with the
oracle genuinely running (tests 35.8s); ODF_SOFFICE_BIN=/usr/bin/false →
same 133 green with all oracle work skipped (tests 1.0s).

Ref: #411
@vercel

vercel Bot commented Jun 11, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
site Ready Ready Preview, Comment Jun 11, 2026 10:04am

Request Review

@github-actions github-actions Bot added the test label Jun 11, 2026
@github-actions

Copy link
Copy Markdown
Contributor

LLM-Based Quality Gate

Overall: ✅ PASS (4 pass · 0 warn · 11 skipped · 15 total)

Check Verdict
⏭️ SKIPPED read_file response metadata parity paths not touched by this PR
⏭️ SKIPPED Live DOM namespace-safe OOXML writes paths not touched by this PR
Deleted field markup keeps w:fldChar outside w:del The PR does not touch field atomization, validateFieldStructure, or deleted field markup, modifying only the LibreOffice probeSofficeUsable utility in packages/docx-core/src/integration/libreoffice-oracle.ts and related test files.
⏭️ SKIPPED Field validation per story, not global paths not touched by this PR
⏭️ SKIPPED Revision IDs seeded from all revision-bearing side parts paths not touched by this PR
Accept/reject sweep side parts and caches The PR does not touch DocxDocument.acceptChanges, DocxDocument.rejectChanges, REVISION_STORY_PART_PATHS, or any side-part revision markup, as it only introduces a preflight probe helper for LibreOffice launchability.
⏭️ SKIPPED DocumentViewNode.heading stays canonical paths not touched by this PR
⏭️ SKIPPED AI-author parity across entry points paths not touched by this PR
⏭️ SKIPPED Property-change wrapper discipline paths not touched by this PR
⏭️ SKIPPED SUPPORT.md Table A drift vs. implementation paths not touched by this PR
⏭️ SKIPPED Table A / Table B boundary on side-part revisions paths not touched by this PR
⏭️ SKIPPED Canonical-emission surface completeness paths not touched by this PR
⏭️ SKIPPED Lean predicate drift against engine semantics (asymmetric) paths not touched by this PR
Unit-test quality (avoid tautological / change-detector tests) The PR modifies several test files (e.g. packages/odf-core/src/compare/lo_inline_roundtrip.test.ts:66, packages/odf-core/src/roundtrip.test.ts:53) only to add preflight checks via probeSofficeUsable to skip tests when LibreOffice is unusable; it does not add, modify, or mock any test assertions or test cases.
Re-derived facts vs canonical sources The PR actively consolidates ad-hoc preflight logic into a canonical helper probeSofficeUsable in packages/docx-core/src/integration/libreoffice-oracle.ts:82, and deletes a duplicate resolveSoffice definition from packages/odf-core/src/roundtrip.test.ts:17 in favor of importing the canonical function.
Full checklist questions
  1. read_file response metadata parity: If this PR touches packages/docx-mcp/src/tools/read_file.ts, budgeted pagination returns, or additive response metadata like warnings / comment_load_error, do every successful return path (default budgeted early return, non-budget fallthrough, explicit limit/node_ids) preserve the same additive diagnostic fields? read_file has multiple success exits; diagnostics have already disappeared on one path before. Reference: fix(docx-core): declare xmlns:w14/w15 on comments root before writing prefixed attributes (#154) #180 surfaced comment_load_error, fix(docx-mcp): warn when read_file budget is exceeded by a single node (closes #184) #186 added an early budget return + warnings, fix(docx-mcp): surface comment_load_error on the default budgeted read path (closes #189) #191 fixed the missing comment_load_error on the default budgeted path.

  2. Live DOM namespace-safe OOXML writes: If this PR touches packages/docx-core/src/primitives/comments.ts or writes prefixed OOXML attributes/elements (w14:*, w15:*, xmlns:*, comments.xml, commentsExtended.xml, people.xml), are prefixed OOXML names written with namespace-aware APIs — root aliases bound with setAttributeNS(XMLNS_NS, ...), prefixed attributes with setAttributeNS(W14_NS/W15_NS, ...), and is there a test that proves the live DOM works before serialization/reparse? String-prefixed attributes can serialize plausibly while the live DOM still throws namespace errors. Reference: fix(docx-core): declare xmlns:w14/w15 on comments root before writing prefixed attributes (#154) #180 (xmlns:w14/w15 declared on comments root before writing prefixed attrs).

  3. Deleted field markup keeps w:fldChar outside w:del: If this PR touches field atomization, validateFieldStructure, hasFldCharInsideDel, w:fldChar, w:instrText, w:delInstrText, or collapsed field comparison logic, does deleted field output stay ECMA-376-conformant — w:fldChar sibling-level (never inside w:del), deleted instructions use w:delInstrText only inside valid delete wrappers, accept/reject safety checks still reject malformed combined output? Word treats deleted field-state markup in the wrong container as document-corrupting. References: fix(docx-core): validate w:delInstrText placement and reject w:fldChar inside <w:del> #211, fix(docx-core): partition field-closure validation by ECMA-376 story (#212) #225, fix(docx-core): fragment w:fldChar outside w:del per ECMA-376 Part 4 #228.

  4. Field validation per story, not global: If this PR touches packages/docx-core/src/baselines/atomizer/pipeline.ts, splitStories, validateFieldStructure, side-part merge logic, or footnote/endnote field handling, is field validation run independently per ECMA story (document.xml, each footnote, each endnote), with sidecars from both original and revised archives considered, and global counter balance not treated as sufficient? A document can be globally balanced but have an invalid field sequence inside one story. References: fix(docx-core): partition field-closure validation by ECMA-376 story (#212) #225, fix(docx-core): fragment w:fldChar outside w:del per ECMA-376 Part 4 #228, feat(docx-core): sweep side-part revisions on accept/reject #218.

  5. Revision IDs seeded from all revision-bearing side parts: If this PR touches packages/docx-mcp/src/session/manager.ts (especially getRevisionContextForSession or FIXED_REVISION_ID_SEED_PARTS), createRevisionContext, revision-ID allocation, or MCP tools that create tracked changes/comments/footnotes, does revision-ID allocation scan all relevant package parts before issuing new IDs — comments, footnotes, endnotes, glossary, headers, footers — ignore non-revision w:id values (comment IDs, bookmarks), and handle malformed optional parts gracefully? Revision IDs are package-wide; document-only seeding collides with existing side-part revisions. Reference: fix(docx-mcp): seed revision ids from side parts #216 (seed revision ids from side parts).

  6. Accept/reject sweep side parts and caches: If this PR touches DocxDocument.acceptChanges, DocxDocument.rejectChanges, REVISION_STORY_PART_PATHS, accept_changes, reject_changes, or side-part revision markup, does accept/reject process every revision-bearing story — updating document.xml + footnotes.xml + endnotes.xml + comments.xml, writing back only changed side parts while refreshing cached XML, and pruning orphan footnotes without deleting reserved separator entries? Accepting only in the main document leaves stale revisions and dangling references in the package. References: feat(docx-core): sweep side-part revisions on accept/reject #218, fix(docx-mcp): seed revision ids from side parts #216, fix(docx-core): partition field-closure validation by ECMA-376 story (#212) #225.

  7. DocumentViewNode.heading stays canonical: If this PR touches packages/docx-core/src/primitives/document_view.ts, HeadingValue, heading heuristics, ListMetadata.header_style, or Google Docs document-view heading normalization, does node.heading remain a structural heading signal — exact Word styles Heading1Heading6 win, heuristic sources suppressed inside table cells while real Word heading styles still pass, ordinary body paragraphs omit the heading key? Consumers use node.heading != null as a structural test; heuristic false positives break downstream navigation. References: fix(docx-core): harden heading detection (#157 Phase 1) #178, fix(docx-core): suppress non-sectional false-positive headings (closes #187) #188, feat(docx-core): add derived heading object to DocumentViewNode (closes #179) #190.

  8. AI-author parity across entry points: If this PR touches packages/docx-mcp/src/server.ts, packages/docx-mcp/src/cli/tool_runner.ts, packages/docx-mcp/src/cli/commands/**, or adds any new new SessionManager(...) call site in docx-mcp, does every entry point that constructs a SessionManager resolve SAFE_DOCX_AI_AUTHOR with the same three-way semantics (set → use it; empty string → opt out to untracked; unset → defaultAiAuthor), or has a new entry path silently bypassed tracked emission? Each entry path looks locally correct while diverging from another; tracked emission has gone dark in one path before anyone noticed. References: feat(docx-mcp): wire configurable AI author through MCP layer (#142) #172 (production MCP wiring would have kept tracked emission dark), fix(docx-mcp): honor SAFE_DOCX_AI_AUTHOR in CLI entry points (#181) #182 (CLI runners constructing bare SessionManager() silently produced untracked edits).

  9. Property-change wrapper discipline: If this PR touches packages/docx-core/src/primitives/layout.ts, packages/docx-core/src/primitives/text.ts, packages/docx-mcp/src/tools/clear_formatting.ts, or packages/docx-core/src/primitives/track-changes-emitter.ts, do tracked formatting/property edits emit exactly one correct *PrChange wrapper (pPrChange / rPrChange / trPrChange / tcPrChange) carrying a snapshot of the prior live properties — not stacking stale wrappers, not stripping valid historical children (cellIns/cellDel/cellMerge), and not omitting the snapshot when the operation is formatting-aware? Emitted OOXML is visually plausible but subtle snapshot mistakes only surface during later accept/reject or in Word's tracked-changes UI. References: feat(docx-core): emit pPrChange/trPrChange/tcPrChange from layout setters (#140) #167 (duplicate pPrChange/trPrChange/tcPrChange stacking + over-broad tcPr exclusion), feat(docx-mcp): emit rPrChange from clear_formatting MCP tool (#141) #170 (clear_formatting failing to strip stale rPrChange), feat(docx-core): emit rPrChange for formatted paragraph replacements #215 (rPrChange for formatted paragraph replacements + filtering nested stale records).

  10. SUPPORT.md Table A drift vs. implementation: If this PR modifies OOXML revision emission behavior (w:ins, w:del, w:rPrChange, etc.) in packages/docx-core/src/primitives/**, or touches packages/docx-core/SUPPORT.md, does the PR symmetrically update Table A in SUPPORT.md when the supported revision-emission surface in primitives changed — added, removed, or weakened — or is the documented contract now lying about what's supported? Reviewers focus on TS AST correctness and golden tests; Markdown contract tables get treated as an afterthought, so the documented surface drifts from the actual surface. Reference: [120.8] Regression suite for canonical revision emission across the surface #143 review caught replaceParagraphTextRange should emit w:rPrChange when run formatting changes #173 (formatting mismatch in Table A) and addCommentReply should emit body revision markup OR SUPPORT.md should be softened #174 (comment body revision omission forcing a Table A softening) late in peer review.

  11. Table A / Table B boundary on side-part revisions: If this PR touches packages/docx-core/src/primitives/comments.ts, packages/docx-core/src/primitives/footnotes.ts, or other side-part primitives, and adds/changes revision markup (w:ins, w:del), does tracked-change revision logic stay scoped to Table A (document-body content inside the side part) without leaking revision markup into Table B (the side-part package bootstrap — comments.xml/footnotes.xml element registration itself)? Body runs and side-part package elements share nearly identical XML namespace schemas; revisions emitted in the wrong table corrupt the package contract while looking plausible. References: [120.3] Emit w:ins/w:del for comment body anchors #138 (comment-body straddle constraints), [120.4] Emit w:ins/w:del for footnote reference and text #139 (footnote-reference straddle constraints).

  12. Canonical-emission surface completeness: If this PR adds or changes a tracked-edit surface in packages/docx-core/src/primitives/** or packages/docx-mcp/src/tools/**, are the paired artifacts updated together — packages/docx-core/src/integration/canonical-emission-regression.test.ts, packages/docx-mcp/src/integration/canonical-emission-mcp.test.ts, and the documented emitter surface (Table A) — or is the rollout only partially wired? The primitive change looks done before the MCP path, regression matrix, and documented contract are wired through; partial rollouts ship undocumented surface that drifts. References: feat(docx-mcp): wire configurable AI author through MCP layer (#142) #172 (RevisionContext threaded through every Table A MCP tool), test(docx-core,docx-mcp): final regression suite for canonical emission (#143) #175 (24-test regression suite + verified write-time emitter rows), feat(docx-core): emit rPrChange for formatted paragraph replacements #215 (re-enabled rPrChange regression + updated support surface for replaceParagraphTextRange).

  13. Lean predicate drift against engine semantics (asymmetric): If this PR changes field-wrapper semantics, the proof boundary, or atomizer behavior — packages/docx-core/src/baselines/atomizer/**, verification/lean/LeanSpike/Spec.lean, verification/lean/Tier2/**, or packages/docx-core/src/integration/lean-spec-bridge.test.ts — and if the TS engine semantics shifted, did the PR also update the Lean residual predicate and bridge tests, or is the proof now pinned to a stale stronger/weaker assumption? Asymmetric: a TS change without a corresponding Lean update is WARN; a Lean-only change without a TS update should not fire. The Lean side can still compile while the abstraction boundary is subtly wrong for the next engine refactor. References: feat(verification): close inv_field_001 with Tier 2 OoxmlDoc subset #208 (closed inv_field_001 using stronger recursivelyWellformed), refactor(verification): weaken inv_field_001 axiom to document-level preservationFriendly (rebased follow-up to #208) #220 (weakened the axiom to document-level preservationFriendly to avoid breakage when field fragmentation lands).

  14. Unit-test quality (avoid tautological / change-detector tests): If this PR adds or modifies any **/*.test.ts (or other test files), are the test assertions independent of the system under test — expected values constructed from first principles rather than re-derived from the function under test, mocks limited to external boundaries (filesystem, network, clocks) rather than mocking the SUT itself, assertions making concrete semantic claims rather than just snapshotting current behavior or asserting non-null, and any test added alongside a bug fix actually exercising the bug? Tests that re-implement the production code as the "expected" value, or mock out the system under test, pass green while providing no regression protection.

  15. Re-derived facts vs canonical sources: If this PR adds logic that re-computes a fact the codebase already derives elsewhere — another fldChar begin/separate/end visible-content walk (canonical: getParagraphRuns in packages/docx-core/src/primitives/text.ts), a second footnote display-number map (buildFootnoteDisplayMap vs getFootnotes().displayNumber), or any sibling re-implementation of an existing helper instead of importing or exporting it — does the PR consume the canonical source, or explicitly justify the new derivation and add a test pinning the copies in agreement? Independent derivations of the same fact drift apart; read_file renders every footnote marker twice in text/tagged_text ([^N][^N]) #382's doubled footnote markers were two passes disagreeing about one fact, and the fix initially added a fifth copy of the field-state walk. References: read_file renders every footnote marker twice in text/tagged_text ([^N][^N]) #382, fix(docx-mcp): render each footnote marker exactly once in read_file output #386, refactor: expose footnote references as document-view node metadata — one derivation of "visible footnote refs", not five fldChar walks #393.

Estimated cost (this run): $0.0059 — 17,869 input + 267 output tokens (≈4 chars/token) on gemini-3.5-flash. Char-count estimate, not provider telemetry.

@codecov

codecov Bot commented Jun 11, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant