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

Сегментация тестов Gradle

Плагин Tuist для Gradle включает встроенную поддержку сегментации тестов. Он планирует наборы тестов, которые Tuist записал во время предыдущих запусков CI для задач тестирования ваших проектов, и использует сервер Tuist для создания сбалансированных планов сегментации на основе исторических данных о времени выполнения.

Требования

Как это работает#

Сегментация тестов выполняется в два этапа:

  1. Этап сборки: Tuist создает план сегментации на сервере на основе наборов тестов, записанных для ваших проектов. Сервер использует исторические данные о времени выполнения тестов за последние 30 дней, чтобы распределить тесты по сегментам так, чтобы каждый сегмент занимал примерно одинаковое количество времени. Этап сборки выводит матрицу сегментов, которую ваша система CI использует для запуска параллельных исполнителей.
  2. Этап тестирования: Каждый исполнитель CI получает индекс сегмента и выполняет только те тесты, которые назначены этому сегменту. Последний сегмент также запускает все наборы тестов, которые не назначены другим сегментам.

Этап сборки#

Подготовьте сегменты тестов с помощью задачи tuistPrepareTestShards:

bash
./gradlew tuistPrepareTestShards \
-PtuistShardMax=5

Эта задача:

  1. Находит проекты, содержащие задачу тестирования для сегментации, без их компиляции
  2. Создает план сегментации на сервере Tuist на основе наборов тестов и временных метрик, записанных для этих проектов за последние 30 дней
  3. Выводит матрицу сегментов для вашей системы CI

Если наборы тестов еще не записаны, например, при первом запуске, план содержит один сегмент, который запускает все тесты.

Параметры сборки#

Настройте сегментацию через свойства проекта Gradle:

СвойствоОписание
-PtuistShardMax=<N>Максимальное количество сегментов (по умолчанию: 2)
-PtuistShardMin=<N>Минимальное количество сегментов
-PtuistShardMaxDuration=<MS>Целевая максимальная длительность одного сегмента в миллисекундах
-PtuistShardTestTask=<NAME>Задача тестирования, тесты которой сегментируются, например testDebugUnitTest. По умолчанию используются все задачи тестирования в сборке

Проекты Android с несколькими вариантами сборки имеют одну задачу модульного тестирования для каждого варианта. Установите -PtuistShardTestTask в значение варианта, который запускают ваши сегменты, чтобы планировались только проекты, имеющие этот вариант:

bash
./gradlew tuistPrepareTestShards \
-PtuistShardMax=5 \
-PtuistShardTestTask=testDebugUnitTest

Ссылка на сегмент автоматически определяется из переменных окружения CI (GITHUB_RUN_ID, CI_PIPELINE_ID и т. д.) или может быть явно задана через переменную окружения TUIST_SHARD_REFERENCE.

Этап тестирования#

Каждый исполнитель сегмента выполняет назначенные ему тесты, используя стандартную задачу test. Когда установлена переменная TUIST_SHARD_INDEX, плагин автоматически получает назначение сегмента с сервера и фильтрует выполнение тестов, включая только назначенные наборы тестов. Задачи тестирования в проектах, где нет наборов, назначенных сегменту, пропускаются.

Последний сегмент запускает все задачи тестирования и исключает наборы, назначенные другим сегментам, поэтому наборы, для которых еще нет записанных запусков, например, недавно добавленные, все равно выполняются.

bash
TUIST_SHARD_INDEX=0 ./gradlew test

Если вы установили -PtuistShardTestTask на этапе сборки, запускайте ту же задачу в каждом сегменте, например ./gradlew testDebugUnitTest.

Непрерывная интеграция#

Tuist автоматически определяет следующие CI-провайдеры:

Для других провайдеров обратитесь к файлу .tuist-shard-matrix.json, чтобы настроить параллельные задачи.

Каждая задача сборки и сегмента должна пройти аутентификацию перед запуском Gradle. Либо установите CLI Tuist и выполните tuist auth login с использованием OIDC-идентичности вашего провайдера CI, либо предоставьте токен аккаунта через переменную TUIST_TOKEN. См. Аутентификация плагина Gradle. В примерах ниже этот шаг опущен.

GitHub Actions#

Используйте стратегию матрицы для параллельного запуска сегментов:

yaml
name: Tests
on: [pull_request]
jobs:
build:
name: Build test shards
runs-on: ubuntu-latest
outputs:
matrix: ${{ steps.build.outputs.matrix }}
steps:
- uses: actions/checkout@v4
- uses: actions/setup-java@v4
with:
distribution: 'temurin'
java-version: '17'
- uses: gradle/actions/setup-gradle@v4
- id: build
run: ./gradlew tuistPrepareTestShards -PtuistShardMax=5
test:
name: "Shard #${{ matrix.shard }}"
needs: build
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
shard: ${{ fromJson(needs.build.outputs.matrix).shard }}
env:
TUIST_SHARD_INDEX: ${{ matrix.shard }}
steps:
- uses: actions/checkout@v4
- uses: actions/setup-java@v4
with:
distribution: 'temurin'
java-version: '17'
- uses: gradle/actions/setup-gradle@v4
- run: ./gradlew test

GitLab CI#

Tuist генерирует файл .tuist-shard-child-pipeline.yml, который вы запускаете как дочерний пайплайн. Определите шаблонную задачу .tuist-shard, которую будут расширять сгенерированные задачи сегментов:

yaml
# .gitlab-ci.yml
stages:
- build
- test
build-shards:
stage: build
script:
- ./gradlew tuistPrepareTestShards -PtuistShardMax=5
artifacts:
paths:
- .tuist-shard-child-pipeline.yml
test-shards:
stage: test
needs: [build-shards]
trigger:
include:
- artifact: .tuist-shard-child-pipeline.yml
job: build-shards
strategy: depend

Дочернему пайплайну требуется шаблон задачи .tuist-shard:

yaml
# .gitlab/shard-template.yml
.tuist-shard:
script:
- ./gradlew test

CircleCI#

Tuist генерирует файл .tuist-shard-continuation.json с параметрами для orb продолжения:

yaml
# .circleci/config.yml
version: 2.1
setup: true
orbs:
continuation: circleci/continuation@1
jobs:
build-shards:
docker:
- image: cimg/openjdk:17.0
steps:
- checkout
- run:
name: Build and plan shards
command: |
./gradlew tuistPrepareTestShards -PtuistShardMax=5
- continuation/continue:
configuration_path: .circleci/continue-config.yml
parameters: .tuist-shard-continuation.json
workflows:
setup:
jobs:
- build-shards
yaml
# .circleci/continue-config.yml
version: 2.1
parameters:
shard-indices:
type: string
default: ""
shard-count:
type: integer
default: 0
jobs:
test-shard:
docker:
- image: cimg/openjdk:17.0
parameters:
shard-index:
type: integer
steps:
- checkout
- run:
name: Run shard
command: |
export TUIST_SHARD_INDEX=<< parameters.shard-index >>
./gradlew test
workflows:
test:
jobs:
- test-shard:
matrix:
parameters:
shard-index: [<< pipeline.parameters.shard-indices >>]

Buildkite#

Tuist генерирует файл .tuist-shard-pipeline.yml с одним шагом для каждого сегмента. Загрузите его с помощью buildkite-agent pipeline upload:

yaml
# pipeline.yml
steps:
- label: "Build test shards"
command: |
./gradlew tuistPrepareTestShards -PtuistShardMax=5
buildkite-agent pipeline upload .tuist-shard-pipeline.yml

Каждый сгенерированный шаг имеет переменную TUIST_SHARD_INDEX в своем окружении. Добавьте команду тестирования к каждому шагу сегмента, используя общий скрипт:

bash
# .buildkite/shard-step.sh
#!/bin/bash
./gradlew test

Codemagic#

Codemagic не поддерживает динамические матричные задачи, поэтому определите отдельный рабочий процесс для каждого сегмента. Tuist записывает TUIST_SHARD_MATRIX и TUIST_SHARD_COUNT в файл CM_ENV для использования в каждом рабочем процессе:

yaml
# codemagic.yaml
workflows:
build-shards:
name: Build test shards
instance_type: linux_x2
environment:
java: 17
scripts:
- name: Build and plan shards
script: |
./gradlew tuistPrepareTestShards -PtuistShardMax=5
test-shard-0: &shard-workflow
name: "Shard #0"
instance_type: linux_x2
environment:
java: 17
vars:
TUIST_SHARD_INDEX: 0
scripts:
- name: Run shard
script: |
./gradlew test
test-shard-1:
<<: *shard-workflow
name: "Shard #1"
environment:
java: 17
vars:
TUIST_SHARD_INDEX: 1
test-shard-2:
<<: *shard-workflow
name: "Shard #2"
environment:
java: 17
vars:
TUIST_SHARD_INDEX: 2
test-shard-3:
<<: *shard-workflow
name: "Shard #3"
environment:
java: 17
vars:
TUIST_SHARD_INDEX: 3
test-shard-4:
<<: *shard-workflow
name: "Shard #4"
environment:
java: 17
vars:
TUIST_SHARD_INDEX: 4

Bitrise#

В Bitrise Tuist записывает .tuist-shard-matrix.json в BITRISE_DEPLOY_DIR, делая его доступным как артефакт сборки для последующих этапов пайплайна. Используйте Bitrise Pipelines с предопределенными параллельными рабочими процессами:

yaml
# bitrise.yml
pipelines:
test-pipeline:
stages:
- build-stage: {}
- test-stage: {}
stages:
build-stage:
workflows:
- build-shards: {}
test-stage:
workflows:
- test-shard-0: {}
- test-shard-1: {}
- test-shard-2: {}
- test-shard-3: {}
- test-shard-4: {}
workflows:
build-shards:
steps:
- script:
title: Build and plan shards
inputs:
- content: |
./gradlew tuistPrepareTestShards -PtuistShardMax=5
test-shard-0: &shard-workflow
envs:
- TUIST_SHARD_INDEX: 0
steps:
- script:
title: Run shard
inputs:
- content: |
./gradlew test
test-shard-1:
<<: *shard-workflow
envs:
- TUIST_SHARD_INDEX: 1
test-shard-2:
<<: *shard-workflow
envs:
- TUIST_SHARD_INDEX: 2
test-shard-3:
<<: *shard-workflow
envs:
- TUIST_SHARD_INDEX: 3
test-shard-4:
<<: *shard-workflow
envs:
- TUIST_SHARD_INDEX: 4
Tip

Bitrise не поддерживает динамическое создание параллельных задач во время выполнения. Определите фиксированное количество рабочих процессов сегментов на этапах вашего пайплайна — рабочие процессы внутри этапа выполняются параллельно автоматически.