Reference

runs

Cloud test runs: a troupe test run split into sandboxed shards, each driving its own device. Index · shared schemas · errors.

runs.create

Start a sharded cloud run of a suite: each shard runs troupe test --shard=i/n in a sandbox with its own device budget

Input:

{
  projectId: ProjectId
  suite: RunSuiteSource
  device: DeviceSpec
  shards?: integer  // 1–16
  workers?: integer  // 1–4
  projects?: string[]  // ≤ 16 items; each 1–128 chars
  grep?: string  // 1–512 chars
  timeoutMs?: integer  // 10000–10800000
  install?: { artifactId: ArtifactId }[]  // ≤ 5 items
}

Output:

{ run: CloudRun; suiteUpload?: SignedRequestOut }

Errors: U, NOT_FOUND, ORG_SUSPENDED, PROJECT_SUSPENDED, QUOTA_EXCEEDED, CAPACITY_UNAVAILABLE, DEVICE_SPEC_INVALID.

Named types: ArtifactId, CloudRun, DeviceSpec, ProjectId, RunSuiteSource, SignedRequestOut.

runs.cancel

Cancel a run: unfinished shards end canceled, their sandboxes stop and their devices are released

Input:

{ projectId: ProjectId; runId: RunId }

Output:

{ run: CloudRun }

Errors: U, NOT_FOUND, CONFLICT.

Named types: CloudRun, ProjectId, RunId.

runs.wait

Wait until the run ends or timeoutMs passes; a timeout is a normal result (done: false)

Input:

{ projectId: ProjectId; runId: RunId; timeoutMs?: TimeoutMs }

Output:

{ done: boolean; run: CloudRun }

Errors: U, NOT_FOUND.

Named types: CloudRun, ProjectId, RunId, TimeoutMs.

runs.shards

A cloud run's shards, in index order, with their status, devices and outcome

Input:

{ projectId: ProjectId; runId: RunId }

Output:

{ shards: CloudShard[] }

Errors: U, NOT_FOUND.

Named types: CloudShard, ProjectId, RunId.