Maven：如何测试目标文件夹中生成的文档是否正确生成？答案

【问题标题】：Maven: How to test that generated documents in target folder are properly generated?Maven：如何测试目标文件夹中生成的文档是否正确生成？
【发布时间】：2018-10-11 19:24:32
【问题描述】：

我有一个使用 RestDocs 生成端点文档的 Java/Maven 项目。

对于不熟悉 RestDocs 的人，它的作用是在构建期间监控测试并使用来自测试的信息来生成“sn-ps”，这些“sn-ps”用于在 mvn 包阶段使用 asciidoc 创建 API 文档。

我面临的问题是，如果 asciidoc (.adoc) 文件引用了一个不存在的 sn-p，则会生成 doc 并显示如下内容：

“myDoc.adoc 中未解决的指令 - include::{sn-ps}/error-example/response-fields.adoc[]”

由于这发生在测试之后，我不知道如何测试这样的事情，以便构建可以停止并让开发人员知道他们需要更新 .adoc 或 sn-p。

任何指导将不胜感激。

【问题讨论】：

检查您的插件的文档，该插件正在渲染 asciidoc 应该有一个参数在这种情况下失败......
感谢@khmarbaise，asciidoc maven 插件有一个 failIf 参数！

标签： maven junit spring-restdocs

【解决方案1】：

当找不到 .adoc 所期望的 sn-p 时，将其添加到 asciidoctor 插件的配置中会导致构建失败：

<logHandler>
     <outputToConsole>true</outputToConsole>
          <failIf>
              <containsText>include file not found</containsText>
          </failIf>
</logHandler>

【讨论】：