Generating an API Test Suite by Importing Files from a Repository
Function
This API is used to generate an API test suite by importing files from a repository.
Calling Method
For details, see Calling APIs.
URI
POST /v1/projects/{project_id}/repository/testsuites
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project UUID, which uniquely identifies a project. For details about how to obtain the project UUID, see Obtaining a Project ID. Constraints 32 characters (letters and digits). Range N/A. Default Value N/A. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token. It can be obtained by calling the corresponding IAM API. The value of X-Subject-Token in the response header is the user token. Constraints 1 to 100,000 characters. Range N/A. Default Value N/A. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
testsuite_name |
Yes |
String |
Definition Name of the test suite to be generated. Constraints 3 to 128 characters. Range N/A. Default Value N/A. |
repository_id |
Yes |
String |
Definition Repository ID. Constraints 32 characters. Range N/A. Default Value N/A. |
repository_branch |
Yes |
String |
Definition Repository branch. Constraints 3 to 100 characters. Range N/A. Default Value N/A. |
file_path |
Yes |
String |
Definition Relative path of the YAML or JSON file in the repository. Only YAML and JSON files of Swagger 2.0 are supported. Constraints 6 to 45 characters. Range N/A. Default Value N/A. |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
testsuite_id |
String |
Definition ID of the generated test suite. Range A string of 32 characters. |
testcase_ids |
Array of strings |
Definition URI list of generated test cases. Range N/A. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code displayed after the API fails to be called. Range A string of 16 characters. |
error_detail |
Array of CommonResponseDetail objects |
Definition Details about API calling failure. This field does not display for non-parameter verification failures. |
error_msg |
String |
Definition Error message displayed after the API fails to be called. Range A string of 3 to 100 characters. |
Parameter |
Type |
Description |
---|---|---|
step_name |
String |
Definition Name of the incorrect step. Range A string of 3 to 100 characters. |
testcase_name |
String |
Definition Case name. Range A string of 3 to 128 characters. |
fail_content |
String |
Definition The actual error content. Range A string of 3 to 128 characters. |
fail_keys |
String |
Definition The keyword that contains the error. Range A string of 3 to 128 characters. |
fail_source |
String |
Definition The header name of the error part. Range A string of 3 to 100 characters. |
fail_type |
String |
Definition Error type. Range A string of 3 to 100 characters. |
stage |
String |
Definition The stage that contains the error. Range A string of 2 to 50 characters. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code displayed after the API fails to be called. Range N/A. |
error_msg |
String |
Definition Error message displayed after the API fails to be called. Range N/A. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code displayed after the API fails to be called. Range N/A. |
error_msg |
String |
Definition Error message displayed after the API fails to be called. Range N/A. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code displayed after the API fails to be called. Range N/A. |
error_msg |
String |
Definition Error message displayed after the API fails to be called. Range N/A. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code displayed after the API fails to be called. Range N/A. |
error_msg |
String |
Definition Error message displayed after the API fails to be called. Range N/A. |
Example Requests
post https://{endpoint}/v1/projects/75681cbb7c324e15a9eb8ee74a96a474/repository/testsuites { "testsuite_name" : "New test suite", "repository_id" : "2213", "repository_branch" : "master", "file_path" : "/opt" }
Example Responses
Status code: 201
Created
{ "testsuite_id" : "v92u00010adqi1bl", "testcase_ids" : [ "bb1d3f7a6ffc409dad173d90b0620d9f", "b24c3b86e8a7456bbb9a9b06cd91dc40" ] }
SDK Sample Code
The sample code is as follows.
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("New test suite"); 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="New test suite" ) 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: "New test suite", } response, err := client.CreateApiTestSuiteByRepoFile(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More SDK Sample Code
For SDK code examples in more programming languages, visit API Explorer and click the Sample Code tab.
Status Codes
Status Code |
Description |
---|---|
201 |
Created |
400 |
Bad request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not found |
500 |
Internal server error |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot