获取覆盖率接口
功能介绍
获取单元测试报告覆盖率。
调用方法
请参见如何调用API。
URI
GET /v1/report/{job_id}/summary
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
job_id |
是 |
String |
参数解释: 填写需要查询构建历史列表的构建任务ID。获取方法:在构建任务详情页,拷贝浏览器URL末尾的32位数字、字母组合的字符串,即为构建任务ID。 约束限制: 不涉及。 取值范围: 只能是英文字母和数字,长度为32个字符。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
build_no |
是 |
Integer |
参数解释: 构建任务的构建编号,从1开始,每次构建递增1。 约束限制: 正整数。 取值范围: 只能使用数字,大于等于1。 默认取值: 1 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。(响应消息头中X-Subject-Token的值)。通过调用IAM服务接口获取,参考获取IAM用户Token。 约束限制: 不支持租户全局token,请使用scope为project的region级token。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
参数解释: 接口响应状态。 取值范围: ● success:表示接口调用成功。 ● fail:表示接口调用失败。 |
error |
Object |
参数解释: 错误信息。 取值范围: 不涉及。 |
result |
result object |
参数解释: 调用接口成功后返回的数据。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
summary |
ShowReportSummary object |
参数解释: 单元测试报告。 取值范围: 不涉及。 |
sub_summarys |
Array of ShowReportSummary objects |
参数解释: 单元测试报告列表。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
参数解释: 构建任务ID。 取值范围: 不涉及。 |
build_no |
Integer |
参数解释: 构建编号,用于标识构建任务执行的历史记录。 取值范围: 正整数。 |
stage_name |
String |
参数解释: 步骤名称,对应构建步骤,例如stage2。 取值范围: 不涉及。 |
root_id |
String |
参数解释: 报告编号。 取值范围: 不涉及。 |
total |
Integer |
参数解释: 单元测试报告测试用例总数。 取值范围: 0-2147483647 |
success |
Integer |
参数解释: 单元测试报告测试用例成功数量。 取值范围: 0-2147483647 |
failures |
Integer |
参数解释: 单元测试报告测试用例失败数量。 取值范围: 0-2147483647 |
errors |
Integer |
参数解释: 单元测试报告测试用例错误数量。 取值范围: 0-2147483647 |
others |
Integer |
参数解释: 单元测试报告测试用例其他结果的数量。 取值范围: 0-2147483647 |
success_density |
Float |
参数解释: 构建时长。 取值范围: 不涉及。 |
execution_time |
Integer |
参数解释: 执行所耗费的时间。 取值范围: 不涉及。 |
genrate_time |
String |
参数解释: 生成报告所用的时间。 取值范围: 不涉及。 |
region |
String |
参数解释: 局点。 取值范围: 不涉及。 |
is_success |
Boolean |
参数解释: 是否通过。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
GET https://{endpoint}/v1/report/48c66c6002964721be537cdc6ce0297b/summary
响应示例
状态码:200
OK
{ "result" : { "summary" : { "job_id" : "c798139500d2456d82d95d108f182b5a", "build_no" : 1, "stage_name" : "stage3", "root_id" : "025fa618-a241-4219-87b5-e0e2b0ce0c89", "total" : 1, "success" : 1, "failures" : 0, "errors" : 0, "others" : 0, "success_density" : 1, "execution_time" : 8602, "genrate_time" : "2024-09-20T06:41:03.000+00:00", "region" : { "region" : null }, "is_success" : true }, "sub_summarys" : [ { "job_id" : "c798139500d2456d82d95d108f182b5a", "build_no" : 1, "stage_name" : "stage3", "root_id" : "e3dc82de-597b-46e4-98e7-7b55652184de", "total" : 1, "success" : 1, "failures" : 0, "errors" : 0, "others" : 0, "success_density" : 1, "execution_time" : 8602, "genrate_time" : "2024-09-20T06:41:03.000+00:00", "region" : "xx-xxxx-xx", "is_success" : true } ] }, "error" : null, "status" : "success" }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.codeartsbuild.v3.region.CodeArtsBuildRegion; import com.huaweicloud.sdk.codeartsbuild.v3.*; import com.huaweicloud.sdk.codeartsbuild.v3.model.*; public class ShowReportSummarySolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CodeArtsBuildClient client = CodeArtsBuildClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsBuildRegion.valueOf("<YOUR REGION>")) .build(); ShowReportSummaryRequest request = new ShowReportSummaryRequest(); request.withJobId("{job_id}"); try { ShowReportSummaryResponse response = client.showReportSummary(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartsbuild.v3.region.codeartsbuild_region import CodeArtsBuildRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsbuild.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CodeArtsBuildClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsBuildRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowReportSummaryRequest() request.job_id = "{job_id}" response = client.show_report_summary(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartsbuild "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := codeartsbuild.NewCodeArtsBuildClient( codeartsbuild.CodeArtsBuildClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowReportSummaryRequest{} request.JobId = "{job_id}" response, err := client.ShowReportSummary(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。