Maven: как проверить правильность создания сгенерированных документов в целевой папке?

У меня есть проект Java/Maven, который использует RestDocs для создания документации наших конечных точек.

Для непосвященных RestDocs, что он делает, так это отслеживает тесты во время сборки и использует информацию из тестов для создания «фрагментов», которые используются для создания документации API с использованием asciidoc на этапе пакета mvn.

Проблема, с которой я сталкиваюсь, заключается в том, что если файл asciidoc (.adoc) ссылается на несуществующий фрагмент, документ создается и говорит что-то вроде:

«Неразрешенная директива в myDoc.adoc — include::{snippets}/error-example/response-fields.adoc[]»

Поскольку это происходит после тестов, я не знаю, как протестировать что-то подобное, чтобы сборка могла остановиться и сообщить разработчику, что им нужно обновить либо .adoc, либо фрагмент.

Любое руководство будет высоко оценено.


maven junit spring-restdocs
person TonyRedYellow    schedule 11.10.2018    source источник
comment
Проверьте документы для вашего плагина, который отображает asciidoc, должен иметь параметр для сбоя в таких ситуациях...   -  person khmarbaise    schedule 11.10.2018
comment
Спасибо @khmarbaise, у плагина asciidoc maven есть параметр failIf!   -  person TonyRedYellow    schedule 12.10.2018

Ответы (1)


arrow_upward
1
arrow_downward

Добавление этого в конфигурацию плагина asciidoctor приводит к сбою сборки, когда не найден фрагмент, ожидаемый .adoc:

<logHandler>
     <outputToConsole>true</outputToConsole>
          <failIf>
              <containsText>include file not found</containsText>
          </failIf>
</logHandler>
person TonyRedYellow    schedule 12.10.2018