テストバランシングAPI

このAPIを使用して、テスト時間を基にparallel: CI/CDジョブのノード全体にテストを分散させ、すべてのノードがほぼ同時に完了するようにします。

テスト分割は、ノード全体に分散される作業単位です。ファイルで分割する場合、各テスト分割はテストファイルです。ノードは、静的テスト分割を共有の保留中プールにシードし、完了するたびに、実行時間の予算に基づいてテスト分割のバッチを繰り返しリクエストします。高速なノードほど多くの作業を吸収します。ノードが再試行されると、元々割り当てられたテスト分割の正確なセットを受け取ります。

両方のエンドポイント:

• 実行中の並列ジョブから呼び出す必要があり、CI/CDジョブトークン（CI_JOB_TOKEN）で認証されている必要があります。
• 呼び出し元ジョブがparallel:キーワードを使用しない場合、422 Unprocessable Entityが返されます。
• パイプライン作成から30日以上前に作成されたパイプラインの場合、422 Unprocessable Entityが返されます。これは、テストバランシングデータ（再試行を含む）がパイプライン作成から30日間保持されるためです。

並列ジョブのテストバランシングを初期化する

呼び出し元の静的テスト分割をジョブグループの共有保留プールにシードし、最初のテスト分割のバッチを取得します。ノードがすでにテスト分割を要求している場合（たとえば、ジョブが再試行された場合やクラッシュから回復した場合）、以前に要求されたテストセットは変更されずに返され、test_splitsパラメータは無視されます。

このエンドポイントは、シードによってジョブグループの共有プール内のテスト分割数が50,000を超える場合、422 Unprocessable Entityを返します。

POST /job/test_balancing/initialize

サポートされている属性は以下のとおりです:

成功した場合、201 Createdと次のレスポンス属性を返します:

リクエスト例:

curl --request POST \
  --header "JOB-TOKEN: $CI_JOB_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"test_splits": [{"path": "spec/models/user_spec.rb", "expected_duration": 12.5}]}' \
  --url "https://gitlab.example.com/api/v4/job/test_balancing/initialize"

レスポンス例:

{
  "mode": "seed",
  "test_splits": [
    {
      "path": "spec/models/user_spec.rb",
      "expected_duration": 12.5
    }
  ]
}

次のテストバッチをリクエストする

呼び出し元ノードのために、保留中のテスト分割の時間予算付きバッチをアトミックに要求します（最も遅いものから優先）。空のtest_splits配列は、キューが空になり、ノードがバッチのリクエストを停止すべきであることを意味します。

サーバーは、共有プール内の残りの予想される期間の合計に基づいて、バッチサイズを自動的に選択します。大量の期間が残っている場合、サーバーはリクエスト数を減らすためにより大きなバッチを返します。プールが枯渇するにつれて、サーバーはノード間で作業のバランスが保たれるようにより小さなバッチを返します。

POST /job/test_balancing/request

このエンドポイントは属性を受け取りません。

成功した場合、201 Createdと次のレスポンス属性を返します:

リクエスト例:

curl --request POST \
  --header "JOB-TOKEN: $CI_JOB_TOKEN" \
  --url "https://gitlab.example.com/api/v4/job/test_balancing/request"

レスポンス例:

{
  "test_splits": [
    {
      "path": "spec/features/login_spec.rb",
      "expected_duration": 210.4
    }
  ]
}