docurun

DocuRun

DocuRun adalah alat untuk menjalankan dokumentasi Anda sebagai pengujian integrasi.

Mengapa ?

Saya yakin tes integrasi dan dokumentasi Anda mengecewakan.

• Tes integrasi Anda mungkin sulit untuk ditulis, sulit dibaca, dan sulit untuk di-debug. Ketika terjadi kesalahan, Anda harus menggali kodenya dan mencoba menebak pada titik mana kode tersebut berbeda dari apa yang Anda lakukan secara manual di browser Anda.
• Dokumentasi pengguna akhir Anda mungkin sudah ketinggalan zaman, karena pengembang tidak ingin memperbaruinya setiap kali mereka mengubah kode. Saat Anda mengubah kata-kata pada tombol, Anda harus ingat untuk memperbarui tangkapan layar di dokumentasi, dan Anda mungkin tidak akan melakukannya.

Jika Anda membuat perubahan yang merusak perilaku antarmuka pengguna yang terdokumentasi, Anda mungkin hanya mengetahuinya saat pengguna Anda mengeluh.

Apa itu DocuRun?

DocuRun adalah alat yang mengambil file penurunan harga termasuk blok kode penulis naskah dan menjalankannya sebagai pengujian integrasi. Ini menghasilkan situs dokumentasi yang indah dengan tangkapan layar yang diambil selama pengujian.

Cara menggunakan DocuRun

1. Tulis dokumentasi Anda dalam file penurunan harga, termasuk blok kode yang menjelaskan cara menggunakan aplikasi Anda. Buat file docurun/index.md yang terlihat seperti ini:
2. Jalankan DocuRun pada file penurunan harga Anda

   npx docurun

3. Docurun akan menampilkan laporan bagus pada keluaran standarnya yang menunjukkan file penurunan harga mana yang berhasil dan mana yang gagal. Kode keluarnya adalah 0 jika semua pengujian lulus, dan 1 jika beberapa pengujian gagal, sehingga memudahkan integrasi dalam pipeline CI/CD Anda. Ini juga akan membuat direktori docurun/website/ yang berisi situs web statis dengan dokumentasi dan tangkapan layar Anda. Jika beberapa pengujian gagal, dokumentasi akan berisi tangkapan layar halaman pada saat kegagalan, dan pesan kesalahan.

Buruh pelabuhan

Anda juga dapat menjalankan DocuRun di kontainer buruh pelabuhan, tanpa harus menginstal node.js di mesin Anda:

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

Lihat lovaoa/docurun di Docker Hub.

Tangkapan layar

Halaman SQL

Ini menunjukkan dokumentasi yang dapat dieksekusi dari alat pembuatan situs web SQLPage.

bintang Github

Kesalahan

Kesalahan yang dijalankan terlihat seperti ini di 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

Dan diberikan: