docurun

文档运行

DocuRun 是一个将文档作为集成测试运行的工具。

为什么 ？

我敢打赌你的集成测试和文档都令人失望。

• 您的集成测试可能难以编写、难以阅读和调试。当出现问题时，您必须深入研究代码并尝试猜测它们与您在浏览器中手动执行的操作有何不同。
• 您的最终用户文档可能已经过时，因为开发人员不想在每次更改代码时都更新它。当您更改按钮的措辞时，您必须记住去更新文档中的屏幕截图，但您可能不会。

如果您所做的更改破坏了用户界面记录的行为，您可能只会在用户抱怨时才发现。

什么是DocuRun？

DocuRun 是一个工具，它获取包含剧作家代码块的 Markdown 文件并将其作为集成测试运行。它生成了一个漂亮的文档网站，其中包含测试期间截取的屏幕截图。

如何使用DocuRun

1. 在 Markdown 文件中编写文档，包括描述如何使用应用程序的代码块。创建一个docurun/index.md文件，如下所示：
2. 在 Markdown 文件上运行 DocuRun

   npx docurun

3. Docurun 将在其标准输出上显示一个很好的报告，显示哪些 Markdown 文件运行成功，哪些失败。如果所有测试都通过，则退出代码将为 0；如果某些测试失败，则退出代码将为 1，这使得它可以轻松集成到 CI/CD 管道中。它还将创建一个docurun/website/目录，其中包含带有文档和屏幕截图的静态网站。如果某些测试失败，文档将包含失败时页面的屏幕截图以及错误消息。

码头工人

您还可以在 docker 容器中运行 DocuRun，而无需在计算机上安装 node.js：

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

请参阅 Docker Hub 上的 lovaoa/docurun。

截图

SQL页

这显示了SQLPage建站工具的可执行文档。

Github 星星

错误

错误运行在终端中看起来像这样

 $ 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

并呈现：