docurun

DocuRun

DocuRun es una herramienta para ejecutar su documentación como pruebas de integración.

Por qué ?

Apuesto a que tanto sus pruebas de integración como su documentación son decepcionantes.

• Sus pruebas de integración probablemente sean difíciles de escribir, leer y depurar. Cuando algo sale mal, tienes que revisar el código e intentar adivinar en qué punto difieren de lo que estás haciendo manualmente en tu navegador.
• Su documentación de usuario final probablemente esté desactualizada porque los desarrolladores no quieren actualizarla cada vez que cambian el código. Cuando cambias la redacción de un botón, debes recordar actualizar las capturas de pantalla en la documentación, y probablemente no lo harás.

Si realiza un cambio que rompe el comportamiento documentado de la interfaz de usuario, probablemente sólo se enterará cuando sus usuarios se quejen.

¿Qué es DocuRun?

DocuRun es una herramienta que toma archivos de rebajas, incluidos bloques de código de dramaturgo, y los ejecuta como pruebas de integración. Produce un hermoso sitio web de documentación con capturas de pantalla tomadas durante las pruebas.

Cómo utilizar DocuRun

1. Escriba su documentación en archivos de rebajas, incluidos bloques de código que describan cómo usar su aplicación. Cree un archivo docurun/index.md similar a este:
2. Ejecute DocuRun en sus archivos de rebajas

   npx docurun

3. Docurun mostrará un buen informe en su salida estándar que muestra qué archivos de rebajas se ejecutaron correctamente y cuáles fallaron. El código de salida será 0 si se aprobaron todas las pruebas y 1 si algunas pruebas fallaron, lo que facilita la integración en su proceso de CI/CD. También creará un directorio docurun/website/ que contiene un sitio web estático con su documentación y capturas de pantalla. Si algunas pruebas fallaron, la documentación contendrá las capturas de pantalla de la página en el momento del error y el mensaje de error.

Estibador

También puedes ejecutar DocuRun en un contenedor acoplable, sin tener que instalar node.js en tu máquina:

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

Consulte lovaoa/docurun en Docker Hub.

Capturas de pantalla

Página SQL

Esto muestra la documentación ejecutable de la herramienta de creación de sitios web SQLPage.

estrellas de github

Errores

Una ejecución de error se ve así en la terminal

 $ 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

Y prestado: