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。如果兩個步驟表示相似的操作，但具有不同的維度值，則它們應共用相同的名稱。例如，如果同一組測試在兩個不同的平台上運行，則這兩個步驟應具有相同的名稱。

• 響應：始終設定
• 在建立請求中：始終設定
• 在更新請求中：從未設定

string

該工具的說明例如：mvn clean package -DskipTests=true

• 回應：如果由建立/更新請求設定則存在
• 在建立/更新請求中：可選

enum ( State )

初始狀態為 IN_PROGRESS。唯一合法的狀態轉換是 * IN_PROGRESS -> COMPLETE

如果請求無效轉換，將傳回 PRECONDITION_FAILED。

建立狀態設定為 COMPLETE 的步驟是有效的。此狀態只能設定為 COMPLETE 一次。如果多次將狀態設為 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，則此欄位允許子層級指定維度的值。

鍵必須與執行的維度定義完全匹配。

例如，如果執行具有dimension_definition = ['attempt', 'device'] ，則步驟必須定義這些維度的值，例如。 dimensionValue = ['attempt': '1', 'device': 'Nexus 6']

如果步驟不參與矩陣的某一維，則該維度的值應為空字串。例如，如果其中一項測試是由不支援重試的運行程序執行的，則該步驟可能具有dimensionValue = ['attempt': '', 'device': 'Nexus 6']

如果該步驟不參與矩陣的任何維度，則可能會保留未設定的DimensionValue。

如果執行的維度定義中不存在任何鍵，則會傳回 PRECONDITION_FAILED。

如果本次執行中的另一個步驟已經具有相同的名稱和維度值，但其他資料欄位不同，例如步驟欄位不同，則會傳回 PRECONDITION_FAILED。

如果設定了DimensionValue，且執行中存在未指定為鍵之一的dimension_definition，則會傳回PRECONDITION_FAILED。

• 回應：如果由 create 設定則存在
• 在建立請求中：可選
• 在更新請求中：從未設定

包含"key": value對。範例： { "name": "wrench", "mass": "1.3kg", "count": "3" } 。

object ( Duration )

這一步驟運行需要多長時間。

如果未設定，則當步驟設定為 COMPLETE 狀態時，此值將設定為creationTime 和completionTime 之間的差值。在某些情況下，單獨設定此值是合適的：例如，如果創建了一個步驟，但它所代表的操作在執行之前排隊了幾分鐘，那麼最好不要將排隊所花費的時間包含在其步驟中。運轉持續時間。

如果嘗試在已設定此欄位的步驟上設定 runDuration，則將傳回 PRECONDITION_FAILED。

• 響應：如果之前設定則存在；始終出現在完成步驟中
• 在建立請求中：可選
• 更新請求中：可選

object ( Duration )

執行測試使用了多少設備資源。

這是用於計費目的的設備使用情況，與 runDuration 不同，例如，基礎設施故障不會對設備使用情況進行計費。

如果嘗試在已設定此欄位的步驟上設定 device_usage，則將傳回 PRECONDITION_FAILED。

• 響應：如果之前設定則存在。
• 在建立請求中：可選
• 更新請求中：可選

object ( MultiStep )

當多個步驟以相同的配置作為一個群組運行時的詳細資訊。這些詳細資訊可用於識別該步驟屬於哪一組。它還標識了對所有群組成員進行索引的群組“主要步驟”。

• 響應：如果之前設定則存在。
• 在建立請求中：可選，設定當且僅當此步驟執行多次。
• 更新請求中：可選

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/資源名稱。該字串必須至少包含一個“/”字元。 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

賦予每個步驟的唯一整數。範圍從 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

賦予每個步驟的唯一整數。範圍從 0（含）到總步數（不含）。初級步長為 0。

object ( Duration )

這一步驟運行需要多長時間。