Gradle ტესტების დაყოფა
Tuist-ის Gradle პლაგინი შეიცავს ჩაშენებულ მხარდაჭერას ტესტების დაყოფისთვის. ის გეგმავს ტესტების სუიტებს, რომლებიც Tuist-მა ჩაწერა თქვენი პროექტების ტესტების ამოცანების წინა CI გაშვებების დროს, და იყენებს Tuist სერვერს ბალანსირებული დაყოფის გეგმების შესაქმნელად ისტორიული დროის მონაცემების საფუძველზე.
- ტესტების ანალიტიკა უნდა იყოს კონფიგურირებული
როგორ მუშაობს#
ტესტების დაყოფა მიჰყვება ორეტაპიან სამუშაო პროცესს:
- აგების ეტაპი: Tuist ქმნის დაყოფის გეგმას სერვერზე თქვენი პროექტებისთვის ჩაწერილი ტესტების სუიტებიდან. სერვერი იყენებს ბოლო 30 დღის ისტორიულ ტესტების დროის მონაცემებს, რათა გაანაწილოს ტესტები დაყოფებში ისე, რომ თითოეულმა დაყოფამ დაახლოებით თანაბარი დრო დახარჯოს. აგების ეტაპი გამოაქვს დაყოფის მატრიცა, რომელსაც თქვენი CI სისტემა იყენებს პარალელური გამშვებების შესაქმნელად.
- ტესტირების ეტაპი: თითოეული CI გამშვები იღებს დაყოფის ინდექსს და ასრულებს მხოლოდ იმ ტესტებს, რომლებიც მინიჭებულია ამ დაყოფას. ბოლო დაყოფა ასევე ასრულებს ყველა ტესტების სუიტას, რომელიც არ არის მინიჭებული სხვა დაყოფას.
აგების ეტაპი#
მოამზადეთ ტესტების დაყოფები tuistPrepareTestShards ამოცანის გამოყენებით:
./gradlew tuistPrepareTestShards \
-PtuistShardMax=5
ეს ამოცანა:
- პოულობს პროექტებს, რომლებსაც აქვთ დასაყოფი ტესტების ამოცანა, მათი კომპილაციის გარეშე
- ქმნის დაყოფის გეგმას Tuist სერვერზე იმ პროექტებისთვის ჩაწერილი ტესტების სუიტებიდან და დროებიდან ბოლო 30 დღის განმავლობაში
- გამოაქვს დაყოფის მატრიცა თქვენი CI სისტემისთვის
როდესაც ჯერ არ არის ჩაწერილი ტესტების სუიტები, მაგალითად პირველ გაშვებაზე, გეგმას აქვს ერთი დაყოფა, რომელიც ასრულებს ყველა ტესტს.
აგების პარამეტრები#
კონფიგურირება დაყოფისა Gradle პროექტის თვისებების მეშვეობით:
| თვისება | აღწერა |
|---|---|
-PtuistShardMax=<N> |
დაყოფების მაქსიმალური რაოდენობა (ნაგულისხმები: 2) |
-PtuistShardMin=<N> |
დაყოფების მინიმალური რაოდენობა |
-PtuistShardMaxDuration=<MS> |
მიზნობრივი მაქსიმალური ხანგრძლივობა თითოეული დაყოფისთვის მილიწამებში |
-PtuistShardTestTask=<NAME> |
ტესტების ამოცანა, რომლის ტესტებიც იყოფა, მაგალითად testDebugUnitTest. ნაგულისხმევად იყენებს ყველა ტესტების ამოცანას აგებაში |
Android პროექტებს მრავალი აგების ვარიანტით აქვთ ერთი ერთეულოვანი ტესტების ამოცანა თითოეული ვარიანტისთვის. დააყენეთ -PtuistShardTestTask იმ ვარიანტზე, რომელსაც თქვენი დაყოფები ასრულებენ, რათა დაიგეგმოს მხოლოდ ის პროექტები, რომლებსაც ის აქვთ:
./gradlew tuistPrepareTestShards \
-PtuistShardMax=5 \
-PtuistShardTestTask=testDebugUnitTest
დაყოფის მითითება ავტომატურად მიიღება CI გარემოს ცვლადებიდან (GITHUB_RUN_ID, CI_PIPELINE_ID და ა.შ.) ან შეიძლება ცალსახად დაყენდეს TUIST_SHARD_REFERENCE გარემოს ცვლადის მეშვეობით.
ტესტირების ეტაპი#
თითოეული დაყოფის გამშვები ასრულებს მისთვის მინიჭებულ ტესტებს სტანდარტული test ამოცანის გამოყენებით. როდესაც TUIST_SHARD_INDEX დაყენებულია, პლაგინი ავტომატურად იღებს დაყოფის მინიჭებას სერვერიდან და ფილტრავს ტესტების შესრულებას ისე, რომ მოიცვას მხოლოდ მინიჭებული ტესტების სუიტები. ტესტების ამოცანები პროექტებში, რომლებსაც არ აქვთ დაყოფისთვის მინიჭებული სუიტები, გამოტოვებულია.
ბოლო დაყოფა ასრულებს ყველა ტესტების ამოცანას და გამორიცხავს სხვა დაყოფებისთვის მინიჭებულ სუიტებს, ასე რომ სუიტები, რომლებსაც ჯერ არ აქვთ ჩაწერილი გაშვებები, როგორიცაა ახლად დამატებული, მაინც სრულდება.
TUIST_SHARD_INDEX=0 ./gradlew test
თუ დააყენებთ -PtuistShardTestTask აგების ეტაპზე, გაუშვით იგივე ამოცანა თითოეულ დაყოფაში, მაგალითად ./gradlew testDebugUnitTest.
უწყვეტი ინტეგრაცია#
Tuist ავტომატურად ამოიცნობს შემდეგ CI პროვაიდერებს:
სხვა პროვაიდერებისთვის, იხილეთ .tuist-shard-matrix.json ფაილი პარალელური სამუშაოების დასაყენებლად.
ყველა აგებისა და დაყოფის სამუშაოს სჭირდება ავთენტიკაცია Gradle-ის გაშვებამდე. ან დააინსტალირეთ Tuist CLI და გაუშვით tuist auth login თქვენი CI პროვაიდერის OIDC იდენტობით, ან გახადეთ ხელმისაწვდომი ანგარიშის ტოკენი როგორც TUIST_TOKEN. იხილეთ Gradle პლაგინის ავთენტიკაცია. ქვემოთ მოყვანილ მაგალითებში ეს ეტაპი გამოტოვებულია.
GitHub Actions#
გამოიყენეთ მატრიცის სტრატეგია დაყოფების პარალელურად გასაშვებად:
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 შაბლონის სამუშაო, რომელსაც წარმოქმნილი დაყოფის სამუშაოები აფართოებენ:
# .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 სამუშაოს შაბლონი:
# .gitlab/shard-template.yml
.tuist-shard:
script:
- ./gradlew test
CircleCI#
Tuist წარმოქმნის .tuist-shard-continuation.json-ს პარამეტრებით გაგრძელების ორბისთვის:
# .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
# .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-ის გამოყენებით:
# pipeline.yml
steps:
- label: "Build test shards"
command: |
./gradlew tuistPrepareTestShards -PtuistShardMax=5
buildkite-agent pipeline upload .tuist-shard-pipeline.yml
თითოეულ წარმოქმნილ ნაბიჯს გარემოში აქვს მითითებული TUIST_SHARD_INDEX. დაამატეთ ტესტის ბრძანება თითოეულ დაყოფის ნაბიჯზე საერთო სკრიპტის გამოყენებით:
# .buildkite/shard-step.sh
#!/bin/bash
./gradlew test
Codemagic#
Codemagic არ უჭერს მხარს დინამიურ მატრიცულ სამუშაოებს, ამიტომ განსაზღვრეთ ცალკეული სამუშაო ნაკადი თითოეული დაყოფისთვის. Tuist წერს TUIST_SHARD_MATRIX-ს და TUIST_SHARD_COUNT-ს CM_ENV ფაილში, რათა ისინი გამოიყენოთ თითოეულ სამუშაო ნაკადში:
# 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 წინასწარ განსაზღვრული პარალელური სამუშაო ნაკადებით:
# 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
Bitrise არ უჭერს მხარს დინამიურ პარალელურ სამუშაოების შექმნას შესრულების დროს. განსაზღვრეთ ფიქსირებული რაოდენობის დაყოფის სამუშაო ნაკადები თქვენს პაიპლაინის ეტაპებში — ერთი ეტაპის ფარგლებში სამუშაო ნაკადები ავტომატურად პარალელურად სრულდება.