uip tm wait

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

uip tm wait polls a test execution until it reaches a terminal state (Finished or Cancelled) and then prints a one-line summary. It turns the asynchronous uip tm testsets run into a blocking step in a CI pipeline.

wait is registered as a top-level verb under tm, not as a resource. Invoke it as uip tm wait, not uip tm executions wait.

概要

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

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

uip tm wait

Block until the given execution reaches a terminal state, polling Test Manager every 60 seconds.

引数

設定はありません。

オプション

• --execution-id <uuid> (必須) — 待機する実行。uip tm testsets runから取得します。

• --project-key <key> — owning project key.

• --project-id <id> — owning project ID. Use instead of --project-key.

  Pass --project-id, --project-key, or --test-set-key. When you pass more than one, --project-id is used first, then --project-key, then the project prefix of --test-set-key.

• --test-set-key <key> — テストセットキー(例: DEMO:42);プロジェクト キーはプレフィックスから派生します。

• --timeout <seconds> — maximum time to wait, in seconds. Defaults to 1800 (30 minutes). Pass 0 to wait indefinitely.

注:

There is no --poll-interval flag on this command. The poll interval is fixed at 60 seconds.

警告:

A manual run closed early with executions finish keeps Status: "Running", so wait never sees a terminal state on it. wait blocks until --timeout and then exits 2. Check such a run's ExecutionFinished timestamp with executions get-stats instead.

例

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

Data shape (terminal state reached before the timeout)

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

Status is the terminal state Test Manager reports: Finished or Cancelled. Reaching a terminal state is the success signal for wait; the verb exits 0 whether the tests inside the execution passed or failed. To branch on pass or fail, read the report get output after wait returns.

終了コード

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

終了コード	意味
0	実行がタイムアウト内に終了ステートに達しました。
1	Polling failed (three consecutive API errors, interrupt, abort), sign-in failed, or no project was given. See the Message field for detail.
2	Timed out. The timeout elapsed before the execution reached a terminal state.
3	検証エラー (不正なフラグ値、必須オプションが見つからない)

Exit code 2 is domain-specific. The shared CLI contract reserves 2 for AuthenticationError, but wait reuses it for timeout so that scripts can distinguish "took too long" from "polling failed" without parsing text. uip tm run uses 4 for its own timeout instead. See Exit-code behavior on executions for the full pattern.

スクリプト パターン

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

関連

• testsets run — 待機する ExecutionId を生成します。
• レポート — wait が 0を返した後に読み取る要約です。
• result — JUnit XMLエクスポート。
• 実行のリトライ — 完了した実行の失敗したケースを再実行します。
• executions cancel — stop a running automated execution; poll it to Cancelled with wait.
• run — run every test in an uploaded package, wait, and write a report in one command.

参照

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