docurun

โดคูรัน

DocuRun เป็นเครื่องมือในการรันเอกสารของคุณเป็นการทดสอบการรวมระบบ

ทำไม ?

ฉันพนันได้เลยว่าทั้ง การทดสอบการรวม และ เอกสาร ของคุณน่าผิดหวัง

• การทดสอบการรวมระบบของคุณอาจเขียนยาก อ่านยาก และแก้ไขข้อบกพร่องได้ยาก เมื่อมีสิ่งผิดปกติเกิดขึ้น คุณต้องขุดโค้ดและพยายามเดาว่าจุดใดที่แตกต่างจากสิ่งที่คุณทำด้วยตนเองในเบราว์เซอร์ของคุณ
• เอกสารสำหรับผู้ใช้ปลายทางของคุณอาจล้าสมัย เนื่องจากนักพัฒนาไม่ต้องการอัปเดตทุกครั้งที่เปลี่ยนโค้ด เมื่อคุณเปลี่ยนถ้อยคำของปุ่ม คุณต้องไม่ลืมที่จะอัปเดตภาพหน้าจอในเอกสารประกอบ และคุณอาจจะไม่อัปเดต

หากคุณทำการเปลี่ยนแปลงที่ขัดต่อพฤติกรรมที่บันทึกไว้ของอินเทอร์เฟซผู้ใช้ คุณอาจทราบเมื่อผู้ใช้ของคุณบ่นเท่านั้น

DocuRun คืออะไร?

DocuRun เป็นเครื่องมือที่ใช้ดึงไฟล์มาร์กดาวน์ รวมถึงบล็อกโค้ดของนักเขียนบทละคร และรันเป็นการทดสอบการรวมระบบ สร้างเว็บไซต์เอกสารที่สวยงามพร้อมภาพหน้าจอที่ถ่ายระหว่างการทดสอบ

วิธีการใช้งาน DocuRun

1. เขียนเอกสารของคุณในไฟล์มาร์กดาวน์ รวมถึงบล็อกโค้ดที่อธิบายวิธีใช้แอปพลิเคชันของคุณ สร้างไฟล์ docurun/index.md ที่มีลักษณะดังนี้:
2. เรียกใช้ DocuRun กับไฟล์มาร์กดาวน์ของคุณ

   npx docurun

3. Docurun จะแสดงรายงานที่ดีเกี่ยวกับเอาต์พุตมาตรฐานโดยแสดงว่าไฟล์มาร์กดาวน์ใดที่รันได้สำเร็จและไฟล์ใดล้มเหลว รหัสทางออกจะเป็น 0 หากการทดสอบทั้งหมดผ่านการทดสอบ และ 1 หากการทดสอบบางรายการล้มเหลว ซึ่งทำให้ง่ายต่อการรวมเข้ากับไปป์ไลน์ CI/CD ของคุณ นอกจากนี้ยังจะสร้างไดเร็กทอรี docurun/website/ ที่มีเว็บไซต์แบบคงที่พร้อมเอกสารประกอบและภาพหน้าจอของคุณ หากการทดสอบบางอย่างล้มเหลว เอกสารประกอบจะประกอบด้วยภาพหน้าจอของเพจ ณ เวลาที่ล้มเหลว และข้อความแสดงข้อผิดพลาด

นักเทียบท่า

คุณยังสามารถรัน DocuRun ในคอนเทนเนอร์นักเทียบท่าได้โดยไม่ต้องติดตั้ง node.js บนเครื่องของคุณ:

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

ดู lovaoa/docurun บน Docker Hub

ภาพหน้าจอ

SQLPage

นี่แสดงเอกสารปฏิบัติการของเครื่องมือสร้างเว็บไซต์ 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

และแสดงผล: