REST Resource: projects.histories.executions.steps

{
  "stepId": string,
  "creationTime": {
    object (Timestamp)
  },
  "completionTime": {
    object (Timestamp)
  },
  "name": string,
  "description": string,
  "state": enum (State),
  "outcome": {
    object (Outcome)
  },
  "hasImages": boolean,
  "labels": {
    string: string,
    ...
  },
  "dimensionValue": {
    string: string,
    ...
  },
  "runDuration": {
    object (Duration)
  },
  "deviceUsageDuration": {
    object (Duration)
  },
  "multiStep": {
    object (MultiStep)
  },

  // Union field step can be only one of the following:
  "testExecutionStep": {
    object (TestExecutionStep)
  },
  "toolExecutionStep": {
    object (ToolExecutionStep)
  }
  // End of list of possible types for union field step.
}

string

このステップの実行内の一意の識別子。

このフィールドが呼び出し元によって設定または上書きされた場合は、INVALID_ARGUMENT を返します。

• 応答: 常に設定
• 作成/更新リクエスト: 設定しない

object ( Timestamp )

ステップが作成された時刻。

• 応答: 常に設定
• 作成/更新リクエスト: 設定しない

object ( Timestamp )

ステップのステータスが完了に設定された時刻。

この値は、状態が COMPLETE に移行すると自動的に設定されます。

• 応答: 実行状態が COMPLETE の場合に設定されます。
• 作成/更新リクエスト: 設定しない

string

UI に表示される人間が判読できる短い名前。最大 100 文字。例: クリーンビルド

新しいステップの名前と次元値が既存のステップと共有されている場合、新しいステップの作成時に PRECONDITION_FAILED が返されます。 2 つのステップが同様のアクションを表しているが、ディメンション値が異なる場合、それらは同じ名前を共有する必要があります。たとえば、同じテスト セットを 2 つの異なるプラットフォームで実行する場合、2 つのステップは同じ名前を持つ必要があります。

• 応答: 常に設定
• 作成リクエストでは: 常に設定されます
• 更新リクエスト時: 設定しない

string

このツールの説明 例: mvn clean package -D stopTests=true

• 応答: 作成/更新リクエストによって設定されている場合は存在します。
• 作成/更新リクエストの場合: オプション

enum ( State )

初期状態は IN_PROGRESS です。正当な状態遷移は * IN_PROGRESS -> COMPLETE のみです。

無効な遷移が要求された場合は、PRECONDITION_FAILED が返されます。

状態を COMPLETE に設定してステップを作成することは有効です。状態を COMPLETE に設定できるのは 1 回だけです。状態が COMPLETE に複数回設定されると、PRECONDITION_FAILED が返されます。

• 応答: 常に設定
• 作成/更新リクエストの場合: オプション

object ( Outcome )

結果の分類 (成功または失敗など)

• 応答: 作成/更新リクエストによって設定されている場合は存在します。
• 作成/更新リクエストの場合: オプション

boolean

このステップの出力のいずれかが、thumbnails.list でサムネイルを取得できる画像であるかどうか。

• 応答: 常に設定
• 作成/更新リクエスト: 設定しない

map (key: string, value: string)

ステップに関連付けられた任意のユーザー指定のキーと値のペア。

ユーザーは、キーが誤って衝突しないようにキーの名前空間を管理する責任があります。

ラベルの数が 100 を超える場合、またはいずれかのキーまたは値の長さが 100 文字を超える場合は、INVALID_ARGUMENT が返されます。

• 応答: 常に設定
• 作成リクエスト内: オプション
• 更新リクエスト時: オプション。新しいキーと値のペアがマップに追加され、既存のキーの新しい値がそのキーの値を更新します。

"key": valueペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" } 。

map (key: string, value: string)

このステップを含む実行に次元定義セットがある場合、このフィールドを使用して子が次元の値を指定できるようになります。

キーは実行の次元定義と正確に一致する必要があります。

たとえば、実行にdimension_definition = ['attempt', 'device']がある場合、ステップではそれらのディメンションの値を定義する必要があります。 dimensionValue = ['attempt': '1', 'device': 'Nexus 6']

ステップが行列の 1 つの次元に参加していない場合、その次元の値は空の文字列である必要があります。たとえば、テストの 1 つが再試行​​をサポートしていないランナーによって実行される場合、ステップdimensionValue = ['attempt': '', 'device': 'Nexus 6']含まれる可能性があります。

ステップが行列のどの次元にも関与していない場合は、dimensionValue を設定しないままにすることができます。

実行の次元定義にキーが存在しない場合は、PRECONDITION_FAILED が返されます。

この実行の別のステップがすでに同じ名前と次元値を持っているが、他のデータ フィールドでは異なる場合 (たとえば、ステップ フィールドが異なる場合)、PRECONDITION_FAILED が返されます。

ディメンション値が設定されており、実行中にキーの 1 つとして指定されていないディメンション定義がある場合は、PRECONDITION_FAILED が返されます。

• 応答: create で設定されている場合は存在します
• 作成リクエスト内: オプション
• 更新リクエスト時: 設定しない

"key": valueペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" } 。

object ( Duration )

このステップの実行にかかった時間。

設定されていない場合、これは、ステップが COMPLETE 状態に設定されたときの CreationTime と completedTime の差に設定されます。場合によっては、この値を個別に設定することが適切な場合があります。たとえば、ステップが作成されたが、それが表す操作が実行前に数分間キューに入れられる場合、キューに費やされた時間をそのステップに含めないことが適切です。 runDuration。

すでにこのフィールドが設定されているステップに runDuration を設定しようとすると、PRECONDITION_FAILED が返されます。

• 応答: 以前に設定されていた場合は存在します。 COMPLETE ステップに常に存在します
• 作成リクエスト内: オプション
• 更新リクエスト時: オプション

object ( Duration )

テストの実行に使用されるデバイス リソースの量。

これは、課金目的で使用されるデバイスの使用量であり、runDuration とは異なります。たとえば、インフラストラクチャの障害に対してデバイスの使用量は課金されません。

すでにこのフィールドが設定されているステップで device_usage を設定しようとすると、PRECONDITION_FAILED が返されます。

• 応答: 以前に設定されていた場合は存在します。
• 作成リクエスト内: オプション
• 更新リクエスト時: オプション

object ( MultiStep )

複数のステップをグループとして同じ構成で実行する場合の詳細。これらの詳細を使用して、このステップがどのグループに属しているかを識別できます。また、すべてのグループ メンバーのインデックスを作成するグループの「プライマリ ステップ」も識別します。

• 応答: 以前に設定されていた場合は存在します。
• create request: オプションで、このステップが複数回実行された場合に設定します。
• 更新リクエスト時: オプション

object ( TestExecutionStep )

テストランナーの実行。

object ( ToolExecutionStep )

ツールの実行 (明示的にサポートされていないステップに使用されます)。

{
  "testSuiteOverviews": [
    {
      object (TestSuiteOverview)
    }
  ],
  "toolExecution": {
    object (ToolExecution)
  },
  "testIssues": [
    {
      object (TestIssue)
    }
  ],
  "testTiming": {
    object (TestTiming)
  }
}

object ( TestSuiteOverview )

テスト スイートの概要コンテンツのリスト。これは、サーバーによって xUnit XML ログから解析されるか、ユーザーによって直接アップロードされます。この参照は、テスト スイートが完全に解析またはアップロードされた場合にのみ呼び出す必要があります。

ステップごとに許可されるテスト スイートの概要の最大数は 1000 です。

• 応答: 常に設定
• 作成リクエスト内: オプション
• 更新リクエスト: なし (代わりに、publishXunitXmlFiles カスタム メソッドを使用します)

object ( ToolExecution )

テストランナーの実行を表します。

このツールの終了コードは、テストが成功したかどうかを判断するために使用されます。

• 応答: 常に設定
• 作成/更新リクエストの場合: オプション

object ( TestIssue )

テスト実行中に観察された問題。

たとえば、テスト中のモバイル アプリがテスト中にクラッシュした場合、デバッグを支援するためにエラー メッセージとスタック トレースの内容をここに記録できます。

• 応答: 作成または更新によって設定されている場合は存在します。
• 作成/更新リクエストの場合: オプション

object ( TestTiming )

テスト実行のタイミングの内訳。

• 応答: 作成または更新によって設定されている場合は存在します。
• 作成/更新リクエストの場合: オプション

{
  "commandLineArguments": [
    string
  ],
  "toolLogs": [
    {
      object (FileReference)
    }
  ],
  "exitCode": {
    object (ToolExitCode)
  },
  "toolOutputs": [
    {
      object (ToolOutputReference)
    }
  ]
}

string

プログラム名を含む完全なトークン化されたコマンド ライン (C プログラムの argv に相当)。

• 応答: 作成リクエストによって設定されている場合は存在します。
• 作成リクエスト内: オプション
• 更新リクエスト時: 設定しない

object ( FileReference )

プレーン テキスト ログへの参照により、ツールの実行が出力されます。

このフィールドは、ツールの実行中にログのライブ ビューにアクセスできるようにするために、ツールが終了する前に設定できます。

ステップごとに許可されるツール ログの最大数は 1000 です。

• 応答: 作成/更新リクエストによって設定されている場合は存在します。
• 作成リクエスト内: オプション
• 更新リクエスト: オプション。指定された値は既存のリストに追加されます。

object ( ToolExitCode )

ツール実行の終了コード。このフィールドは、ツールが終了すると設定されます。

• 応答: 作成/更新リクエストによって設定されている場合は存在します。
• 作成リクエスト内: オプション
• 更新リクエスト: オプションで、exitCode がすでに設定されている場合は FAILED_PRECONDITION エラーが返されます。

object ( ToolOutputReference )

ツールの実行によって出力される任意の形式の不透明なファイルへの参照。

ステップごとに許可されるツール出力の最大数は 1000 です。

• 応答: 作成/更新リクエストによって設定されている場合は存在します。
• 作成リクエスト内: オプション
• 更新リクエスト: オプション。指定された値は既存のリストに追加されます。

{
  "number": integer
}

integer

ツール実行の終了コード。値 0 は、実行が成功したことを意味します。

• 応答: 常に設定
• 作成/更新リクエスト: 常に設定

{
  "errorMessage": string,
  "stackTrace": {
    object (StackTrace)
  },
  "warning": {
    object (Any)
  },
  "severity": enum (Severity),
  "type": enum (Type),
  "category": enum (Category)
}

string

問題を説明する人間が読める短いメッセージ。必須。

object ( StackTrace )

特定の警告内のスタック トレース フィールドを優先して非推奨になりました。

object ( Any )

問題の追加詳細を含む警告メッセージ。常に com.google.devtools.toolresults.v1.warnings からのメッセージである必要があります。

enum ( Severity )

問題の重大度。必須。

enum ( Type )

問題の種類。必須。

enum ( Category )

問題のカテゴリ。必須。

{
  "typeUrl": string,
  "value": string
}

string

シリアル化されたプロトコル バッファ メッセージのタイプを一意に識別する URL/リソース名。この文字列には少なくとも 1 つの「/」文字が含まれている必要があります。 URL のパスの最後のセグメントは、タイプの完全修飾名を表す必要があります ( path/google.protobuf.Durationなど)。名前は正規形式である必要があります (たとえば、先頭の「.」は受け入れられません)。

実際には、チームは通常、Any のコンテキストで使用すると予想されるすべての型をバイナリにプリコンパイルします。ただし、スキームhttp 、 httpsを使用する、またはスキームを使用しない URL の場合は、次のように、タイプ URL をメッセージ定義にマップするタイプ サーバーをオプションでセットアップできます。

• スキームが指定されていない場合は、 httpsが想定されます。
• URL に対する HTTP GET は、バイナリ形式のgoogle.protobuf.Type値を生成する必要があり、そうでない場合はエラーが発生します。
• アプリケーションは、URL に基づいてルックアップ結果をキャッシュしたり、ルックアップを回避するためにバイナリにプリコンパイルしたりすることができます。したがって、型の変更時にバイナリ互換性を維持する必要があります。 (重大な変更を管理するには、バージョン管理された型名を使用します。)

注: この機能は現在、公式の protobuf リリースでは使用できません。また、type.googleapis.com で始まるタイプの URL には使用されません。

http 、 https (または空のスキーム) 以外のスキームは、実装固有のセマンティクスで使用される可能性があります。

string ( bytes format)

上記で指定されたタイプの有効なシリアル化されたプロトコル バッファーである必要があります。

Base64 でエンコードされた文字列。

{
  "testProcessDuration": {
    object (Duration)
  }
}

object ( Duration )

テストプロセスの実行にかかった時間。

• 応答: 以前に設定されていた場合は存在します。
• 作成/更新リクエストの場合: オプション

{
  "toolExecution": {
    object (ToolExecution)
  }
}

object ( ToolExecution )

ツールの実行。

• 応答: 作成/更新リクエストによって設定されている場合は存在します。
• 作成/更新リクエストの場合: オプション

{
  "primaryStepId": string,
  "multistepNumber": integer,
  "primaryStep": {
    object (PrimaryStep)
  }
}

string

プライマリ (元の) ステップのステップ ID (このステップである可能性があります)。

integer

各ステップに与えられる一意の int。範囲は 0 (両端を含む) から合計ステップ数 (両端を含まない) までです。プライマリステップは 0 です。

object ( PrimaryStep )

プライマリ (オリジナル) ステップの場合に存在します。

{
  "rollUp": enum (OutcomeSummary),
  "individualOutcome": [
    {
      object (IndividualOutcome)
    }
  ]
}

enum ( OutcomeSummary )

グループとして同じ構成で実行された複数のステップのロールアップ テスト ステータス。

object ( IndividualOutcome )

ステップ ID と各ステップの結果。

{
  "stepId": string,
  "outcomeSummary": enum (OutcomeSummary),
  "multistepNumber": integer,
  "runDuration": {
    object (Duration)
  }
}

string

enum ( OutcomeSummary )

integer

各ステップに与えられる一意の int。範囲は 0 (両端を含む) から合計ステップ数 (両端を含まない) までです。プライマリステップは 0 です。

object ( Duration )

このステップの実行にかかった時間。