virtool

virtool

virtool adalah aplikasi berbasis web untuk mendiagnosis infeksi patogen menggunakan pengurutan throughput tinggi.

Situs web: https://www.virtool.ca

Memulai

Lihat dokumentasi virtool untuk memulai dengan versi terbaru virtool 4.0.0.

Tentang Versi

virtool saat ini sedang mengalami transformasi besar menjadi aplikasi cloud-native. Ini berarti virtool dapat menskalakan pekerjaan di banyak host dan berjalan secara native di Kubernetes dan penyedia cloud publik.

Untuk pengguna dan administrator saat ini:

1. seri virtool 4.0.0 harus digunakan untuk saat ini .
2. seri virtool 4.0.0 akan terus menerima perbaikan bug dan keamanan di masa mendatang.
3. virtool 5.0.0 akan terdiri dari beberapa layanan dalam container yang perlu dijalankan bersama. Panduan penerapan dan migrasi akan disediakan.

Tes

Di root direktori sumber:

1. Mulai layanan pencadangan yang diperlukan di Docker.

    docker compose -f tests/docker-compose.yml -p virtool -test up -d
   

2. Jalankan rangkaian pengujian:

    poetry run pytest
   

Multipleksing

Rangkaian pengujian berfungsi dengan pytest-xdist .

 poetry run pytest -n 4

Ini akan menggunakan beberapa proses Python untuk menjalankan pengujian secara paralel.

Jepretan

Kami menggunakan Syrupy untuk pengujian snapshot.

Snapshot digunakan untuk pengujian di mana kita ingin menegaskan bahwa suatu objek (mis. Catatan database, objek Pydantic, respons API) memiliki bentuk dan kumpulan nilai yang diharapkan.

Jika snapshot perlu diperbarui:

 poetry run pytest <path_to_test_file> --su

Anda bisa lebih spesifik lagi dengan menentukan kelas atau fungsi pengujian:

 poetry run pytest <path_to_test_file>::<class_or_function>

Selalu spesifik tentang snapshot apa yang Anda perbarui . Jangan memperbarui banyak file snapshot secara membabi buta hanya agar pengujian Anda lulus.

Berkomitmen

Semua komitmen harus mengikuti spesifikasi Komit Konvensional.

Pesan penerapan standar ini digunakan untuk mempublikasikan rilis secara otomatis menggunakan semantic-release setelah penerapan digabungkan ke main dari PR yang berhasil.

Contoh

 feat: add API support for assigning labels to existing samples

Badan dan footer deskriptif diperlukan jika diperlukan untuk menggambarkan dampak penerapan. Gunakan peluru jika diperlukan.

Persyaratan Tambahan

1. Tulis dalam bentuk imperatif . Misalnya, "memperbaiki bug" , bukan "memperbaiki bug" atau "memperbaiki bug" .
2. Jangan mengacu pada masalah atau tinjauan kode . Misalnya, jangan menulis sesuatu seperti ini: "buat perubahan gaya yang diminta dalam tinjauan" . Sebaliknya, "perbarui gaya untuk meningkatkan aksesibilitas" .
3. Komit bukanlah jurnal pribadi Anda . Misalnya, jangan menulis sesuatu seperti ini: "server berjalan kembali" atau "oops. perbaiki bau kode saya" .

Dari Tim Pope: Catatan Tentang Pesan Git Commit