virtool

virtool

virtool — это веб-приложение для диагностики патогенных инфекций с использованием высокопроизводительного секвенирования.

Сайт: https://www.virtool.ca.

Начиная

См. документацию virtool , чтобы начать работу с последней версией virtool 4.0.0.

О версиях

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>

Всегда уточняйте, какие снимки вы обновляете . Не обновляйте слепо массу файлов моментальных снимков только для того, чтобы ваши тесты прошли успешно.

фиксирует

Все коммиты должны соответствовать спецификации обычных коммитов.

Эти стандартизированные сообщения о фиксации используются для автоматической публикации релизов с использованием semantic-release после слияния коммитов с main из успешных PR.

Пример

 feat: add API support for assigning labels to existing samples

Описательные тела и нижние колонтитулы необходимы там, где необходимо описать влияние фиксации. Используйте пули там, где это уместно.

Дополнительные требования

1. Пишите в повелительном наклонении . Например, «исправить ошибку» , а не «исправить ошибку» или «исправить ошибку» .
2. Не ссылайтесь на проблемы или обзоры кода . Например, не пишите что-то вроде: «внесите изменения в стиль, запрошенные при проверке» . Вместо этого «обновите стили, чтобы улучшить доступность» .
3. Коммиты не являются вашим личным журналом . Например, не пишите что-то вроде: «Сервер снова заработал» или «Упс. Исправлен запах моего кода» .

От Тима Поупа: заметка о сообщениях коммитов Git