Красивый вывод файлов функций Gherkin

Мы создаем спецификацию в Gherkin и хотели бы представить файлы функций заинтересованным сторонам бизнеса. Как мы можем экспортировать все наши файлы функций в каком-то «красивом» формате?

Например:

  • Создайте документ, содержащий все функции
  • ИЛИ интегрировать функции в другую документацию
  • ИЛИ опубликуйте файлы функций на веб-портале (хорошо отформатированные)

person dgmstuart    schedule 08.11.2011    source источник
comment
не могли бы вы уточнить, какой из них вы выберете в конце концов, и как вы размещаетесь внутри компании?   -  person vikramvi    schedule 24.11.2016
comment
Я покинул проект и компанию до того, как было принято решение.   -  person dgmstuart    schedule 04.12.2016
comment
Вы пробовали это в новом проекте и компании? Ваш вклад будет очень полезен сообществу и мне в том числе :)   -  person vikramvi    schedule 05.12.2016
comment
Нет: с тех пор я вообще не использовал корнишоны/огурцы.   -  person dgmstuart    schedule 06.12.2016


Ответы (5)


Лучшее, что я видел до сих пор, это Пиклз; http://github.com/picklesdoc/pickles

Это работа в процессе, но уже выглядит хорошо. Пожалуйста, оставьте свой отзыв на GitHub

person Marcus Hammarberg    schedule 09.11.2011
comment
Сейчас я покинул проект, но этот выглядел наиболее многообещающе — мы действительно начали его использовать, но я не знаю, как далеко продвинулась с ним команда. - person dgmstuart; 30.01.2012
comment
@dgmstuart жив и здоров! Они просто добавили поддержку JSON и DITA, а также поддержку запуска из командной строки, powershell (например, в VS2010), MsBuild и NAant. Проверьте это: nuget.org/packages/Pickles - person Marcus Hammarberg; 30.01.2012
comment
К сожалению, это похоже только на машины с Windows... Нет поддержки Mac или Linux :( - person Nosrettap; 11.11.2013
comment
Я только что создал GherkinDoc, пакет npm, который генерирует HTML-сайты на основе функций Gherkin, npmjs.com/package/gherkindoc< /а> - person AlexandrosD; 22.10.2016

Наша команда в настоящее время использует relish, проект кода, чтобы красиво оформить корнишоны на веб-сайте.

Однако у него есть некоторые недостатки — он «бесплатен только в бета-версии», но это все же может дать вам некоторые идеи.

Приятной особенностью Relish является то, что ваша команда разработчиков может выбрать отправлять корнишоны всякий раз, когда они будут готовы, а заинтересованным сторонам не нужно управлять/получать новые электронные письма/документы и т. д. — они могут просто обновить веб-страница проекта.

person perfectionist    schedule 28.01.2012
comment
Привет - спасибо, да, я видел Relish сейчас, но, к сожалению, бизнесу было неудобно открывать спецификацию для всеобщего обозрения - это огромный недостаток. Мы взглянули на Pickle, который не очень зрелый, но выглядел интересно. Я ушел из компании, к которой эта проблема относилась... - person dgmstuart; 30.01.2012
comment
AFAIK все, чтобы увидеть, не является точным. Вам действительно нужно загрузить файлы функций на веб-сайт приправы — так что в этом участвует третья сторона, но ваши страницы приправы видны только вашему собственному входу в систему. - person perfectionist; 30.01.2012
comment
Ах, они, кажется, добавили частные проекты с тех пор, как я последний раз смотрел. - person dgmstuart; 09.02.2012

Как вы думаете, почему вы хотите это сделать?

Я бы предположил, что красота bdd заключается в том, что он обеспечивает универсальный язык для заинтересованных сторон, тестировщиков и разработчиков. Его можно использовать на любом этапе цикла тестирования для описания нужных функций и сценариев, которым они соответствуют. Если ваш функциональный файл в стиле корнишонов представляет собой простой текстовый файл, его может редактировать непосредственно заинтересованное лицо и передать обратно в репозиторий исходного кода. Вы можете буквально брать новые сценарии из бизнеса и подтверждать, какие функции нуждаются в доработке, прежде чем писать одну строку кода.

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

Итак, я бы предположил, что лучший формат для представления заинтересованным сторонам бизнеса точно такой же, как формат, в котором они уже находятся.

Тем не менее, рассматривали ли вы возможность смены бегуна ваших тестов. Даже если функции по-прежнему представлены в виде обычного текста, бегун, такой как concordion или Concordion.net даст вам очень красивое изображение тестового запуска.

person AlSki    schedule 15.11.2011
comment
Привет. Да, согласен, с форматом лучше не заморачиваться, но основная проблема, которую предстоит решить, это представить спецификацию пользователям - они совсем не разбираются в технологиях, так что вряд ли смогу заставить их загружать обновления в локальный репозиторий! Есть ряд действительно простых проблем: совместное использование из системы управления версиями, представление спецификации в визуально читаемом виде (например, с подсветкой синтаксиса) и представление только списка описаний функций для заинтересованных сторон более высокого уровня. Есть идеи с этого ракурса? - person dgmstuart; 30.01.2012
comment
Рассматривали ли вы реализацию интерфейса? Кто-то (ведущий разработчик / руководитель группы / технически подкованный менеджер проекта) поддерживает связь с пользователями. Они фиксируют по электронной почте интерфейс, который затем обрабатывает фактическую фиксацию. Да, это не идеально, но это заставляет все двигаться, и кто знает, как только они привыкнут к этой идее, они тоже будут фиксировать напрямую. - person AlSki; 31.01.2012
comment
Я унаследовал систему с 450 историями, насчитывающими более 46 000 слов, и эта система продолжает расти. Попытка понять функциональность из необработанных текстовых файлов истории подобна попытке понять архитектуру системы, читая тысячи строк кода. Если истории должны служить документацией, должен быть механизм, позволяющий легко увеличивать или уменьшать масштаб до уровня, на котором вы хотите просмотреть. - person Chris Snow; 18.01.2014

Еще один вариант, не требующий никаких технических навыков. Аналогичен другому ответу здесь, но специально разработан для бизнеса, а не для технических заинтересованных сторон. Это расширение Chrome, которое автоматически форматирует любой файл *.feature, открытый в Chrome. Посмотрите примеры и установите здесь: средство просмотра файлов функций Pretty Gherkin.

person ItsMe-Rodders    schedule 11.03.2015

Попробуйте Gherkin Viewer

Для этой цели я собрал это расширение Chrome, так как мне не нравилась идея экспорта/переиздания файлов функций. Это позволяет просматривать первоисточник правды :)

https://chrome.google.com/webstore/detail/gherkin-viewer/lfckgakamnfdbanfefglincnckfnlapp?hl=en-GB

Посмотрите, посмотрите, работает ли это для вас. Источник находится на GitHub, очень простой старт, если кто-то хочет внести свой вклад, мы будем очень признательны.

person John Byrne    schedule 12.09.2014