Перейти к содержимому

Проект на Elixir

plaintext
Help me get started with Tuist. Follow the setup at:
https://tuist.dev/en/docs/guides/get-started/elixir-project

Настройте Tuist один раз, а затем продолжайте использовать mix compile и mix test. Hex-пакет tuist_ex кэширует поддерживаемые зависимости и отправляет данные о сборках и запусках тестов в вашу панель управления.

Предварительные требования#

  • Проект на Elixir, собранный с помощью Mix, на Elixir версии 1.18 или новее.
  • Аккаунт Tuist.

Настройка Tuist#

Создайте проект в панели управления Tuist и выберите Mix (Elixir) в качестве системы сборки. Добавьте пакет в зависимости в вашем файле mix.exs:

elixir
defp deps do
[
{:tuist_ex, "~> 0.10", runtime: false}
]
end

Загрузите его, настройте проект и войдите в систему:

bash
mix deps.get
mix tuist.setup --project account/project
mix tuist.login

Настройка обновляет mix.exs, добавляя идентификатор вашего проекта, включает кэширование зависимостей и устанавливает алиасы для компиляции и тестирования. Она сохраняет другие настройки и стандартную подготовку к тестам, например настройку базы данных Phoenix. Если интеграция пользовательского алиаса небезопасна, процесс останавливается без изменения файла.

Зафиксируйте обновленный mix.exs в репозитории, чтобы ваша команда и CI использовали одинаковую настройку. Не нужно копировать скрипты или код оценки. Вход в систему открывает браузер; см. раздел аутентификации для входа без интерфейса и использования учетных данных CI.

Теперь запустите ваши обычные команды:

bash
mix compile
mix test

Сборки отображаются в разделе Builds, запуски тестов — в разделе Tests, а активность кэша зависимостей — в разделе Mix cache. Это общая настройка для всех трех функций. Обнаружение нестабильных тестов использует отправленные запуски; повторные попытки и шардирование в CI являются опциональными.

Кэширование зависимостей#

Tuist автоматически выбирает поддерживаемые зависимости Hex и Git без списка зависимостей. Промах кэша приводит к обычной компиляции и сохранению результата; попадание в кэш восстанавливает его. Нативная/пользовательская компиляция и локальные зависимости остаются под управлением Mix.

Компиляция должна быть воспроизводимой: объявите дополнительные входные данные времени компиляции и исключите зависимости с немоделируемыми входными данными или требуемыми побочными эффектами. См. раздел кэширования Elixir для получения информации о поддерживаемых входных данных, проверке кэша и настройке.

Аналитика сборок#

Время сборки, граф зависимостей между вашими файлами и то, как они меняются со временем, дают вам всё необходимое для оптимизации графа сборки и максимального использования всех ядер, доступных в среде, где происходит компиляция.

При наличии алиаса compile Tuist сообщает данные о каждой сборке: сколько времени она заняла, какие предупреждения и ошибки возникли, сколько времени заняла компиляция каждого файла и от каких файлов он зависит. Откройте раздел Builds на панели управления после следующего mix compile, чтобы увидеть эти данные.

Аналитика тестов#

Tuist записывает результат и длительность каждого теста в каждом запуске mix test, чтобы вы могли видеть, как меняется ваш набор тестов со временем, находить медленные тесты или те, что стали медленнее, и понимать, почему запуск завершился ошибкой в CI. Вы найдете их в разделе Tests на панели управления, вплоть до модуля, блока describe и самого теста.

Нестабильные тесты#

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

elixir
tuist: [project: "account/project", cache: true, test_retries: 2]

Тест, который проходит при повторной попытке, сообщается как нестабильный, а запуск считается успешным. Страница Flaky Tests содержит их список.

Шардирование тестов#

Шардирование тестов распределяет ваш набор тестов по раннерам CI. Tuist балансирует шарды, используя время выполнения каждого тестового файла в предыдущих запусках, компилирует проект один раз и передает эту сборку каждому раннеру. Одна команда планирует шарды:

bash
mix tuist.test.build --shard-max 4

Каждый раннер затем запускает свою часть с установленным значением TUIST_SHARD_INDEX, и результаты поступают на панель управления как единый запуск тестов:

bash
TUIST_SHARD_INDEX=0 mix test

Подключите команду#

Ценность аналитики растет с увеличением числа людей, подключенных к проекту. Пригласите коллег в организацию через настройки аккаунта на панели управления и настройте Single Sign-On (Google, Okta, Microsoft), чтобы подключение занимало один клик, а не требовало индивидуального mix tuist.login для каждого человека.

Для CI не используйте личный вход. GitHub Actions, CircleCI и Bitrise могут проходить аутентификацию через OpenID Connect; на других провайдерах установите токен TUIST_TOKEN с ограниченной областью действия. Следуйте шагам аутентификации для CI.