Возможна ли читабельная документация со Споком? - PullRequest
Новая
       16

Возможна ли читабельная документация со Споком?

7 голосов
/ 04 августа 2011

Поэтому недавно я обратился к спецификациям и тестированию с использованием таких инструментов, как FitNesse & Spock.

Я сделал первый удар в FitNesse, и это было одно недокументированное испытание за другим.К счастью, я споткнулся о Спока и довольно быстро влюбился в него.

При этом, единственное, что я предпочел, это функция документации FitNesse в вики-стиле.Он предоставил как код, так и документы для этих тестов спецификаций.

Есть ли способ в Споке (с плагином? / Из коробки?) Генерировать любую читаемую человеком документацию для демонстрациируководители проектов / заинтересованные стороны?

Ответы [ 3 ]

9 голосов
/ 12 сентября 2013

Что ж, я использовал строки, которые описывают каждый блок Спока в ваших тестах, для генерации отчетов в формате HTML. Пожалуйста, посетите мой проект и дайте мне знать, если это поможет:

https://github.com/renatoathaydes/spock-reports

Вы можете скачать jar из каталога reports, а затем просто добавить его в свой путь к классам. Запустите ваши тесты, и «чудесным образом» вы получите отчеты, сгенерированные в каталоге build/spock-reports!

Вы даже можете предоставить свои собственные таблицы стилей CSS, если хотите настроить отчеты, как описано в README.

Вот пост в блоге Я писал о написании этого расширения Спока.

UPDATE

спок-отчеты уже некоторое время доступны на Maven Central , а также JCenter .

3 голосов
/ 05 августа 2011

Спок позволяет вам добавлять описания к блокам, например ::

when: "5 dollars are withdrawn from the account"
account.withdraw(5)

then: "3 dollars remain"
account.balance == 3

Хотя мы пока не используем эту информацию, к ней легко получить доступ из расширения (см. Ссылку ниже). Осталось сделать из этого хороший отчет.

https://github.com/spockframework/spock-uberconf-2011/blob/master/src/test/groovy/extension/custom/ReportExtension.groovy

0 голосов
/ 09 октября 2015

Здесь уже есть несколько отличных ответов, но если вы хотите, чтобы ваши определения BDD были свободны от какой-либо сантехники, вы можете взглянуть на pease , что позволит вам использовать язык спецификаций Gherkin сСпок.

...