virtool

virtool

virtool ist eine webbasierte Anwendung zur Diagnose von Pathogeninfektionen mittels Hochdurchsatzsequenzierung.

Website: https://www.virtool.ca

Erste Schritte

Sehen Sie sich die virtool Dokumentation an, um mit der neuesten Version von virtool 4.0.0 zu beginnen.

Über Versionen

virtool durchläuft derzeit eine große Transformation hin zu einer Cloud-nativen Anwendung. Dies bedeutet, dass virtool die Arbeit auf mehrere Hosts skalieren und nativ in Kubernetes und öffentlichen Cloud-Anbietern ausführen kann.

Für aktuelle Benutzer und Administratoren:

1. Vorerst sollte virtool 4.0.0-Serie verwendet werden .
2. virtool 4.0.0-Serie wird auf absehbare Zeit weiterhin Fehler- und Sicherheitskorrekturen erhalten.
3. virtool 5.0.0 wird mehrere Containerdienste umfassen, die zusammen ausgeführt werden müssen. Es wird ein Bereitstellungs- und Migrationsleitfaden bereitgestellt.

Tests

Im Stammverzeichnis des Quellverzeichnisses:

1. Starten Sie die erforderlichen Sicherungsdienste in Docker.

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

2. Führen Sie die Testsuite aus:

    poetry run pytest
   

Multiplexen

Die Testsuite funktioniert mit pytest-xdist .

 poetry run pytest -n 4

Dadurch werden mehrere Python-Prozesse verwendet, um die Tests parallel auszuführen.

Schnappschüsse

Wir verwenden Syrupy für Snapshot-Tests.

Snapshots werden für Tests verwendet, bei denen wir sicherstellen möchten, dass ein Objekt (z. B. Datenbankeintrag, Pydantic-Objekt, API-Antwort) eine erwartete Form und einen erwarteten Wertesatz hat.

Wenn Snapshots aktualisiert werden müssen:

 poetry run pytest <path_to_test_file> --su

Sie können noch spezifischer sein, indem Sie die Testklasse oder -funktion angeben:

 poetry run pytest <path_to_test_file>::<class_or_function>

Geben Sie immer genau an, welche Snapshots Sie aktualisieren . Aktualisieren Sie nicht blind eine Menge Snapshot-Dateien, nur damit Ihre Tests bestehen.

Commits

Alle Commits müssen der Spezifikation für konventionelle Commits entsprechen.

Diese standardisierten Commit-Nachrichten werden verwendet, um Releases mithilfe von semantic-release automatisch zu veröffentlichen, nachdem Commits aus erfolgreichen PRs mit main zusammengeführt wurden.

Beispiel

 feat: add API support for assigning labels to existing samples

Bei Bedarf sind beschreibende Textkörper und Fußzeilen erforderlich, um die Auswirkungen des Commits zu beschreiben. Verwenden Sie gegebenenfalls Aufzählungszeichen.

Zusätzliche Anforderungen

1. Schreiben Sie im Imperativ . Beispiel: „Fehler beheben“ , nicht „Fehler beheben“ oder „Fehler beheben“ .
2. Beziehen Sie sich nicht auf Probleme oder Codeüberprüfungen . Schreiben Sie beispielsweise nicht so etwas wie: „Nehmen Sie in der Rezension angeforderte Stiländerungen vor“ . Stattdessen „Stile aktualisieren, um die Barrierefreiheit zu verbessern“ .
3. Commits sind nicht Ihr persönliches Tagebuch . Schreiben Sie zum Beispiel nicht so etwas wie: „Server läuft wieder“ oder „Ups. Mein Code-Geruch wurde behoben.“

Von Tim Pope: Eine Anmerkung zu Git-Commit-Nachrichten