docurun

DocuRun

DocuRun — это инструмент для запуска вашей документации в виде интеграционных тестов.

Почему ?

Могу поспорить, что и ваши интеграционные тесты , и ваша документация разочаровывают.

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

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

Что такое DocuRun?

DocuRun — это инструмент, который берет файлы уценки, включая блоки кода драматурга, и запускает их в качестве интеграционных тестов. Он создает красивый веб-сайт документации со скриншотами, сделанными во время тестов.

Как использовать DocuRun

1. Напишите свою документацию в файлах уценки, включая блоки кода, описывающие, как использовать ваше приложение. Создайте файл docurun/index.md , который выглядит следующим образом:
2. Запустите DocuRun для файлов уценки.

   npx docurun

3. Docurun отобразит хороший отчет в своем стандартном выводе, показывающий, какие файлы уценки были выполнены успешно, а какие нет. Код выхода будет равен 0, если все тесты пройдены, и 1, если некоторые тесты не пройдены, что упрощает интеграцию в ваш конвейер CI/CD. Он также создаст каталог docurun/website/ , содержащий статический веб-сайт с вашей документацией и скриншотами. Если некоторые тесты не пройдены, документация будет содержать скриншоты страницы на момент сбоя и сообщение об ошибке.

Докер

Вы также можете запустить DocuRun в Docker-контейнере без необходимости устанавливать node.js на свой компьютер:

docker run -v $( pwd ) /docurun:/docurun -it lovasoa/docurun

См. lovaoa/docurun в Docker Hub.

Скриншоты

SQLПейдж

Здесь показана исполняемая документация инструмента создания веб-сайтов SQLPage.

Звезды Гитхаба

Ошибки

Ошибка запуска выглядит в терминале так

 $ npx docurun

> [email protected] start
> node cli.js

Processing all files in ./docurun/:
 - download_sqlpage.md
 - star_a_repository.md.
Saving results to ./docurun/website/.

✅ download_sqlpage
Error while executing code:
await page.getByText('inexistent element').click()

locator.click: Timeout 30000ms exceeded.
Call log:
  - waiting for getByText('inexistent element')

 star_a_repository

И отрисовано: