virtool

virtool

virtool高スループット シーケンスを使用して病原体感染を診断するための Web ベースのアプリケーションです。

Web サイト: https://www.virtool.ca

はじめる

最新バージョンのvirtool 4.0.0 の使用を開始するには、 virtoolドキュメントを参照してください。

バージョンについて

virtoolは現在、クラウドネイティブ アプリケーションへの大きな変革を行っています。これは、 virtool複数のホストにわたって作業を拡張し、Kubernetes やパブリック クラウド プロバイダーでネイティブに実行できることを意味します。

現在のユーザーおよび管理者向け:

1. 現時点では、 virtool 4.0.0 シリーズを使用してください。
2. virtool 4.0.0 シリーズでは、今後もバグとセキュリティの修正が行われます。
3. virtool 5.0.0 は、一緒に実行する必要がある複数のコンテナ化されたサービスで構成されます。導入および移行ガイドが提供されます。

テスト

ソース ディレクトリのルート内:

1. Docker で必要なバッキング サービスを開始します。

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

2. テスト スイートを実行します。

    poetry run pytest
   

多重化

テスト スイートはpytest-xdistで動作します。

 poetry run pytest -n 4

これにより、複数の Python プロセスを使用してテストが並行して実行されます。

スナップショット

スナップショットのテストには Syrupy を使用します。

スナップショットは、オブジェクト (データベース レコード、Pydantic オブジェクト、API 応答など) が期待される形状と値のセットを持っていることを確認するテストに使用されます。

スナップショットを更新する必要がある場合:

 poetry run pytest <path_to_test_file> --su

テスト クラスまたは関数を指定すると、さらに具体的にすることができます。

 poetry run pytest <path_to_test_file>::<class_or_function>

どのスナップショットを更新するのかを常に具体的にしてください。テストに合格させるためだけに、大量のスナップショット ファイルをやみくもに更新しないでください。

コミット

すべてのコミットは従来のコミット仕様に従う必要があります。

これらの標準化されたコミット メッセージは、成功した PR からコミットがmainにマージされた後に、 semantic-release使用してリリースを自動的に公開するために使用されます。

例

 feat: add API support for assigning labels to existing samples

コミットの影響を説明するために、必要に応じて説明的な本文とフッターが必要です。必要に応じて箇条書きを使用します。

追加の要件

1. 命令形で書きます。たとえば、 「バグを修正」または「バグを修正」ではなく、 「バグを修正」します。
2. 問題やコードレビューには言及しないでください。たとえば、 「レビューでリクエストされたスタイル変更を行う」のような内容は書かないでください。代わりに、 「スタイルを更新してアクセシビリティを向上させてください」 。
3. コミットは個人的な日記ではありません。たとえば、 「サーバーが再び実行されました」または「おっと、コードの匂いが修正されました」のようなことは書かないでください。

Tim Pope より: Git コミット メッセージに関するメモ