将Word文档作为R单元测试参考数据的XML对比问题排查

你遇到的问题核心是Word的OOXML底层包含大量自动生成的动态元数据（比如创建/修改时间、随机段落ID、修订版本号等），这些内容不影响文档的实际展示效果，但会导致二进制或原始XML对比时出现无意义的差异，进而触发测试失败。以下是针对性的解决方案：

1. 清理XML中的动态无关内容 #

在对比XML前，先移除那些不影响文档内容的动态节点/属性，确保只对比核心逻辑内容。可以基于xml2包实现清理逻辑：

# 封装XML清理函数，移除动态元数据
clean_dynamic_xml <- function(xml_obj) {
  # 复制XML对象，避免修改原文档
  cleaned_xml <- xml2::xml_clone(xml_obj)
  
  # 移除核心属性中的时间戳、修改者信息
  core_props <- xml2::xml_find_first(cleaned_xml, ".//cp:coreProperties")
  if (!is.na(core_props)) {
    xml2::xml_remove(xml2::xml_find_all(core_props, ".//dcterms:created"))
    xml2::xml_remove(xml2::xml_find_all(core_props, ".//dcterms:modified"))
    xml2::xml_remove(xml2::xml_find_all(core_props, ".//cp:lastModifiedBy"))
    xml2::xml_remove(xml2::xml_find_all(core_props, ".//cp:revision"))
  }
  
  # 移除自动生成的段落、表格ID
  xml2::xml_set_attr(xml2::xml_find_all(cleaned_xml, ".//w:p/w:pPr/w:pId"), "w:val", NULL)
  xml2::xml_set_attr(xml2::xml_find_all(cleaned_xml, ".//w:tbl/w:tblPr/w:tblId"), "w:val", NULL)
  
  return(cleaned_xml)
}

# 修改转换函数，加入清理步骤
convert_to_cleaned_xml <- function(doc_path) {
  doc <- officer::read_docx(doc_path)
  raw_xml <- doc$doc_obj$get()
  cleaned_xml <- clean_dynamic_xml(raw_xml)
  
  xml_out <- tempfile(fileext = ".xml")
  # 统一XML输出格式，避免缩进/换行差异
  xml2::write_xml(cleaned_xml, file = xml_out, format = TRUE, indent = "  ")
  xml_out
}

2. 更换更合适的对比方式 #

expect_snapshot_file是二进制级别的对比，任何细微的无关差异都会导致失败，不适合这类场景。推荐两种替代方案：

方案A：对比清理后的XML对象 #

直接用xml2::xml_compare对比清理后的XML结构，它会忽略命名空间前缀、属性顺序等无关差异，只关注核心内容：

test_that("document content matches reference", {
  # 生成测试文档
  output_doc <- generate_document()
  output_xml <- officer::read_docx(output_doc)$doc_obj$get()
  cleaned_output <- clean_dynamic_xml(output_xml)
  
  # 读取参考文档
  ref_doc <- officer::read_docx(get_reference_path())
  ref_xml <- ref_doc$doc_obj$get()
  cleaned_ref <- clean_dynamic_xml(ref_xml)
  
  # 对比清理后的XML结构
  expect_true(xml2::xml_compare(cleaned_output, cleaned_ref))
})

方案B：对比结构化内容摘要 #

如果不需要关注底层XML细节，直接用officer::docx_summary提取文档的结构化内容（文本、表格数据、格式信息等），对比这些高层数据更直观，也更符合单元测试的核心目标：

test_that("document content matches reference", {
  output_doc <- generate_document()
  output_summary <- officer::docx_summary(output_doc)
  
  ref_doc <- officer::read_docx(get_reference_path())
  ref_summary <- officer::docx_summary(ref_doc)
  
  # 对比结构化摘要
  expect_equal(output_summary, ref_summary)
})

总结 #

• 避免直接对比Word文档的二进制或原始XML，因为动态元数据会导致无意义的差异；
• 优先选择结构化内容对比（docx_summary），逻辑更清晰，测试维护成本更低；
• 若必须对比XML，一定要先清理动态无关内容，再用xml_compare做语义级对比，而非二进制对比。

内容的提问来源于stack exchange，提问作者Jakub Małecki