文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 测试套管理/ 通过导入仓库中的文件生成接口测试套
更新时间:2025-06-26 GMT+08:00
分享

通过导入仓库中的文件生成接口测试套

功能介绍

通过导入仓库中的文件生成接口测试套

调用方法

请参见如何调用API

URI

POST /v1/projects/{project_id}/repository/testsuites

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID

约束限制

不涉及

取值范围

32个字符组成的字符串

默认取值

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

约束限制

不涉及

取值范围

字符串长度不少于1,不超过100000

默认取值

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

testsuite_name

String

参数解释

要生成的测试套名称

约束限制

不涉及

取值范围

只能由英文字符组成,且长度为[3-128]个字符

默认取值

不涉及

repository_id

String

参数解释

仓库id

约束限制

不涉及

取值范围

只能由英文字符组成,且长度为32个字符

默认取值

不涉及

repository_branch

String

参数解释

仓库分支

约束限制

不涉及

取值范围

只能由英文字符组成,且长度为[3-100]个字符

默认取值

不涉及

file_path

String

参数解释

仓库中yaml或json文件的相对路径,仅支持swagger 2.0版本的yaml和json文件

约束限制

不涉及

取值范围

只能由英文字符组成,且长度为[6-45]个字符

默认取值

不涉及

响应参数

状态码:201

表4 响应Body参数

参数

参数类型

描述

testsuite_id

String

参数解释

生成的测试套的id

取值范围

32个字符组成的字符串

testcase_ids

Array of strings

参数解释

生成的测试用例uri列表

取值范围

不涉及

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

16个字符组成的字符串

error_detail

Array of CommonResponseDetail objects

参数解释

接口调用失败的详情信息,非参数校验失败没有该结构

error_msg

String

参数解释

接口调用失败错误信息

取值范围

3-100个字符组成的字符串

表6 CommonResponseDetail

参数

参数类型

描述

step_name

String

参数解释

记录错误步骤名称

取值范围

3-100个字符组成的字符串

testcase_name

String

参数解释

用例名称

取值范围

3-128个字符组成的字符串

fail_content

String

参数解释

记录实际错误内容值

取值范围

3-128个字符组成的字符串

fail_keys

String

参数解释

记录包含错误的关键字

取值范围

3-128个字符组成的字符串

fail_source

String

参数解释

记录错误部位header name等

取值范围

3-100个字符组成的字符串

fail_type

String

参数解释

记录错误类型

取值范围

3-100个字符组成的字符串

stage

String

参数解释

记录包含错误阶段

取值范围

2-50个字符组成的字符串

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

状态码:403

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

状态码:404

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

状态码:500

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

请求示例

post https://{endpoint}/v1/projects/75681cbb7c324e15a9eb8ee74a96a474/repository/testsuites

{
  "testsuite_name" : "新测试套",
  "repository_id" : "2213",
  "repository_branch" : "master",
  "file_path" : "/opt"
}

响应示例

状态码:201

Created

{
  "testsuite_id" : "v92u00010adqi1bl",
  "testcase_ids" : [ "bb1d3f7a6ffc409dad173d90b0620d9f", "b24c3b86e8a7456bbb9a9b06cd91dc40" ]
}

SDK代码示例

SDK代码示例如下。

Java

 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
47
48
49
50
51
52
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.cloudtest.v1.region.CloudtestRegion;
import com.huaweicloud.sdk.cloudtest.v1.*;
import com.huaweicloud.sdk.cloudtest.v1.model.*;


public class CreateApiTestSuiteByRepoFileSolution {

    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);

        CloudtestClient client = CloudtestClient.newBuilder()
                .withCredential(auth)
                .withRegion(CloudtestRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateApiTestSuiteByRepoFileRequest request = new CreateApiTestSuiteByRepoFileRequest();
        request.withProjectId("{project_id}");
        CreateTestSuitByRepoFileInfo body = new CreateTestSuitByRepoFileInfo();
        body.withFilePath("/opt");
        body.withRepositoryBranch("master");
        body.withRepositoryId("2213");
        body.withTestsuiteName("新测试套");
        request.withBody(body);
        try {
            CreateApiTestSuiteByRepoFileResponse response = client.createApiTestSuiteByRepoFile(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());
        }
    }
}

Python

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcloudtest.v1.region.cloudtest_region import CloudtestRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcloudtest.v1 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 = CloudtestClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CloudtestRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateApiTestSuiteByRepoFileRequest()
        request.project_id = "{project_id}"
        request.body = CreateTestSuitByRepoFileInfo(
            file_path="/opt",
            repository_branch="master",
            repository_id="2213",
            testsuite_name="新测试套"
        )
        response = client.create_api_test_suite_by_repo_file(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cloudtest "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1/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 := cloudtest.NewCloudtestClient(
        cloudtest.CloudtestClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateApiTestSuiteByRepoFileRequest{}
	request.ProjectId = "{project_id}"
	request.Body = &model.CreateTestSuitByRepoFileInfo{
		FilePath: "/opt",
		RepositoryBranch: "master",
		RepositoryId: "2213",
		TestsuiteName: "新测试套",
	}
	response, err := client.CreateApiTestSuiteByRepoFile(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档