virtool

virtool

virtool 처리량이 높은 시퀀싱을 사용하여 병원체 감염을 진단하기 위한 웹 기반 애플리케이션입니다.

웹사이트: 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 커밋 메시지에 대한 참고 사항