uip tm wait

「uip tm wait」の構文とオプション - テスト実行が終了状態になるまでポーリングし、1 行の要約を出力します。

uip tm wait は、テスト実行が終了状態 (Passed、 Failed、 Cancelledなど) に達するまでポーリングし、1 行の概要を出力します。非同期 uip tm testsets run をCIパイプラインのブロッキングステップに変えます。

wait は、リソースとしてではなく、 tmの下に最上位の動詞として登録されます — uip tm executions waitではなく uip tm waitとして呼び出します。

概要

uip tm wait --execution-id <uuid> (--project-key <key> | --test-set-key <key>)
            [--timeout <seconds>]

グローバル オプションを優先します。タイムアウト時のドメイン固有の動作については、以下の「終了コード」セクションを参照してください。

uip tm wait

特定の実行が最終ステートに達するまでブロックし、60 秒ごとに Test Manager をポーリングします (修正 — 設定不可)。

引数

設定はありません。

オプション

• --execution-id <uuid> (必須) — 待機する実行。uip tm testsets runから取得します。
• --project-key <key> — 所有プロジェクト。これまたは --test-set-key が必要です。
• --test-set-key <key> — テストセットキー(例: DEMO:42);プロジェクト キーはプレフィックスから派生します。
• --timeout <seconds> — 待機する最大時間 (秒単位)。既定値は 1800 (30 分) です。無期限に待機するには 0 渡します。
• --log-level <level> — debug、 info、 warn、 error。既定値は [ Informationです。

注:

このコマンドには --poll-interval フラグはありません。ポーリング間隔は 60 秒にハードコードされ、上書きできません。

例

# wait up to 15 minutes
uip tm wait \
  --execution-id a1b2c3d4-0000-0000-0000-000000000001 \
  --project-key DEMO \
  --timeout 900

データ形状 — 実行がタイムアウト前に終了ステートに達した

{
  "Code": "WaitComplete",
  "Data": {
    "ExecutionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Status": "Passed",
    "EndTime": "2025-04-15T10:32:11Z",
    "Duration": "00:02:11"
  }
}

Status 、Test Manager のレポート Passed、 Failed、 Cancelledなどの終了ステートを指定できます。「Reached a terminal state」は wait の成功シグナルであり、実行内のテストが成功したか失敗したかに関係なく、動詞は 0 終了します。合格/不合格で分岐するには、waitが戻った後にreport get出力を読みます。

終了コード

wait、0、1、および3の標準終了コードに従い、ドメイン固有の2の再利用が1つあります。

終了コード	意味
0	実行がタイムアウト内に終了ステートに達しました。
1	ポーリングの失敗 (API エラーの繰り返し、割り込み、中止) — 詳細は Message フィールドを参照してください。
2	タイムアウト。実行が終了ステートに達するまでのタイムアウトが経過しました。
3	検証エラー (不正なフラグ値、必須オプションが見つからない)

終了コード 2 はドメイン固有です。共有CLIコントラクトはAuthenticationError用に2を予約しますが、waitタイムアウトに再利用されるため、スクリプトはテキストを解析せずに「時間がかかりすぎた」と「ポーリングが本当に失敗した」を区別できます。完全なパターンについては、「executionsでの終了コードの動作」を参照してください。

スクリプト パターン

if ! uip tm wait \
    --execution-id "$id" \
    --project-key DEMO \
    --timeout 1800; then
  case $? in
    2) echo "timed out" >&2; exit 2 ;;
    *) echo "wait failed" >&2; exit 1 ;;
  esac
fi

関連

• testsets run — 待機する ExecutionId を生成します。
• レポート — wait が 0を返した後に読み取る要約です。
• result — JUnit XMLエクスポート。
• 実行のリトライ — 完了した実行の失敗したケースを再実行します。

参照

• Test Manager の概要
• 終了コード — 共有契約。
• スクリプト パターン — 起動、待機、検証パイプライン。