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

並呈現：