测试

# 执行测试任务

请求

POST /openapi/quality/testing/task

Body 参数说明

参数名	说明	类型	必填
`project_key`	项目标识	string	是
`test_name`	测试名称	string	是
`repo_info`	代码库运行时配置，未指定时使用测试配置中的默认值	[]RepoInfo	否
`inputs`	运行时变量，未指定的变量使用测试配置中的默认值	[]Input	否

RepoInfo 参数说明

参数名	说明	类型	必填
`codehost_name`	代码源名称	string	是
`repo_namespace`	代码库所属命名空间（组织/个人）	string	是
`repo_name`	代码库名称	string	是
`branch`	分支名称，`enable_commit` 为 `false` 时必填	string	否
`pr`	Pull Request 编号	int	否
`prs`	Pull Request 编号列表	[]int	否
`enable_commit`	是否使用指定 Commit	bool	否
`commit_id`	Commit ID，`enable_commit` 为 `true` 时必填	string	否

repo_info 中的代码库必须已配置在该测试中，不支持覆盖 Perforce 代码库。

Input 参数说明

参数名	说明	类型	必填
`key`	变量名称，必须已配置在该测试中	string	是
`value`	变量值	string	否
`type`	变量类型	string	否
`is_credential`	是否为敏感变量	bool	否
`file_id`	文件 ID	string	否
`file_name`	文件名称	string	否
`file_path`	文件路径	string	否

Body 参数示例

{
    "project_key": "demo",
    "test_name": "test-demo",
    "repo_info": [
        {
            "codehost_name": "github",
            "repo_namespace": "koderover",
            "repo_name": "zadig",
            "branch": "main"
        }
    ],
    "inputs": [
        {
            "key": "ENV",
            "value": "test"
        }
    ]
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

成功返回

参数名	类型	描述
`task_id`	int	测试任务 ID

{
  "task_id": 27
}

1
2
3

失败返回

{
    "code": 500,
    "description": "mongo: no documents in result",
    "message": "Internal Error: "
}

1
2
3
4
5

# 获取测试变量

获取测试的运行时变量定义。敏感变量的 value 不会返回，可通过 has_value 判断是否已配置值。

请求

GET /openapi/quality/testing/:testName?projectKey=<项目标识>

路径参数说明

参数名	类型	描述	必填
`testName`	string	测试名称	是

Query 参数说明

参数名	类型	描述	必填
`projectKey`	string	项目标识	是

成功返回说明

参数名	类型	描述
`project_key`	string	项目标识
`test_name`	string	测试名称
`inputs`	[]TestInput	运行时变量定义

TestInput 参数说明

参数名	类型	描述
`key`	string	变量名称
`value`	string	默认值，敏感变量不返回该字段
`type`	string	变量类型
`choice_option`	[]string	可选值列表
`required`	bool	是否必填
`is_credential`	bool	是否为敏感变量
`has_value`	bool	是否已配置值
`description`	string	变量描述

成功返回示例

{
    "project_key": "demo",
    "test_name": "test-demo",
    "inputs": [
        {
            "key": "ENV",
            "value": "test",
            "type": "choice",
            "choice_option": [
                "test",
                "production"
            ],
            "required": true,
            "is_credential": false,
            "has_value": true,
            "description": "运行环境"
        },
        {
            "key": "PASSWORD",
            "type": "string",
            "required": true,
            "is_credential": true,
            "has_value": true
        }
    ]
}

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

# 获取测试任务详情

请求

GET /openapi/quality/testing/:testName/task/:taskID?projectKey=<项目标识>